Humanloop Documentation and API Reference

Update a Log.

Update the details of a Log with the given ID.

Path parameters

idstringRequired

Unique identifier for Prompt.

log_idstringRequired

Unique identifier for the Log.

Request

This endpoint expects an object.

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 prompt template.

sourcestringOptional

Identifies where the model was called from.

metadatamap from strings to anyOptional

Any additional metadata to record.

start_timedatetimeOptional

When the logged event started.

end_timedatetimeOptional

When the logged event ended.

Response

Successful Response

Prompt Log Responseobject

Tool Log Responseobject

Evaluator Log Responseobject

Flow Log Responseobject

Errors

1 curl -X PATCH https://api.humanloop.com/v5/tools/id/log/log_id \ 2 -H "X-API-KEY: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "output_message": { 3 "content": "content", 4 "name": "name", 5 "tool_call_id": "tool_call_id", 6 "role": "user", 7 "tool_calls": [ 8 { 9 "id": "id", 10 "type": "function", 11 "function": { 12 "name": "name" 13 } 14 } 15 ] 16 }, 17 "prompt_tokens": 1, 18 "output_tokens": 1, 19 "prompt_cost": 1.1, 20 "output_cost": 1.1, 21 "finish_reason": "finish_reason", 22 "messages": [ 23 { 24 "content": "content", 25 "name": "name", 26 "tool_call_id": "tool_call_id", 27 "role": "user", 28 "tool_calls": [ 29 { 30 "id": "id", 31 "type": "function", 32 "function": { 33 "name": "name" 34 } 35 } 36 ] 37 } 38 ], 39 "tool_choice": "none", 40 "prompt": { 41 "path": "path", 42 "id": "id", 43 "directory_id": "directory_id", 44 "model": "model", 45 "endpoint": "complete", 46 "template": "template", 47 "provider": "openai", 48 "max_tokens": 1, 49 "temperature": 1.1, 50 "top_p": 1.1, 51 "stop": "stop", 52 "presence_penalty": 1.1, 53 "frequency_penalty": 1.1, 54 "other": { 55 "key": "value" 56 }, 57 "seed": 1, 58 "response_format": { 59 "type": "json_object", 60 "json_schema": { 61 "key": "value" 62 } 63 }, 64 "tools": [ 65 { 66 "name": "name", 67 "description": "description" 68 } 69 ], 70 "linked_tools": [ 71 { 72 "name": "name", 73 "description": "description", 74 "id": "id", 75 "version_id": "version_id" 76 } 77 ], 78 "attributes": { 79 "key": "value" 80 }, 81 "commit_message": "commit_message", 82 "name": "name", 83 "version_id": "version_id", 84 "type": "prompt", 85 "environments": [ 86 { 87 "id": "id", 88 "created_at": "2024-01-15T09:30:00Z", 89 "name": "name", 90 "tag": "default" 91 } 92 ], 93 "created_at": "2024-01-15T09:30:00Z", 94 "updated_at": "2024-01-15T09:30:00Z", 95 "created_by": { 96 "id": "id", 97 "email_address": "email_address", 98 "full_name": "full_name" 99 }, 100 "committed_by": { 101 "id": "id", 102 "email_address": "email_address", 103 "full_name": "full_name" 104 }, 105 "committed_at": "2024-01-15T09:30:00Z", 106 "status": "uncommitted", 107 "last_used_at": "2024-01-15T09:30:00Z", 108 "version_logs_count": 1, 109 "total_logs_count": 1, 110 "inputs": [ 111 { 112 "name": "name" 113 } 114 ], 115 "evaluator_aggregates": [ 116 { 117 "value": 1.1, 118 "evaluator_id": "evaluator_id", 119 "evaluator_version_id": "evaluator_version_id", 120 "created_at": "2024-01-15T09:30:00Z", 121 "updated_at": "2024-01-15T09:30:00Z" 122 } 123 ] 124 }, 125 "start_time": "2024-01-15T09:30:00Z", 126 "end_time": "2024-01-15T09:30:00Z", 127 "output": "output", 128 "created_at": "2024-01-15T09:30:00Z", 129 "error": "error", 130 "provider_latency": 1.1, 131 "stdout": "stdout", 132 "provider_request": { 133 "key": "value" 134 }, 135 "provider_response": { 136 "key": "value" 137 }, 138 "inputs": { 139 "key": "value" 140 }, 141 "source": "source", 142 "metadata": { 143 "key": "value" 144 }, 145 "source_datapoint_id": "source_datapoint_id", 146 "trace_parent_id": "trace_parent_id", 147 "batches": [ 148 "batches" 149 ], 150 "user": "user", 151 "environment": "environment", 152 "save": true, 153 "log_id": "log_id", 154 "id": "id", 155 "evaluator_logs": [ 156 { 157 "start_time": "2024-01-15T09:30:00Z", 158 "end_time": "2024-01-15T09:30:00Z", 159 "output": "output", 160 "created_at": "2024-01-15T09:30:00Z", 161 "error": "error", 162 "provider_latency": 1.1, 163 "stdout": "stdout", 164 "provider_request": { 165 "key": "value" 166 }, 167 "provider_response": { 168 "key": "value" 169 }, 170 "inputs": { 171 "key": "value" 172 }, 173 "source": "source", 174 "metadata": { 175 "key": "value" 176 }, 177 "parent_id": "parent_id", 178 "source_datapoint_id": "source_datapoint_id", 179 "trace_parent_id": "trace_parent_id", 180 "batches": [ 181 "batches" 182 ], 183 "user": "user", 184 "environment": "environment", 185 "save": true, 186 "log_id": "log_id", 187 "judgment": true, 188 "marked_completed": true, 189 "id": "id", 190 "evaluator_logs": [], 191 "trace_flow_id": "trace_flow_id", 192 "trace_id": "trace_id", 193 "evaluator": { 194 "path": "path", 195 "id": "id", 196 "spec": { 197 "arguments_type": "target_free", 198 "return_type": "boolean", 199 "evaluator_type": "llm" 200 }, 201 "name": "name", 202 "version_id": "version_id", 203 "created_at": "2024-01-15T09:30:00Z", 204 "updated_at": "2024-01-15T09:30:00Z", 205 "status": "uncommitted", 206 "last_used_at": "2024-01-15T09:30:00Z", 207 "version_logs_count": 1, 208 "total_logs_count": 1, 209 "inputs": [ 210 { 211 "name": "name" 212 } 213 ] 214 } 215 } 216 ], 217 "trace_flow_id": "trace_flow_id", 218 "trace_id": "trace_id" 219 }

