APIFlows

Update Flow Log

Update the status, inputs, output of a Flow Log.

Marking a Flow Log as complete will trigger any monitoring Evaluators to run. Inputs and output (or error) must be provided in order to mark it as complete.

The end_time log attribute will be set to match the time the log is marked as complete.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

log_idstringRequired
Unique identifier of the Flow Log.

Request

This endpoint expects an object.
messageslist of objectsOptional
List of chat messages that were used as an input to the Flow.
output_messageobjectOptional
The output message returned by this Flow.
inputsmap from strings to anyOptional
The inputs passed to the Flow Log.
outputstringOptional

The output of the Flow Log. Provide None to unset existing output value. Provide either this, output_message or error.

errorstringOptional

The error message of the Flow Log. Provide None to unset existing error value. Provide either this, output_message or output.

log_statusenumOptional

Status of the Flow Log. When a Flow Log is updated to complete, no more Logs can be added to it. You cannot update a Flow Log’s status from complete to incomplete.

Allowed values:

Response

Successful Response
idstring
Unique identifier for the Log.
evaluator_logslist of objects
List of Evaluator Logs associated with the Log. These contain Evaluator judgments on the Log.
flowobject
Flow used to generate the Log.
messageslist of objects
List of chat messages that were used as an input to the Flow.
output_messageobject
The output message returned by this Flow.
start_timedatetime
When the logged event started.
end_timedatetime
When the logged event ended.
outputstring

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.

created_atdatetime
User defined timestamp for when the log was created.
errorstring
Error message if the log is an error.
provider_latencydouble
Duration of the logged event in seconds.
stdoutstring
Captured log and debug statements.
provider_requestmap from strings to any
Raw request sent to provider.
provider_responsemap from strings to any
Raw response received the provider.
inputsmap from strings to any
The inputs passed to the Flow Log.
sourcestring
Identifies where the model was called from.
metadatamap from strings to any
Any additional metadata to record.
log_statusenum

Status of the Flow Log. When a Flow Log is updated to complete, no more Logs can be added to it. You cannot update a Flow Log’s status from complete to incomplete.

Allowed values:
source_datapoint_idstring

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.

trace_parent_idstring
The ID of the parent Log to nest this Log under in a Trace.
batcheslist of strings
Array of Batch IDs that this Log is part of. Batches are used to group Logs together for offline Evaluations
userstring

End-user ID related to the Log.

environmentstring
The name of the Environment the Log is associated to.
savebooleanDefaults to true

Whether the request/response payloads will be stored on Humanloop.

log_idstring
This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
trace_flow_idstring
Identifier for the Flow that the Trace belongs to.
trace_idstring
Identifier for the Trace that the Log belongs to.
trace_childrenlist of objects
Logs nested under this Log in the Trace.

Errors

422
Update Log Flows Logs Log ID Patch Request Unprocessable Entity Error