arbi 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of arbi might be problematic. Click here for more details.

Files changed (143) hide show
  1. arbi/__init__.py +90 -0
  2. arbi/_base_client.py +1995 -0
  3. arbi/_client.py +394 -0
  4. arbi/_compat.py +219 -0
  5. arbi/_constants.py +14 -0
  6. arbi/_exceptions.py +108 -0
  7. arbi/_files.py +123 -0
  8. arbi/_models.py +829 -0
  9. arbi/_qs.py +150 -0
  10. arbi/_resource.py +43 -0
  11. arbi/_response.py +830 -0
  12. arbi/_streaming.py +333 -0
  13. arbi/_types.py +219 -0
  14. arbi/_utils/__init__.py +57 -0
  15. arbi/_utils/_logs.py +25 -0
  16. arbi/_utils/_proxy.py +65 -0
  17. arbi/_utils/_reflection.py +42 -0
  18. arbi/_utils/_resources_proxy.py +24 -0
  19. arbi/_utils/_streams.py +12 -0
  20. arbi/_utils/_sync.py +86 -0
  21. arbi/_utils/_transform.py +447 -0
  22. arbi/_utils/_typing.py +151 -0
  23. arbi/_utils/_utils.py +422 -0
  24. arbi/_version.py +4 -0
  25. arbi/lib/.keep +4 -0
  26. arbi/py.typed +0 -0
  27. arbi/resources/__init__.py +19 -0
  28. arbi/resources/api/__init__.py +145 -0
  29. arbi/resources/api/api.py +422 -0
  30. arbi/resources/api/assistant.py +300 -0
  31. arbi/resources/api/configs.py +499 -0
  32. arbi/resources/api/conversation/__init__.py +33 -0
  33. arbi/resources/api/conversation/conversation.py +555 -0
  34. arbi/resources/api/conversation/user.py +270 -0
  35. arbi/resources/api/document/__init__.py +33 -0
  36. arbi/resources/api/document/annotation.py +384 -0
  37. arbi/resources/api/document/document.py +873 -0
  38. arbi/resources/api/health.py +304 -0
  39. arbi/resources/api/sso.py +333 -0
  40. arbi/resources/api/tag.py +614 -0
  41. arbi/resources/api/user/__init__.py +33 -0
  42. arbi/resources/api/user/settings.py +251 -0
  43. arbi/resources/api/user/user.py +532 -0
  44. arbi/resources/api/workspace.py +1061 -0
  45. arbi/types/__init__.py +8 -0
  46. arbi/types/api/__init__.py +84 -0
  47. arbi/types/api/assistant_query_params.py +59 -0
  48. arbi/types/api/assistant_retrieve_params.py +59 -0
  49. arbi/types/api/chunker_config_param.py +9 -0
  50. arbi/types/api/config_create_params.py +45 -0
  51. arbi/types/api/config_create_response.py +15 -0
  52. arbi/types/api/config_delete_response.py +11 -0
  53. arbi/types/api/config_get_versions_response.py +19 -0
  54. arbi/types/api/config_retrieve_response.py +46 -0
  55. arbi/types/api/conversation/__init__.py +8 -0
  56. arbi/types/api/conversation/user_add_params.py +11 -0
  57. arbi/types/api/conversation/user_add_response.py +11 -0
  58. arbi/types/api/conversation/user_remove_params.py +11 -0
  59. arbi/types/api/conversation/user_remove_response.py +11 -0
  60. arbi/types/api/conversation_delete_message_response.py +11 -0
  61. arbi/types/api/conversation_delete_response.py +11 -0
  62. arbi/types/api/conversation_retrieve_threads_response.py +91 -0
  63. arbi/types/api/conversation_share_response.py +11 -0
  64. arbi/types/api/conversation_update_title_params.py +12 -0
  65. arbi/types/api/conversation_update_title_response.py +13 -0
  66. arbi/types/api/doc_response.py +48 -0
  67. arbi/types/api/document/__init__.py +8 -0
  68. arbi/types/api/document/annotation_create_params.py +16 -0
  69. arbi/types/api/document/annotation_delete_response.py +11 -0
  70. arbi/types/api/document/annotation_update_params.py +16 -0
  71. arbi/types/api/document/doc_tag_response.py +26 -0
  72. arbi/types/api/document_date_extractor_llm_config.py +29 -0
  73. arbi/types/api/document_date_extractor_llm_config_param.py +28 -0
  74. arbi/types/api/document_delete_response.py +11 -0
  75. arbi/types/api/document_get_parsed_response.py +26 -0
  76. arbi/types/api/document_get_tags_response.py +10 -0
  77. arbi/types/api/document_update_params.py +19 -0
  78. arbi/types/api/document_update_response.py +22 -0
  79. arbi/types/api/document_upload_params.py +23 -0
  80. arbi/types/api/document_view_params.py +13 -0
  81. arbi/types/api/embedder_config.py +18 -0
  82. arbi/types/api/embedder_config_param.py +17 -0
  83. arbi/types/api/health_check_app_response.py +9 -0
  84. arbi/types/api/health_check_models_response.py +21 -0
  85. arbi/types/api/health_check_services_response.py +23 -0
  86. arbi/types/api/health_get_models_response.py +19 -0
  87. arbi/types/api/model_citation_config.py +23 -0
  88. arbi/types/api/model_citation_config_param.py +23 -0
  89. arbi/types/api/parser_config_param.py +9 -0
  90. arbi/types/api/query_llm_config.py +30 -0
  91. arbi/types/api/query_llm_config_param.py +29 -0
  92. arbi/types/api/reranker_config.py +21 -0
  93. arbi/types/api/reranker_config_param.py +20 -0
  94. arbi/types/api/retriever_config.py +23 -0
  95. arbi/types/api/retriever_config_param.py +23 -0
  96. arbi/types/api/sso_invite_params.py +11 -0
  97. arbi/types/api/sso_invite_response.py +11 -0
  98. arbi/types/api/sso_login_params.py +16 -0
  99. arbi/types/api/sso_login_response.py +15 -0
  100. arbi/types/api/sso_rotate_passcode_response.py +11 -0
  101. arbi/types/api/tag_apply_to_docs_params.py +12 -0
  102. arbi/types/api/tag_apply_to_docs_response.py +13 -0
  103. arbi/types/api/tag_create_params.py +18 -0
  104. arbi/types/api/tag_create_response.py +11 -0
  105. arbi/types/api/tag_delete_response.py +9 -0
  106. arbi/types/api/tag_get_docs_response.py +10 -0
  107. arbi/types/api/tag_remove_from_docs_params.py +12 -0
  108. arbi/types/api/tag_remove_from_docs_response.py +13 -0
  109. arbi/types/api/tag_update_params.py +14 -0
  110. arbi/types/api/tag_update_response.py +17 -0
  111. arbi/types/api/title_llm_config.py +29 -0
  112. arbi/types/api/title_llm_config_param.py +28 -0
  113. arbi/types/api/token.py +13 -0
  114. arbi/types/api/user/__init__.py +6 -0
  115. arbi/types/api/user/setting_retrieve_response.py +36 -0
  116. arbi/types/api/user/setting_update_params.py +24 -0
  117. arbi/types/api/user_list_workspaces_response.py +10 -0
  118. arbi/types/api/user_login_params.py +13 -0
  119. arbi/types/api/user_logout_response.py +9 -0
  120. arbi/types/api/user_register_params.py +17 -0
  121. arbi/types/api/user_response.py +19 -0
  122. arbi/types/api/workspace_create_protected_params.py +14 -0
  123. arbi/types/api/workspace_delete_response.py +9 -0
  124. arbi/types/api/workspace_get_conversations_response.py +28 -0
  125. arbi/types/api/workspace_get_doctags_response.py +10 -0
  126. arbi/types/api/workspace_get_documents_response.py +10 -0
  127. arbi/types/api/workspace_get_stats_response.py +13 -0
  128. arbi/types/api/workspace_get_tags_response.py +30 -0
  129. arbi/types/api/workspace_get_users_response.py +17 -0
  130. arbi/types/api/workspace_remove_user_params.py +11 -0
  131. arbi/types/api/workspace_remove_user_response.py +11 -0
  132. arbi/types/api/workspace_response.py +24 -0
  133. arbi/types/api/workspace_share_params.py +11 -0
  134. arbi/types/api/workspace_share_response.py +21 -0
  135. arbi/types/api/workspace_update_params.py +14 -0
  136. arbi/types/chunk.py +12 -0
  137. arbi/types/chunk_metadata.py +31 -0
  138. arbi/types/chunk_metadata_param.py +32 -0
  139. arbi/types/chunk_param.py +15 -0
  140. arbi-0.1.0.dist-info/METADATA +410 -0
  141. arbi-0.1.0.dist-info/RECORD +143 -0
  142. arbi-0.1.0.dist-info/WHEEL +4 -0
  143. arbi-0.1.0.dist-info/licenses/LICENSE +201 -0
