GET
/
v4
/
evaluation-datasets
/
{evaluation_dataset_id}
/
test-cases
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const testCase of client.evaluationDatasets.testCases.list('evaluation_dataset_id')) {
    console.log(testCase);
  }
}

main();
{
  "items": [
    {
      "evaluation_dataset_id": "<string>",
      "schema_type": "GENERATION",
      "test_case_data": {
        "input": "<string>",
        "expected_output": "<string>",
        "expected_extra_info": {
          "schema_type": "CHUNKS",
          "chunks": [
            {
              "text": "<string>",
              "metadata": {}
            }
          ]
        },
        "artifact_ids_filter": [
          "<string>"
        ]
      },
      "chat_history": {},
      "autogenerated": true,
      "test_case_metadata": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "created_by_user_id": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

evaluation_dataset_id
string
required

Query Parameters

page
integer
default:
1

Page number for pagination to be returned by the given endpoint. Starts at page 1

Required range: x > 1
limit
integer
default:
100

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

Required range: 1 < x < 10000
account_id
string | null
include_archived
boolean
default:
false

Response

200
application/json
Successful Response
items
object[]
required

The data returned for the current page.

total_item_count
integer
required

The total number of items of the query

current_page
integer
required

The current page number.

items_per_page
integer
required

The number of items per page.