flows

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.

patch/flows/logs/{log_id}

Request

  • Base URL: https://api.humanloop.com/v5
  • URL: https://api.humanloop.com/v5/flows/logs/{log_id}
  • Auth: API key in header X-API-KEY

Path parameters

log_idstring required

Unique identifier of the Flow Log.

Request body

inputsobject

The inputs passed to the Flow Log.

outputstring

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

errorstring

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

log_status'complete' | 'incomplete'

An enumeration.

Response

Successful Response

start_timestring date-time

When the logged event started.

end_timestring date-time

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_atstring date-time

User defined timestamp for when the log was created.

errorstring

Error message if the log is an error.

provider_latencynumber double

Duration of the logged event in seconds.

stdoutstring

Captured log and debug statements.

provider_requestobject

Raw request sent to provider.

provider_responseobject

Raw response received the provider.

inputsobject

The inputs passed to the Flow Log.

sourcestring

Identifies where the model was called from.

metadataobject

Any additional metadata to record.

log_status'complete' | 'incomplete'

An enumeration.

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.

batchesstring[]

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.

saveboolean

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.

idstring required

Unique identifier for the Log.

trace_flow_idstring

Identifier for the Flow that the Trace belongs to.

trace_idstring

Identifier for the Trace that the Log belongs to.

Changes

No recorded changes to this operation across all 1 revision of this API.