PATCH
/
v4
/
evaluations
/
{evaluation_id}
/
test-case-results
/
{test_case_result_id}

Authorizations

x-api-key
string
headerrequired

Path Parameters

evaluation_id
string
required
test_case_result_id
string
required

Body

application/json
label_status
enum<string>
Available options:
PENDING,
COMPLETED,
FAILED
audit_status
enum<string>
Available options:
UNAUDITED,
FIXED,
APPROVED
audit_required
boolean
audit_comment
string
application_spec_id
string
evaluation_dataset_version_num
string
test_case_id
string
test_case_evaluation_data
object
result
object
time_spent_labeling_s
integer
account_id
string
annotated_by_user_id
string

Response

200 - application/json
label_status
enum<string>
required

The status of the test case result. This should not be explictly set when creating a test case result. When patching a test case result, this field can be set to 'PENDING' to prevent the test case result from being marked 'COMPLETED'.

Available options:
PENDING,
COMPLETED,
FAILED
application_spec_id
string
required
evaluation_id
string
required
evaluation_dataset_id
string
required
evaluation_dataset_version_num
string
required
test_case_id
string
required
test_case_evaluation_data
object
required
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.

audit_status
enum<string>
Available options:
UNAUDITED,
FIXED,
APPROVED
audit_required
boolean
audit_comment
string
test_case_evaluation_data_schema
enum<string>
default: GENERATION
Available options:
GENERATION
result
object

The result of the test case evaluation, in JSON form where the key is the question ID and the value is the result.

completed_at
string
time_spent_labeling_s
integer

The time spent labeling in seconds.

application_test_case_output_id
string
annotated_by_user_id
string

The user who annotated the task.

archived_at
string

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