Scale API | Evaluation Configs › List Evaluation Configs

Evaluation Configs

evaluation_configs

Methods

Create Evaluation Config ->

EvaluationConfig

post/v4/evaluation-configs

Description

Creates a evaluation config

Details

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

Delete Evaluation Config ->

GenericDeleteResponse

delete/v4/evaluation-configs/{evaluation_config_id}

Description

Deletes a evaluation config

Details

This API can be used to delete a evaluation config by ID. To use this API, pass in the id that was returned from your Create Evaluation Config API call as a path parameter.

List Evaluation Configs -> PageResponse<

EvaluationConfig

get/v4/evaluation-configs

Description

Lists all evaluation configs accessible to the user.

Details

This API can be used to list evaluation configs. If a user has access to multiple accounts, all evaluation configs 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

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

Response fields

PaginatedEvaluationConfigs

Request example

curl https://api.egp.scale.com/v4/evaluation-configs \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_user_id": "created_by_user_id",
      "evaluation_type": "studio",
      "question_set_id": "question_set_id",
      "auto_evaluation_model": "gpt-4-32k-0613",
      "studio_project_id": "studio_project_id"
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Get Evaluation Config ->

EvaluationConfig

get/v4/evaluation-configs/{evaluation_config_id}

Description

Gets the details of a evaluation config

Details

This API can be used to get information about a single evaluation config by ID. To use this API, pass in the id that was returned from your Create Evaluation Config API call as a path parameter.

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

Domain types

EvaluationConfig = { id, account_id, created_at, 5 more... }

PaginatedEvaluationConfigs = { current_page, items, items_per_page, 1 more... }