PATCH
/
v4
/
evaluation-datasets
/
{evaluation_dataset_id}

Authorizations

x-api-key
string
headerrequired

Path Parameters

evaluation_dataset_id
string
required

Body

application/json
name
string
required

The name of the dataset

restore
boolean
default: false

Set to true to restore the entity from the database.

Response

200 - application/json
name
string
required

The name of the dataset

schema_type
enum<string>
required

The schema type of the dataset.

Available options:
GENERATION,
FLEXIBLE
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
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.

archived_at
string

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