-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathbase_client.py
More file actions
170 lines (142 loc) · 7.66 KB
/
base_client.py
File metadata and controls
170 lines (142 loc) · 7.66 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
# This file was auto-generated by Fern from our API Definition.
import os
import typing
import httpx
from .agents.client import AgentsClient, AsyncAgentsClient
from .core.api_error import ApiError
from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from .datasets.client import AsyncDatasetsClient, DatasetsClient
from .directories.client import AsyncDirectoriesClient, DirectoriesClient
from .environment import HumanloopEnvironment
from .evaluations.client import AsyncEvaluationsClient, EvaluationsClient
from .evaluators.client import AsyncEvaluatorsClient, EvaluatorsClient
from .files.client import AsyncFilesClient, FilesClient
from .flows.client import AsyncFlowsClient, FlowsClient
from .logs.client import AsyncLogsClient, LogsClient
from .prompts.client import AsyncPromptsClient, PromptsClient
from .tools.client import AsyncToolsClient, ToolsClient
class BaseHumanloop:
"""
Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
Parameters
----------
base_url : typing.Optional[str]
The base url to use for requests from the client.
environment : HumanloopEnvironment
The environment to use for requests from the client. from .environment import HumanloopEnvironment
Defaults to HumanloopEnvironment.DEFAULT
api_key : typing.Optional[str]
timeout : typing.Optional[float]
The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
follow_redirects : typing.Optional[bool]
Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
httpx_client : typing.Optional[httpx.Client]
The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
Examples
--------
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
"""
def __init__(
self,
*,
base_url: typing.Optional[str] = None,
environment: HumanloopEnvironment = HumanloopEnvironment.DEFAULT,
api_key: typing.Optional[str] = os.getenv("HUMANLOOP_API_KEY"),
timeout: typing.Optional[float] = None,
follow_redirects: typing.Optional[bool] = True,
httpx_client: typing.Optional[httpx.Client] = None,
):
_defaulted_timeout = (
timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
)
if api_key is None:
raise ApiError(
body="The client must be instantiated be either passing in api_key or setting HUMANLOOP_API_KEY"
)
self._client_wrapper = SyncClientWrapper(
base_url=_get_base_url(base_url=base_url, environment=environment),
api_key=api_key,
httpx_client=httpx_client
if httpx_client is not None
else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
if follow_redirects is not None
else httpx.Client(timeout=_defaulted_timeout),
timeout=_defaulted_timeout,
)
self.prompts = PromptsClient(client_wrapper=self._client_wrapper)
self.tools = ToolsClient(client_wrapper=self._client_wrapper)
self.datasets = DatasetsClient(client_wrapper=self._client_wrapper)
self.evaluators = EvaluatorsClient(client_wrapper=self._client_wrapper)
self.flows = FlowsClient(client_wrapper=self._client_wrapper)
self.agents = AgentsClient(client_wrapper=self._client_wrapper)
self.directories = DirectoriesClient(client_wrapper=self._client_wrapper)
self.files = FilesClient(client_wrapper=self._client_wrapper)
self.evaluations = EvaluationsClient(client_wrapper=self._client_wrapper)
self.logs = LogsClient(client_wrapper=self._client_wrapper)
class AsyncBaseHumanloop:
"""
Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
Parameters
----------
base_url : typing.Optional[str]
The base url to use for requests from the client.
environment : HumanloopEnvironment
The environment to use for requests from the client. from .environment import HumanloopEnvironment
Defaults to HumanloopEnvironment.DEFAULT
api_key : typing.Optional[str]
timeout : typing.Optional[float]
The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
follow_redirects : typing.Optional[bool]
Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
httpx_client : typing.Optional[httpx.AsyncClient]
The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
Examples
--------
from humanloop import AsyncHumanloop
client = AsyncHumanloop(api_key="YOUR_API_KEY", )
"""
def __init__(
self,
*,
base_url: typing.Optional[str] = None,
environment: HumanloopEnvironment = HumanloopEnvironment.DEFAULT,
api_key: typing.Optional[str] = os.getenv("HUMANLOOP_API_KEY"),
timeout: typing.Optional[float] = None,
follow_redirects: typing.Optional[bool] = True,
httpx_client: typing.Optional[httpx.AsyncClient] = None,
):
_defaulted_timeout = (
timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
)
if api_key is None:
raise ApiError(
body="The client must be instantiated be either passing in api_key or setting HUMANLOOP_API_KEY"
)
self._client_wrapper = AsyncClientWrapper(
base_url=_get_base_url(base_url=base_url, environment=environment),
api_key=api_key,
httpx_client=httpx_client
if httpx_client is not None
else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
if follow_redirects is not None
else httpx.AsyncClient(timeout=_defaulted_timeout),
timeout=_defaulted_timeout,
)
self.prompts = AsyncPromptsClient(client_wrapper=self._client_wrapper)
self.tools = AsyncToolsClient(client_wrapper=self._client_wrapper)
self.datasets = AsyncDatasetsClient(client_wrapper=self._client_wrapper)
self.evaluators = AsyncEvaluatorsClient(client_wrapper=self._client_wrapper)
self.flows = AsyncFlowsClient(client_wrapper=self._client_wrapper)
self.agents = AsyncAgentsClient(client_wrapper=self._client_wrapper)
self.directories = AsyncDirectoriesClient(client_wrapper=self._client_wrapper)
self.files = AsyncFilesClient(client_wrapper=self._client_wrapper)
self.evaluations = AsyncEvaluationsClient(client_wrapper=self._client_wrapper)
self.logs = AsyncLogsClient(client_wrapper=self._client_wrapper)
def _get_base_url(*, base_url: typing.Optional[str] = None, environment: HumanloopEnvironment) -> str:
if base_url is not None:
return base_url
elif environment is not None:
return environment.value
else:
raise Exception("Please pass in either base_url or environment to construct the client")