List Evaluations For A Given Agent

List evaluations for a given agent

List Evaluations For A Given Agent

cURL

curl --request GET \
  --url https://{api_endpoint}/api/v1/orchestrate/agent/{agent_id}/evaluations \
  --header 'Authorization: Bearer <token>'

200

{
  "total": 123,
  "page": 123,
  "page_size": 123,
  "evaluations": [
    {
      "executed_date": "<string>",
      "evaluation_status": "PENDING",
      "number_of_test_cases": 123,
      "executed_by": "<string>",
      "id": "<string>",
      "aggregate_metrices": {
        "tool_quality": {
          "average": {
            "value": 123,
            "status": "<string>"
          },
          "accuracy": {
            "value": 123,
            "status": "<string>"
          },
          "relevance": {
            "value": 123,
            "status": "<string>"
          }
        },
        "answer_quality": {
          "average": {
            "value": 123,
            "status": "<string>"
          },
          "relevance": {
            "value": 123,
            "status": "<string>"
          },
          "correctness": {
            "value": 123,
            "status": "<string>"
          },
          "faithfulness": {
            "value": 123,
            "status": "<string>"
          }
        },
        "transaction_completion": {
          "average": {
            "value": 123,
            "status": "<string>"
          },
          "failed": 123,
          "success": 123,
          "total": 123
        }
      },
      "agent_name": "<string>",
      "agent_description": "<string>",
      "agent_environment": []
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

agent_id · string<uuid> · required

Query Parameters

limit · integer · default: 5

Limit the number of results returned

Required range: x >= 1

offset · integer · default: 0

Skip the first N results

Required range: x >= 0

sortkey · enum<string> · default: executed_date

Sort key

Available options: executed_date, number_of_test_cases, executed_by

sort · enum<string> · default: desc

Sort order

Available options: asc, desc

Response

200

application/json

Successful Response

total · integer · required

Total number of evaluations

page · integer · required

Current page

page_size · integer · required

Number of results per page

evaluations · EvaluationResponse · object[] · required

List of evaluations in this page

Show child attributes