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

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

// Automatically fetches more pages as needed.
for await (const testCaseResult of client.evaluations.testCaseResults.history.list('evaluation_id', 'num')) {
  console.log(testCaseResult);
}
{
  "items": [
    {
      "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>",
      "annotated_by_user_id": "<string>",
      "edited_by_user_id": "<string>",
      "archived_at": "2023-11-07T05:31:56Z",
      "edited_by": {
        "id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "preferences": {}
      }
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string

Path Parameters

​
num
string
required
​
evaluation_id
string
required

Query Parameters

​
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

Response

200
application/json

Successful Response

The response is of type object.