1	curl -X PATCH https://api.humanloop.com/v5/tools/id/log/log_id \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"output_message": {
3	"content": "content",
4	"name": "name",
5	"tool_call_id": "tool_call_id",
6	"role": "user",
7	"tool_calls": [
8	{
9	"id": "id",
10	"type": "function",
11	"function": {
12	"name": "name"
13	}
14	}
15	]
16	},
17	"prompt_tokens": 1,
18	"output_tokens": 1,
19	"prompt_cost": 1.1,
20	"output_cost": 1.1,
21	"finish_reason": "finish_reason",
22	"messages": [
23	{
24	"content": "content",
25	"name": "name",
26	"tool_call_id": "tool_call_id",
27	"role": "user",
28	"tool_calls": [
29	{
30	"id": "id",
31	"type": "function",
32	"function": {
33	"name": "name"
34	}
35	}
36	]
37	}
38	],
39	"tool_choice": "none",
40	"prompt": {
41	"path": "path",
42	"id": "id",
43	"directory_id": "directory_id",
44	"model": "model",
45	"endpoint": "complete",
46	"template": "template",
47	"provider": "openai",
48	"max_tokens": 1,
49	"temperature": 1.1,
50	"top_p": 1.1,
51	"stop": "stop",
52	"presence_penalty": 1.1,
53	"frequency_penalty": 1.1,
54	"other": {
55	"key": "value"
56	},
57	"seed": 1,
58	"response_format": {
59	"type": "json_object",
60	"json_schema": {
61	"key": "value"
62	}
63	},
64	"tools": [
65	{
66	"name": "name",
67	"description": "description"
68	}
69	],
70	"linked_tools": [
71	{
72	"name": "name",
73	"description": "description",
74	"id": "id",
75	"version_id": "version_id"
76	}
77	],
78	"attributes": {
79	"key": "value"
80	},
81	"commit_message": "commit_message",
82	"name": "name",
83	"version_id": "version_id",
84	"type": "prompt",
85	"environments": [
86	{
87	"id": "id",
88	"created_at": "2024-01-15T09:30:00Z",
89	"name": "name",
90	"tag": "default"
91	}
92	],
93	"created_at": "2024-01-15T09:30:00Z",
94	"updated_at": "2024-01-15T09:30:00Z",
95	"created_by": {
96	"id": "id",
97	"email_address": "email_address",
98	"full_name": "full_name"
99	},
100	"committed_by": {
101	"id": "id",
102	"email_address": "email_address",
103	"full_name": "full_name"
104	},
105	"committed_at": "2024-01-15T09:30:00Z",
106	"status": "uncommitted",
107	"last_used_at": "2024-01-15T09:30:00Z",
108	"version_logs_count": 1,
109	"total_logs_count": 1,
110	"inputs": [
111	{
112	"name": "name"
113	}
114	],
115	"evaluator_aggregates": [
116	{
117	"value": 1.1,
118	"evaluator_id": "evaluator_id",
119	"evaluator_version_id": "evaluator_version_id",
120	"created_at": "2024-01-15T09:30:00Z",
121	"updated_at": "2024-01-15T09:30:00Z"
122	}
123	]
124	},
125	"start_time": "2024-01-15T09:30:00Z",
126	"end_time": "2024-01-15T09:30:00Z",
127	"output": "output",
128	"created_at": "2024-01-15T09:30:00Z",
129	"error": "error",
130	"provider_latency": 1.1,
131	"stdout": "stdout",
132	"provider_request": {
133	"key": "value"
134	},
135	"provider_response": {
136	"key": "value"
137	},
138	"inputs": {
139	"key": "value"
140	},
141	"source": "source",
142	"metadata": {
143	"key": "value"
144	},
145	"source_datapoint_id": "source_datapoint_id",
146	"trace_parent_id": "trace_parent_id",
147	"batches": [
148	"batches"
149	],
150	"user": "user",
151	"environment": "environment",
152	"save": true,
153	"log_id": "log_id",
154	"id": "id",
155	"evaluator_logs": [
156	{
157	"start_time": "2024-01-15T09:30:00Z",
158	"end_time": "2024-01-15T09:30:00Z",
159	"output": "output",
160	"created_at": "2024-01-15T09:30:00Z",
161	"error": "error",
162	"provider_latency": 1.1,
163	"stdout": "stdout",
164	"provider_request": {
165	"key": "value"
166	},
167	"provider_response": {
168	"key": "value"
169	},
170	"inputs": {
171	"key": "value"
172	},
173	"source": "source",
174	"metadata": {
175	"key": "value"
176	},
177	"parent_id": "parent_id",
178	"source_datapoint_id": "source_datapoint_id",
179	"trace_parent_id": "trace_parent_id",
180	"batches": [
181	"batches"
182	],
183	"user": "user",
184	"environment": "environment",
185	"save": true,
186	"log_id": "log_id",
187	"judgment": true,
188	"marked_completed": true,
189	"id": "id",
190	"evaluator_logs": [],
191	"trace_flow_id": "trace_flow_id",
192	"trace_id": "trace_id",
193	"evaluator": {
194	"path": "path",
195	"id": "id",
196	"spec": {
197	"arguments_type": "target_free",
198	"return_type": "boolean",
199	"evaluator_type": "llm"
200	},
201	"name": "name",
202	"version_id": "version_id",
203	"created_at": "2024-01-15T09:30:00Z",
204	"updated_at": "2024-01-15T09:30:00Z",
205	"status": "uncommitted",
206	"last_used_at": "2024-01-15T09:30:00Z",
207	"version_logs_count": 1,
208	"total_logs_count": 1,
209	"inputs": [
210	{
211	"name": "name"
212	}
213	]
214	}
215	}
216	],
217	"trace_flow_id": "trace_flow_id",
218	"trace_id": "trace_id"
219	}