GET
/
v4
/
evaluations
/
{evaluation_id}
/
test-case-results
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() {
  // Automatically fetches more pages as needed.
  for await (const testCaseResultWithViews of client.evaluations.testCaseResults.list('evaluation_id')) {
    console.log(testCaseResultWithViews);
  }
}

main();
{
  "items": [
    {
      "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"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

evaluation_id
string
required

Query Parameters

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

Page number for pagination to be returned by the given endpoint. Starts at page 1

Required range: x > 1
limit
integer
default:
100

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

Required range: 1 < x < 10000
account_id
string | null
include_archived
boolean
default:
false

Response

200
application/json
Successful Response
items
object[]
required

The data returned for the current page.

total_item_count
integer
required

The total number of items of the query

current_page
integer
required

The current page number.

items_per_page
integer
required

The number of items per page.