GET
/
v4
/
application-variant-reports
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 applicationVariantWithScoresAndViews of client.applicationVariantReports.list()) {
    console.log(applicationVariantWithScoresAndViews.id);
  }
}

main();
{
  "items": [
    {
      "async_jobs": [
        {
          "id": "<string>",
          "job_type": "application-variant-report-generation",
          "status": "Pending",
          "progress": {
            "completed": 123,
            "failed": 123,
            "pending": 123
          },
          "job_metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "application_spec_id": "<string>",
      "application_variant_id": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "evaluation_datasets": [
        {
          "generation_status": "Pending",
          "evaluation_dataset_version_num": 123,
          "evaluation_dataset": {
            "name": "<string>",
            "schema_type": "GENERATION",
            "knowledge_base_id": "<string>",
            "evaluation_dataset_metadata": {},
            "out_of_date": true,
            "vendor": "scale",
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "account_id": "<string>",
            "created_by_user_id": "<string>",
            "archived_at": "2023-11-07T05:31:56Z",
            "schema_sub_type": "summarization"
          },
          "scored_test_case_count": 123
        }
      ],
      "score": 123,
      "category_scores": [
        {
          "category": "accuracy",
          "score": 123,
          "metric_scores": [
            {
              "score": 123,
              "metric_type": "answer-correctness",
              "category": "accuracy"
            }
          ]
        }
      ]
    }
  ],
  "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

Query Parameters

view
enum<string>[] | null
Available options:
AsyncJobs
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
application_spec_id
application_variant_id

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.