Skip to main content
POST
/
v4
/
evaluation-datasets
/
{evaluation_dataset_id}
/
evaluation-dataset-versions
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const evaluationDatasetVersion = await client.evaluationDatasets.evaluationDatasetVersions.create(
  'evaluation_dataset_id',
);

console.log(evaluationDatasetVersion.id);
{
  "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"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string

Path Parameters

​
evaluation_dataset_id
string
required

Body

application/json
​
draft
boolean

Boolean to check whether or not the evaluation dataset is in draft mode

​
published_at
string<date-time>

The date and time that all test case results for the evaluation were completed for the evaluation in ISO format.

​
account_id
string

The ID of the account that owns the given entity.

Response

Successful Response

​
num
integer
required

The version number, automatically incremented on creation

​
evaluation_dataset_id
string
required

The ID of the associated evaluation dataset.

​
draft
boolean
required

Boolean to check whether or not the evaluation dataset is in draft mode

​
id
string
required

The unique identifier of the entity.

​
created_at
string<date-time>
required

The date and time when the entity was created 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.

​
created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
​
published_at
string<date-time>

The date and time that all test case results for the evaluation were completed for the evaluation in ISO format.

​
archived_at
string<date-time>

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