relevan 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.
Files changed (140) hide show
  1. relevan/__init__.py +23 -0
  2. relevan/_auth.py +37 -0
  3. relevan/_beta.py +20 -0
  4. relevan/_errors.py +44 -0
  5. relevan/_generated/__init__.py +8 -0
  6. relevan/_generated/api/__init__.py +1 -0
  7. relevan/_generated/api/documents/__init__.py +1 -0
  8. relevan/_generated/api/documents/delete_v_1_org_id_indexes_index_name_documents_document_id.py +214 -0
  9. relevan/_generated/api/documents/get_v_1_org_id_indexes_index_name_documents.py +236 -0
  10. relevan/_generated/api/documents/get_v_1_org_id_indexes_index_name_documents_document_id.py +210 -0
  11. relevan/_generated/api/documents/post_v_1_org_id_indexes_index_name_documents.py +242 -0
  12. relevan/_generated/api/documents/post_v_1_org_id_indexes_index_name_documents_bulk.py +262 -0
  13. relevan/_generated/api/documents/put_v_1_org_id_indexes_index_name_documents_document_id.py +243 -0
  14. relevan/_generated/api/feedback/__init__.py +1 -0
  15. relevan/_generated/api/feedback/post_v_1_beta_org_id_indexes_index_name_feedback.py +239 -0
  16. relevan/_generated/api/indexes/__init__.py +1 -0
  17. relevan/_generated/api/indexes/delete_v_1_org_id_indexes_index_name.py +200 -0
  18. relevan/_generated/api/indexes/get_v_1_org_id_indexes.py +220 -0
  19. relevan/_generated/api/indexes/get_v_1_org_id_indexes_index_name.py +204 -0
  20. relevan/_generated/api/indexes/post_v_1_org_id_indexes.py +221 -0
  21. relevan/_generated/api/indexes/put_v_1_org_id_indexes_index_name.py +227 -0
  22. relevan/_generated/api/mappings/__init__.py +1 -0
  23. relevan/_generated/api/mappings/get_v_1_org_id_indexes_index_name_mappings.py +207 -0
  24. relevan/_generated/api/mappings/get_v_1_org_id_indexes_index_name_mappings_mapping_id.py +218 -0
  25. relevan/_generated/api/mappings/post_v_1_org_id_indexes_index_name_mappings.py +231 -0
  26. relevan/_generated/api/organizations/__init__.py +1 -0
  27. relevan/_generated/api/organizations/delete_v_1_org_id.py +195 -0
  28. relevan/_generated/api/organizations/get_v1_organizations.py +169 -0
  29. relevan/_generated/api/search/__init__.py +1 -0
  30. relevan/_generated/api/search/get_v_1_org_id_indexes_index_name_skill.py +206 -0
  31. relevan/_generated/api/search/post_v_1_org_id_indexes_index_name_filter_values.py +276 -0
  32. relevan/_generated/api/search/post_v_1_org_id_indexes_index_name_search.py +248 -0
  33. relevan/_generated/api/usage/__init__.py +1 -0
  34. relevan/_generated/api/usage/get_v_1_org_id_usage.py +185 -0
  35. relevan/_generated/client.py +272 -0
  36. relevan/_generated/errors.py +16 -0
  37. relevan/_generated/models/__init__.py +175 -0
  38. relevan/_generated/models/bulk_ingest_item.py +77 -0
  39. relevan/_generated/models/bulk_ingest_item_content.py +47 -0
  40. relevan/_generated/models/bulk_ingest_request.py +75 -0
  41. relevan/_generated/models/bulk_ingest_response.py +69 -0
  42. relevan/_generated/models/bulk_validation_error_response.py +83 -0
  43. relevan/_generated/models/create_document.py +77 -0
  44. relevan/_generated/models/create_document_content.py +47 -0
  45. relevan/_generated/models/create_index.py +81 -0
  46. relevan/_generated/models/created_index.py +181 -0
  47. relevan/_generated/models/created_index_status.py +10 -0
  48. relevan/_generated/models/document.py +102 -0
  49. relevan/_generated/models/document_content.py +47 -0
  50. relevan/_generated/models/document_validation_error.py +77 -0
  51. relevan/_generated/models/documents_list.py +99 -0
  52. relevan/_generated/models/error_response.py +72 -0
  53. relevan/_generated/models/feedback_request.py +240 -0
  54. relevan/_generated/models/feedback_request_action_name.py +11 -0
  55. relevan/_generated/models/feedback_request_grade_type_0.py +8 -0
  56. relevan/_generated/models/feedback_request_grade_type_1.py +8 -0
  57. relevan/_generated/models/feedback_request_grade_type_2.py +8 -0
  58. relevan/_generated/models/feedback_request_source.py +9 -0
  59. relevan/_generated/models/field_filter_values.py +117 -0
  60. relevan/_generated/models/field_filter_values_values_item.py +74 -0
  61. relevan/_generated/models/field_mapping.py +124 -0
  62. relevan/_generated/models/field_mapping_entity_type.py +11 -0
  63. relevan/_generated/models/field_mapping_kind.py +15 -0
  64. relevan/_generated/models/field_mapping_language.py +9 -0
  65. relevan/_generated/models/field_mapping_use_item.py +13 -0
  66. relevan/_generated/models/field_range_values.py +100 -0
  67. relevan/_generated/models/filter_values_request.py +151 -0
  68. relevan/_generated/models/filter_values_result.py +86 -0
  69. relevan/_generated/models/filter_values_result_fields.py +60 -0
  70. relevan/_generated/models/filter_values_result_ranges.py +60 -0
  71. relevan/_generated/models/get_v1_org_id_indexes_response_401.py +72 -0
  72. relevan/_generated/models/index.py +160 -0
  73. relevan/_generated/models/index_detail.py +201 -0
  74. relevan/_generated/models/index_detail_status.py +10 -0
  75. relevan/_generated/models/index_status.py +10 -0
  76. relevan/_generated/models/limit_error_response.py +115 -0
  77. relevan/_generated/models/limit_error_response_code.py +8 -0
  78. relevan/_generated/models/mapping.py +89 -0
  79. relevan/_generated/models/mapping_fields.py +65 -0
  80. relevan/_generated/models/mapping_language.py +9 -0
  81. relevan/_generated/models/mapping_revision.py +125 -0
  82. relevan/_generated/models/message_response.py +61 -0
  83. relevan/_generated/models/organization.py +78 -0
  84. relevan/_generated/models/search_context.py +239 -0
  85. relevan/_generated/models/search_context_decay.py +87 -0
  86. relevan/_generated/models/search_context_entities.py +98 -0
  87. relevan/_generated/models/search_context_entities_matches_item.py +88 -0
  88. relevan/_generated/models/search_context_entities_matches_item_mode.py +9 -0
  89. relevan/_generated/models/search_context_entities_outcomes.py +66 -0
  90. relevan/_generated/models/search_context_entities_outcomes_additional_property.py +9 -0
  91. relevan/_generated/models/search_context_fallback.py +81 -0
  92. relevan/_generated/models/search_context_fallback_kind.py +8 -0
  93. relevan/_generated/models/search_context_retrieval.py +87 -0
  94. relevan/_generated/models/search_context_retrieval_classification.py +13 -0
  95. relevan/_generated/models/search_context_retrieval_mode.py +9 -0
  96. relevan/_generated/models/search_filter_type_0.py +73 -0
  97. relevan/_generated/models/search_filter_type_1.py +82 -0
  98. relevan/_generated/models/search_hit.py +156 -0
  99. relevan/_generated/models/search_hit_document.py +47 -0
  100. relevan/_generated/models/search_hit_highlights.py +54 -0
  101. relevan/_generated/models/search_judgment_result.py +123 -0
  102. relevan/_generated/models/search_judgment_result_grade_type_0.py +8 -0
  103. relevan/_generated/models/search_judgment_result_grade_type_1.py +8 -0
  104. relevan/_generated/models/search_judgment_result_grade_type_2.py +8 -0
  105. relevan/_generated/models/search_quota_error_response.py +109 -0
  106. relevan/_generated/models/search_quota_error_response_code.py +8 -0
  107. relevan/_generated/models/search_range_filter.py +99 -0
  108. relevan/_generated/models/search_request.py +215 -0
  109. relevan/_generated/models/search_request_boost.py +54 -0
  110. relevan/_generated/models/search_result.py +93 -0
  111. relevan/_generated/models/storage_limit_error_response.py +122 -0
  112. relevan/_generated/models/storage_limit_error_response_code.py +8 -0
  113. relevan/_generated/models/storage_usage.py +91 -0
  114. relevan/_generated/models/update_document.py +68 -0
  115. relevan/_generated/models/update_document_content.py +47 -0
  116. relevan/_generated/models/update_index.py +70 -0
  117. relevan/_generated/models/update_mapping.py +88 -0
  118. relevan/_generated/models/update_mapping_fields.py +65 -0
  119. relevan/_generated/models/update_mapping_language.py +9 -0
  120. relevan/_generated/models/usage.py +77 -0
  121. relevan/_generated/models/usage_tier.py +11 -0
  122. relevan/_generated/types.py +54 -0
  123. relevan/_rate_limit.py +101 -0
  124. relevan/_unwrap.py +92 -0
  125. relevan/async_client.py +92 -0
  126. relevan/client.py +90 -0
  127. relevan/py.typed +0 -0
  128. relevan/resources/__init__.py +0 -0
  129. relevan/resources/beta.py +204 -0
  130. relevan/resources/documents.py +176 -0
  131. relevan/resources/indexes.py +158 -0
  132. relevan/resources/mappings.py +94 -0
  133. relevan/resources/organizations.py +43 -0
  134. relevan/resources/search.py +230 -0
  135. relevan/resources/skill.py +44 -0
  136. relevan/resources/usage.py +38 -0
  137. relevan-0.1.0.dist-info/METADATA +175 -0
  138. relevan-0.1.0.dist-info/RECORD +140 -0
  139. relevan-0.1.0.dist-info/WHEEL +4 -0
  140. relevan-0.1.0.dist-info/licenses/LICENSE +202 -0
