POST
/
v4
/
evaluation-datasets
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() {
  const evaluationDataset = await client.evaluationDatasets.create({
    account_id: 'account_id',
    name: 'name',
    schema_type: 'GENERATION',
  });

  console.log(evaluationDataset.id);
}

main();
{
  "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

Headers

​
x-selected-account-id
string

Body

application/json
​
name
string
required

The name of the dataset

​
schema_type
enum<string>
required

The schema type of the dataset. Only GENERATION is currently supported.

Available options:
GENERATION
​
account_id
string
required

The ID of the account that owns the given entity.

​
knowledge_base_id
string
required

ID of the knowledge base to generate the evaluation dataset from.

​
type
enum<string>
default:autogenerated

Manually or automatically generated dataset

Response

200
application/json
Successful Response
​
name
string
required

The name of the dataset

​
schema_type
enum<string>
required

The schema type of the dataset.

Available options:
GENERATION,
FLEXIBLE
​
id
string
required

The unique identifier of the entity.

​
created_at
string
required

The date and time when the entity was created in ISO format.

​
updated_at
string
required

The date and time when the entity was last updated in ISO format.

​
account_id
string
required

The ID of the account that owns the given entity.

​
created_by_user_id
string
required

The user who originally created the entity.

​
knowledge_base_id
string

ID of the knowledge base that the evaluation dataset is associated with.

​
evaluation_dataset_metadata
object

Metadata about the Evaluation Dataset that it is associated with

​
out_of_date
boolean

Boolean to check whether or not the knowledge base has been uploaded to since publication of the dataset.

​
vendor
enum<string>

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).

Available options:
scale
​
archived_at
string

The date and time when the entity was archived in ISO format.

​
schema_sub_type
enum<string>
Available options:
summarization,
translation