List Evaluation Datasets

get https://api.egp.scale.com/v4/evaluation-datasets

Description

Lists all evaluation datasets accessible to the user.

Details

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.

Responses

Response body

object

items

array of objects

required

The data returned for the current page.

Paginated list of EvaluationDatasetResponseWithViews*

object

test_case_count

integer

evaluation_dataset_versions

array of objects

Evaluation Dataset Versions

object

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

published_at

date-time

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

string

required

The unique identifier of the entity.

created_at

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.

archived_at

date-time

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

name

string

required

The name of the dataset

schema_type

string

required

The schema type of the dataset.

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

Has additional fields

out_of_date

boolean

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

vendor

const

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

string

required

The unique identifier of the entity.

created_at

date-time

required

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

updated_at

date-time

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

date-time

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

schema_sub_type

string

summarization translation

total_item_count

integer

required

The total number of items of the query

current_page

integer

required

The current page number.

items_per_page

integer

required

The number of items per page.

Language

Credentials

Header

Request


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.egp.scale.com/v4/evaluation-datasets?page=1&limit=100&include_archived=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error