Log to a Flow.
You can use query parameters version_id
, or environment
, to target
an existing version of the Flow. Otherwise, the default deployed version will be chosen.
A specific Version ID of the Flow to log to.
Name of the Environment identifying a deployed version to log to.
Unique identifier for the Evaluation Report to associate the Log to.
Path of the Flow, including the name. This locates the Flow in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name
or just name
.
ID for an existing Flow.
The start time of the Trace. Will be updated if a child Log with an earlier start time is added.
The end time of the Trace. Will be updated if a child Log with a later end time is added.
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.
Unique identifier for the Batch to add this Batch to. Batches are used to group Logs together for Evaluations. A Batch will be created if one with the given ID does not exist.
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.
The identifier for the Log. If not specified, a default ID will be generated. This allows additional Logs to be appended to the trace without waiting for Humanloop to return an ID.
Flow used to generate the Trace.
Status of the Trace. When a Trace is marked as complete
, no more Logs can be added to it. Monitoring Evaluators will only run on complete
Traces. If you do not intend to add more Logs to the Trace after creation, set this to complete
.
Unique identifier for the Log.
Unique identifier for the Flow.
Unique identifier for the Flow Version.
Status of the Trace. When a Trace is marked as complete
, no more Logs can be added to it. Monitoring Evaluators will only run on complete
Traces.