Commit

POST

Commit a version of the Tool with a commit message.

If the version is already committed, an exception will be raised.

Path parameters

idstringRequired
Unique identifier for Tool.
version_idstringRequired
Unique identifier for the specific version of the Tool.

Request

This endpoint expects an object.
commit_messagestringRequired
Message describing the changes made.

Response

This endpoint returns an object.
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
statusenum
Allowed values: uncommittedcommitteddeleted
The status of the Tool Version.
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_idstringOptional
ID of the directory that the file is in on Humanloop.
functionobjectOptional
Callable function specification of the Tool shown to the model for tool calling.
source_codestringOptional
Code source of the Tool.
setup_valuesmap from strings to anyOptional

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

attributesmap from strings to anyOptional
Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.
tool_typeenumOptional
Type of Tool.
commit_messagestringOptional
Message describing the changes made.
type"tool"Optional
environmentslist of objectsOptional
The list of environments the Tool Version is deployed to.
created_byobjectOptional
The user who created the Tool.
evaluatorslist of objectsOptional
Evaluators that have been attached to this Tool that are used for monitoring logs.
signaturestringOptional
Signature of the Tool.
evaluator_aggregateslist of objectsOptional
Aggregation of Evaluator results for the Tool Version.

Errors

Built with