POST
/
v4
/
evaluations

Authorizations

x-api-key
string
headerrequired

Headers

x-selected-account-id
string

Body

application/json
name
string
required
description
string
required
application_spec_id
string
required
application_variant_id
string
required
tags
object
evaluation_config
object
evaluation_config_id
string

The ID of the associated evaluation config.

question_id_to_annotation_config
object

Specifies the annotation configuration to use for specific questions.

account_id
string
required

The ID of the account that owns the given entity.

annotation_config
object

Annotation configuration for tasking

type
enum<string>
default: builder

create standalone evaluation or build evaluation which will auto generate test case results

Available options:
builder
evaluation_dataset_id
string
required
evaluation_dataset_version
integer

Response

200 - application/json
name
string
required
description
string
required
status
enum<string>
required

An enumeration.

Available options:
PENDING,
COMPLETED,
FAILED
application_spec_id
string
required
application_variant_id
string
tags
object
evaluation_config
object
evaluation_config_id
string

The ID of the associated evaluation config.

completed_at
string

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

question_id_to_annotation_config
object

Specifies the annotation configuration to use for specific questions.

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.

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.