GET
/
v4
/
evaluations
/
{evaluation_id}
/
test-case-results
/
history
/
{num}
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 testCaseResult of client.evaluations.testCaseResults.history.list(
    'evaluation_id',
    'num',
  )) {
    console.log(testCaseResult);
  }
}

main();
{
  "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>",
      "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

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 | null

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.