evaluators

Get Evaluator

Retrieve the Evaluator with the given ID.

By default, the deployed version of the Evaluator is returned. Use the query parameters version_id or environment to target a specific version of the Evaluator.

get/evaluators/{id}

Request

  • Base URL: https://api.humanloop.com/v5
  • URL: https://api.humanloop.com/v5/evaluators/{id}
  • Auth: API key in header X-API-KEY

Path parameters

idstring required

Unique identifier for Evaluator.

Query parameters

version_idstring

A specific Version ID of the Evaluator to retrieve.

environmentstring

Name of the Environment to retrieve a deployed Version from.

Response

Successful Response

pathstring required

Path of the Evaluator including the Evaluator name, which is used as a unique identifier.

idstring required

Unique identifier for the Evaluator.

directory_idstring

ID of the directory that the file is in on Humanloop.

version_namestring

Unique name for the Evaluator version. Version names must be unique for a given Evaluator.

version_descriptionstring

Description of the version, e.g., the changes made in this version.

namestring required

Name of the Evaluator, which is used as a unique identifier.

descriptionstring

Description of the Evaluator.

schemaobject

The JSON schema for the File.

readmestring

Long description of the file.

tagsstring[]

List of tags associated with the file.

version_idstring required

Unique identifier for the specific Evaluator Version. If no query params provided, the default deployed Evaluator Version is returned.

type'evaluator'
created_atstring date-time required
updated_atstring date-time required
created_byunknown
last_used_atstring date-time required
version_logs_countinteger required

The number of logs that have been generated for this Evaluator Version

total_logs_countinteger required

The number of logs that have been generated across all Evaluator Versions

attributesobject

Additional fields to describe the Evaluator. Helpful to separate Evaluator versions from each other with details on how they were created or used.

Changes

No recorded changes to this operation across all 1 revision of this API.