POST
/
v4
/
evaluations
/
{evaluation_id}
/
test-case-results
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const testCaseResult = await client.evaluations.testCaseResults.create('evaluation_id', {
  application_spec_id: 'application_spec_id',
  evaluation_dataset_version_num: 'evaluation_dataset_version_num',
  test_case_evaluation_data: { foo: 'bar' },
  test_case_id: 'test_case_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": {}
  }
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string

Path Parameters

evaluation_id
string
required

Body

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

Response

Successful Response

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<date-time>
required

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

updated_at
string<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.

created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
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:
TitleConst
Test Case Evaluation Data SchemaGENERATION
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<date-time>
time_spent_labeling_s
integer

The time spent labeling in seconds.

application_test_case_output_id
string
invalidated_at
string<date-time>

The date and time when the entity was overwritten or deleted in ISO format.

annotated_by_user_id
string

The user who annotated the task.

annotated_by_identity_type
enum<string>

The type of identity that annotated the entity.

Available options:
user,
service_account
edited_by_user_id
string

The user who edited the task.

edited_by_identity_type
enum<string>

The type of identity that edited the entity.

Available options:
user,
service_account
archived_at
string<date-time>

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

edited_by
object