Upsert Tool
Create a Tool or update it with a new version if it already exists.
Tools are identified by the ID
or their path
. The name, description and parameters determine the versions of the Tool.
You can provide version_name
and version_description
to identify and describe your versions.
Version names must be unique within a Tool - attempting to create a version with a name
that already exists will result in a 409 Conflict error.
Headers
Request
Path of the Tool, including the name. This locates the Tool in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name
or just name
.
ID for an existing Tool.
Callable function specification of the Tool shown to the model for tool calling.
Code source of the Tool.
Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/
Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.
Type of Tool.
Unique identifier for this Tool version. Each Tool can only have one version with a given name.
Description of the Version.
Response
Successful Response
Path of the Tool, including the name, which is used as a unique identifier.
Unique identifier for the Tool.
Name of the Tool, which is used as a unique identifier.
Unique identifier for the specific Tool Version. If no query params provided, the default deployed Tool Version is returned.
The number of logs that have been generated for this Tool Version
The number of logs that have been generated across all Tool Versions
Inputs associated to the Prompt. Inputs correspond to any of the variables used within the Tool template.
ID of the directory that the file is in on Humanloop.
Callable function specification of the Tool shown to the model for tool calling.
Code source of the Tool.
Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/
Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.
Type of Tool.
Unique identifier for this Tool version. Each Tool can only have one version with a given name.
Description of the Version.
Description of the Tool.
Long description of the file.
The list of environments the Tool Version is deployed to.
The user who created the Tool.
Evaluators that have been attached to this Tool that are used for monitoring logs.
Signature of the Tool.
Aggregation of Evaluator results for the Tool Version.