relevan/__init__.py ADDED
@@ -0,0 +1,23 @@
1
+ from importlib.metadata import version
2
+
3
+ from ._beta import RelevanBetaWarning
4
+ from ._errors import RelevanAPIError, RelevanAuthError, RelevanError, RelevanRateLimitError
5
+ from ._rate_limit import RateLimit
6
+ from .async_client import AsyncClient
7
+ from .client import Client
8
+ from .resources.beta import JudgedResult
9
+
10
+ __version__ = version("relevan")
11
+
12
+ __all__ = [
13
+ "AsyncClient",
14
+ "Client",
15
+ "JudgedResult",
16
+ "RateLimit",
17
+ "RelevanAPIError",
18
+ "RelevanAuthError",
19
+ "RelevanBetaWarning",
20
+ "RelevanError",
21
+ "RelevanRateLimitError",
22
+ "__version__",
23
+ ]
relevan/_auth.py ADDED
@@ -0,0 +1,37 @@
1
+ from __future__ import annotations
2
+
3
+ import os
4
+
5
+ API_KEY_ENV_VAR = "RELEVAN_API_KEY"
6
+ API_KEY_PREFIX = "relevan_"
7
+
8
+
9
+ def resolve_api_key(api_key: str | None) -> str:
10
+ """Resolve the API key to use: an explicit argument, else the environment.
11
+
12
+ Args:
13
+ api_key: A key passed directly to `Client()` / `AsyncClient()`, or `None`
14
+ to fall back to the `RELEVAN_API_KEY` environment variable.
15
+
16
+ Returns:
17
+ The resolved API key.
18
+
19
+ Raises:
20
+ RelevanAuthError: No key was passed and `RELEVAN_API_KEY` is not set.
21
+ """
22
+ from ._errors import RelevanAuthError
23
+
24
+ key = api_key if api_key is not None else os.environ.get(API_KEY_ENV_VAR)
25
+ if not key:
26
+ raise RelevanAuthError(
27
+ f"No API key found. Pass api_key=... or set the {API_KEY_ENV_VAR} environment variable."
28
+ )
29
+ return key
30
+
31
+
32
+ def mask_api_key(api_key: str) -> str:
33
+ """Mask an API key for use in logs and `repr()` — never print a full key."""
34
+ prefix_len = len(API_KEY_PREFIX)
35
+ if len(api_key) <= prefix_len:
36
+ return "***"
37
+ return f"{api_key[:prefix_len]}{'*' * 8}"
relevan/_beta.py ADDED
@@ -0,0 +1,20 @@
1
+ from __future__ import annotations
2
+
3
+ import warnings
4
+
5
+
6
+ class RelevanBetaWarning(UserWarning):
7
+ """Raised on every call to a `client.beta` method.
8
+
9
+ Endpoints under the API's `/v1-beta` path have a different stability
10
+ guarantee than `/v1`: their contract may change without warning. This
11
+ warning makes that visible at the call site, not only in documentation.
12
+ """
13
+
14
+
15
+ def warn_beta(endpoint: str) -> None:
16
+ warnings.warn(
17
+ f"{endpoint} is a beta endpoint (/v1-beta). Its contract may change without warning.",
18
+ category=RelevanBetaWarning,
19
+ stacklevel=3,
20
+ )
relevan/_errors.py ADDED
@@ -0,0 +1,44 @@
1
+ from __future__ import annotations
2
+
3
+ from collections.abc import Mapping
4
+
5
+
6
+ class RelevanError(Exception):
7
+ """Base class for every error this package raises.
8
+
9
+ Attributes:
10
+ headers: The headers of the error response, when the error came from one.
11
+ """
12
+
13
+ headers: Mapping[str, str] | None = None
14
+
15
+
16
+ class RelevanAuthError(RelevanError):
17
+ """The API rejected the request's credentials (HTTP 401)."""
18
+
19
+
20
+ class RelevanRateLimitError(RelevanError):
21
+ """The request was rate limited and all retries were exhausted (HTTP 429).
22
+
23
+ Attributes:
24
+ retry_after_seconds: How long the server asked the caller to wait,
25
+ when the response included that detail.
26
+ """
27
+
28
+ def __init__(self, message: str, *, retry_after_seconds: float | None = None) -> None:
29
+ super().__init__(message)
30
+ self.retry_after_seconds = retry_after_seconds
31
+
32
+
33
+ class RelevanAPIError(RelevanError):
34
+ """The API returned an error response other than an auth or rate-limit error.
35
+
36
+ Attributes:
37
+ status_code: The HTTP status code of the response.
38
+ detail: Additional detail from the response body, when present.
39
+ """
40
+
41
+ def __init__(self, message: str, *, status_code: int, detail: str | None = None) -> None:
42
+ super().__init__(message)
43
+ self.status_code = status_code
44
+ self.detail = detail
@@ -0,0 +1,8 @@
1
+ """A client library for accessing Relevan API"""
2
+
3
+ from .client import AuthenticatedClient, Client
4
+
5
+ __all__ = (
6
+ "AuthenticatedClient",
7
+ "Client",
8
+ )
@@ -0,0 +1 @@
1
+ """Contains methods for accessing the API"""
@@ -0,0 +1 @@
1
+ """Contains endpoint functions for accessing the API"""
@@ -0,0 +1,214 @@
1
+ from http import HTTPStatus
2
+ from typing import Any
3
+ from urllib.parse import quote
4
+
5
+ import httpx
6
+
7
+ from ... import errors
8
+ from ...client import AuthenticatedClient, Client
9
+ from ...models.error_response import ErrorResponse
10
+ from ...models.message_response import MessageResponse
11
+ from ...types import Response
12
+
13
+
14
+ def _get_kwargs(
15
+ org_id: str,
16
+ index_name: str,
17
+ document_id: str,
18
+ ) -> dict[str, Any]:
19
+
20
+ _kwargs: dict[str, Any] = {
21
+ "method": "delete",
22
+ "url": "/v1/{org_id}/indexes/{index_name}/documents/{document_id}".format(
23
+ org_id=quote(str(org_id), safe=""),
24
+ index_name=quote(str(index_name), safe=""),
25
+ document_id=quote(str(document_id), safe=""),
26
+ ),
27
+ }
28
+
29
+ return _kwargs
30
+
31
+
32
+ def _parse_response(
33
+ *, client: AuthenticatedClient | Client, response: httpx.Response
34
+ ) -> ErrorResponse | MessageResponse | None:
35
+ if response.status_code == 200:
36
+ response_200 = MessageResponse.from_dict(response.json())
37
+
38
+ return response_200
39
+
40
+ if response.status_code == 401:
41
+ response_401 = ErrorResponse.from_dict(response.json())
42
+
43
+ return response_401
44
+
45
+ if response.status_code == 404:
46
+ response_404 = ErrorResponse.from_dict(response.json())
47
+
48
+ return response_404
49
+
50
+ if client.raise_on_unexpected_status:
51
+ raise errors.UnexpectedStatus(response.status_code, response.content)
52
+ else:
53
+ return None
54
+
55
+
56
+ def _build_response(
57
+ *, client: AuthenticatedClient | Client, response: httpx.Response
58
+ ) -> Response[ErrorResponse | MessageResponse]:
59
+ return Response(
60
+ status_code=HTTPStatus(response.status_code),
61
+ content=response.content,
62
+ headers=response.headers,
63
+ parsed=_parse_response(client=client, response=response),
64
+ )
65
+
66
+
67
+ def sync_detailed(
68
+ org_id: str,
69
+ index_name: str,
70
+ document_id: str,
71
+ *,
72
+ client: AuthenticatedClient | Client,
73
+ ) -> Response[ErrorResponse | MessageResponse]:
74
+ """Delete a document
75
+
76
+ Tombstones a document in Aurora and enqueues removal from OpenSearch. The document will no longer
77
+ appear in search results once processed.
78
+
79
+ Permission: `write`. Only a write API key can call this route. A read API key gets 403.
80
+
81
+ Args:
82
+ org_id (str):
83
+ index_name (str):
84
+ document_id (str): Unique document identifier Example: doc_42a1b8d9.
85
+
86
+ Raises:
87
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
88
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
89
+
90
+ Returns:
91
+ Response[ErrorResponse | MessageResponse]
92
+ """
93
+
94
+ kwargs = _get_kwargs(
95
+ org_id=org_id,
96
+ index_name=index_name,
97
+ document_id=document_id,
98
+ )
99
+
100
+ response = client.get_httpx_client().request(
101
+ **kwargs,
102
+ )
103
+
104
+ return _build_response(client=client, response=response)
105
+
106
+
107
+ def sync(
108
+ org_id: str,
109
+ index_name: str,
110
+ document_id: str,
111
+ *,
112
+ client: AuthenticatedClient | Client,
113
+ ) -> ErrorResponse | MessageResponse | None:
114
+ """Delete a document
115
+
116
+ Tombstones a document in Aurora and enqueues removal from OpenSearch. The document will no longer
117
+ appear in search results once processed.
118
+
119
+ Permission: `write`. Only a write API key can call this route. A read API key gets 403.
120
+
121
+ Args:
122
+ org_id (str):
123
+ index_name (str):
124
+ document_id (str): Unique document identifier Example: doc_42a1b8d9.
125
+
126
+ Raises:
127
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
128
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
129
+
130
+ Returns:
131
+ ErrorResponse | MessageResponse
132
+ """
133
+
134
+ return sync_detailed(
135
+ org_id=org_id,
136
+ index_name=index_name,
137
+ document_id=document_id,
138
+ client=client,
139
+ ).parsed
140
+
141
+
142
+ async def asyncio_detailed(
143
+ org_id: str,
144
+ index_name: str,
145
+ document_id: str,
146
+ *,
147
+ client: AuthenticatedClient | Client,
148
+ ) -> Response[ErrorResponse | MessageResponse]:
149
+ """Delete a document
150
+
151
+ Tombstones a document in Aurora and enqueues removal from OpenSearch. The document will no longer
152
+ appear in search results once processed.
153
+
154
+ Permission: `write`. Only a write API key can call this route. A read API key gets 403.
155
+
156
+ Args:
157
+ org_id (str):
158
+ index_name (str):
159
+ document_id (str): Unique document identifier Example: doc_42a1b8d9.
160
+
161
+ Raises:
162
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
163
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
164
+
165
+ Returns:
166
+ Response[ErrorResponse | MessageResponse]
167
+ """
168
+
169
+ kwargs = _get_kwargs(
170
+ org_id=org_id,
171
+ index_name=index_name,
172
+ document_id=document_id,
173
+ )
174
+
175
+ response = await client.get_async_httpx_client().request(**kwargs)
176
+
177
+ return _build_response(client=client, response=response)
178
+
179
+
180
+ async def asyncio(
181
+ org_id: str,
182
+ index_name: str,
183
+ document_id: str,
184
+ *,
185
+ client: AuthenticatedClient | Client,
186
+ ) -> ErrorResponse | MessageResponse | None:
187
+ """Delete a document
188
+
189
+ Tombstones a document in Aurora and enqueues removal from OpenSearch. The document will no longer
190
+ appear in search results once processed.
191
+
192
+ Permission: `write`. Only a write API key can call this route. A read API key gets 403.
193
+
194
+ Args:
195
+ org_id (str):
196
+ index_name (str):
197
+ document_id (str): Unique document identifier Example: doc_42a1b8d9.
198
+
199
+ Raises:
200
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
201
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
202
+
203
+ Returns:
204
+ ErrorResponse | MessageResponse
205
+ """
206
+
207
+ return (
208
+ await asyncio_detailed(
209
+ org_id=org_id,
210
+ index_name=index_name,
211
+ document_id=document_id,
212
+ client=client,
213
+ )
214
+ ).parsed
@@ -0,0 +1,236 @@
1
+ from http import HTTPStatus
2
+ from typing import Any
3
+ from urllib.parse import quote
4
+
5
+ import httpx
6
+
7
+ from ... import errors
8
+ from ...client import AuthenticatedClient, Client
9
+ from ...models.documents_list import DocumentsList
10
+ from ...models.error_response import ErrorResponse
11
+ from ...types import UNSET, Response, Unset
12
+
13
+
14
+ def _get_kwargs(
15
+ org_id: str,
16
+ index_name: str,
17
+ *,
18
+ page: int | Unset = UNSET,
19
+ limit: int | Unset = UNSET,
20
+ ) -> dict[str, Any]:
21
+
22
+ params: dict[str, Any] = {}
23
+
24
+ params["page"] = page
25
+
26
+ params["limit"] = limit
27
+
28
+ params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
29
+
30
+ _kwargs: dict[str, Any] = {
31
+ "method": "get",
32
+ "url": "/v1/{org_id}/indexes/{index_name}/documents".format(
33
+ org_id=quote(str(org_id), safe=""),
34
+ index_name=quote(str(index_name), safe=""),
35
+ ),
36
+ "params": params,
37
+ }
38
+
39
+ return _kwargs
40
+
41
+
42
+ def _parse_response(
43
+ *, client: AuthenticatedClient | Client, response: httpx.Response
44
+ ) -> DocumentsList | ErrorResponse | None:
45
+ if response.status_code == 200:
46
+ response_200 = DocumentsList.from_dict(response.json())
47
+
48
+ return response_200
49
+
50
+ if response.status_code == 401:
51
+ response_401 = ErrorResponse.from_dict(response.json())
52
+
53
+ return response_401
54
+
55
+ if response.status_code == 404:
56
+ response_404 = ErrorResponse.from_dict(response.json())
57
+
58
+ return response_404
59
+
60
+ if client.raise_on_unexpected_status:
61
+ raise errors.UnexpectedStatus(response.status_code, response.content)
62
+ else:
63
+ return None
64
+
65
+
66
+ def _build_response(
67
+ *, client: AuthenticatedClient | Client, response: httpx.Response
68
+ ) -> Response[DocumentsList | ErrorResponse]:
69
+ return Response(
70
+ status_code=HTTPStatus(response.status_code),
71
+ content=response.content,
72
+ headers=response.headers,
73
+ parsed=_parse_response(client=client, response=response),
74
+ )
75
+
76
+
77
+ def sync_detailed(
78
+ org_id: str,
79
+ index_name: str,
80
+ *,
81
+ client: AuthenticatedClient | Client,
82
+ page: int | Unset = UNSET,
83
+ limit: int | Unset = UNSET,
84
+ ) -> Response[DocumentsList | ErrorResponse]:
85
+ """List documents in an index
86
+
87
+ Get paginated active documents in a specific index.
88
+
89
+ Permission: `read`. A read API key or a write API key can call this route.
90
+
91
+ Args:
92
+ org_id (str):
93
+ index_name (str): URL-safe index name (lowercase alphanumeric + hyphens, unique within
94
+ org) Example: products.
95
+ page (int | Unset): Page number Example: 1.
96
+ limit (int | Unset): Results per page (max 100) Example: 20.
97
+
98
+ Raises:
99
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
100
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
101
+
102
+ Returns:
103
+ Response[DocumentsList | ErrorResponse]
104
+ """
105
+
106
+ kwargs = _get_kwargs(
107
+ org_id=org_id,
108
+ index_name=index_name,
109
+ page=page,
110
+ limit=limit,
111
+ )
112
+
113
+ response = client.get_httpx_client().request(
114
+ **kwargs,
115
+ )
116
+
117
+ return _build_response(client=client, response=response)
118
+
119
+
120
+ def sync(
121
+ org_id: str,
122
+ index_name: str,
123
+ *,
124
+ client: AuthenticatedClient | Client,
125
+ page: int | Unset = UNSET,
126
+ limit: int | Unset = UNSET,
127
+ ) -> DocumentsList | ErrorResponse | None:
128
+ """List documents in an index
129
+
130
+ Get paginated active documents in a specific index.
131
+
132
+ Permission: `read`. A read API key or a write API key can call this route.
133
+
134
+ Args:
135
+ org_id (str):
136
+ index_name (str): URL-safe index name (lowercase alphanumeric + hyphens, unique within
137
+ org) Example: products.
138
+ page (int | Unset): Page number Example: 1.
139
+ limit (int | Unset): Results per page (max 100) Example: 20.
140
+
141
+ Raises:
142
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
143
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
144
+
145
+ Returns:
146
+ DocumentsList | ErrorResponse
147
+ """
148
+
149
+ return sync_detailed(
150
+ org_id=org_id,
151
+ index_name=index_name,
152
+ client=client,
153
+ page=page,
154
+ limit=limit,
155
+ ).parsed
156
+
157
+
158
+ async def asyncio_detailed(
159
+ org_id: str,
160
+ index_name: str,
161
+ *,
162
+ client: AuthenticatedClient | Client,
163
+ page: int | Unset = UNSET,
164
+ limit: int | Unset = UNSET,
165
+ ) -> Response[DocumentsList | ErrorResponse]:
166
+ """List documents in an index
167
+
168
+ Get paginated active documents in a specific index.
169
+
170
+ Permission: `read`. A read API key or a write API key can call this route.
171
+
172
+ Args:
173
+ org_id (str):
174
+ index_name (str): URL-safe index name (lowercase alphanumeric + hyphens, unique within
175
+ org) Example: products.
176
+ page (int | Unset): Page number Example: 1.
177
+ limit (int | Unset): Results per page (max 100) Example: 20.
178
+
179
+ Raises:
180
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
181
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
182
+
183
+ Returns:
184
+ Response[DocumentsList | ErrorResponse]
185
+ """
186
+
187
+ kwargs = _get_kwargs(
188
+ org_id=org_id,
189
+ index_name=index_name,
190
+ page=page,
191
+ limit=limit,
192
+ )
193
+
194
+ response = await client.get_async_httpx_client().request(**kwargs)
195
+
196
+ return _build_response(client=client, response=response)
197
+
198
+
199
+ async def asyncio(
200
+ org_id: str,
201
+ index_name: str,
202
+ *,
203
+ client: AuthenticatedClient | Client,
204
+ page: int | Unset = UNSET,
205
+ limit: int | Unset = UNSET,
206
+ ) -> DocumentsList | ErrorResponse | None:
207
+ """List documents in an index
208
+
209
+ Get paginated active documents in a specific index.
210
+
211
+ Permission: `read`. A read API key or a write API key can call this route.
212
+
213
+ Args:
214
+ org_id (str):
215
+ index_name (str): URL-safe index name (lowercase alphanumeric + hyphens, unique within
216
+ org) Example: products.
217
+ page (int | Unset): Page number Example: 1.
218
+ limit (int | Unset): Results per page (max 100) Example: 20.
219
+
220
+ Raises:
221
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
222
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
223
+
224
+ Returns:
225
+ DocumentsList | ErrorResponse
226
+ """
227
+
228
+ return (
229
+ await asyncio_detailed(
230
+ org_id=org_id,
231
+ index_name=index_name,
232
+ client=client,
233
+ page=page,
234
+ limit=limit,
235
+ )
236
+ ).parsed