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.
Path parameters
idstringRequired
Unique identifier for Evaluator.
Query parameters
version_idstringOptional
A specific Version ID of the Evaluator to retrieve.
environmentstringOptional
Name of the Environment to retrieve a deployed Version from.
Response
This endpoint returns an object.
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
statusenum
Allowed values: uncommittedcommitteddeleted
An enumeration.
last_used_atdatetime
version_logs_countinteger
The number of logs that have been generated for this Prompt Version
total_logs_countinteger
The number of logs that have been generated across all Prompt Versions
inputslist of objects
Inputs associated to the Prompt. Inputs correspond to any of the variables used within the Prompt template.
directory_idstringOptional
ID of the directory that the file is in on Humanloop.
commit_messagestringOptional
Message describing the changes made.
type"evaluator"Optional
environmentslist of objectsOptional
The list of environments the Prompt Version is deployed to.
created_byobjectOptional
The user who created the Prompt.
evaluatorslist of objectsOptional
Evaluators that have been attached to this Prompt 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.