Update Flow Log | Humanloop Docs

curl -X PATCH https://api.humanloop.com/v5/flows/logs/medqa_experiment_0001 \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "inputs": {
    "question": "Patient with a history of diabetes and normal tension presents with chest pain and shortness of breath."
  },
  "output": "The patient is likely experiencing a myocardial infarction. Immediate medical attention is required.",
  "error": null,
  "log_status": "complete"
}'

{
  "id": "medqa_experiment_0001",
  "evaluator_logs": [],
  "flow": {
    "path": "Personal Projects/MedQA",
    "id": "fl_6o701g4jmcanPVHxdqD0O",
    "attributes": {
      "prompt": {
        "template": "You are a helpful assistant helping with medical anamnesis",
        "model": "gpt-4o",
        "temperature": 0.8
      },
      "tool": {
        "name": "retrieval_tool_v3",
        "description": "Retrieval tool for MedQA.",
        "source_code": "def retrieval_tool(question: str) -> str:\n    pass\n"
      }
    },
    "name": "MedQA Flow",
    "version_id": "flv_7ZNQREaScH0JkhUwtXrLN",
    "created_at": "2024-07-08T22:40:39",
    "updated_at": "2024-07-08T22:40:39",
    "last_used_at": "2024-07-08T22:40:35",
    "version_logs_count": 10
  },
  "output": "The patient is likely experiencing a myocardial infarction. Immediate medical attention is required.",
  "error": null,
  "inputs": {
    "question": "Patient with a history of diabetes and normal tension presents with chest pain and shortness of breath."
  },
  "log_status": "complete"
}

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 objectsOptional

List of chat messages that were used as an input to the Flow.

output_messageobjectOptional

The output message returned by this Flow.

start_timedatetimeOptional

When the logged event started.

end_timedatetimeOptional

When the logged event ended.

outputstringOptional

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_atdatetimeOptional

User defined timestamp for when the log was created.

errorstringOptional

Error message if the log is an error.

provider_latencydoubleOptional

Duration of the logged event in seconds.

stdoutstringOptional

Captured log and debug statements.

provider_requestmap from strings to anyOptional

Raw request sent to provider.

provider_responsemap from strings to anyOptional

Raw response received the provider.

inputsmap from strings to anyOptional

The inputs passed to the Flow Log.

sourcestringOptional

Identifies where the model was called from.

metadatamap from strings to anyOptional

Any additional metadata to record.

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.

source_datapoint_idstringOptional

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_idstringOptional

The ID of the parent Log to nest this Log under in a Trace.

batcheslist of stringsOptional

Array of Batch IDs that this Log is part of. Batches are used to group Logs together for offline Evaluations

userstringOptional

End-user ID related to the Log.

environmentstringOptional

The name of the Environment the Log is associated to.

savebooleanOptionalDefaults to true

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

log_idstringOptional

This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.

trace_flow_idstringOptional

Identifier for the Flow that the Trace belongs to.

trace_idstringOptional

Identifier for the Trace that the Log belongs to.

trace_childrenlist of objectsOptional

Logs nested under this Log in the Trace.

Errors

422

Update Log Flows Logs Log ID Patch Request Unprocessable Entity Error