Skip to main content
GET
Python

Authorizations

x-api-key
string
header
required

Path Parameters

evaluation_id
string
required

Query Parameters

view
enum<string>[] | null
Available options:
ApplicationSpec,
AsyncJobs,
EvaluationConfig,
EvaluationDatasets

Response

Successful Response

name
string
required
description
string
required
status
enum<string>
required
Available options:
PENDING,
COMPLETED,
FAILED
application_spec_id
string
required
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

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
evaluation_datasets
EvaluationDatasetResponse · object[]
evaluation_config_expanded
EvaluationConfigExpanded · object
async_jobs
AsyncJobForView · object[]
application_spec
ApplicationSpecResponse · object
application_variant_id
string
tags
Tags · object
evaluation_config
Evaluation Config · object
evaluation_config_id
string

The ID of the associated evaluation config.

completed_at
string<date-time>

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

annotation_config
AnnotationConfig · object

Annotation configuration for tasking

question_id_to_annotation_config
Question Id To Annotation Config · object

Specifies the annotation configuration to use for specific questions.

metric_config
MetricConfig · object

Specifies the config for the metrics to be computed.

archived_at
string<date-time>

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