arbi 0.1.0__py3-none-any.whl → 0.2.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.
- arbi/__init__.py +3 -1
- arbi/_base_client.py +12 -12
- arbi/_client.py +8 -8
- arbi/_compat.py +48 -48
- arbi/_models.py +51 -45
- arbi/_qs.py +7 -7
- arbi/_types.py +53 -12
- arbi/_utils/__init__.py +9 -2
- arbi/_utils/_compat.py +45 -0
- arbi/_utils/_datetime_parse.py +136 -0
- arbi/_utils/_transform.py +13 -3
- arbi/_utils/_typing.py +6 -1
- arbi/_utils/_utils.py +4 -5
- arbi/_version.py +1 -1
- arbi/resources/api/api.py +3 -3
- arbi/resources/api/assistant.py +17 -17
- arbi/resources/api/configs.py +41 -33
- arbi/resources/api/conversation/conversation.py +11 -11
- arbi/resources/api/conversation/user.py +5 -5
- arbi/resources/api/document/annotation.py +17 -17
- arbi/resources/api/document/document.py +166 -33
- arbi/resources/api/health.py +129 -11
- arbi/resources/api/sso.py +9 -9
- arbi/resources/api/tag.py +26 -26
- arbi/resources/api/user/settings.py +28 -20
- arbi/resources/api/user/user.py +107 -16
- arbi/resources/api/workspace.py +69 -39
- arbi/types/api/__init__.py +5 -0
- arbi/types/api/assistant_query_params.py +16 -4
- arbi/types/api/assistant_retrieve_params.py +16 -4
- arbi/types/api/config_create_params.py +67 -2
- arbi/types/api/config_retrieve_response.py +98 -2
- arbi/types/api/conversation_retrieve_threads_response.py +13 -2
- arbi/types/api/document_date_extractor_llm_config.py +3 -3
- arbi/types/api/document_date_extractor_llm_config_param.py +3 -3
- arbi/types/api/document_upload_from_url_params.py +23 -0
- arbi/types/api/document_upload_params.py +3 -3
- arbi/types/api/embedder_config.py +12 -0
- arbi/types/api/embedder_config_param.py +12 -0
- arbi/types/api/health_check_app_response.py +6 -0
- arbi/types/api/health_retrieve_status_response.py +45 -0
- arbi/types/api/health_retrieve_version_response.py +8 -0
- arbi/types/api/query_llm_config.py +1 -1
- arbi/types/api/query_llm_config_param.py +1 -1
- arbi/types/api/tag_apply_to_docs_params.py +3 -2
- arbi/types/api/tag_remove_from_docs_params.py +3 -2
- arbi/types/api/title_llm_config.py +1 -1
- arbi/types/api/title_llm_config_param.py +1 -1
- arbi/types/api/user/setting_retrieve_response.py +10 -1
- arbi/types/api/user/setting_update_params.py +8 -2
- arbi/types/api/user_register_params.py +2 -0
- arbi/types/api/user_verify_email_params.py +11 -0
- arbi/types/api/user_verify_email_response.py +9 -0
- arbi/types/api/workspace_create_protected_params.py +2 -0
- arbi/types/api/workspace_response.py +2 -0
- arbi/types/api/workspace_update_params.py +2 -0
- {arbi-0.1.0.dist-info → arbi-0.2.0.dist-info}/METADATA +3 -3
- {arbi-0.1.0.dist-info → arbi-0.2.0.dist-info}/RECORD +60 -53
- {arbi-0.1.0.dist-info → arbi-0.2.0.dist-info}/WHEEL +0 -0
- {arbi-0.1.0.dist-info → arbi-0.2.0.dist-info}/licenses/LICENSE +0 -0
arbi/resources/api/configs.py
CHANGED
|
@@ -6,7 +6,7 @@ from typing import Any, Optional, cast
|
|
|
6
6
|
|
|
7
7
|
import httpx
|
|
8
8
|
|
|
9
|
-
from ..._types import
|
|
9
|
+
from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
|
|
10
10
|
from ..._utils import maybe_transform, async_maybe_transform
|
|
11
11
|
from ..._compat import cached_property
|
|
12
12
|
from ..._resource import SyncAPIResource, AsyncAPIResource
|
|
@@ -60,23 +60,25 @@ class ConfigsResource(SyncAPIResource):
|
|
|
60
60
|
def create(
|
|
61
61
|
self,
|
|
62
62
|
*,
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
63
|
+
agent_llm: Optional[config_create_params.AgentLlm] | Omit = omit,
|
|
64
|
+
agents: Optional[config_create_params.Agents] | Omit = omit,
|
|
65
|
+
chunker: Optional[ChunkerConfigParam] | Omit = omit,
|
|
66
|
+
document_date_extractor_llm: Optional[DocumentDateExtractorLlmConfigParam] | Omit = omit,
|
|
67
|
+
embedder: Optional[EmbedderConfigParam] | Omit = omit,
|
|
68
|
+
model_citation: Optional[ModelCitationConfigParam] | Omit = omit,
|
|
69
|
+
parent_message_ext_id: Optional[str] | Omit = omit,
|
|
70
|
+
parser: Optional[ParserConfigParam] | Omit = omit,
|
|
71
|
+
query_llm: Optional[QueryLlmConfigParam] | Omit = omit,
|
|
72
|
+
reranker: Optional[RerankerConfigParam] | Omit = omit,
|
|
73
|
+
retriever: Optional[RetrieverConfigParam] | Omit = omit,
|
|
74
|
+
title: str | Omit = omit,
|
|
75
|
+
title_llm: Optional[TitleLlmConfigParam] | Omit = omit,
|
|
74
76
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
75
77
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
76
78
|
extra_headers: Headers | None = None,
|
|
77
79
|
extra_query: Query | None = None,
|
|
78
80
|
extra_body: Body | None = None,
|
|
79
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
81
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
80
82
|
) -> ConfigCreateResponse:
|
|
81
83
|
"""
|
|
82
84
|
Save a new configuration.
|
|
@@ -94,6 +96,8 @@ class ConfigsResource(SyncAPIResource):
|
|
|
94
96
|
"/api/configs/",
|
|
95
97
|
body=maybe_transform(
|
|
96
98
|
{
|
|
99
|
+
"agent_llm": agent_llm,
|
|
100
|
+
"agents": agents,
|
|
97
101
|
"chunker": chunker,
|
|
98
102
|
"document_date_extractor_llm": document_date_extractor_llm,
|
|
99
103
|
"embedder": embedder,
|
|
@@ -123,7 +127,7 @@ class ConfigsResource(SyncAPIResource):
|
|
|
123
127
|
extra_headers: Headers | None = None,
|
|
124
128
|
extra_query: Query | None = None,
|
|
125
129
|
extra_body: Body | None = None,
|
|
126
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
130
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
127
131
|
) -> ConfigRetrieveResponse:
|
|
128
132
|
"""
|
|
129
133
|
Read configurations from database to be displayed in the UI
|
|
@@ -163,7 +167,7 @@ class ConfigsResource(SyncAPIResource):
|
|
|
163
167
|
extra_headers: Headers | None = None,
|
|
164
168
|
extra_query: Query | None = None,
|
|
165
169
|
extra_body: Body | None = None,
|
|
166
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
170
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
167
171
|
) -> ConfigDeleteResponse:
|
|
168
172
|
"""
|
|
169
173
|
Delete a specific configuration from database
|
|
@@ -195,7 +199,7 @@ class ConfigsResource(SyncAPIResource):
|
|
|
195
199
|
extra_headers: Headers | None = None,
|
|
196
200
|
extra_query: Query | None = None,
|
|
197
201
|
extra_body: Body | None = None,
|
|
198
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
202
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
199
203
|
) -> object:
|
|
200
204
|
"""Return the JSON schema for all config models"""
|
|
201
205
|
return self._get(
|
|
@@ -214,7 +218,7 @@ class ConfigsResource(SyncAPIResource):
|
|
|
214
218
|
extra_headers: Headers | None = None,
|
|
215
219
|
extra_query: Query | None = None,
|
|
216
220
|
extra_body: Body | None = None,
|
|
217
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
221
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
218
222
|
) -> ConfigGetVersionsResponse:
|
|
219
223
|
"""Returns a list of available configuration versions for the current user"""
|
|
220
224
|
return self._get(
|
|
@@ -249,23 +253,25 @@ class AsyncConfigsResource(AsyncAPIResource):
|
|
|
249
253
|
async def create(
|
|
250
254
|
self,
|
|
251
255
|
*,
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
256
|
+
agent_llm: Optional[config_create_params.AgentLlm] | Omit = omit,
|
|
257
|
+
agents: Optional[config_create_params.Agents] | Omit = omit,
|
|
258
|
+
chunker: Optional[ChunkerConfigParam] | Omit = omit,
|
|
259
|
+
document_date_extractor_llm: Optional[DocumentDateExtractorLlmConfigParam] | Omit = omit,
|
|
260
|
+
embedder: Optional[EmbedderConfigParam] | Omit = omit,
|
|
261
|
+
model_citation: Optional[ModelCitationConfigParam] | Omit = omit,
|
|
262
|
+
parent_message_ext_id: Optional[str] | Omit = omit,
|
|
263
|
+
parser: Optional[ParserConfigParam] | Omit = omit,
|
|
264
|
+
query_llm: Optional[QueryLlmConfigParam] | Omit = omit,
|
|
265
|
+
reranker: Optional[RerankerConfigParam] | Omit = omit,
|
|
266
|
+
retriever: Optional[RetrieverConfigParam] | Omit = omit,
|
|
267
|
+
title: str | Omit = omit,
|
|
268
|
+
title_llm: Optional[TitleLlmConfigParam] | Omit = omit,
|
|
263
269
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
264
270
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
265
271
|
extra_headers: Headers | None = None,
|
|
266
272
|
extra_query: Query | None = None,
|
|
267
273
|
extra_body: Body | None = None,
|
|
268
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
274
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
269
275
|
) -> ConfigCreateResponse:
|
|
270
276
|
"""
|
|
271
277
|
Save a new configuration.
|
|
@@ -283,6 +289,8 @@ class AsyncConfigsResource(AsyncAPIResource):
|
|
|
283
289
|
"/api/configs/",
|
|
284
290
|
body=await async_maybe_transform(
|
|
285
291
|
{
|
|
292
|
+
"agent_llm": agent_llm,
|
|
293
|
+
"agents": agents,
|
|
286
294
|
"chunker": chunker,
|
|
287
295
|
"document_date_extractor_llm": document_date_extractor_llm,
|
|
288
296
|
"embedder": embedder,
|
|
@@ -312,7 +320,7 @@ class AsyncConfigsResource(AsyncAPIResource):
|
|
|
312
320
|
extra_headers: Headers | None = None,
|
|
313
321
|
extra_query: Query | None = None,
|
|
314
322
|
extra_body: Body | None = None,
|
|
315
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
323
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
316
324
|
) -> ConfigRetrieveResponse:
|
|
317
325
|
"""
|
|
318
326
|
Read configurations from database to be displayed in the UI
|
|
@@ -352,7 +360,7 @@ class AsyncConfigsResource(AsyncAPIResource):
|
|
|
352
360
|
extra_headers: Headers | None = None,
|
|
353
361
|
extra_query: Query | None = None,
|
|
354
362
|
extra_body: Body | None = None,
|
|
355
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
363
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
356
364
|
) -> ConfigDeleteResponse:
|
|
357
365
|
"""
|
|
358
366
|
Delete a specific configuration from database
|
|
@@ -384,7 +392,7 @@ class AsyncConfigsResource(AsyncAPIResource):
|
|
|
384
392
|
extra_headers: Headers | None = None,
|
|
385
393
|
extra_query: Query | None = None,
|
|
386
394
|
extra_body: Body | None = None,
|
|
387
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
395
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
388
396
|
) -> object:
|
|
389
397
|
"""Return the JSON schema for all config models"""
|
|
390
398
|
return await self._get(
|
|
@@ -403,7 +411,7 @@ class AsyncConfigsResource(AsyncAPIResource):
|
|
|
403
411
|
extra_headers: Headers | None = None,
|
|
404
412
|
extra_query: Query | None = None,
|
|
405
413
|
extra_body: Body | None = None,
|
|
406
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
414
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
407
415
|
) -> ConfigGetVersionsResponse:
|
|
408
416
|
"""Returns a list of available configuration versions for the current user"""
|
|
409
417
|
return await self._get(
|
|
@@ -12,7 +12,7 @@ from .user import (
|
|
|
12
12
|
UserResourceWithStreamingResponse,
|
|
13
13
|
AsyncUserResourceWithStreamingResponse,
|
|
14
14
|
)
|
|
15
|
-
from ...._types import
|
|
15
|
+
from ...._types import Body, Query, Headers, NotGiven, not_given
|
|
16
16
|
from ...._utils import maybe_transform, async_maybe_transform
|
|
17
17
|
from ...._compat import cached_property
|
|
18
18
|
from ...._resource import SyncAPIResource, AsyncAPIResource
|
|
@@ -66,7 +66,7 @@ class ConversationResource(SyncAPIResource):
|
|
|
66
66
|
extra_headers: Headers | None = None,
|
|
67
67
|
extra_query: Query | None = None,
|
|
68
68
|
extra_body: Body | None = None,
|
|
69
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
69
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
70
70
|
) -> ConversationDeleteResponse:
|
|
71
71
|
"""Delete a conversation.
|
|
72
72
|
|
|
@@ -104,7 +104,7 @@ class ConversationResource(SyncAPIResource):
|
|
|
104
104
|
extra_headers: Headers | None = None,
|
|
105
105
|
extra_query: Query | None = None,
|
|
106
106
|
extra_body: Body | None = None,
|
|
107
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
107
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
108
108
|
) -> ConversationDeleteMessageResponse:
|
|
109
109
|
"""
|
|
110
110
|
Delete a message along with all descendants.
|
|
@@ -137,7 +137,7 @@ class ConversationResource(SyncAPIResource):
|
|
|
137
137
|
extra_headers: Headers | None = None,
|
|
138
138
|
extra_query: Query | None = None,
|
|
139
139
|
extra_body: Body | None = None,
|
|
140
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
140
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
141
141
|
) -> ConversationRetrieveThreadsResponse:
|
|
142
142
|
"""
|
|
143
143
|
Retrieve all conversation threads (leaf messages and their histories) for a
|
|
@@ -173,7 +173,7 @@ class ConversationResource(SyncAPIResource):
|
|
|
173
173
|
extra_headers: Headers | None = None,
|
|
174
174
|
extra_query: Query | None = None,
|
|
175
175
|
extra_body: Body | None = None,
|
|
176
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
176
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
177
177
|
) -> ConversationShareResponse:
|
|
178
178
|
"""
|
|
179
179
|
Share all messages in a conversation by setting their shared flag to true.
|
|
@@ -211,7 +211,7 @@ class ConversationResource(SyncAPIResource):
|
|
|
211
211
|
extra_headers: Headers | None = None,
|
|
212
212
|
extra_query: Query | None = None,
|
|
213
213
|
extra_body: Body | None = None,
|
|
214
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
214
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
215
215
|
) -> ConversationUpdateTitleResponse:
|
|
216
216
|
"""Update a conversation title.
|
|
217
217
|
|
|
@@ -276,7 +276,7 @@ class AsyncConversationResource(AsyncAPIResource):
|
|
|
276
276
|
extra_headers: Headers | None = None,
|
|
277
277
|
extra_query: Query | None = None,
|
|
278
278
|
extra_body: Body | None = None,
|
|
279
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
279
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
280
280
|
) -> ConversationDeleteResponse:
|
|
281
281
|
"""Delete a conversation.
|
|
282
282
|
|
|
@@ -314,7 +314,7 @@ class AsyncConversationResource(AsyncAPIResource):
|
|
|
314
314
|
extra_headers: Headers | None = None,
|
|
315
315
|
extra_query: Query | None = None,
|
|
316
316
|
extra_body: Body | None = None,
|
|
317
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
317
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
318
318
|
) -> ConversationDeleteMessageResponse:
|
|
319
319
|
"""
|
|
320
320
|
Delete a message along with all descendants.
|
|
@@ -347,7 +347,7 @@ class AsyncConversationResource(AsyncAPIResource):
|
|
|
347
347
|
extra_headers: Headers | None = None,
|
|
348
348
|
extra_query: Query | None = None,
|
|
349
349
|
extra_body: Body | None = None,
|
|
350
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
350
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
351
351
|
) -> ConversationRetrieveThreadsResponse:
|
|
352
352
|
"""
|
|
353
353
|
Retrieve all conversation threads (leaf messages and their histories) for a
|
|
@@ -383,7 +383,7 @@ class AsyncConversationResource(AsyncAPIResource):
|
|
|
383
383
|
extra_headers: Headers | None = None,
|
|
384
384
|
extra_query: Query | None = None,
|
|
385
385
|
extra_body: Body | None = None,
|
|
386
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
386
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
387
387
|
) -> ConversationShareResponse:
|
|
388
388
|
"""
|
|
389
389
|
Share all messages in a conversation by setting their shared flag to true.
|
|
@@ -421,7 +421,7 @@ class AsyncConversationResource(AsyncAPIResource):
|
|
|
421
421
|
extra_headers: Headers | None = None,
|
|
422
422
|
extra_query: Query | None = None,
|
|
423
423
|
extra_body: Body | None = None,
|
|
424
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
424
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
425
425
|
) -> ConversationUpdateTitleResponse:
|
|
426
426
|
"""Update a conversation title.
|
|
427
427
|
|
|
@@ -4,7 +4,7 @@ from __future__ import annotations
|
|
|
4
4
|
|
|
5
5
|
import httpx
|
|
6
6
|
|
|
7
|
-
from ...._types import
|
|
7
|
+
from ...._types import Body, Query, Headers, NotGiven, not_given
|
|
8
8
|
from ...._utils import maybe_transform, async_maybe_transform
|
|
9
9
|
from ...._compat import cached_property
|
|
10
10
|
from ...._resource import SyncAPIResource, AsyncAPIResource
|
|
@@ -52,7 +52,7 @@ class UserResource(SyncAPIResource):
|
|
|
52
52
|
extra_headers: Headers | None = None,
|
|
53
53
|
extra_query: Query | None = None,
|
|
54
54
|
extra_body: Body | None = None,
|
|
55
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
55
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
56
56
|
) -> UserAddResponse:
|
|
57
57
|
"""
|
|
58
58
|
Add a user to a conversation.
|
|
@@ -92,7 +92,7 @@ class UserResource(SyncAPIResource):
|
|
|
92
92
|
extra_headers: Headers | None = None,
|
|
93
93
|
extra_query: Query | None = None,
|
|
94
94
|
extra_body: Body | None = None,
|
|
95
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
95
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
96
96
|
) -> UserRemoveResponse:
|
|
97
97
|
"""
|
|
98
98
|
Remove a user from a conversation.
|
|
@@ -152,7 +152,7 @@ class AsyncUserResource(AsyncAPIResource):
|
|
|
152
152
|
extra_headers: Headers | None = None,
|
|
153
153
|
extra_query: Query | None = None,
|
|
154
154
|
extra_body: Body | None = None,
|
|
155
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
155
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
156
156
|
) -> UserAddResponse:
|
|
157
157
|
"""
|
|
158
158
|
Add a user to a conversation.
|
|
@@ -192,7 +192,7 @@ class AsyncUserResource(AsyncAPIResource):
|
|
|
192
192
|
extra_headers: Headers | None = None,
|
|
193
193
|
extra_query: Query | None = None,
|
|
194
194
|
extra_body: Body | None = None,
|
|
195
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
195
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
196
196
|
) -> UserRemoveResponse:
|
|
197
197
|
"""
|
|
198
198
|
Remove a user from a conversation.
|
|
@@ -6,7 +6,7 @@ from typing import Optional
|
|
|
6
6
|
|
|
7
7
|
import httpx
|
|
8
8
|
|
|
9
|
-
from ...._types import
|
|
9
|
+
from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
|
|
10
10
|
from ...._utils import maybe_transform, async_maybe_transform
|
|
11
11
|
from ...._compat import cached_property
|
|
12
12
|
from ...._resource import SyncAPIResource, AsyncAPIResource
|
|
@@ -48,15 +48,15 @@ class AnnotationResource(SyncAPIResource):
|
|
|
48
48
|
self,
|
|
49
49
|
doc_ext_id: str,
|
|
50
50
|
*,
|
|
51
|
-
note: Optional[str] |
|
|
52
|
-
page_ref: Optional[int] |
|
|
53
|
-
tag_name: Optional[str] |
|
|
51
|
+
note: Optional[str] | Omit = omit,
|
|
52
|
+
page_ref: Optional[int] | Omit = omit,
|
|
53
|
+
tag_name: Optional[str] | Omit = omit,
|
|
54
54
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
55
55
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
56
56
|
extra_headers: Headers | None = None,
|
|
57
57
|
extra_query: Query | None = None,
|
|
58
58
|
extra_body: Body | None = None,
|
|
59
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
59
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
60
60
|
) -> DocTagResponse:
|
|
61
61
|
"""
|
|
62
62
|
Create an annotation for a document.
|
|
@@ -97,14 +97,14 @@ class AnnotationResource(SyncAPIResource):
|
|
|
97
97
|
doctag_ext_id: str,
|
|
98
98
|
*,
|
|
99
99
|
doc_ext_id: str,
|
|
100
|
-
note: Optional[str] |
|
|
101
|
-
page_ref: Optional[int] |
|
|
100
|
+
note: Optional[str] | Omit = omit,
|
|
101
|
+
page_ref: Optional[int] | Omit = omit,
|
|
102
102
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
103
103
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
104
104
|
extra_headers: Headers | None = None,
|
|
105
105
|
extra_query: Query | None = None,
|
|
106
106
|
extra_body: Body | None = None,
|
|
107
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
107
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
108
108
|
) -> DocTagResponse:
|
|
109
109
|
"""
|
|
110
110
|
Update an annotation (doctag) for a document.
|
|
@@ -147,7 +147,7 @@ class AnnotationResource(SyncAPIResource):
|
|
|
147
147
|
extra_headers: Headers | None = None,
|
|
148
148
|
extra_query: Query | None = None,
|
|
149
149
|
extra_body: Body | None = None,
|
|
150
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
150
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
151
151
|
) -> AnnotationDeleteResponse:
|
|
152
152
|
"""
|
|
153
153
|
Delete a specific annotation (doctag) for a document.
|
|
@@ -198,15 +198,15 @@ class AsyncAnnotationResource(AsyncAPIResource):
|
|
|
198
198
|
self,
|
|
199
199
|
doc_ext_id: str,
|
|
200
200
|
*,
|
|
201
|
-
note: Optional[str] |
|
|
202
|
-
page_ref: Optional[int] |
|
|
203
|
-
tag_name: Optional[str] |
|
|
201
|
+
note: Optional[str] | Omit = omit,
|
|
202
|
+
page_ref: Optional[int] | Omit = omit,
|
|
203
|
+
tag_name: Optional[str] | Omit = omit,
|
|
204
204
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
205
205
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
206
206
|
extra_headers: Headers | None = None,
|
|
207
207
|
extra_query: Query | None = None,
|
|
208
208
|
extra_body: Body | None = None,
|
|
209
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
209
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
210
210
|
) -> DocTagResponse:
|
|
211
211
|
"""
|
|
212
212
|
Create an annotation for a document.
|
|
@@ -247,14 +247,14 @@ class AsyncAnnotationResource(AsyncAPIResource):
|
|
|
247
247
|
doctag_ext_id: str,
|
|
248
248
|
*,
|
|
249
249
|
doc_ext_id: str,
|
|
250
|
-
note: Optional[str] |
|
|
251
|
-
page_ref: Optional[int] |
|
|
250
|
+
note: Optional[str] | Omit = omit,
|
|
251
|
+
page_ref: Optional[int] | Omit = omit,
|
|
252
252
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
253
253
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
254
254
|
extra_headers: Headers | None = None,
|
|
255
255
|
extra_query: Query | None = None,
|
|
256
256
|
extra_body: Body | None = None,
|
|
257
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
257
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
258
258
|
) -> DocTagResponse:
|
|
259
259
|
"""
|
|
260
260
|
Update an annotation (doctag) for a document.
|
|
@@ -297,7 +297,7 @@ class AsyncAnnotationResource(AsyncAPIResource):
|
|
|
297
297
|
extra_headers: Headers | None = None,
|
|
298
298
|
extra_query: Query | None = None,
|
|
299
299
|
extra_body: Body | None = None,
|
|
300
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
300
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
301
301
|
) -> AnnotationDeleteResponse:
|
|
302
302
|
"""
|
|
303
303
|
Delete a specific annotation (doctag) for a document.
|