-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathclient.py
More file actions
360 lines (295 loc) · 12.4 KB
/
client.py
File metadata and controls
360 lines (295 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
# This file was auto-generated by Fern from our API Definition.
import datetime as dt
import typing
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.pagination import AsyncPager, SyncPager
from ..core.request_options import RequestOptions
from ..types.log_response import LogResponse
from .raw_client import AsyncRawLogsClient, RawLogsClient
class LogsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawLogsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawLogsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawLogsClient
"""
return self._raw_client
def list(
self,
*,
file_id: str,
page: typing.Optional[int] = None,
size: typing.Optional[int] = None,
version_id: typing.Optional[str] = None,
id: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
search: typing.Optional[str] = None,
metadata_search: typing.Optional[str] = None,
start_date: typing.Optional[dt.datetime] = None,
end_date: typing.Optional[dt.datetime] = None,
include_parent: typing.Optional[bool] = None,
in_trace_filter: typing.Optional[typing.Union[bool, typing.Sequence[bool]]] = None,
sample: typing.Optional[int] = None,
include_trace_children: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> SyncPager[LogResponse]:
"""
List all Logs for the given filter criteria.
Parameters
----------
file_id : str
Unique identifier for the File to list Logs for.
page : typing.Optional[int]
Page number for pagination.
size : typing.Optional[int]
Page size for pagination. Number of Logs to fetch.
version_id : typing.Optional[str]
If provided, only Logs belonging to the specified Version will be returned.
id : typing.Optional[typing.Union[str, typing.Sequence[str]]]
If provided, returns Logs whose IDs contain any of the specified values as substrings.
search : typing.Optional[str]
If provided, only Logs that contain the provided string in its inputs and output will be returned.
metadata_search : typing.Optional[str]
If provided, only Logs that contain the provided string in its metadata will be returned.
start_date : typing.Optional[dt.datetime]
If provided, only Logs created after the specified date will be returned.
end_date : typing.Optional[dt.datetime]
If provided, only Logs created before the specified date will be returned.
include_parent : typing.Optional[bool]
If true, include the full parent Log in the response. Only applicable when retrieving Evaluator Logs.
in_trace_filter : typing.Optional[typing.Union[bool, typing.Sequence[bool]]]
If true, return Logs that are associated to a Trace. False, return Logs that are not associated to a Trace.
sample : typing.Optional[int]
If provided, limit the response to a random subset of logs from the filtered results. (This will be an approximate sample, not a strict limit.)
include_trace_children : typing.Optional[bool]
If true, populate `trace_children` for the retrieved Logs. Only applicable when retrieving Flow or Agent Logs.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SyncPager[LogResponse]
Successful Response
Examples
--------
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.logs.list(file_id='file_123abc', size=1, )
for item in response:
yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
yield page
"""
return self._raw_client.list(
file_id=file_id,
page=page,
size=size,
version_id=version_id,
id=id,
search=search,
metadata_search=metadata_search,
start_date=start_date,
end_date=end_date,
include_parent=include_parent,
in_trace_filter=in_trace_filter,
sample=sample,
include_trace_children=include_trace_children,
request_options=request_options,
)
def delete(
self,
*,
id: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> None:
"""
Delete Logs with the given IDs.
Parameters
----------
id : typing.Optional[typing.Union[str, typing.Sequence[str]]]
Unique identifiers for the Logs to delete.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.logs.delete(id='prv_Wu6zx1lAWJRqOyL8nWuZk', )
"""
_response = self._raw_client.delete(id=id, request_options=request_options)
return _response.data
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> LogResponse:
"""
Retrieve the Log with the given ID.
Parameters
----------
id : str
Unique identifier for Log.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LogResponse
Successful Response
Examples
--------
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.logs.get(id='prv_Wu6zx1lAWJRqOyL8nWuZk', )
"""
_response = self._raw_client.get(id, request_options=request_options)
return _response.data
class AsyncLogsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawLogsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawLogsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawLogsClient
"""
return self._raw_client
async def list(
self,
*,
file_id: str,
page: typing.Optional[int] = None,
size: typing.Optional[int] = None,
version_id: typing.Optional[str] = None,
id: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
search: typing.Optional[str] = None,
metadata_search: typing.Optional[str] = None,
start_date: typing.Optional[dt.datetime] = None,
end_date: typing.Optional[dt.datetime] = None,
include_parent: typing.Optional[bool] = None,
in_trace_filter: typing.Optional[typing.Union[bool, typing.Sequence[bool]]] = None,
sample: typing.Optional[int] = None,
include_trace_children: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncPager[LogResponse]:
"""
List all Logs for the given filter criteria.
Parameters
----------
file_id : str
Unique identifier for the File to list Logs for.
page : typing.Optional[int]
Page number for pagination.
size : typing.Optional[int]
Page size for pagination. Number of Logs to fetch.
version_id : typing.Optional[str]
If provided, only Logs belonging to the specified Version will be returned.
id : typing.Optional[typing.Union[str, typing.Sequence[str]]]
If provided, returns Logs whose IDs contain any of the specified values as substrings.
search : typing.Optional[str]
If provided, only Logs that contain the provided string in its inputs and output will be returned.
metadata_search : typing.Optional[str]
If provided, only Logs that contain the provided string in its metadata will be returned.
start_date : typing.Optional[dt.datetime]
If provided, only Logs created after the specified date will be returned.
end_date : typing.Optional[dt.datetime]
If provided, only Logs created before the specified date will be returned.
include_parent : typing.Optional[bool]
If true, include the full parent Log in the response. Only applicable when retrieving Evaluator Logs.
in_trace_filter : typing.Optional[typing.Union[bool, typing.Sequence[bool]]]
If true, return Logs that are associated to a Trace. False, return Logs that are not associated to a Trace.
sample : typing.Optional[int]
If provided, limit the response to a random subset of logs from the filtered results. (This will be an approximate sample, not a strict limit.)
include_trace_children : typing.Optional[bool]
If true, populate `trace_children` for the retrieved Logs. Only applicable when retrieving Flow or Agent Logs.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncPager[LogResponse]
Successful Response
Examples
--------
from humanloop import AsyncHumanloop
import asyncio
client = AsyncHumanloop(api_key="YOUR_API_KEY", )
async def main() -> None:
response = await client.logs.list(file_id='file_123abc', size=1, )
async for item in response:
yield item
# alternatively, you can paginate page-by-page
async for page in response.iter_pages():
yield page
asyncio.run(main())
"""
return await self._raw_client.list(
file_id=file_id,
page=page,
size=size,
version_id=version_id,
id=id,
search=search,
metadata_search=metadata_search,
start_date=start_date,
end_date=end_date,
include_parent=include_parent,
in_trace_filter=in_trace_filter,
sample=sample,
include_trace_children=include_trace_children,
request_options=request_options,
)
async def delete(
self,
*,
id: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> None:
"""
Delete Logs with the given IDs.
Parameters
----------
id : typing.Optional[typing.Union[str, typing.Sequence[str]]]
Unique identifiers for the Logs to delete.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from humanloop import AsyncHumanloop
import asyncio
client = AsyncHumanloop(api_key="YOUR_API_KEY", )
async def main() -> None:
await client.logs.delete(id='prv_Wu6zx1lAWJRqOyL8nWuZk', )
asyncio.run(main())
"""
_response = await self._raw_client.delete(id=id, request_options=request_options)
return _response.data
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> LogResponse:
"""
Retrieve the Log with the given ID.
Parameters
----------
id : str
Unique identifier for Log.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LogResponse
Successful Response
Examples
--------
from humanloop import AsyncHumanloop
import asyncio
client = AsyncHumanloop(api_key="YOUR_API_KEY", )
async def main() -> None:
await client.logs.get(id='prv_Wu6zx1lAWJRqOyL8nWuZk', )
asyncio.run(main())
"""
_response = await self._raw_client.get(id, request_options=request_options)
return _response.data