mypy-boto3-s3vectors 1.39.5__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 mypy-boto3-s3vectors might be problematic. Click here for more details.
- mypy_boto3_s3vectors/__init__.py +41 -0
- mypy_boto3_s3vectors/__init__.pyi +40 -0
- mypy_boto3_s3vectors/__main__.py +43 -0
- mypy_boto3_s3vectors/client.py +313 -0
- mypy_boto3_s3vectors/client.pyi +310 -0
- mypy_boto3_s3vectors/literals.py +470 -0
- mypy_boto3_s3vectors/literals.pyi +468 -0
- mypy_boto3_s3vectors/paginator.py +114 -0
- mypy_boto3_s3vectors/paginator.pyi +104 -0
- mypy_boto3_s3vectors/py.typed +0 -0
- mypy_boto3_s3vectors/type_defs.py +362 -0
- mypy_boto3_s3vectors/type_defs.pyi +318 -0
- mypy_boto3_s3vectors/version.py +7 -0
- mypy_boto3_s3vectors-1.39.5.dist-info/METADATA +492 -0
- mypy_boto3_s3vectors-1.39.5.dist-info/RECORD +18 -0
- mypy_boto3_s3vectors-1.39.5.dist-info/WHEEL +5 -0
- mypy_boto3_s3vectors-1.39.5.dist-info/licenses/LICENSE +21 -0
- mypy_boto3_s3vectors-1.39.5.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,362 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Type annotations for s3vectors service type definitions.
|
|
3
|
+
|
|
4
|
+
[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/type_defs/)
|
|
5
|
+
|
|
6
|
+
Copyright 2025 Vlad Emelianov
|
|
7
|
+
|
|
8
|
+
Usage::
|
|
9
|
+
|
|
10
|
+
```python
|
|
11
|
+
from mypy_boto3_s3vectors.type_defs import EncryptionConfigurationTypeDef
|
|
12
|
+
|
|
13
|
+
data: EncryptionConfigurationTypeDef = ...
|
|
14
|
+
```
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
from __future__ import annotations
|
|
18
|
+
|
|
19
|
+
import sys
|
|
20
|
+
from datetime import datetime
|
|
21
|
+
from typing import Any, Union
|
|
22
|
+
|
|
23
|
+
from .literals import DistanceMetricType, SseTypeType
|
|
24
|
+
|
|
25
|
+
if sys.version_info >= (3, 9):
|
|
26
|
+
from builtins import dict as Dict
|
|
27
|
+
from builtins import list as List
|
|
28
|
+
from collections.abc import Mapping, Sequence
|
|
29
|
+
else:
|
|
30
|
+
from typing import Dict, List, Mapping, Sequence
|
|
31
|
+
if sys.version_info >= (3, 12):
|
|
32
|
+
from typing import Literal, NotRequired, TypedDict
|
|
33
|
+
else:
|
|
34
|
+
from typing_extensions import Literal, NotRequired, TypedDict
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
__all__ = (
|
|
38
|
+
"CreateIndexInputTypeDef",
|
|
39
|
+
"CreateVectorBucketInputTypeDef",
|
|
40
|
+
"DeleteIndexInputTypeDef",
|
|
41
|
+
"DeleteVectorBucketInputTypeDef",
|
|
42
|
+
"DeleteVectorBucketPolicyInputTypeDef",
|
|
43
|
+
"DeleteVectorsInputTypeDef",
|
|
44
|
+
"EncryptionConfigurationTypeDef",
|
|
45
|
+
"GetIndexInputTypeDef",
|
|
46
|
+
"GetIndexOutputTypeDef",
|
|
47
|
+
"GetOutputVectorTypeDef",
|
|
48
|
+
"GetVectorBucketInputTypeDef",
|
|
49
|
+
"GetVectorBucketOutputTypeDef",
|
|
50
|
+
"GetVectorBucketPolicyInputTypeDef",
|
|
51
|
+
"GetVectorBucketPolicyOutputTypeDef",
|
|
52
|
+
"GetVectorsInputTypeDef",
|
|
53
|
+
"GetVectorsOutputTypeDef",
|
|
54
|
+
"IndexSummaryTypeDef",
|
|
55
|
+
"IndexTypeDef",
|
|
56
|
+
"ListIndexesInputPaginateTypeDef",
|
|
57
|
+
"ListIndexesInputTypeDef",
|
|
58
|
+
"ListIndexesOutputTypeDef",
|
|
59
|
+
"ListOutputVectorTypeDef",
|
|
60
|
+
"ListVectorBucketsInputPaginateTypeDef",
|
|
61
|
+
"ListVectorBucketsInputTypeDef",
|
|
62
|
+
"ListVectorBucketsOutputTypeDef",
|
|
63
|
+
"ListVectorsInputPaginateTypeDef",
|
|
64
|
+
"ListVectorsInputTypeDef",
|
|
65
|
+
"ListVectorsOutputTypeDef",
|
|
66
|
+
"MetadataConfigurationOutputTypeDef",
|
|
67
|
+
"MetadataConfigurationTypeDef",
|
|
68
|
+
"MetadataConfigurationUnionTypeDef",
|
|
69
|
+
"PaginatorConfigTypeDef",
|
|
70
|
+
"PutInputVectorTypeDef",
|
|
71
|
+
"PutVectorBucketPolicyInputTypeDef",
|
|
72
|
+
"PutVectorsInputTypeDef",
|
|
73
|
+
"QueryOutputVectorTypeDef",
|
|
74
|
+
"QueryVectorsInputTypeDef",
|
|
75
|
+
"QueryVectorsOutputTypeDef",
|
|
76
|
+
"ResponseMetadataTypeDef",
|
|
77
|
+
"VectorBucketSummaryTypeDef",
|
|
78
|
+
"VectorBucketTypeDef",
|
|
79
|
+
"VectorDataOutputTypeDef",
|
|
80
|
+
"VectorDataTypeDef",
|
|
81
|
+
"VectorDataUnionTypeDef",
|
|
82
|
+
)
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
class EncryptionConfigurationTypeDef(TypedDict):
|
|
86
|
+
sseType: NotRequired[SseTypeType]
|
|
87
|
+
kmsKeyArn: NotRequired[str]
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
class DeleteIndexInputTypeDef(TypedDict):
|
|
91
|
+
vectorBucketName: NotRequired[str]
|
|
92
|
+
indexName: NotRequired[str]
|
|
93
|
+
indexArn: NotRequired[str]
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
class DeleteVectorBucketInputTypeDef(TypedDict):
|
|
97
|
+
vectorBucketName: NotRequired[str]
|
|
98
|
+
vectorBucketArn: NotRequired[str]
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
class DeleteVectorBucketPolicyInputTypeDef(TypedDict):
|
|
102
|
+
vectorBucketName: NotRequired[str]
|
|
103
|
+
vectorBucketArn: NotRequired[str]
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
class DeleteVectorsInputTypeDef(TypedDict):
|
|
107
|
+
keys: Sequence[str]
|
|
108
|
+
vectorBucketName: NotRequired[str]
|
|
109
|
+
indexName: NotRequired[str]
|
|
110
|
+
indexArn: NotRequired[str]
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
class GetIndexInputTypeDef(TypedDict):
|
|
114
|
+
vectorBucketName: NotRequired[str]
|
|
115
|
+
indexName: NotRequired[str]
|
|
116
|
+
indexArn: NotRequired[str]
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
class ResponseMetadataTypeDef(TypedDict):
|
|
120
|
+
RequestId: str
|
|
121
|
+
HTTPStatusCode: int
|
|
122
|
+
HTTPHeaders: Dict[str, str]
|
|
123
|
+
RetryAttempts: int
|
|
124
|
+
HostId: NotRequired[str]
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
class VectorDataOutputTypeDef(TypedDict):
|
|
128
|
+
float32: NotRequired[List[float]]
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
class GetVectorBucketInputTypeDef(TypedDict):
|
|
132
|
+
vectorBucketName: NotRequired[str]
|
|
133
|
+
vectorBucketArn: NotRequired[str]
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
class GetVectorBucketPolicyInputTypeDef(TypedDict):
|
|
137
|
+
vectorBucketName: NotRequired[str]
|
|
138
|
+
vectorBucketArn: NotRequired[str]
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
class GetVectorsInputTypeDef(TypedDict):
|
|
142
|
+
keys: Sequence[str]
|
|
143
|
+
vectorBucketName: NotRequired[str]
|
|
144
|
+
indexName: NotRequired[str]
|
|
145
|
+
indexArn: NotRequired[str]
|
|
146
|
+
returnData: NotRequired[bool]
|
|
147
|
+
returnMetadata: NotRequired[bool]
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
class IndexSummaryTypeDef(TypedDict):
|
|
151
|
+
vectorBucketName: str
|
|
152
|
+
indexName: str
|
|
153
|
+
indexArn: str
|
|
154
|
+
creationTime: datetime
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
class MetadataConfigurationOutputTypeDef(TypedDict):
|
|
158
|
+
nonFilterableMetadataKeys: List[str]
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
class PaginatorConfigTypeDef(TypedDict):
|
|
162
|
+
MaxItems: NotRequired[int]
|
|
163
|
+
PageSize: NotRequired[int]
|
|
164
|
+
StartingToken: NotRequired[str]
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
class ListIndexesInputTypeDef(TypedDict):
|
|
168
|
+
vectorBucketName: NotRequired[str]
|
|
169
|
+
vectorBucketArn: NotRequired[str]
|
|
170
|
+
maxResults: NotRequired[int]
|
|
171
|
+
nextToken: NotRequired[str]
|
|
172
|
+
prefix: NotRequired[str]
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
class ListVectorBucketsInputTypeDef(TypedDict):
|
|
176
|
+
maxResults: NotRequired[int]
|
|
177
|
+
nextToken: NotRequired[str]
|
|
178
|
+
prefix: NotRequired[str]
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
class VectorBucketSummaryTypeDef(TypedDict):
|
|
182
|
+
vectorBucketName: str
|
|
183
|
+
vectorBucketArn: str
|
|
184
|
+
creationTime: datetime
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
class ListVectorsInputTypeDef(TypedDict):
|
|
188
|
+
vectorBucketName: NotRequired[str]
|
|
189
|
+
indexName: NotRequired[str]
|
|
190
|
+
indexArn: NotRequired[str]
|
|
191
|
+
maxResults: NotRequired[int]
|
|
192
|
+
nextToken: NotRequired[str]
|
|
193
|
+
segmentCount: NotRequired[int]
|
|
194
|
+
segmentIndex: NotRequired[int]
|
|
195
|
+
returnData: NotRequired[bool]
|
|
196
|
+
returnMetadata: NotRequired[bool]
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
class MetadataConfigurationTypeDef(TypedDict):
|
|
200
|
+
nonFilterableMetadataKeys: Sequence[str]
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
class PutVectorBucketPolicyInputTypeDef(TypedDict):
|
|
204
|
+
policy: str
|
|
205
|
+
vectorBucketName: NotRequired[str]
|
|
206
|
+
vectorBucketArn: NotRequired[str]
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
class VectorDataTypeDef(TypedDict):
|
|
210
|
+
float32: NotRequired[Sequence[float]]
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
class CreateVectorBucketInputTypeDef(TypedDict):
|
|
214
|
+
vectorBucketName: str
|
|
215
|
+
encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef]
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
class VectorBucketTypeDef(TypedDict):
|
|
219
|
+
vectorBucketName: str
|
|
220
|
+
vectorBucketArn: str
|
|
221
|
+
creationTime: datetime
|
|
222
|
+
encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef]
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
class GetVectorBucketPolicyOutputTypeDef(TypedDict):
|
|
226
|
+
policy: str
|
|
227
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
class GetOutputVectorTypeDef(TypedDict):
|
|
231
|
+
key: str
|
|
232
|
+
data: NotRequired[VectorDataOutputTypeDef]
|
|
233
|
+
metadata: NotRequired[Dict[str, Any]]
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
class ListOutputVectorTypeDef(TypedDict):
|
|
237
|
+
key: str
|
|
238
|
+
data: NotRequired[VectorDataOutputTypeDef]
|
|
239
|
+
metadata: NotRequired[Dict[str, Any]]
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
class QueryOutputVectorTypeDef(TypedDict):
|
|
243
|
+
key: str
|
|
244
|
+
data: NotRequired[VectorDataOutputTypeDef]
|
|
245
|
+
metadata: NotRequired[Dict[str, Any]]
|
|
246
|
+
distance: NotRequired[float]
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
class ListIndexesOutputTypeDef(TypedDict):
|
|
250
|
+
indexes: List[IndexSummaryTypeDef]
|
|
251
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
252
|
+
nextToken: NotRequired[str]
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
class IndexTypeDef(TypedDict):
|
|
256
|
+
vectorBucketName: str
|
|
257
|
+
indexName: str
|
|
258
|
+
indexArn: str
|
|
259
|
+
creationTime: datetime
|
|
260
|
+
dataType: Literal["float32"]
|
|
261
|
+
dimension: int
|
|
262
|
+
distanceMetric: DistanceMetricType
|
|
263
|
+
metadataConfiguration: NotRequired[MetadataConfigurationOutputTypeDef]
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
class ListIndexesInputPaginateTypeDef(TypedDict):
|
|
267
|
+
vectorBucketName: NotRequired[str]
|
|
268
|
+
vectorBucketArn: NotRequired[str]
|
|
269
|
+
prefix: NotRequired[str]
|
|
270
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
class ListVectorBucketsInputPaginateTypeDef(TypedDict):
|
|
274
|
+
prefix: NotRequired[str]
|
|
275
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
class ListVectorsInputPaginateTypeDef(TypedDict):
|
|
279
|
+
vectorBucketName: NotRequired[str]
|
|
280
|
+
indexName: NotRequired[str]
|
|
281
|
+
indexArn: NotRequired[str]
|
|
282
|
+
segmentCount: NotRequired[int]
|
|
283
|
+
segmentIndex: NotRequired[int]
|
|
284
|
+
returnData: NotRequired[bool]
|
|
285
|
+
returnMetadata: NotRequired[bool]
|
|
286
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
class ListVectorBucketsOutputTypeDef(TypedDict):
|
|
290
|
+
vectorBuckets: List[VectorBucketSummaryTypeDef]
|
|
291
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
292
|
+
nextToken: NotRequired[str]
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
MetadataConfigurationUnionTypeDef = Union[
|
|
296
|
+
MetadataConfigurationTypeDef, MetadataConfigurationOutputTypeDef
|
|
297
|
+
]
|
|
298
|
+
VectorDataUnionTypeDef = Union[VectorDataTypeDef, VectorDataOutputTypeDef]
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
class GetVectorBucketOutputTypeDef(TypedDict):
|
|
302
|
+
vectorBucket: VectorBucketTypeDef
|
|
303
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
class GetVectorsOutputTypeDef(TypedDict):
|
|
307
|
+
vectors: List[GetOutputVectorTypeDef]
|
|
308
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
class ListVectorsOutputTypeDef(TypedDict):
|
|
312
|
+
vectors: List[ListOutputVectorTypeDef]
|
|
313
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
314
|
+
nextToken: NotRequired[str]
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
class QueryVectorsOutputTypeDef(TypedDict):
|
|
318
|
+
vectors: List[QueryOutputVectorTypeDef]
|
|
319
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
class GetIndexOutputTypeDef(TypedDict):
|
|
323
|
+
index: IndexTypeDef
|
|
324
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
class CreateIndexInputTypeDef(TypedDict):
|
|
328
|
+
indexName: str
|
|
329
|
+
dataType: Literal["float32"]
|
|
330
|
+
dimension: int
|
|
331
|
+
distanceMetric: DistanceMetricType
|
|
332
|
+
vectorBucketName: NotRequired[str]
|
|
333
|
+
vectorBucketArn: NotRequired[str]
|
|
334
|
+
metadataConfiguration: NotRequired[MetadataConfigurationUnionTypeDef]
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
class PutInputVectorTypeDef(TypedDict):
|
|
338
|
+
key: str
|
|
339
|
+
data: VectorDataUnionTypeDef
|
|
340
|
+
metadata: NotRequired[Mapping[str, Any]]
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
QueryVectorsInputTypeDef = TypedDict(
|
|
344
|
+
"QueryVectorsInputTypeDef",
|
|
345
|
+
{
|
|
346
|
+
"topK": int,
|
|
347
|
+
"queryVector": VectorDataUnionTypeDef,
|
|
348
|
+
"vectorBucketName": NotRequired[str],
|
|
349
|
+
"indexName": NotRequired[str],
|
|
350
|
+
"indexArn": NotRequired[str],
|
|
351
|
+
"filter": NotRequired[Mapping[str, Any]],
|
|
352
|
+
"returnMetadata": NotRequired[bool],
|
|
353
|
+
"returnDistance": NotRequired[bool],
|
|
354
|
+
},
|
|
355
|
+
)
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
class PutVectorsInputTypeDef(TypedDict):
|
|
359
|
+
vectors: Sequence[PutInputVectorTypeDef]
|
|
360
|
+
vectorBucketName: NotRequired[str]
|
|
361
|
+
indexName: NotRequired[str]
|
|
362
|
+
indexArn: NotRequired[str]
|
|
@@ -0,0 +1,318 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Type annotations for s3vectors service type definitions.
|
|
3
|
+
|
|
4
|
+
[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/type_defs/)
|
|
5
|
+
|
|
6
|
+
Copyright 2025 Vlad Emelianov
|
|
7
|
+
|
|
8
|
+
Usage::
|
|
9
|
+
|
|
10
|
+
```python
|
|
11
|
+
from mypy_boto3_s3vectors.type_defs import EncryptionConfigurationTypeDef
|
|
12
|
+
|
|
13
|
+
data: EncryptionConfigurationTypeDef = ...
|
|
14
|
+
```
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
from __future__ import annotations
|
|
18
|
+
|
|
19
|
+
import sys
|
|
20
|
+
from datetime import datetime
|
|
21
|
+
from typing import Any, Union
|
|
22
|
+
|
|
23
|
+
from .literals import DistanceMetricType, SseTypeType
|
|
24
|
+
|
|
25
|
+
if sys.version_info >= (3, 9):
|
|
26
|
+
from builtins import dict as Dict
|
|
27
|
+
from builtins import list as List
|
|
28
|
+
from collections.abc import Mapping, Sequence
|
|
29
|
+
else:
|
|
30
|
+
from typing import Dict, List, Mapping, Sequence
|
|
31
|
+
if sys.version_info >= (3, 12):
|
|
32
|
+
from typing import Literal, NotRequired, TypedDict
|
|
33
|
+
else:
|
|
34
|
+
from typing_extensions import Literal, NotRequired, TypedDict
|
|
35
|
+
|
|
36
|
+
__all__ = (
|
|
37
|
+
"CreateIndexInputTypeDef",
|
|
38
|
+
"CreateVectorBucketInputTypeDef",
|
|
39
|
+
"DeleteIndexInputTypeDef",
|
|
40
|
+
"DeleteVectorBucketInputTypeDef",
|
|
41
|
+
"DeleteVectorBucketPolicyInputTypeDef",
|
|
42
|
+
"DeleteVectorsInputTypeDef",
|
|
43
|
+
"EncryptionConfigurationTypeDef",
|
|
44
|
+
"GetIndexInputTypeDef",
|
|
45
|
+
"GetIndexOutputTypeDef",
|
|
46
|
+
"GetOutputVectorTypeDef",
|
|
47
|
+
"GetVectorBucketInputTypeDef",
|
|
48
|
+
"GetVectorBucketOutputTypeDef",
|
|
49
|
+
"GetVectorBucketPolicyInputTypeDef",
|
|
50
|
+
"GetVectorBucketPolicyOutputTypeDef",
|
|
51
|
+
"GetVectorsInputTypeDef",
|
|
52
|
+
"GetVectorsOutputTypeDef",
|
|
53
|
+
"IndexSummaryTypeDef",
|
|
54
|
+
"IndexTypeDef",
|
|
55
|
+
"ListIndexesInputPaginateTypeDef",
|
|
56
|
+
"ListIndexesInputTypeDef",
|
|
57
|
+
"ListIndexesOutputTypeDef",
|
|
58
|
+
"ListOutputVectorTypeDef",
|
|
59
|
+
"ListVectorBucketsInputPaginateTypeDef",
|
|
60
|
+
"ListVectorBucketsInputTypeDef",
|
|
61
|
+
"ListVectorBucketsOutputTypeDef",
|
|
62
|
+
"ListVectorsInputPaginateTypeDef",
|
|
63
|
+
"ListVectorsInputTypeDef",
|
|
64
|
+
"ListVectorsOutputTypeDef",
|
|
65
|
+
"MetadataConfigurationOutputTypeDef",
|
|
66
|
+
"MetadataConfigurationTypeDef",
|
|
67
|
+
"MetadataConfigurationUnionTypeDef",
|
|
68
|
+
"PaginatorConfigTypeDef",
|
|
69
|
+
"PutInputVectorTypeDef",
|
|
70
|
+
"PutVectorBucketPolicyInputTypeDef",
|
|
71
|
+
"PutVectorsInputTypeDef",
|
|
72
|
+
"QueryOutputVectorTypeDef",
|
|
73
|
+
"QueryVectorsInputTypeDef",
|
|
74
|
+
"QueryVectorsOutputTypeDef",
|
|
75
|
+
"ResponseMetadataTypeDef",
|
|
76
|
+
"VectorBucketSummaryTypeDef",
|
|
77
|
+
"VectorBucketTypeDef",
|
|
78
|
+
"VectorDataOutputTypeDef",
|
|
79
|
+
"VectorDataTypeDef",
|
|
80
|
+
"VectorDataUnionTypeDef",
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
class EncryptionConfigurationTypeDef(TypedDict):
|
|
84
|
+
sseType: NotRequired[SseTypeType]
|
|
85
|
+
kmsKeyArn: NotRequired[str]
|
|
86
|
+
|
|
87
|
+
class DeleteIndexInputTypeDef(TypedDict):
|
|
88
|
+
vectorBucketName: NotRequired[str]
|
|
89
|
+
indexName: NotRequired[str]
|
|
90
|
+
indexArn: NotRequired[str]
|
|
91
|
+
|
|
92
|
+
class DeleteVectorBucketInputTypeDef(TypedDict):
|
|
93
|
+
vectorBucketName: NotRequired[str]
|
|
94
|
+
vectorBucketArn: NotRequired[str]
|
|
95
|
+
|
|
96
|
+
class DeleteVectorBucketPolicyInputTypeDef(TypedDict):
|
|
97
|
+
vectorBucketName: NotRequired[str]
|
|
98
|
+
vectorBucketArn: NotRequired[str]
|
|
99
|
+
|
|
100
|
+
class DeleteVectorsInputTypeDef(TypedDict):
|
|
101
|
+
keys: Sequence[str]
|
|
102
|
+
vectorBucketName: NotRequired[str]
|
|
103
|
+
indexName: NotRequired[str]
|
|
104
|
+
indexArn: NotRequired[str]
|
|
105
|
+
|
|
106
|
+
class GetIndexInputTypeDef(TypedDict):
|
|
107
|
+
vectorBucketName: NotRequired[str]
|
|
108
|
+
indexName: NotRequired[str]
|
|
109
|
+
indexArn: NotRequired[str]
|
|
110
|
+
|
|
111
|
+
class ResponseMetadataTypeDef(TypedDict):
|
|
112
|
+
RequestId: str
|
|
113
|
+
HTTPStatusCode: int
|
|
114
|
+
HTTPHeaders: Dict[str, str]
|
|
115
|
+
RetryAttempts: int
|
|
116
|
+
HostId: NotRequired[str]
|
|
117
|
+
|
|
118
|
+
class VectorDataOutputTypeDef(TypedDict):
|
|
119
|
+
float32: NotRequired[List[float]]
|
|
120
|
+
|
|
121
|
+
class GetVectorBucketInputTypeDef(TypedDict):
|
|
122
|
+
vectorBucketName: NotRequired[str]
|
|
123
|
+
vectorBucketArn: NotRequired[str]
|
|
124
|
+
|
|
125
|
+
class GetVectorBucketPolicyInputTypeDef(TypedDict):
|
|
126
|
+
vectorBucketName: NotRequired[str]
|
|
127
|
+
vectorBucketArn: NotRequired[str]
|
|
128
|
+
|
|
129
|
+
class GetVectorsInputTypeDef(TypedDict):
|
|
130
|
+
keys: Sequence[str]
|
|
131
|
+
vectorBucketName: NotRequired[str]
|
|
132
|
+
indexName: NotRequired[str]
|
|
133
|
+
indexArn: NotRequired[str]
|
|
134
|
+
returnData: NotRequired[bool]
|
|
135
|
+
returnMetadata: NotRequired[bool]
|
|
136
|
+
|
|
137
|
+
class IndexSummaryTypeDef(TypedDict):
|
|
138
|
+
vectorBucketName: str
|
|
139
|
+
indexName: str
|
|
140
|
+
indexArn: str
|
|
141
|
+
creationTime: datetime
|
|
142
|
+
|
|
143
|
+
class MetadataConfigurationOutputTypeDef(TypedDict):
|
|
144
|
+
nonFilterableMetadataKeys: List[str]
|
|
145
|
+
|
|
146
|
+
class PaginatorConfigTypeDef(TypedDict):
|
|
147
|
+
MaxItems: NotRequired[int]
|
|
148
|
+
PageSize: NotRequired[int]
|
|
149
|
+
StartingToken: NotRequired[str]
|
|
150
|
+
|
|
151
|
+
class ListIndexesInputTypeDef(TypedDict):
|
|
152
|
+
vectorBucketName: NotRequired[str]
|
|
153
|
+
vectorBucketArn: NotRequired[str]
|
|
154
|
+
maxResults: NotRequired[int]
|
|
155
|
+
nextToken: NotRequired[str]
|
|
156
|
+
prefix: NotRequired[str]
|
|
157
|
+
|
|
158
|
+
class ListVectorBucketsInputTypeDef(TypedDict):
|
|
159
|
+
maxResults: NotRequired[int]
|
|
160
|
+
nextToken: NotRequired[str]
|
|
161
|
+
prefix: NotRequired[str]
|
|
162
|
+
|
|
163
|
+
class VectorBucketSummaryTypeDef(TypedDict):
|
|
164
|
+
vectorBucketName: str
|
|
165
|
+
vectorBucketArn: str
|
|
166
|
+
creationTime: datetime
|
|
167
|
+
|
|
168
|
+
class ListVectorsInputTypeDef(TypedDict):
|
|
169
|
+
vectorBucketName: NotRequired[str]
|
|
170
|
+
indexName: NotRequired[str]
|
|
171
|
+
indexArn: NotRequired[str]
|
|
172
|
+
maxResults: NotRequired[int]
|
|
173
|
+
nextToken: NotRequired[str]
|
|
174
|
+
segmentCount: NotRequired[int]
|
|
175
|
+
segmentIndex: NotRequired[int]
|
|
176
|
+
returnData: NotRequired[bool]
|
|
177
|
+
returnMetadata: NotRequired[bool]
|
|
178
|
+
|
|
179
|
+
class MetadataConfigurationTypeDef(TypedDict):
|
|
180
|
+
nonFilterableMetadataKeys: Sequence[str]
|
|
181
|
+
|
|
182
|
+
class PutVectorBucketPolicyInputTypeDef(TypedDict):
|
|
183
|
+
policy: str
|
|
184
|
+
vectorBucketName: NotRequired[str]
|
|
185
|
+
vectorBucketArn: NotRequired[str]
|
|
186
|
+
|
|
187
|
+
class VectorDataTypeDef(TypedDict):
|
|
188
|
+
float32: NotRequired[Sequence[float]]
|
|
189
|
+
|
|
190
|
+
class CreateVectorBucketInputTypeDef(TypedDict):
|
|
191
|
+
vectorBucketName: str
|
|
192
|
+
encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef]
|
|
193
|
+
|
|
194
|
+
class VectorBucketTypeDef(TypedDict):
|
|
195
|
+
vectorBucketName: str
|
|
196
|
+
vectorBucketArn: str
|
|
197
|
+
creationTime: datetime
|
|
198
|
+
encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef]
|
|
199
|
+
|
|
200
|
+
class GetVectorBucketPolicyOutputTypeDef(TypedDict):
|
|
201
|
+
policy: str
|
|
202
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
203
|
+
|
|
204
|
+
class GetOutputVectorTypeDef(TypedDict):
|
|
205
|
+
key: str
|
|
206
|
+
data: NotRequired[VectorDataOutputTypeDef]
|
|
207
|
+
metadata: NotRequired[Dict[str, Any]]
|
|
208
|
+
|
|
209
|
+
class ListOutputVectorTypeDef(TypedDict):
|
|
210
|
+
key: str
|
|
211
|
+
data: NotRequired[VectorDataOutputTypeDef]
|
|
212
|
+
metadata: NotRequired[Dict[str, Any]]
|
|
213
|
+
|
|
214
|
+
class QueryOutputVectorTypeDef(TypedDict):
|
|
215
|
+
key: str
|
|
216
|
+
data: NotRequired[VectorDataOutputTypeDef]
|
|
217
|
+
metadata: NotRequired[Dict[str, Any]]
|
|
218
|
+
distance: NotRequired[float]
|
|
219
|
+
|
|
220
|
+
class ListIndexesOutputTypeDef(TypedDict):
|
|
221
|
+
indexes: List[IndexSummaryTypeDef]
|
|
222
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
223
|
+
nextToken: NotRequired[str]
|
|
224
|
+
|
|
225
|
+
class IndexTypeDef(TypedDict):
|
|
226
|
+
vectorBucketName: str
|
|
227
|
+
indexName: str
|
|
228
|
+
indexArn: str
|
|
229
|
+
creationTime: datetime
|
|
230
|
+
dataType: Literal["float32"]
|
|
231
|
+
dimension: int
|
|
232
|
+
distanceMetric: DistanceMetricType
|
|
233
|
+
metadataConfiguration: NotRequired[MetadataConfigurationOutputTypeDef]
|
|
234
|
+
|
|
235
|
+
class ListIndexesInputPaginateTypeDef(TypedDict):
|
|
236
|
+
vectorBucketName: NotRequired[str]
|
|
237
|
+
vectorBucketArn: NotRequired[str]
|
|
238
|
+
prefix: NotRequired[str]
|
|
239
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
240
|
+
|
|
241
|
+
class ListVectorBucketsInputPaginateTypeDef(TypedDict):
|
|
242
|
+
prefix: NotRequired[str]
|
|
243
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
244
|
+
|
|
245
|
+
class ListVectorsInputPaginateTypeDef(TypedDict):
|
|
246
|
+
vectorBucketName: NotRequired[str]
|
|
247
|
+
indexName: NotRequired[str]
|
|
248
|
+
indexArn: NotRequired[str]
|
|
249
|
+
segmentCount: NotRequired[int]
|
|
250
|
+
segmentIndex: NotRequired[int]
|
|
251
|
+
returnData: NotRequired[bool]
|
|
252
|
+
returnMetadata: NotRequired[bool]
|
|
253
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
254
|
+
|
|
255
|
+
class ListVectorBucketsOutputTypeDef(TypedDict):
|
|
256
|
+
vectorBuckets: List[VectorBucketSummaryTypeDef]
|
|
257
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
258
|
+
nextToken: NotRequired[str]
|
|
259
|
+
|
|
260
|
+
MetadataConfigurationUnionTypeDef = Union[
|
|
261
|
+
MetadataConfigurationTypeDef, MetadataConfigurationOutputTypeDef
|
|
262
|
+
]
|
|
263
|
+
VectorDataUnionTypeDef = Union[VectorDataTypeDef, VectorDataOutputTypeDef]
|
|
264
|
+
|
|
265
|
+
class GetVectorBucketOutputTypeDef(TypedDict):
|
|
266
|
+
vectorBucket: VectorBucketTypeDef
|
|
267
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
268
|
+
|
|
269
|
+
class GetVectorsOutputTypeDef(TypedDict):
|
|
270
|
+
vectors: List[GetOutputVectorTypeDef]
|
|
271
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
272
|
+
|
|
273
|
+
class ListVectorsOutputTypeDef(TypedDict):
|
|
274
|
+
vectors: List[ListOutputVectorTypeDef]
|
|
275
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
276
|
+
nextToken: NotRequired[str]
|
|
277
|
+
|
|
278
|
+
class QueryVectorsOutputTypeDef(TypedDict):
|
|
279
|
+
vectors: List[QueryOutputVectorTypeDef]
|
|
280
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
281
|
+
|
|
282
|
+
class GetIndexOutputTypeDef(TypedDict):
|
|
283
|
+
index: IndexTypeDef
|
|
284
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
285
|
+
|
|
286
|
+
class CreateIndexInputTypeDef(TypedDict):
|
|
287
|
+
indexName: str
|
|
288
|
+
dataType: Literal["float32"]
|
|
289
|
+
dimension: int
|
|
290
|
+
distanceMetric: DistanceMetricType
|
|
291
|
+
vectorBucketName: NotRequired[str]
|
|
292
|
+
vectorBucketArn: NotRequired[str]
|
|
293
|
+
metadataConfiguration: NotRequired[MetadataConfigurationUnionTypeDef]
|
|
294
|
+
|
|
295
|
+
class PutInputVectorTypeDef(TypedDict):
|
|
296
|
+
key: str
|
|
297
|
+
data: VectorDataUnionTypeDef
|
|
298
|
+
metadata: NotRequired[Mapping[str, Any]]
|
|
299
|
+
|
|
300
|
+
QueryVectorsInputTypeDef = TypedDict(
|
|
301
|
+
"QueryVectorsInputTypeDef",
|
|
302
|
+
{
|
|
303
|
+
"topK": int,
|
|
304
|
+
"queryVector": VectorDataUnionTypeDef,
|
|
305
|
+
"vectorBucketName": NotRequired[str],
|
|
306
|
+
"indexName": NotRequired[str],
|
|
307
|
+
"indexArn": NotRequired[str],
|
|
308
|
+
"filter": NotRequired[Mapping[str, Any]],
|
|
309
|
+
"returnMetadata": NotRequired[bool],
|
|
310
|
+
"returnDistance": NotRequired[bool],
|
|
311
|
+
},
|
|
312
|
+
)
|
|
313
|
+
|
|
314
|
+
class PutVectorsInputTypeDef(TypedDict):
|
|
315
|
+
vectors: Sequence[PutInputVectorTypeDef]
|
|
316
|
+
vectorBucketName: NotRequired[str]
|
|
317
|
+
indexName: NotRequired[str]
|
|
318
|
+
indexArn: NotRequired[str]
|