Scale API | Application Variant Reports › List Application Variant Reports

Application Variant Reports

application_variant_reports

Methods

Create Application Variant Report ->

ApplicationVariantWithScores

post/v4/application-variant-reports

Description

Creates a application variant report

Details

This API can be used to create a application variant report. To use this API, review the request schema and pass in all fields that are required to create a application variant report.

List Application Variant Reports -> PageResponse<

ApplicationVariantWithScoresAndViews

get/v4/application-variant-reports

Description

Lists all application variant reports accessible to the user.

Details

This API can be used to list application variant reports. If a user has access to multiple accounts, all application variant reports from all accounts the user is associated with will be returned.

Security

API Key Header

Example: x-api-key: My API Key

Parameters

account_id: string

Optional

application_spec_id:

Optional

UnionMember0 = number

UnionMember1 = string

application_variant_id:

Optional

UnionMember0 = number

UnionMember1 = string

limit: number

Optional

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

page: number

Optional

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

view: Array<

Optional

"AsyncJobs"

Response fields

current_page: number

The current page number.

items: Array<

ApplicationVariantWithScoresAndViews

The data returned for the current page.

items_per_page: number

The number of items per page.

total_item_count: number

The total number of items of the query

Request example

curl https://api.egp.scale.com/v4/application-variant-reports \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "application_spec_id": "application_spec_id",
      "application_variant_id": "application_variant_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "async_jobs": [
        {
          "id": "id",
          "created_at": "2019-12-27T18:11:19.117Z",
          "job_type": "application-variant-report-generation",
          "status": "Pending",
          "updated_at": "2019-12-27T18:11:19.117Z",
          "job_metadata": {},
          "progress": {
            "completed": 0,
            "failed": 0,
            "pending": 0
          }
        }
      ],
      "category_scores": [
        {
          "category": "accuracy",
          "metric_scores": [
            {
              "category": "accuracy",
              "metric_type": "answer-correctness",
              "score": 0
            }
          ],
          "score": 0
        }
      ],
      "evaluation_datasets": [
        {
          "evaluation_dataset": {
            "id": "id",
            "account_id": "account_id",
            "created_at": "2019-12-27T18:11:19.117Z",
            "created_by_user_id": "created_by_user_id",
            "name": "name",
            "schema_type": "GENERATION",
            "updated_at": "2019-12-27T18:11:19.117Z",
            "archived_at": "2019-12-27T18:11:19.117Z",
            "evaluation_dataset_metadata": {},
            "knowledge_base_id": "knowledge_base_id",
            "out_of_date": true,
            "schema_sub_type": "summarization",
            "vendor": "scale"
          },
          "evaluation_dataset_version_num": 0,
          "generation_status": "Pending",
          "scored_test_case_count": 0
        }
      ],
      "score": 0
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Get Application Variant Report ->

ApplicationVariantWithScoresAndViews

get/v4/application-variant-reports/{application_variant_report_id}

Description

Gets the details of a application variant report

Details

This API can be used to get information about a single application variant report by ID. To use this API, pass in the id that was returned from your Create Application Variant Report API call as a path parameter.

Review the response schema to see the fields that will be returned.

Domain types

ApplicationVariantWithScores = { id, account_id, application_spec_id, 6 more... }

ApplicationVariantWithScoresAndViews = { id, account_id, application_spec_id, 7 more... }