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

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

const evaluationDataset = await client.evaluationDatasets.retrieve('evaluation_dataset_id');

console.log(evaluationDataset.id);
{
  "test_case_count": 123,
  "evaluation_dataset_versions": [
    {
      "num": 123,
      "evaluation_dataset_id": "<string>",
      "draft": true,
      "published_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "created_by_user_id": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "name": "<string>",
  "schema_type": "GENERATION",
  "knowledge_base_id": "<string>",
  "evaluation_dataset_metadata": {},
  "out_of_date": true,
  "vendor": "scale",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "archived_at": "2023-11-07T05:31:56Z",
  "schema_sub_type": "summarization"
}

Authorizations

x-api-key
string
header
required

Path Parameters

evaluation_dataset_id
string
required

Query Parameters

view
enum<string>[]

Response

200
application/json

Successful Response

The response is of type object.