Humanloop Documentation and API Reference

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.

Path parameters

log_idstringRequired

Unique identifier of the Flow Log.

Request

This endpoint expects an object.

trace_status"complete" or "incomplete"Required

Allowed values: completeincomplete

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 completed Traces.

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 or error.

errorstringOptional

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

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.

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.

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.

savebooleanOptional

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

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.

trace_status"complete" or "incomplete"Optional

Allowed values: completeincomplete

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 completed Traces.

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

1	{
2	"id": "medqa_experiment_0001",
3	"evaluator_logs": [],
4	"flow": {
5	"path": "Personal Projects/MedQA",
6	"id": "fl_6o701g4jmcanPVHxdqD0O",
7	"attributes": {
8	"prompt": {
9	"template": "You are a helpful assistant helping with medical anamnesis",
10	"model": "gpt-4o",
11	"temperature": 0.8
12	},
13	"tool": {
14	"name": "retrieval_tool_v3",
15	"description": "Retrieval tool for MedQA.",
16	"source_code": "def retrieval_tool(question: str) -> str:\n pass\n"
17	}
18	},
19	"name": "MedQA Flow",
20	"version_id": "flv_7ZNQREaScH0JkhUwtXrLN",
21	"created_at": "2024-07-08T22:40:39",
22	"updated_at": "2024-07-08T22:40:39",
23	"status": "committed",
24	"last_used_at": "2024-07-08T22:40:35",
25	"version_logs_count": 10
26	},
27	"output": "The patient is likely experiencing a myocardial infarction. Immediate medical attention is required.",
28	"inputs": {
29	"question": "Patient with a history of diabetes and normal tension presents with chest pain and shortness of breath."
30	},
31	"trace_status": "complete"
32	}

Update Flow Log

Path parameters

Request

Response

Errors