Skip to main content
POST
/
v4
/
application-variant-reports
Python
import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
application_variant_with_scores = client.application_variant_reports.create(
    application_variant_id="application_variant_id",
    evaluation_dataset_ids=["string"],
)
print(application_variant_with_scores.id)
package main

import (
"context"
"fmt"

"github.com/stainless-sdks/sgp-go"
"github.com/stainless-sdks/sgp-go/option"
)

func main() {
client := sgp.NewClient(
option.WithAPIKey("My API Key"),
)
applicationVariantWithScores, err := client.ApplicationVariantReports.New(context.TODO(), sgp.ApplicationVariantReportNewParams{
ApplicationVariantID: sgp.F("application_variant_id"),
EvaluationDatasetIDs: sgp.F([]string{"string"}),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", applicationVariantWithScores.ID)
}
curl --request POST \
--url https://api.egp.scale.com/v4/application-variant-reports \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"application_variant_id": "<string>",
"evaluation_dataset_ids": [
"<string>"
],
"account_id": "<string>",
"application_test_case_output_group_ids": [
"<string>"
]
}
'
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
application_variant_id: '<string>',
evaluation_dataset_ids: ['<string>'],
account_id: '<string>',
application_test_case_output_group_ids: ['<string>']
})
};

fetch('https://api.egp.scale.com/v4/application-variant-reports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v4/application-variant-reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_variant_id' => '<string>',
'evaluation_dataset_ids' => [
'<string>'
],
'account_id' => '<string>',
'application_test_case_output_group_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v4/application-variant-reports")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"application_variant_id\": \"<string>\",\n \"evaluation_dataset_ids\": [\n \"<string>\"\n ],\n \"account_id\": \"<string>\",\n \"application_test_case_output_group_ids\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v4/application-variant-reports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_variant_id\": \"<string>\",\n \"evaluation_dataset_ids\": [\n \"<string>\"\n ],\n \"account_id\": \"<string>\",\n \"application_test_case_output_group_ids\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "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": [
    {
      "evaluation_dataset_version_num": 123,
      "evaluation_dataset": {
        "name": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "account_id": "<string>",
        "created_by_user_id": "<string>",
        "knowledge_base_id": "<string>",
        "evaluation_dataset_metadata": {},
        "out_of_date": true,
        "vendor": "scale",
        "archived_at": "2023-11-07T05:31:56Z"
      },
      "scored_test_case_count": 123
    }
  ],
  "score": 123,
  "category_scores": [
    {
      "category": "<string>",
      "metric_scores": [
        {
          "metric_type": "<string>",
          "category": "<string>",
          "score": 123
        }
      ],
      "score": 123
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

x-api-key
string
header
required

Body

application/json
application_variant_id
string
required
evaluation_dataset_ids
string[]
required
Minimum array length: 1
account_id
string

The ID of the account that owns the given entity.

application_test_case_output_group_ids
string[]
Minimum array length: 1

Response

Successful Response

application_spec_id
string
required
application_variant_id
string
required
id
string
required

The unique identifier of the entity.

created_at
string<date-time>
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<date-time>
required

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

evaluation_datasets
EvaluationDatasetReportGeneration · object[]
score
number
category_scores
(ApplicationCategoryScoreAccuracy · object | ApplicationCategoryScoreRetrieval · object | ApplicationCategoryScoreQuality · object | ApplicationCategoryScoreTrustAndSafety · object)[]