Evaluation Run Finish

Finish an evaluation run.

POST /v2/{entity}/{project}/evaluation_runs/{evaluation_run_id}/finish

Evaluation Run Finish

cURL

curl --request POST \
  --url https://api.example.com/v2/{entity}/{project}/evaluation_runs/{evaluation_run_id}/finish \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "summary": {}
}'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

entity · string · required

project · string · required

evaluation_run_id · string · required

Body

application/json

Request body for finishing an evaluation run via REST API.

This model excludes project_id and evaluation_run_id since they come from the URL path in RESTful endpoints.

summary · Summary · object

Optional summary dictionary for the evaluation run

Response

200

application/json

Successful Response

success · boolean · required

Whether the evaluation run was finished successfully