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
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
.
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.
End-user ID related to the Log.
Whether the request/response payloads will be stored on Humanloop.
Response
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.
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.
End-user ID related to the Log.
Whether the request/response payloads will be stored on Humanloop.