/datastores/{id}/documents
/agents/{id}/query
/agents/{id}/evaluate
/agents/{id}/datasets/evaluate
/agents/{id}/datasets/tune
/agents/{id}/tune
/lmunit
/generate
/rerank
List Evaluations
Retrieve a list of Evaluation
jobs run for a given Agent
, including the Evaluation
’s status and other metadata.
curl --request GET \
--url https://api.contextual.ai/v1/agents/{agent_id}/evaluate/jobs \
--header 'Authorization: Bearer <token>'
{
"evaluation_rounds": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"processing_started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"status": "pending",
"summary_results": {},
"num_predictions": 123,
"num_failed_predictions": 123,
"num_successful_predictions": 123,
"num_processed_predictions": 123,
"results_dataset_name": "<string>"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of agent for which to retrieve evaluation jobs
Response
Response from List Evaluations request
List of evaluation results
Metadata of an evaluation round
ID of the evaluation round
Email of the user who launched the evaluation round
Timestamp indicating when the evaluation round was created
Status of the evaluation round
pending
, processing
, retrying
, completed
, failed
, cancelled
, failed_to_provision
, generating_data
, training_in_progress
, failed_to_generate_data
, provisioning
Timestamp indicating when the evaluation round started processing
Timestamp indicating when the evaluation round finished processing
Score of the evaluation round
Total number of predictions made during the evaluation round
Number of predictions that failed during the evaluation round
Number of predictions that were successful during the evaluation round
Number of predictions that have been processed during the evaluation round
Name of the dataset with the evaluation results
Was this page helpful?
curl --request GET \
--url https://api.contextual.ai/v1/agents/{agent_id}/evaluate/jobs \
--header 'Authorization: Bearer <token>'
{
"evaluation_rounds": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"processing_started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"status": "pending",
"summary_results": {},
"num_predictions": 123,
"num_failed_predictions": 123,
"num_successful_predictions": 123,
"num_processed_predictions": 123,
"results_dataset_name": "<string>"
}
]
}