Call Tool
Call a Tool.
Calling a Tool with inputs runs the tool’s source code and logs the result and metadata to Humanloop.
You can use query parameters version_id
, or environment
, to target
an existing version of the Tool. Otherwise, the default deployed version will be chosen.
Instead of targeting an existing version explicitly, you can instead pass in Tool details in the request body. In this case, we will check if the details correspond to an existing version of the Tool. If they do not, we will create a new version. This is helpful in the case where you are storing or deriving your Tool details in code.
Headers
Query parameters
A specific Version ID of the Tool to call.
Name of the Environment identifying a deployed version to call.
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.
Details of your Tool. A new Tool version will be created if the provided details are new.
The inputs passed to the prompt template.
Identifies where the model was called from.
Any additional metadata to record.
When the logged event started.
When the logged event ended.
Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
The ID of the parent Log to nest this Log under in a Trace.
End-user ID related to the Log.
The name of the Environment the Log is associated to.
Whether the request/response payloads will be stored on Humanloop.
This will identify a Log. If you don’t provide a Log ID, Humanloop will generate one for you.
Response
Successful Response
Tool used to generate the Log.
ID of the log.
List of Evaluator Logs associated with the Log. These contain Evaluator judgments on the Log.
When the logged event started.
When the logged event ended.
Generated output from your model for the provided inputs. Can be None
if logging an error, or if creating a parent Log with the intention to populate it later.
User defined timestamp for when the log was created.
Error message if the log is an error.
Duration of the logged event in seconds.
Captured log and debug statements.
Raw request sent to provider.
Raw response received the provider.
The inputs passed to the prompt template.
Identifies where the model was called from.
Any additional metadata to record.
Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
The ID of the parent Log to nest this Log under in a Trace.
Array of Batch IDs that this Log is part of. Batches are used to group Logs together for offline Evaluations
End-user ID related to the Log.
The name of the Environment the Log is associated to.
Whether the request/response payloads will be stored on Humanloop.
This will identify a Log. If you don’t provide a Log ID, Humanloop will generate one for you.
Identifier for the Flow that the Trace belongs to.
ID of the Trace containing the Tool Call Log.
Logs nested under this Log in the Trace.