GET
/
v4
/
application-variant-reports
/
{application_variant_report_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 applicationVariantWithScoresAndViews = await client.applicationVariantReports.retrieve(
    'application_variant_report_id',
  );

  console.log(applicationVariantWithScoresAndViews.id);
}

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

Authorizations

x-api-key
string
header
required

Path Parameters

application_variant_report_id
string
required

Query Parameters

view
enum<string>[] | null
Available options:
AsyncJobs

Response

200
application/json
Successful Response
application_spec_id
string
required
application_variant_id
string
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.

updated_at
string
required

The date and time when the entity was last updated in ISO format.

async_jobs
object[]
evaluation_datasets
object[]
score
number
category_scores
object[]