APITools

Update Monitoring

Activate and deactivate Evaluators for monitoring the Tool. An activated Evaluator will automatically be run on all new Logs within the Tool for monitoring purposes.

Path parameters

idstringRequired

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
activatelist of objectsOptional
Evaluators to activate for Monitoring. These will be automatically run on new Logs.
deactivatelist of objectsOptional
Evaluators to deactivate. These will not be run on new Logs.

Response

Successful Response
pathstring
Path of the Tool, including the name, which is used as a unique identifier.
idstring
Unique identifier for the Tool.
namestring
Name of the Tool, which is used as a unique identifier.
version_idstring
Unique identifier for the specific Tool Version. If no query params provided, the default deployed Tool Version is returned.
created_atdatetime
updated_atdatetime
last_used_atdatetime
version_logs_countinteger
The number of logs that have been generated for this Tool Version
total_logs_countinteger
The number of logs that have been generated across all Tool Versions
inputslist of objects
Inputs associated to the Prompt. Inputs correspond to any of the variables used within the Tool template.
directory_idstring or null
ID of the directory that the file is in on Humanloop.
functionobject or null
Callable function specification of the Tool shown to the model for tool calling.
source_codestring or null
Code source of the Tool.
setup_valuesmap from strings to any or null

Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/

attributesmap from strings to any or null
Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.
tool_typeenum or null
Type of Tool.
version_namestring or null
Unique identifier for this Tool version. Each Tool can only have one version with a given name.
version_descriptionstring or null
Description of the Version.
descriptionstring or null
Description of the Tool.
readmestring or null
Long description of the file.
tagslist of strings or null
List of tags associated with the file.
type"tool" or nullDefaults to tool
environmentslist of objects or null
The list of environments the Tool Version is deployed to.
created_byany or null
The user who created the Tool.
evaluatorslist of objects or null
Evaluators that have been attached to this Tool that are used for monitoring logs.
signaturestring or null
Signature of the Tool.
evaluator_aggregateslist of objects or null
Aggregation of Evaluator results for the Tool Version.

Errors