GET
/
agents
/
{agent_id}
/
evaluate
/
jobs
/
{job_id}
/
metadata
curl --request GET \
  --url https://api.contextual.ai/v1/agents/{agent_id}/evaluate/jobs/{job_id}/metadata \
  --header 'Authorization: Bearer <token>'
{
  "status": "pending",
  "metrics": {},
  "job_metadata": {
    "num_predictions": 0,
    "num_failed_predictions": 0,
    "num_successful_predictions": 0,
    "num_processed_predictions": 0
  },
  "dataset_name": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_id
string
required

ID of agent for which to retrieve evaluations

​
job_id
string
required

Evaluation job ID to retrieve status and results for

Response

200
application/json
Successful Response

Response from Get Evaluation Results request

​
status
enum<string>
required

Status of the evaluation round

Available options:
pending,
processing,
retrying,
completed,
failed,
cancelled,
failed_to_provision,
generating_data,
training_in_progress,
failed_to_generate_data,
provisioning
​
metrics
object
required

Results of the evaluation round, grouped by each metric

​
job_metadata
object
required

Metadata of the evaluation round with the number of predictions, failed predictions, and successful predictions.

​
dataset_name
string
required

Dataset name containing the individual results of the evaluation round

Was this page helpful?