Get Evaluation

get https://api.egp.scale.com/v4/evaluations/{evaluation_id}

Description

Gets the details of a evaluation

Details

This API can be used to get information about a single evaluation by ID. To use this API, pass in the id that was returned from your Create Evaluation API call as a path parameter.

Review the response schema to see the fields that will be returned.

Responses

Response body

object

evaluation_datasets

array of objects

Evaluation Datasets

object

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

evaluation_config_expanded

async_jobs

array of objects

Async Jobs

object

job_type

string

parent_job_id

string

status

string

required

progress

object

Has additional fields

job_metadata

object

Has additional fields

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.

string

required

The unique identifier of the entity.

application_spec

object

name

string

required

The name of the Application Spec

description

string

required

The description of the Application Spec

theme_id

string

run_online_evaluation

boolean

Whether the application spec should run online evaluation, default is false

parent_application_spec_id

string

Application spec ID of the parent application from which the variants and deployments are inherited.

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

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

description

string

required

status

string

required

PENDING COMPLETED FAILED

application_spec_id

string

required

application_variant_id

string

tags

object

Has additional fields

evaluation_config

object

Has additional fields

evaluation_config_id

string

The ID of the associated evaluation config.

completed_at

date-time

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

total_test_case_result_count

integer

required

The total number of test case results for the evaluation

completed_test_case_result_count

integer

required

The number of test case results that have been completed for the evaluation

annotation_config

object

Annotation configuration for tasking

annotation_config_type

string

Defaults to flexible

generation flexible summarization multiturn translation

components

array of arrays of objects

Components

array of objects

object

optional

boolean

Defaults to false

data_loc

array of strings

required

DataLoc*

label

string

direction

string

Defaults to row

col row

llm_prompt

object

question_id_to_annotation_config

object

Specifies the annotation configuration to use for specific questions.

metric_config

object

Specifies the config for the metrics to be computed.

components

array of objects

required

Components*

object

type

string

required

rouge bleu meteor cosine_similarity f1

name

string

required

mappings

object

params

object

Has additional fields

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.

Language

Credentials

Header

Request


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.egp.scale.com/v4/evaluations/evaluation_id \
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