import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const testCaseResult = await client.evaluations.testCaseResults.update(
'evaluation_id',
'test_case_result_id',
);
console.log(testCaseResult);
{
"label_status": "PENDING",
"audit_status": "UNAUDITED",
"audit_required": true,
"audit_comment": "<string>",
"application_spec_id": "<string>",
"evaluation_id": "<string>",
"evaluation_dataset_id": "<string>",
"evaluation_dataset_version_num": "<string>",
"test_case_id": "<string>",
"test_case_evaluation_data": {
"generation_output": "<string>",
"generation_extra_info": {
"schema_type": "CHUNKS",
"chunks": [
{
"text": "<string>",
"metadata": {}
}
]
}
},
"test_case_evaluation_data_schema": "GENERATION",
"result": {},
"completed_at": "2023-11-07T05:31:56Z",
"time_spent_labeling_s": 123,
"application_test_case_output_id": "<string>",
"invalidated_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"annotated_by_user_id": "<string>",
"annotated_by_identity_type": "user",
"edited_by_user_id": "<string>",
"edited_by_identity_type": "user",
"archived_at": "2023-11-07T05:31:56Z",
"edited_by": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"preferences": {}
}
}
Updates a test case result
This API can be used to update the test case result that matches the ID that was passed in as a path parameter. To use this API, pass in the id
that was returned from your Create Test Case Result API call as a path parameter.
Review the request schema to see the fields that can be updated.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const testCaseResult = await client.evaluations.testCaseResults.update(
'evaluation_id',
'test_case_result_id',
);
console.log(testCaseResult);
{
"label_status": "PENDING",
"audit_status": "UNAUDITED",
"audit_required": true,
"audit_comment": "<string>",
"application_spec_id": "<string>",
"evaluation_id": "<string>",
"evaluation_dataset_id": "<string>",
"evaluation_dataset_version_num": "<string>",
"test_case_id": "<string>",
"test_case_evaluation_data": {
"generation_output": "<string>",
"generation_extra_info": {
"schema_type": "CHUNKS",
"chunks": [
{
"text": "<string>",
"metadata": {}
}
]
}
},
"test_case_evaluation_data_schema": "GENERATION",
"result": {},
"completed_at": "2023-11-07T05:31:56Z",
"time_spent_labeling_s": 123,
"application_test_case_output_id": "<string>",
"invalidated_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"annotated_by_user_id": "<string>",
"annotated_by_identity_type": "user",
"edited_by_user_id": "<string>",
"edited_by_identity_type": "user",
"archived_at": "2023-11-07T05:31:56Z",
"edited_by": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"preferences": {}
}
}
Successful Response
The response is of type object
.