import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const evaluationDataset of client.evaluationDatasets.list()) {
console.log(evaluationDataset.id);
}{
"items": [
{
"name": "<string>",
"schema_type": "GENERATION",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"test_case_count": 123,
"evaluation_dataset_versions": [
{
"num": 123,
"evaluation_dataset_id": "<string>",
"draft": true,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"published_at": "2023-11-07T05:31:56Z",
"archived_at": "2023-11-07T05:31:56Z"
}
],
"knowledge_base_id": "<string>",
"evaluation_dataset_metadata": {},
"out_of_date": true,
"vendor": "scale",
"archived_at": "2023-11-07T05:31:56Z",
"schema_sub_type": "summarization"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}Lists all evaluation datasets accessible to the user.
This API can be used to list evaluation datasets. If a user has access to multiple accounts, all evaluation datasets from all accounts the user is associated with will be returned.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const evaluationDataset of client.evaluationDatasets.list()) {
console.log(evaluationDataset.id);
}{
"items": [
{
"name": "<string>",
"schema_type": "GENERATION",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"test_case_count": 123,
"evaluation_dataset_versions": [
{
"num": 123,
"evaluation_dataset_id": "<string>",
"draft": true,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"published_at": "2023-11-07T05:31:56Z",
"archived_at": "2023-11-07T05:31:56Z"
}
],
"knowledge_base_id": "<string>",
"evaluation_dataset_metadata": {},
"out_of_date": true,
"vendor": "scale",
"archived_at": "2023-11-07T05:31:56Z",
"schema_sub_type": "summarization"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}DatasetVersion, TestCaseCount 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 name of the dataset
The schema type of the dataset.
GENERATION, FLEXIBLE The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The date and time when the entity was last updated in ISO format.
The ID of the account that owns the given entity.
The user who originally created the entity.
The type of identity that created the entity.
user, service_account Show child attributes
The version number, automatically incremented on creation
The ID of the associated evaluation dataset.
Boolean to check whether or not the evaluation dataset is in draft mode
The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The ID of the account that owns the given entity.
The user who originally created the entity.
The type of identity that created the entity.
user, service_account The date and time that all test case results for the evaluation were completed for the evaluation in ISO format.
The date and time when the entity was archived in ISO format.
ID of the knowledge base that the evaluation dataset is associated with.
Metadata about the Evaluation Dataset that it is associated with
Boolean to check whether or not the knowledge base has been uploaded to since publication of the dataset.
The vendor of the evaluation dataset (e.g. 'Scale' for Scale off-the-shelf datasets). Null if the evaluation dataset is not from a vendor (e.g., is created by the customer).
scale The date and time when the entity was archived in ISO format.
summarization, translation The total number of items of the query
The current page number.
The number of items per page.