GET
/
v4
/
evaluations
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 evaluationWithViews of client.evaluations.list()) {
    console.log(evaluationWithViews.id);
  }
}

main();
{
  "items": [
    {
      "evaluation_datasets": [
        {
          "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"
        }
      ],
      "evaluation_config_expanded": {
        "evaluation_type": "studio",
        "question_set_id": "<string>",
        "studio_project_id": "<string>",
        "auto_evaluation_model": "gpt-4-32k-0613",
        "auto_evaluation_parameters": {
          "temperature": 1,
          "batch_size": 13
        },
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "account_id": "<string>",
        "created_by_user_id": "<string>",
        "question_set": {
          "name": "<string>",
          "question_id_to_config": {},
          "instructions": "<string>",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "account_id": "<string>",
          "created_by_user_id": "<string>",
          "archived_at": "2023-11-07T05:31:56Z",
          "questions": [
            {
              "type": "categorical",
              "title": "<string>",
              "prompt": "<string>",
              "choices": [
                {
                  "label": "<string>",
                  "value": "<string>",
                  "audit_required": false
                }
              ],
              "ratingOptions": {
                "minLabel": "<string>",
                "maxLabel": "<string>",
                "scaleSteps": 123
              },
              "numberOptions": {
                "min": 123,
                "max": 123
              },
              "multi": true,
              "dropdown": true,
              "required": true,
              "conditions": [
                {}
              ],
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "account_id": "<string>",
              "created_by_user_id": "<string>"
            }
          ]
        }
      },
      "async_jobs": [
        {
          "job_type": "<string>",
          "parent_job_id": "<string>",
          "status": "<string>",
          "progress": {},
          "job_metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "id": "<string>"
        }
      ],
      "application_spec": {
        "name": "<string>",
        "description": "<string>",
        "theme_id": "<string>",
        "run_online_evaluation": true,
        "parent_application_spec_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "account_id": "<string>",
        "created_by_user_id": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      },
      "name": "<string>",
      "description": "<string>",
      "status": "PENDING",
      "application_spec_id": "<string>",
      "application_variant_id": "<string>",
      "tags": {},
      "evaluation_config": {},
      "evaluation_config_id": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "total_test_case_result_count": 123,
      "completed_test_case_result_count": 123,
      "annotation_config": {
        "annotation_config_type": "generation",
        "components": [
          [
            {
              "optional": true,
              "data_loc": [
                "<string>"
              ],
              "label": "<string>"
            }
          ]
        ],
        "direction": "col",
        "llm_prompt": {
          "variables": [
            {
              "name": "<string>",
              "optional": true,
              "data_loc": [
                "<string>"
              ]
            }
          ],
          "template": "<string>"
        }
      },
      "question_id_to_annotation_config": {},
      "metric_config": {
        "components": [
          {
            "type": "rouge",
            "name": "<string>",
            "mappings": {},
            "params": {}
          }
        ]
      },
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "created_by_user_id": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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:
ApplicationSpec,
AsyncJobs,
EvaluationConfig,
EvaluationDatasets
​
sort_by
enum<string>[]
Available options:
status:asc,
status:desc,
application_spec_id:asc,
application_spec_id:desc,
application_spec:asc,
application_spec:desc,
application_variant_id:asc,
application_variant_id:desc,
application_variant:asc,
application_variant:desc,
evaluation_config_id:asc,
evaluation_config_id:desc,
completed_at:asc,
completed_at:desc,
total_test_case_result_count:asc,
total_test_case_result_count:desc,
completed_test_case_result_count:asc,
completed_test_case_result_count:desc,
annotation_config:asc,
annotation_config:desc,
question_id_to_annotation_config:asc,
question_id_to_annotation_config:desc,
metric_config:asc,
metric_config:desc,
evaluation_config_expanded:asc,
evaluation_config_expanded:desc,
test_case_results:asc,
test_case_results:desc,
async_jobs:asc,
async_jobs:desc,
evaluation_datasets:asc,
evaluation_datasets:desc,
id:asc,
id:desc,
created_at:asc,
created_at:desc,
account_id:asc,
account_id:desc,
created_by_user_id:asc,
created_by_user_id:desc,
archived_at:asc,
archived_at:desc,
created_by_user:asc,
created_by_user:desc,
name:asc,
name:desc,
description:asc,
description:desc,
tags:asc,
tags:desc,
evaluation_config:asc,
evaluation_config:desc
​
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
​
include_archived
boolean
default:
false

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.

Get Hybrid Evaluation MetricsCreate Evaluation