APIEvaluators

Deploy Evaluator

Deploy Evaluator to an Environment. Set the deployed version for the specified Environment. This Evaluator will be used for calls made to the Evaluator in this Environment.

Path parameters

idstringRequired
Unique identifier for Evaluator.
environment_idstringRequired
Unique identifier for the Environment to deploy the Version to.

Headers

X-API-KEYstringRequired

Query parameters

version_idstringRequired
Unique identifier for the specific version of the Evaluator.

Response

Successful Response
pathstring
Path of the Evaluator including the Evaluator name, which is used as a unique identifier.
idstring
Unique identifier for the Evaluator.
specobject
namestring
Name of the Evaluator, which is used as a unique identifier.
version_idstring
Unique identifier for the specific Evaluator Version. If no query params provided, the default deployed Evaluator Version is returned.
created_atdatetime
updated_atdatetime
last_used_atdatetime
version_logs_countinteger
The number of logs that have been generated for this Evaluator Version
total_logs_countinteger
The number of logs that have been generated across all Evaluator Versions
inputslist of objects
Inputs associated to the Evaluator. Inputs correspond to any of the variables used within the Evaluator template.
directory_idstringOptional
ID of the directory that the file is in on Humanloop.
version_namestringOptional
Unique name for the Evaluator version. Version names must be unique for a given Evaluator.
version_descriptionstringOptional
Description of the version, e.g., the changes made in this version.
descriptionstringOptional
Description of the Evaluator.
schemamap from strings to anyOptional
The JSON schema for the File.
readmestringOptional
Long description of the file.
tagslist of stringsOptional
List of tags associated with the file.
type"evaluator"OptionalDefaults to evaluator
environmentslist of objectsOptional
The list of environments the Evaluator Version is deployed to.
created_byanyOptional
The user who created the Evaluator.
evaluatorslist of objectsOptional
Evaluators that have been attached to this Evaluator that are used for monitoring logs.
evaluator_aggregateslist of objectsOptional
Aggregation of Evaluator results for the Evaluator Version.
attributesmap from strings to anyOptional
Additional fields to describe the Evaluator. Helpful to separate Evaluator versions from each other with details on how they were created or used.

Errors