Log to an Agent
Create an Agent Log.
You can use query parameters version_id
, or environment
, to target
an existing version of the Agent. Otherwise, the default deployed version will be chosen.
If you create the Agent Log with a log_status
of incomplete
, you should later update it to complete
in order to trigger Evaluators.
Headers
Query parameters
Request
Path of the Agent, including the name. This locates the Agent in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name
or just name
.
Controls how the model uses tools. The following options are supported:
'none'
means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.'auto'
means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.'required'
means the model must call one or more of the provided tools.{'type': 'function', 'function': {name': <TOOL_NAME>}}
forces the model to use the named function.
The Agent configuration to use. Two formats are supported:
- An object representing the details of the Agent configuration
- A string representing the raw contents of a .agent file
A new Agent version will be created if the provided details do not match any existing version.
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.
Response
Status of the Agent Log. When a Agent Log is marked as complete
, no more Logs can be added to it.