Skip to main content
GET
/
v4
/
evaluations
/
{evaluation_id}
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
)
evaluation = client.evaluations.retrieve(
    evaluation_id="evaluation_id",
)
print(evaluation.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"),
	)
	evaluation, err := client.Evaluations.Get(
		context.TODO(),
		"evaluation_id",
		sgp.EvaluationGetParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", evaluation.ID)
}
curl --request GET \
  --url https://api.egp.scale.com/v4/evaluations/{evaluation_id} \
  --header 'x-api-key: <api-key>'
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.egp.scale.com/v4/evaluations/{evaluation_id}', 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/evaluations/{evaluation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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.get("https://api.egp.scale.com/v4/evaluations/{evaluation_id}")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v4/evaluations/{evaluation_id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "name": "<string>",
  "description": "<string>",
  "application_spec_id": "<string>",
  "total_test_case_result_count": 123,
  "completed_test_case_result_count": 123,
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "evaluation_datasets": [
    {
      "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"
    }
  ],
  "evaluation_config_expanded": {
    "question_set_id": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "account_id": "<string>",
    "created_by_user_id": "<string>",
    "question_set": {
      "name": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "created_by_user_id": "<string>",
      "questions": [
        {
          "title": "<string>",
          "prompt": "<string>",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "account_id": "<string>",
          "created_by_user_id": "<string>",
          "choices": [
            {
              "label": "<string>",
              "value": "<string>",
              "audit_required": false
            }
          ],
          "ratingOptions": {
            "minLabel": "<string>",
            "maxLabel": "<string>",
            "scaleSteps": 123
          },
          "numberOptions": {
            "min": 123,
            "max": 123
          },
          "freeTextOptions": {
            "characterLimit": {
              "min": 50,
              "max": 1000
            }
          },
          "multi": true,
          "dropdown": true,
          "required": true,
          "conditions": [
            {}
          ],
          "default": "<unknown>",
          "form_schema": {}
        }
      ],
      "question_id_to_config": {},
      "instructions": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    },
    "studio_project_id": "<string>",
    "auto_evaluation_parameters": {
      "temperature": 1,
      "batch_size": 13
    }
  },
  "async_jobs": [
    {
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "job_type": "<string>",
      "parent_job_id": "<string>",
      "status_reason": "<string>",
      "progress": {},
      "job_metadata": {}
    }
  ],
  "application_spec": {
    "name": "<string>",
    "description": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "account_id": "<string>",
    "theme_id": "<string>",
    "run_online_evaluation": false,
    "parent_application_spec_id": "<string>",
    "created_by_user_id": "<string>",
    "archived_at": "2023-11-07T05:31:56Z"
  },
  "application_variant_id": "<string>",
  "tags": {},
  "evaluation_config": {},
  "evaluation_config_id": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "annotation_config": {
    "annotation_config_type": "flexible",
    "components": [
      [
        {
          "data_loc": [
            "<string>"
          ],
          "optional": false,
          "label": "<string>"
        }
      ]
    ],
    "direction": "row",
    "llm_prompt": {
      "variables": [
        {
          "name": "<string>",
          "data_loc": [
            "<string>"
          ],
          "optional": false
        }
      ],
      "template": "<string>"
    }
  },
  "question_id_to_annotation_config": {},
  "metric_config": {
    "components": [
      {
        "name": "<string>",
        "mappings": {},
        "params": {}
      }
    ]
  },
  "archived_at": "2023-11-07T05:31:56Z"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

evaluation_id
string
required

Query Parameters

view
enum<string>[] | null
Available options:
ApplicationSpec,
AsyncJobs,
EvaluationConfig,
EvaluationDatasets

Response

Successful Response

name
string
required
description
string
required
status
enum<string>
required
Available options:
PENDING,
COMPLETED,
FAILED
application_spec_id
string
required
total_test_case_result_count
integer
required

The total number of test case results for the evaluation

completed_test_case_result_count
integer
required

The number of test case results that have been completed for the evaluation

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.

created_by_user_id
string
required

The user who originally created the entity.

created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
evaluation_datasets
EvaluationDatasetResponse · object[]
evaluation_config_expanded
EvaluationConfigExpanded · object
async_jobs
AsyncJobForView · object[]
application_spec
ApplicationSpecResponse · object
application_variant_id
string
tags
Tags · object
evaluation_config
Evaluation Config · object
evaluation_config_id
string

The ID of the associated evaluation config.

completed_at
string<date-time>

The date and time that all test case results for the evaluation were completed for the evaluation in ISO format.

annotation_config
AnnotationConfig · object

Annotation configuration for tasking

question_id_to_annotation_config
Question Id To Annotation Config · object

Specifies the annotation configuration to use for specific questions.

metric_config
MetricConfig · object

Specifies the config for the metrics to be computed.

archived_at
string<date-time>

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