import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const autogeneratedDraftTestCase of client.evaluationDatasets.autogeneratedDraftTestCases.list(
'evaluation_dataset_id',
)) {
console.log(autogeneratedDraftTestCase.id);
}{
"items": [
{
"evaluation_dataset_id": "<string>",
"schema_type": "GENERATION",
"test_case_data": {
"input": "<string>",
"artifact_ids_filter": [
"<string>"
],
"expected_output": "<string>",
"expected_extra_info": {
"chunks": [
{
"text": "<string>",
"metadata": {}
}
],
"schema_type": "CHUNKS"
}
},
"approved": true,
"content_metadata": {},
"id": "<string>",
"account_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"topic_str": "<string>",
"missing_chunks": [
{
"chunk_text": "<string>",
"artifact_id": "<string>",
"artifact_name": "<string>",
"artifact_content_modification_identifier": "<string>"
}
]
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const autogeneratedDraftTestCase of client.evaluationDatasets.autogeneratedDraftTestCases.list(
'evaluation_dataset_id',
)) {
console.log(autogeneratedDraftTestCase.id);
}{
"items": [
{
"evaluation_dataset_id": "<string>",
"schema_type": "GENERATION",
"test_case_data": {
"input": "<string>",
"artifact_ids_filter": [
"<string>"
],
"expected_output": "<string>",
"expected_extra_info": {
"chunks": [
{
"text": "<string>",
"metadata": {}
}
],
"schema_type": "CHUNKS"
}
},
"approved": true,
"content_metadata": {},
"id": "<string>",
"account_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"topic_str": "<string>",
"missing_chunks": [
{
"chunk_text": "<string>",
"artifact_id": "<string>",
"artifact_name": "<string>",
"artifact_content_modification_identifier": "<string>"
}
]
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}Check if test cases are based on missing chunks
Page number for pagination to be returned by the given endpoint. Starts at page 1
x >= 1Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
1 <= x <= 10000Successful Response
The data returned for the current page.
Show child attributes
The total number of items of the query
The current page number.
The number of items per page.