@@ -0,0 +1,410 @@
1
+ Metadata-Version: 2.3
2
+ Name: arbi
3
+ Version: 0.1.0
4
+ Summary: The official Python library for the arbi API
5
+ Project-URL: Homepage, https://github.com/arbitrationcity/arbi-python
6
+ Project-URL: Repository, https://github.com/arbitrationcity/arbi-python
7
+ Author: Arbi
8
+ License: Apache-2.0
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: License :: OSI Approved :: Apache Software License
11
+ Classifier: Operating System :: MacOS
12
+ Classifier: Operating System :: Microsoft :: Windows
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Operating System :: POSIX
15
+ Classifier: Operating System :: POSIX :: Linux
16
+ Classifier: Programming Language :: Python :: 3.8
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.8
25
+ Requires-Dist: anyio<5,>=3.5.0
26
+ Requires-Dist: distro<2,>=1.7.0
27
+ Requires-Dist: httpx<1,>=0.23.0
28
+ Requires-Dist: pydantic<3,>=1.9.0
29
+ Requires-Dist: sniffio
30
+ Requires-Dist: typing-extensions<5,>=4.10
31
+ Provides-Extra: aiohttp
32
+ Requires-Dist: aiohttp; extra == 'aiohttp'
33
+ Requires-Dist: httpx-aiohttp>=0.1.8; extra == 'aiohttp'
34
+ Description-Content-Type: text/markdown
35
+
36
+ # Arbi Python API library
37
+
38
+ <!-- prettier-ignore -->
39
+ [![PyPI version](https://img.shields.io/pypi/v/arbi.svg?label=pypi%20(stable))](https://pypi.org/project/arbi/)
40
+
41
+ The Arbi Python library provides convenient access to the Arbi REST API from any Python 3.8+
42
+ application. The library includes type definitions for all request params and response fields,
43
+ and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
44
+
45
+ It is generated with [Stainless](https://www.stainless.com/).
46
+
47
+ ## Documentation
48
+
49
+ The full API of this library can be found in [api.md](https://github.com/arbitrationcity/arbi-python/tree/main/api.md).
50
+
51
+ ## Installation
52
+
53
+ ```sh
54
+ # install from PyPI
55
+ pip install arbi
56
+ ```
57
+
58
+ ## Usage
59
+
60
+ The full API of this library can be found in [api.md](https://github.com/arbitrationcity/arbi-python/tree/main/api.md).
61
+
62
+ ```python
63
+ import os
64
+ from arbi import Arbi
65
+
66
+ client = Arbi(
67
+ api_key=os.environ.get("ARBI_API_KEY"), # This is the default and can be omitted
68
+ )
69
+
70
+ response = client.api.index()
71
+ ```
72
+
73
+ While you can provide an `api_key` keyword argument,
74
+ we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
75
+ to add `ARBI_API_KEY="My API Key"` to your `.env` file
76
+ so that your API Key is not stored in source control.
77
+
78
+ ## Async usage
79
+
80
+ Simply import `AsyncArbi` instead of `Arbi` and use `await` with each API call:
81
+
82
+ ```python
83
+ import os
84
+ import asyncio
85
+ from arbi import AsyncArbi
86
+
87
+ client = AsyncArbi(
88
+ api_key=os.environ.get("ARBI_API_KEY"), # This is the default and can be omitted
89
+ )
90
+
91
+
92
+ async def main() -> None:
93
+ response = await client.api.index()
94
+
95
+
96
+ asyncio.run(main())
97
+ ```
98
+
99
+ Functionality between the synchronous and asynchronous clients is otherwise identical.
100
+
101
+ ### With aiohttp
102
+
103
+ By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
104
+
105
+ You can enable this by installing `aiohttp`:
106
+
107
+ ```sh
108
+ # install from PyPI
109
+ pip install arbi[aiohttp]
110
+ ```
111
+
112
+ Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
113
+
114
+ ```python
115
+ import asyncio
116
+ from arbi import DefaultAioHttpClient
117
+ from arbi import AsyncArbi
118
+
119
+
120
+ async def main() -> None:
121
+ async with AsyncArbi(
122
+ api_key="My API Key",
123
+ http_client=DefaultAioHttpClient(),
124
+ ) as client:
125
+ response = await client.api.index()
126
+
127
+
128
+ asyncio.run(main())
129
+ ```
130
+
131
+ ## Using types
132
+
133
+ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
134
+
135
+ - Serializing back into JSON, `model.to_json()`
136
+ - Converting to a dictionary, `model.to_dict()`
137
+
138
+ Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
139
+
140
+ ## Nested params
141
+
142
+ Nested parameters are dictionaries, typed using `TypedDict`, for example:
143
+
144
+ ```python
145
+ from arbi import Arbi
146
+
147
+ client = Arbi()
148
+
149
+ config = client.api.configs.create(
150
+ document_date_extractor_llm={},
151
+ )
152
+ print(config.document_date_extractor_llm)
153
+ ```
154
+
155
+ ## Handling errors
156
+
157
+ When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `arbi.APIConnectionError` is raised.
158
+
159
+ When the API returns a non-success status code (that is, 4xx or 5xx
160
+ response), a subclass of `arbi.APIStatusError` is raised, containing `status_code` and `response` properties.
161
+
162
+ All errors inherit from `arbi.APIError`.
163
+
164
+ ```python
165
+ import arbi
166
+ from arbi import Arbi
167
+
168
+ client = Arbi()
169
+
170
+ try:
171
+ client.api.index()
172
+ except arbi.APIConnectionError as e:
173
+ print("The server could not be reached")
174
+ print(e.__cause__) # an underlying Exception, likely raised within httpx.
175
+ except arbi.RateLimitError as e:
176
+ print("A 429 status code was received; we should back off a bit.")
177
+ except arbi.APIStatusError as e:
178
+ print("Another non-200-range status code was received")
179
+ print(e.status_code)
180
+ print(e.response)
181
+ ```
182
+
183
+ Error codes are as follows:
184
+
185
+ | Status Code | Error Type |
186
+ | ----------- | -------------------------- |
187
+ | 400 | `BadRequestError` |
188
+ | 401 | `AuthenticationError` |
189
+ | 403 | `PermissionDeniedError` |
190
+ | 404 | `NotFoundError` |
191
+ | 422 | `UnprocessableEntityError` |
192
+ | 429 | `RateLimitError` |
193
+ | >=500 | `InternalServerError` |
194
+ | N/A | `APIConnectionError` |
195
+
196
+ ### Retries
197
+
198
+ Certain errors are automatically retried 2 times by default, with a short exponential backoff.
199
+ Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
200
+ 429 Rate Limit, and >=500 Internal errors are all retried by default.
201
+
202
+ You can use the `max_retries` option to configure or disable retry settings:
203
+
204
+ ```python
205
+ from arbi import Arbi
206
+
207
+ # Configure the default for all requests:
208
+ client = Arbi(
209
+ # default is 2
210
+ max_retries=0,
211
+ )
212
+
213
+ # Or, configure per-request:
214
+ client.with_options(max_retries=5).api.index()
215
+ ```
216
+
217
+ ### Timeouts
218
+
219
+ By default requests time out after 1 minute. You can configure this with a `timeout` option,
220
+ which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
221
+
222
+ ```python
223
+ from arbi import Arbi
224
+
225
+ # Configure the default for all requests:
226
+ client = Arbi(
227
+ # 20 seconds (default is 1 minute)
228
+ timeout=20.0,
229
+ )
230
+
231
+ # More granular control:
232
+ client = Arbi(
233
+ timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
234
+ )
235
+
236
+ # Override per-request:
237
+ client.with_options(timeout=5.0).api.index()
238
+ ```
239
+
240
+ On timeout, an `APITimeoutError` is thrown.
241
+
242
+ Note that requests that time out are [retried twice by default](https://github.com/arbitrationcity/arbi-python/tree/main/#retries).
243
+
244
+ ## Advanced
245
+
246
+ ### Logging
247
+
248
+ We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
249
+
250
+ You can enable logging by setting the environment variable `ARBI_LOG` to `info`.
251
+
252
+ ```shell
253
+ $ export ARBI_LOG=info
254
+ ```
255
+
256
+ Or to `debug` for more verbose logging.
257
+
258
+ ### How to tell whether `None` means `null` or missing
259
+
260
+ In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:
261
+
262
+ ```py
263
+ if response.my_field is None:
264
+ if 'my_field' not in response.model_fields_set:
265
+ print('Got json like {}, without a "my_field" key present at all.')
266
+ else:
267
+ print('Got json like {"my_field": null}.')
268
+ ```
269
+
270
+ ### Accessing raw response data (e.g. headers)
271
+
272
+ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
273
+
274
+ ```py
275
+ from arbi import Arbi
276
+
277
+ client = Arbi()
278
+ response = client.api.with_raw_response.index()
279
+ print(response.headers.get('X-My-Header'))
280
+
281
+ api = response.parse() # get the object that `api.index()` would have returned
282
+ print(api)
283
+ ```
284
+
285
+ These methods return an [`APIResponse`](https://github.com/arbitrationcity/arbi-python/tree/main/src/arbi/_response.py) object.
286
+
287
+ The async client returns an [`AsyncAPIResponse`](https://github.com/arbitrationcity/arbi-python/tree/main/src/arbi/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
288
+
289
+ #### `.with_streaming_response`
290
+
291
+ The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
292
+
293
+ To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
294
+
295
+ ```python
296
+ with client.api.with_streaming_response.index() as response:
297
+ print(response.headers.get("X-My-Header"))
298
+
299
+ for line in response.iter_lines():
300
+ print(line)
301
+ ```
302
+
303
+ The context manager is required so that the response will reliably be closed.
304
+
305
+ ### Making custom/undocumented requests
306
+
307
+ This library is typed for convenient access to the documented API.
308
+
309
+ If you need to access undocumented endpoints, params, or response properties, the library can still be used.
310
+
311
+ #### Undocumented endpoints
312
+
313
+ To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
314
+ http verbs. Options on the client will be respected (such as retries) when making this request.
315
+
316
+ ```py
317
+ import httpx
318
+
319
+ response = client.post(
320
+ "/foo",
321
+ cast_to=httpx.Response,
322
+ body={"my_param": True},
323
+ )
324
+
325
+ print(response.headers.get("x-foo"))
326
+ ```
327
+
328
+ #### Undocumented request params
329
+
330
+ If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
331
+ options.
332
+
333
+ #### Undocumented response properties
334
+
335
+ To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
336
+ can also get all the extra fields on the Pydantic model as a dict with
337
+ [`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
338
+
339
+ ### Configuring the HTTP client
340
+
341
+ You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
342
+
343
+ - Support for [proxies](https://www.python-httpx.org/advanced/proxies/)
344
+ - Custom [transports](https://www.python-httpx.org/advanced/transports/)
345
+ - Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
346
+
347
+ ```python
348
+ import httpx
349
+ from arbi import Arbi, DefaultHttpxClient
350
+
351
+ client = Arbi(
352
+ # Or use the `ARBI_BASE_URL` env var
353
+ base_url="http://my.test.server.example.com:8083",
354
+ http_client=DefaultHttpxClient(
355
+ proxy="http://my.test.proxy.example.com",
356
+ transport=httpx.HTTPTransport(local_address="0.0.0.0"),
357
+ ),
358
+ )
359
+ ```
360
+
361
+ You can also customize the client on a per-request basis by using `with_options()`:
362
+
363
+ ```python
364
+ client.with_options(http_client=DefaultHttpxClient(...))
365
+ ```
366
+
367
+ ### Managing HTTP resources
368
+
369
+ By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
370
+
371
+ ```py
372
+ from arbi import Arbi
373
+
374
+ with Arbi() as client:
375
+ # make requests here
376
+ ...
377
+
378
+ # HTTP client is now closed
379
+ ```
380
+
381
+ ## Versioning
382
+
383
+ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
384
+
385
+ 1. Changes that only affect static types, without breaking runtime behavior.
386
+ 2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
387
+ 3. Changes that we do not expect to impact the vast majority of users in practice.
388
+
389
+ We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
390
+
391
+ We are keen for your feedback; please open an [issue](https://www.github.com/arbitrationcity/arbi-python/issues) with questions, bugs, or suggestions.
392
+
393
+ ### Determining the installed version
394
+
395
+ If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
396
+
397
+ You can determine the version that is being used at runtime with:
398
+
399
+ ```py
400
+ import arbi
401
+ print(arbi.__version__)
402
+ ```
403
+
404
+ ## Requirements
405
+
406
+ Python 3.8 or higher.
407
+
408
+ ## Contributing
409
+
410
+ See [the contributing documentation](https://github.com/arbitrationcity/arbi-python/tree/main/./CONTRIBUTING.md).
@@ -0,0 +1,143 @@
1
+ arbi/__init__.py,sha256=3CoWILxiYL8zuBNlOio4fcfNDHvbomp7eRTwKF0meIs,2560
2
+ arbi/_base_client.py,sha256=f0MBRAHvfRL7fMTbMNI7oQ6O90p-nipfrc-cVw62FaM,67033
3
+ arbi/_client.py,sha256=metIqf0pogvyPr2NrnouJglreecwWb_hwis-pLbXOTM,14748
4
+ arbi/_compat.py,sha256=VWemUKbj6DDkQ-O4baSpHVLJafotzeXmCQGJugfVTIw,6580
5
+ arbi/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
6
+ arbi/_exceptions.py,sha256=ymYmwHMUBfDutGbh6IppIeeweaUQ646Qqe3CdCk5wgM,3216
7
+ arbi/_files.py,sha256=KnEzGi_O756MvKyJ4fOCW_u3JhOeWPQ4RsmDvqihDQU,3545
8
+ arbi/_models.py,sha256=KvjsMfb88XZlFUKVoOxr8OyDj47MhoH2OKqWNEbBhk4,30010
9
+ arbi/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
10
+ arbi/_resource.py,sha256=eBjjRTRH59kNM8uLWIK04QCR0Sknrv9fEs4DvHw749U,1088
11
+ arbi/_response.py,sha256=YuaBc04B9DUJJE0ptEY4_9l_sEhDGdmfNEoow70cdRk,28776
12
+ arbi/_streaming.py,sha256=pYS_kis2y_Hm4dOrU0VpTwXipsTChy9GdB3qBsRp36s,10092
13
+ arbi/_types.py,sha256=SFb5o_NJvOJyurBOicgN9TM2JwDMvh32SiugySIyGRw,6195
14
+ arbi/_version.py,sha256=2muwqp5xH_0N-hnsXD7AhLjHgpjObb-hg42HA1rNG0I,156
15
+ arbi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
16
+ arbi/_utils/__init__.py,sha256=PNZ_QJuzZEgyYXqkO1HVhGkj5IU9bglVUcw7H-Knjzw,2062
17
+ arbi/_utils/_logs.py,sha256=8KRH2HNTPpXiZmTJwcw1JgdwU3GDtFOuxJ83fb_hrFY,768
18
+ arbi/_utils/_proxy.py,sha256=aglnj2yBTDyGX9Akk2crZHrl10oqRmceUy2Zp008XEs,1975
19
+ arbi/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU,1364
20
+ arbi/_utils/_resources_proxy.py,sha256=Ar894nC6HRi3YKu1Hl8-4xUTXwqtXkfrl1IId_ivR_w,579
21
+ arbi/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
22
+ arbi/_utils/_sync.py,sha256=TpGLrrhRNWTJtODNE6Fup3_k7zrWm1j2RlirzBwre-0,2862
23
+ arbi/_utils/_transform.py,sha256=n7kskEWz6o__aoNvhFoGVyDoalNe6mJwp-g7BWkdj88,15617
24
+ arbi/_utils/_typing.py,sha256=D0DbbNu8GnYQTSICnTSHDGsYXj8TcAKyhejb0XcnjtY,4602
25
+ arbi/_utils/_utils.py,sha256=V3vyXdIQrhXaQrHpCAytOlcTEf3xNkH4hbKIEq9XVj8,12291
26
+ arbi/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
27
+ arbi/resources/__init__.py,sha256=Ks_RQk6zvKGqOl6H7gpnyW1FrSY8SVsrKGj4mcmQ61k,513
28
+ arbi/resources/api/__init__.py,sha256=BB3HidGaRiEo2ul0vZ3GEkUb9KcWwq2AqQxQNkl-WFQ,4654
29
+ arbi/resources/api/api.py,sha256=wtm1HbRPYfTiDyTDFpoeF3WJVRiZC0Jcbc1RNO-gslE,14490
30
+ arbi/resources/api/assistant.py,sha256=n5L8F-dk3geJCT0SE6RCfR8Hza4oCRSfcEXBu8hPsOk,11463
31
+ arbi/resources/api/configs.py,sha256=BC0RLNUfTltUmBjRk0PbSmlecQJdbyCgisuchiR4-6Y,20572
32
+ arbi/resources/api/health.py,sha256=UAaumIpWooNuebCp5Gw26aZ2u2M5IKlGeGB11tiJ5EE,12378
33
+ arbi/resources/api/sso.py,sha256=xi-W_DghOFLYbG_AO6Ub_IW9mhnTe6vtLhtuNDpWI3Y,12463
34
+ arbi/resources/api/tag.py,sha256=epRB0TVkY1KsYXI2eScqLuiHaHr-8cdq5ZCOwXsABk0,23608
35
+ arbi/resources/api/workspace.py,sha256=aYZ7xAt167QNYkhJRR46EQ_WQPesk497RX_S6igSpoI,42415
36
+ arbi/resources/api/conversation/__init__.py,sha256=WQKtfAPfHwgtRJaTnZszRZmQ0caUcMcDv7EHhu1rf4U,1054
37
+ arbi/resources/api/conversation/conversation.py,sha256=UthtT2G__nRW8HzFDsAj4o9rOCK0Wts4hElK3xjN-UM,22210
38
+ arbi/resources/api/conversation/user.py,sha256=dsv4ZABRyOk7HjSS118U_5SpBA3YRw9PDh8UvJKE3dk,10280
39
+ arbi/resources/api/document/__init__.py,sha256=3O8YXgjavyK-5v5Gyf9lFsnvOxKXcQUHfQ_i-c7KhSY,1080
40
+ arbi/resources/api/document/annotation.py,sha256=hwPHox6KxvcQQd5985GKToccX7KuglCDBO6ezQ8bOtw,15172
41
+ arbi/resources/api/document/document.py,sha256=bHEWEKp8a6CsGAYZMEr3JpyvRCBqe56sSJP11tXKpsY,34409
42
+ arbi/resources/api/user/__init__.py,sha256=hmOPYjiZ4KjFv2MNjhz26s2BMBzvXGiXOGdwhTaG5BI,1002
43
+ arbi/resources/api/user/settings.py,sha256=Yd0riIuLqYbklMUUBc4B3684OKuNpoA-xFMFqqrxo30,10154
44
+ arbi/resources/api/user/user.py,sha256=RySlF5E1Ogq0Ki-SpImLUBTr2NVM_NTvOsScGSPEYfc,19830
45
+ arbi/types/__init__.py,sha256=zOxql2OO_R5LGwkFLawHC6O_f57kidrnO9hwxyuquzE,341
46
+ arbi/types/chunk.py,sha256=J6LQxWxLDW9feXQZOiYNNSBKgwkzhXgf74DS_noHFLs,254
47
+ arbi/types/chunk_metadata.py,sha256=GHcVONko0WWfDAa6rvLHldxgxL2IWmI6NqKwXAJLgYQ,545
48
+ arbi/types/chunk_metadata_param.py,sha256=UwGaK35hTMRR-YKPivEpQtUorIAqu-I7did2HnOV4aE,629
49
+ arbi/types/chunk_param.py,sha256=YI77ArEd8KXaDXspgezw1h36xQhoCnb4iwX6Hws3nzU,368
50
+ arbi/types/api/__init__.py,sha256=y_sMJHBPnkAB-6cpuahVXf7iY6jG9YKzNxOwkML0uJM,6607
51
+ arbi/types/api/assistant_query_params.py,sha256=f9cgpwRTDv95zvwSgCzQCEvbcT3mZY1BrP_8wIMOAtk,1383
52
+ arbi/types/api/assistant_retrieve_params.py,sha256=2HLkEYE7ojtlS5NkqOFZ8o7gvEdBabsZZdkrJNSmMRo,1389
53
+ arbi/types/api/chunker_config_param.py,sha256=hdYyEXCdR_g6DB_c0EuoH_73MocVOVaqwaV2Z5D_hCs,237
54
+ arbi/types/api/config_create_params.py,sha256=UU4Q5C_lu9lmOUS2lKMhCweTXtCIwuIWbQxF4Wgi5QE,1789
55
+ arbi/types/api/config_create_response.py,sha256=BnoDpvdgYv0l3OQFCw2kz61pnXMsqkd8Lru57RF7jAM,301
56
+ arbi/types/api/config_delete_response.py,sha256=DSBLJ9NT42K3icy_XFSyM1bfiSSvo6NPi6DN5drK2IQ,259
57
+ arbi/types/api/config_get_versions_response.py,sha256=9zPsTDowITXN_zjK1dzCnUQK8otPKBmaZMtdZLcLLwU,384
58
+ arbi/types/api/config_retrieve_response.py,sha256=JTB-CE9ZHbZdAt6k1C_nUdjPmaMcHTdQJokPu9LSQVM,1704
59
+ arbi/types/api/conversation_delete_message_response.py,sha256=4te9sHh4cWMdUUR_79_LnwoV1tFOzg2TR50fw6ALgfY,285
60
+ arbi/types/api/conversation_delete_response.py,sha256=9qOWK2udruW1Emzp_0o_iSbPVhTi9qI3TNyvv8Mo9TA,271
61
+ arbi/types/api/conversation_retrieve_threads_response.py,sha256=KTr98DgU6n8Xs8w0cNm5SzQvmWlTaqmFpbpu7Qs1uTc,2202
62
+ arbi/types/api/conversation_share_response.py,sha256=wm3-w5puCTF3nKV2Xbt0RYXwPWW9oHWnR2OPTdpGp44,269
63
+ arbi/types/api/conversation_update_title_params.py,sha256=G2o6v4B8iQn41YtZTZ0rKIRevStNED4JWwM7lN1BbIc,357
64
+ arbi/types/api/conversation_update_title_response.py,sha256=GHtttE9kyIjYhSa8D5bMLvfhvsjRvy4FEVPikG3x04Q,297
65
+ arbi/types/api/doc_response.py,sha256=PMfZnlNipsGv_rgwDCIKAnw-n4ByYUSp-evLbRjCDxU,884
66
+ arbi/types/api/document_date_extractor_llm_config.py,sha256=YrQ9QbMYuruL7AEICgHDxpDmWxiSAccj6-DPDEKRZgA,1079
67
+ arbi/types/api/document_date_extractor_llm_config_param.py,sha256=vPPRKQVW8hoH-UGCVjZDHpwYChxD9CekGAdlN99fXbs,1023
68
+ arbi/types/api/document_delete_response.py,sha256=G-xYnoYPqiy82dlueVoTVobcX7qu0Z5OnHRftvXtYsM,263
69
+ arbi/types/api/document_get_parsed_response.py,sha256=Ug91THKXOkvxZdiwKAmQEBSaaY4zfKX2kDqZa5jli-w,588
70
+ arbi/types/api/document_get_tags_response.py,sha256=HK-2gtqB7_SIQDJeYNTPSYesPbMyQScI0mOLVk3oEbI,304
71
+ arbi/types/api/document_update_params.py,sha256=yXwKGkvHHS7xd6Yii58gnZOXVgguZBqZHmqvexlnqus,495
72
+ arbi/types/api/document_update_response.py,sha256=32tVCwearilpe3k230PqUITphqURuaXfWIL935mlE1E,418
73
+ arbi/types/api/document_upload_params.py,sha256=YCMujKFFHAZkYRyTlEkOC0KHVVHGlbU3ucZzl6LZ9qs,608
74
+ arbi/types/api/document_view_params.py,sha256=GogDVeskOJg2fiqnYUvnx3zaghVdaOKzgHrVcCCE5gU,341
75
+ arbi/types/api/embedder_config.py,sha256=6ajJCaNgfV7C4SJc3OlCr2bbhiNUq9xhWuZkzGDNLhQ,559
76
+ arbi/types/api/embedder_config_param.py,sha256=S-2Kc7EdBiHp6-ezAoWSPxoh31ftEulJV368HqT2u0k,547
77
+ arbi/types/api/health_check_app_response.py,sha256=Fw-VFR7fTk-Ds_jTFLT7dhW0Q-FvfcUjdUTnI7JdFa0,217
78
+ arbi/types/api/health_check_models_response.py,sha256=tMKh7I40pCkteDLR1TLMiutYEgCFQdEsc1l3nMS95DY,389
79
+ arbi/types/api/health_check_services_response.py,sha256=pxn38TYSIT14FcIf0qG-Bsxj9p9tPMf6sJ5HoOM32TM,477
80
+ arbi/types/api/health_get_models_response.py,sha256=GpHTGHIz8ddUDkDwAYk-nMJ633q943BWhf5wzekRHls,403
81
+ arbi/types/api/model_citation_config.py,sha256=am2bXs6i2EpCq05nT_zTrljig40Ln3kQxbilZJXpZDg,899
82
+ arbi/types/api/model_citation_config_param.py,sha256=5lOXLYvG991xXsX9fDAKguURcikWkE9rj4DGfmjRU2g,898
83
+ arbi/types/api/parser_config_param.py,sha256=lFJO9CO8m3e8YFltmHLrMKhC83FFwCJWjsua5l3Jjic,235
84
+ arbi/types/api/query_llm_config.py,sha256=TRVk7r2KxbpTXZNWf4zMkZOJVDJuNkTxdw9JhnD1IvY,1088
85
+ arbi/types/api/query_llm_config_param.py,sha256=No62efnYikObr6Mjo0knnPuWoGrCQ4iwI9AZDdUjDo0,1032
86
+ arbi/types/api/reranker_config.py,sha256=PJkomlrt6wYihqWcj7_oLgbdFY0ArFcRpU6m71XoD3M,718
87
+ arbi/types/api/reranker_config_param.py,sha256=eMFvnO972sio_O_gVFlmRhdmQWUWBbhpIkkhO3uVpaw,695
88
+ arbi/types/api/retriever_config.py,sha256=YHOLfj-uWQkHFwrfeClsPqwU40tTNXiWc_3U19yNKH4,920
89
+ arbi/types/api/retriever_config_param.py,sha256=0qBZZmA5phOZK0nDT6Ubv4t29mHzRDaMgsV7c7vUaTQ,919
90
+ arbi/types/api/sso_invite_params.py,sha256=2QVplrsXUZo7PTcsBaRarQI3ORM2PabsOAL4t1kVmEs,278
91
+ arbi/types/api/sso_invite_response.py,sha256=BK7ZdSoLHYMi1TiamLJWooI8WiDgi4cHk3avi4JjuAk,229
92
+ arbi/types/api/sso_login_params.py,sha256=8Q5-DU31_ppOQdkHdfq_PRO5c2C1gnx0HaBTy9vSXNg,359
93
+ arbi/types/api/sso_login_response.py,sha256=h9nObM2u4uEO3zIhPq87H4Kcy9D_Ir1Xft8-uxvBrbw,292
94
+ arbi/types/api/sso_rotate_passcode_response.py,sha256=OU5O6MeSe1mEunnTI0-J0ZdkqAkYCR2fMNC_ppTVBZs,246
95
+ arbi/types/api/tag_apply_to_docs_params.py,sha256=uELJHQ4oTyTRHwWe71X0XFfyNYBMNeFZgi2QyB9qcAU,320
96
+ arbi/types/api/tag_apply_to_docs_response.py,sha256=TsxwW3pDclPASWe_k1Hze2r2q3Iem8gs_6-LT_UYE98,270
97
+ arbi/types/api/tag_create_params.py,sha256=0qK1udaTYjI9LunJmMjINvt_iS0EFGbQypvIiM5XTpI,404
98
+ arbi/types/api/tag_create_response.py,sha256=WXsPBZc74s8qsvKMMOLjSD-YRCxwbHIWWv3nDKLl-eQ,224
99
+ arbi/types/api/tag_delete_response.py,sha256=uRvx0SqOe0ZGQwl8oRAZGe7zyWk6SqNL77ksAfIs7M8,207
100
+ arbi/types/api/tag_get_docs_response.py,sha256=jHs4iruSi_qTUpCKA7xmbbqU-Lo7FfSWqA8sC_vXBk0,294
101
+ arbi/types/api/tag_remove_from_docs_params.py,sha256=Iivm1rM_1YbZkpXlSLa0PJkncA4F8zSABbzIGH5gyr0,326
102
+ arbi/types/api/tag_remove_from_docs_response.py,sha256=Mx1c34ChFjHK2fBzDkQeSjKm1C0y7qqfhiqPGq5wbwQ,284
103
+ arbi/types/api/tag_update_params.py,sha256=z1ZtNJlNRgJAgLL9og-GjKyFekEBkM4QK6PKYbF9pnE,323
104
+ arbi/types/api/tag_update_response.py,sha256=JrAwUO5Gxq8OmiYruEnCIlXVb4gZmmMX0iSRANn4d4Q,320
105
+ arbi/types/api/title_llm_config.py,sha256=jEeS7AIo-_kg2IbWs2bnG4OWvatzI3KNDnVkwuCuuQE,1047
106
+ arbi/types/api/title_llm_config_param.py,sha256=ol0he5y4X0s7Mu_kNy8qtvWGa8EfY8kfT3zGZ3cp8e4,991
107
+ arbi/types/api/token.py,sha256=e1QsctdKEqdwxs-boLYUsFVZyj1oCeNSe9PhzKFqXI8,232
108
+ arbi/types/api/user_list_workspaces_response.py,sha256=X0oscmn3j575hI61D9rRytgNWvdw066jkSrhNohP2iw,309
109
+ arbi/types/api/user_login_params.py,sha256=nFXWVqG5Rm16HGkTY5DZ5xQYCdyZUrfJiL4hZkFkEKw,307
110
+ arbi/types/api/user_logout_response.py,sha256=osQbYps3A6UNKeIrbPRZcC9z1zgFv-wpVRicvAXbEGA,209
111
+ arbi/types/api/user_register_params.py,sha256=5VbxF0Tu9Ep3CA86lAZM4FRsksg7ErxvNa8Vq_KTAzo,368
112
+ arbi/types/api/user_response.py,sha256=QqeAfX3YBxj72gWYoyW7bPBQ8fbeaUu_WJOqtdQ1Ub0,388
113
+ arbi/types/api/workspace_create_protected_params.py,sha256=uATBBX3CCX6Q8Wo8M178F9Lmj1NNLR945VbJ2Zl8PU0,367
114
+ arbi/types/api/workspace_delete_response.py,sha256=9a8IW_EpP-YkirjDnXomQBe-JkgBv6FfH-x_R1WYKhI,219
115
+ arbi/types/api/workspace_get_conversations_response.py,sha256=-zANZeLpmieOeaj29PoogwDagM0O74KOdRcAbZAjzvU,656
116
+ arbi/types/api/workspace_get_doctags_response.py,sha256=A1iXtPTjnhlo7WOadfDF6Fct6fmebztgQwKYhKiBHak,312
117
+ arbi/types/api/workspace_get_documents_response.py,sha256=Jugc3x-GMaBiP0xBev78uQXlXGLjgRI2y-XerSpBsT0,297
118
+ arbi/types/api/workspace_get_stats_response.py,sha256=OcRn-x_TiQ1zT9i2ePOgsha8e3FIvl7T9Gjh7c1Ho6s,323
119
+ arbi/types/api/workspace_get_tags_response.py,sha256=cGX-wVpeZPrcJ05DmQOMjqOSU5vDEzmWWKRfyTvgz08,513
120
+ arbi/types/api/workspace_get_users_response.py,sha256=-An5rEppqZnDgdRhAsODQBTDC0lWfWLPE0DJ7jDbmnU,428
121
+ arbi/types/api/workspace_remove_user_params.py,sha256=w5hOk29XiNAtgfe5wxdi9mfLWnwqpZg8FPTGhvIe0k8,304
122
+ arbi/types/api/workspace_remove_user_response.py,sha256=R6V0FWSqpL4OoZ4YbEQcohXU51Az4wQSDFYol3AfGCI,273
123
+ arbi/types/api/workspace_response.py,sha256=NTh_uIZGPbvaocQh0GILClmbrzqD9rflCt-P7g2QPSM,450
124
+ arbi/types/api/workspace_share_params.py,sha256=m-RZd0vFlAAwkwNrghYeYqPcl2wQZRII85qfqzImPQI,298
125
+ arbi/types/api/workspace_share_response.py,sha256=vO-CI3_ZQ75SqcnL80WDy9sHXogIKtS9HcxGHLDkvkY,387
126
+ arbi/types/api/workspace_update_params.py,sha256=YHW-m8nESEKFcWh5acRDcncHIuS_SFbwqjq3IJz2RCQ,339
127
+ arbi/types/api/conversation/__init__.py,sha256=jzfeVJd78d972p4eSzTZNWXY7EXR50kJ3e6pzDcG8d8,393
128
+ arbi/types/api/conversation/user_add_params.py,sha256=bzAIbyla6URUE6xkArzggJnv1sDFxCG1AzYiMKMlQ74,280
129
+ arbi/types/api/conversation/user_add_response.py,sha256=85ahGr81kC7sqLn0T1r-AYxgvER4gFki6YdhxTJ1pf0,250
130
+ arbi/types/api/conversation/user_remove_params.py,sha256=97uPdwbgNpPhij4ZdOxYM5pvayf9gbNAQiFK8v81wbw,286
131
+ arbi/types/api/conversation/user_remove_response.py,sha256=fWNQvo7H5ZrtYW_PObSaQEhHbojHrazeoLRgCpWdYbI,256
132
+ arbi/types/api/document/__init__.py,sha256=yxwyY0oCmARRhWdtIveKTkHCBdM3JOR0j2v4Rmw8pXw,453
133
+ arbi/types/api/document/annotation_create_params.py,sha256=OTFcprYmIvzXDsQA0WLkx68026HjWm9zkh_RBxLt5B4,367
134
+ arbi/types/api/document/annotation_delete_response.py,sha256=Wnu_PpHc_rKwpJEGVoCQMXXFUIDcZV6wsXmOZY8Xezk,269
135
+ arbi/types/api/document/annotation_update_params.py,sha256=jXOIdvuCU8HnxKV19U6BDAnPtI4Tu0QydHq3d6lgJ1c,379
136
+ arbi/types/api/document/doc_tag_response.py,sha256=3gL_vh9MacHcL6n7XyTpWiuCcK1jC2JKug-c15eEZNU,458
137
+ arbi/types/api/user/__init__.py,sha256=b9vEjTKAmJh0n8S3HhlpX4qxnKy5XCv-YuiX84mZJOY,291
138
+ arbi/types/api/user/setting_retrieve_response.py,sha256=hI3gEKlDkkU1jkN51hy_Z86U2MG16X-3AvbnOKj0UUc,1112
139
+ arbi/types/api/user/setting_update_params.py,sha256=uOkYK4faRzym_P_I_YOmRnevDlD9l9xgQFFQi47I854,576
140
+ arbi-0.1.0.dist-info/METADATA,sha256=W6UQXPkNTCCrqzCdoN0F38Ox6nmIdLk2V6IkjTQT34Q,13288
141
+ arbi-0.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
142
+ arbi-0.1.0.dist-info/licenses/LICENSE,sha256=NdV0oP8MV-RCBufnchF66WBpOGG_tJCxGnK1wt1OkrQ,11334
143
+ arbi-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.26.3
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any