List Results

Retrieve Results of an Evaluation Run

get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results

To retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results.

Path Parameters

evaluation_run_uuidstring

Returns

evaluation_runagent_deletedbooleanagent_namestringagent_uuidstringagent_version_hashstringagent_workspace_uuidstringcreated_by_user_emailstringcreated_by_user_idstringerror_descriptionstringevaluation_run_uuidstringfinished_atstringpass_statusbooleanrun_level_metric_resultsarray of APIEvaluationMetricResultrun_namestringstar_metric_resultAPIEvaluationMetricResultstarted_atstringstatusenumtest_case_uuidstringtest_case_versionnumberAPIEvaluationRun

optional

promptsarray of ground_truthstringinputstringoutputstringprompt_chunksarray of objectprompt_idnumberprompt_level_metric_resultsarray of APIEvaluationMetricResultAPIEvaluationPrompt

optional

The prompt level results.

Request example cURL

curl https://api.digitalocean.com//v2/gen-ai/evaluation_runs/$EVALUATION_RUN_UUID/results \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"

200 Example

{
  "evaluation_run": {
    "agent_deleted": true,
    "agent_name": "agent_name",
    "agent_uuid": "agent_uuid",
    "agent_version_hash": "agent_version_hash",
    "agent_workspace_uuid": "agent_workspace_uuid",
    "created_by_user_email": "created_by_user_email",
    "created_by_user_id": "created_by_user_id",
    "error_description": "error_description",
    "evaluation_run_uuid": "evaluation_run_uuid",
    "finished_at": "2019-12-27T18:11:19.117Z",
    "pass_status": true,
    "run_level_metric_results": [
      {
        "metric_name": "metric_name",
        "number_value": 0,
        "string_value": "string_value"
      }
    ],
    "run_name": "run_name",
    "star_metric_result": {
      "metric_name": "metric_name",
      "number_value": 0,
      "string_value": "string_value"
    },
    "started_at": "2019-12-27T18:11:19.117Z",
    "status": "EVALUATION_RUN_STATUS_UNSPECIFIED",
    "test_case_uuid": "test_case_uuid",
    "test_case_version": 0
  },
  "prompts": [
    {
      "ground_truth": "ground_truth",
      "input": "input",
      "output": "output",
      "prompt_chunks": [
        {
          "chunk_usage_pct": 0,
          "chunk_used": true,
          "index_uuid": "index_uuid",
          "source_name": "source_name",
          "text": "text"
        }
      ],
      "prompt_id": 0,
      "prompt_level_metric_results": [
        {
          "metric_name": "metric_name",
          "number_value": 0,
          "string_value": "string_value"
        }
      ]
    }
  ]
}