Get Golden Dataset

Get golden dataset test cases with score history from recent eval runs.

GET /api/evals/golden

Get Golden Dataset

cURL

curl --request GET \
  --url https://api.example.com/api/evals/golden

200

{
  "cases": [
    {
      "category": "<string>",
      "difficulty": "<string>",
      "id": "<string>",
      "namespace": "<string>",
      "notes": "<string>",
      "reference": "<string>",
      "reference_contexts": [
        "<string>"
      ],
      "reference_source_ids": [
        "<string>"
      ],
      "score_history": [
        {
          "avg": 0.5,
          "context_recall": 0.5,
          "factual_correctness": 0.5,
          "faithfulness": 0.5,
          "run_id": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "response_relevancy": 0.5
        }
      ],
      "tags": [
        "<string>"
      ],
      "user_input": "<string>"
    }
  ],
  "runs_sampled": 123,
  "total": 123
}

Query Parameters

max_runs · integer · default: 10

Max recent runs for score history

Required range: 1 <= x <= 50

Response

200

application/json

Successful Response

Response for the golden dataset endpoint.

cases · GoldenTestCaseWithHistory · object[] · required

Show child attributes

runs_sampled · integer · required

total · integer · required