Skip to main content
GET
/
v4
/
evaluations
/
{evaluation_id}
/
test-case-results
/
{test_case_result_id}
JavaScript
import SGPClient from 'sgp';

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

const testCaseResultWithViews = await client.evaluations.testCaseResults.retrieve(
  'evaluation_id',
  'test_case_result_id',
);

console.log(testCaseResultWithViews);
{
  "label_status": "PENDING",
  "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": {
      "chunks": [
        {
          "text": "<string>",
          "metadata": {}
        }
      ],
      "schema_type": "CHUNKS"
    }
  },
  "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",
  "application_test_case_output": {
    "application_variant_id": "<string>",
    "evaluation_dataset_id": "<string>",
    "test_case_version_id": "<string>",
    "test_case_id": "<string>",
    "output": {
      "generation_output": "<string>",
      "generation_extra_info": {
        "chunks": [
          {
            "text": "<string>",
            "metadata": {}
          }
        ],
        "schema_type": "CHUNKS"
      }
    },
    "schema_type": "GENERATION",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "account_id": "<string>",
    "application_interaction_id": "<string>",
    "application_test_case_output_group_id": "<string>",
    "interaction": {
      "id": "<string>",
      "input": {},
      "output": {},
      "aggregated": true,
      "application_spec_id": "<string>",
      "application_variant_id": "<string>",
      "start_timestamp": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "operation_status": "SUCCESS",
      "created_at": "2023-11-07T05:31:56Z",
      "operation_metadata": {},
      "chat_thread_id": "<string>",
      "interaction_source": "EXTERNAL_AI",
      "trace_spans": [
        {
          "id": "<string>",
          "node_id": "<string>",
          "operation_type": "TEXT_INPUT",
          "operation_status": "SUCCESS",
          "operation_input": {},
          "operation_output": {},
          "start_timestamp": "2023-11-07T05:31:56Z",
          "duration_ms": 123,
          "application_interaction_id": "<string>",
          "application_variant_id": "<string>",
          "operation_expected": {},
          "operation_metadata": {},
          "end_timestamp": "2023-11-07T05:31:56Z",
          "trace_id": "<string>",
          "parent_id": "<string>",
          "group_id": "<string>",
          "account_id": "<string>",
          "created_by_user_id": "<string>",
          "created_by_identity_type": "user"
        }
      ]
    }
  },
  "test_case_version": {
    "evaluation_dataset_id": "<string>",
    "test_case_data": {
      "input": "<string>",
      "artifact_ids_filter": [
        "<string>"
      ],
      "expected_output": "<string>",
      "expected_extra_info": {
        "chunks": [
          {
            "text": "<string>",
            "metadata": {}
          }
        ],
        "schema_type": "CHUNKS"
      }
    },
    "autogenerated": true,
    "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",
    "schema_type": "GENERATION",
    "chat_history": {},
    "test_case_metadata": {},
    "invalidated_at": "2023-11-07T05:31:56Z",
    "archived_at": "2023-11-07T05:31:56Z"
  },
  "task": {
    "id": "<string>",
    "task_type": "EVALUATION_ANNOTATION",
    "task_entity_parent_id": "<string>",
    "task_entity_id": "<string>",
    "account_id": "<string>",
    "status": "NOT_READY",
    "priority": 123,
    "assigned_to": {
      "id": "<string>",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "preferences": {}
    },
    "assignment_expires_at": "2023-11-07T05:31:56Z",
    "task_entity": {
      "label_status": "PENDING",
      "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": {
          "chunks": [
            {
              "text": "<string>",
              "metadata": {}
            }
          ],
          "schema_type": "CHUNKS"
        }
      },
      "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",
      "audit_status": "UNAUDITED",
      "audit_required": true,
      "audit_comment": "<string>",
      "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",
      "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>",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "preferences": {}
      }
    }
  },
  "metrics": {},
  "custom_metrics": [
    {
      "id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "output": 123
    }
  ],
  "audit_tasks": [
    {
      "id": "<string>",
      "task_type": "EVALUATION_ANNOTATION",
      "task_entity_parent_id": "<string>",
      "task_entity_id": "<string>",
      "account_id": "<string>",
      "status": "NOT_READY",
      "priority": 123,
      "assigned_to": {
        "id": "<string>",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "preferences": {}
      },
      "assignment_expires_at": "2023-11-07T05:31:56Z",
      "task_entity": {
        "label_status": "PENDING",
        "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": {
            "chunks": [
              {
                "text": "<string>",
                "metadata": {}
              }
            ],
            "schema_type": "CHUNKS"
          }
        },
        "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",
        "audit_status": "UNAUDITED",
        "audit_required": true,
        "audit_comment": "<string>",
        "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",
        "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>",
          "email": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "preferences": {}
        }
      }
    }
  ],
  "annotation_results": [
    {
      "question_id": "<string>",
      "annotation_type": "llm_auto",
      "test_case_result_lineage_id": "<string>",
      "selected_choice": {
        "label": "<string>",
        "value": "<string>",
        "audit_required": false
      },
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "llm_auto_eval_metadata": {
        "prompt_tokens": 123,
        "completion_tokens": 123,
        "time_elapsed_s": 123,
        "llm_reasoning": "<string>",
        "annotation_result_id": "<string>",
        "cost": 123
      }
    }
  ],
  "audit_status": "UNAUDITED",
  "audit_required": true,
  "audit_comment": "<string>",
  "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",
  "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>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "preferences": {}
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
evaluation_id
string
required
​
test_case_result_id
string
required

Query Parameters

​
view
enum<string>[]
Available options:
AnnotationResults,
AuditTasks,
CustomMetrics,
Metrics,
Task,
TestCaseVersion,
Trace

Response

Successful Response

  • GenerationTestCaseResultResponseWithViews
  • FlexibleTestCaseResultResponseWithViews
​
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
ResultSchemaGeneration · 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
​
application_test_case_output
ApplicationTestCaseOutputWithTraces · object
​
test_case_version
GenerationTestCaseVersionResponse · object
  • GenerationTestCaseVersionResponse
  • FlexibleTestCaseVersionResponse
​
task
TaskWithAssignee · object
​
metrics
Metrics · object
​
custom_metrics
MetricValueEntity · object[]
​
audit_tasks
TaskWithAssignee · object[]
​
annotation_results
AnnotationResultExpanded · object[]
​
audit_status
enum<string>
Available options:
UNAUDITED,
FIXED,
APPROVED
​
audit_required
boolean
​
audit_comment
string
​
test_case_evaluation_data_schema
string
default:GENERATION
Allowed value: "GENERATION"
​
result
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
UserV2Details · object