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

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

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

  console.log(testCaseResultWithViews);
}

main();
{
  "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": {
        "schema_type": "CHUNKS",
        "chunks": [
          {
            "text": "<string>",
            "metadata": {}
          }
        ]
      }
    },
    "schema_type": "GENERATION",
    "application_interaction_id": "<string>",
    "application_test_case_output_group_id": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "account_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",
      "operation_metadata": {},
      "chat_thread_id": "<string>",
      "interaction_source": "EXTERNAL_AI",
      "created_at": "2023-11-07T05:31:56Z",
      "trace_spans": [
        {
          "id": "<string>",
          "application_interaction_id": "<string>",
          "node_id": "<string>",
          "operation_type": "TEXT_INPUT",
          "operation_status": "SUCCESS",
          "operation_input": {},
          "operation_output": {},
          "operation_expected": {},
          "operation_metadata": {},
          "start_timestamp": "2023-11-07T05:31:56Z",
          "duration_ms": 123
        }
      ]
    }
  },
  "test_case_version": {
    "evaluation_dataset_id": "<string>",
    "schema_type": "GENERATION",
    "test_case_data": {
      "input": "<string>",
      "expected_output": "<string>",
      "expected_extra_info": {
        "schema_type": "CHUNKS",
        "chunks": [
          {
            "text": "<string>",
            "metadata": {}
          }
        ]
      },
      "artifact_ids_filter": [
        "<string>"
      ]
    },
    "chat_history": {},
    "autogenerated": true,
    "test_case_metadata": {},
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "account_id": "<string>",
    "created_by_user_id": "<string>",
    "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>",
    "assigned_to": {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "preferences": {}
    },
    "assignment_expires_at": "2023-11-07T05:31:56Z",
    "status": "PENDING",
    "priority": 123,
    "task_entity": {
      "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>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "created_by_user_id": "<string>",
      "annotated_by_user_id": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  },
  "metrics": {},
  "custom_metrics": [
    {
      "id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "output": 123
    }
  ],
  "annotation_results": [
    {
      "question_id": "<string>",
      "annotation_type": "llm_auto",
      "test_case_result_lineage_id": "<string>",
      "selected_choice": {
        "label": "<string>",
        "value": "<string>",
        "audit_required": true
      },
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "llm_auto_eval_metadata": {
        "cost": 123,
        "prompt_tokens": 123,
        "completion_tokens": 123,
        "time_elapsed_s": 123,
        "llm_reasoning": "<string>",
        "annotation_result_id": "<string>"
      }
    }
  ],
  "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>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "annotated_by_user_id": "<string>",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

evaluation_id
string
required
test_case_result_id
string
required

Query Parameters

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

Response

200
application/json
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
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.

application_test_case_output
object
test_case_version
object
task
object
metrics
object
custom_metrics
object[]
annotation_results
object[]
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.