1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
"""Handles incoming s3vectors requests, invokes methods, returns responses."""
from moto.core.responses import ActionResult, BaseResponse, EmptyResult, get_partition
from .exceptions import (
ValidationError,
VectorBucketInvalidChars,
VectorBucketInvalidLength,
)
from .models import S3VectorsBackend, s3vectors_backends
# Some obvious invalid chars - but I haven't found an official list (or even a allowed regex, which would be easier)
INVALID_BUCKET_NAME_CHARACTERS = ["&", "_"]
class S3VectorsResponse(BaseResponse):
"""Handler for S3Vectors requests and responses."""
def __init__(self) -> None:
super().__init__(service_name="s3vectors")
@property
def s3vectors_backend(self) -> S3VectorsBackend:
return s3vectors_backends[self.current_account][get_partition(self.region)]
def create_vector_bucket(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
encryption_configuration = self._get_param("encryptionConfiguration")
if not 2 < len(vector_bucket_name) < 64:
raise VectorBucketInvalidLength(length=len(vector_bucket_name))
if any(char in vector_bucket_name for char in INVALID_BUCKET_NAME_CHARACTERS):
raise VectorBucketInvalidChars
self.s3vectors_backend.create_vector_bucket(
region=self.region,
vector_bucket_name=vector_bucket_name,
encryption_configuration=encryption_configuration,
)
return EmptyResult()
def delete_vector_bucket(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
self.s3vectors_backend.delete_vector_bucket(
vector_bucket_name=vector_bucket_name,
)
return EmptyResult()
def get_vector_bucket(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
vector_bucket_arn = self._get_param("vectorBucketArn")
bucket = self.s3vectors_backend.get_vector_bucket(
vector_bucket_name=vector_bucket_name,
vector_bucket_arn=vector_bucket_arn,
)
return ActionResult(result={"vectorBucket": bucket})
def list_vector_buckets(self) -> ActionResult:
prefix = self._get_param("prefix")
buckets = self.s3vectors_backend.list_vector_buckets(
prefix=prefix,
)
return ActionResult(result={"vectorBuckets": buckets})
def create_index(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
vector_bucket_arn = self._get_param("vectorBucketArn")
index_name = self._get_param("indexName")
data_type = self._get_param("dataType")
dimension = self._get_param("dimension")
distance_metric = self._get_param("distanceMetric")
if data_type not in ["float32"]:
raise ValidationError(
"1 validation error detected. Value at '/dataType' failed to satisfy constraint: Member must satisfy enum value set: [float32]"
)
if dimension < 1 or dimension >= 4096:
raise ValidationError(
"1 validation error detected. Value at '/dimension' failed to satisfy constraint: Member must be between 1 and 4096, inclusive"
)
if distance_metric not in ["euclidean", "cosine"]:
raise ValidationError(
"1 validation error detected. Value at '/distanceMetric' failed to satisfy constraint: Member must satisfy enum value set: [euclidean, cosine]"
)
self.s3vectors_backend.create_index(
vector_bucket_name=vector_bucket_name,
vector_bucket_arn=vector_bucket_arn,
index_name=index_name,
data_type=data_type,
dimension=dimension,
distance_metric=distance_metric,
)
return EmptyResult()
def delete_index(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
index_name = self._get_param("indexName")
index_arn = self._get_param("indexArn")
self.s3vectors_backend.delete_index(
vector_bucket_name=vector_bucket_name,
index_name=index_name,
index_arn=index_arn,
)
return EmptyResult()
def get_index(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
index_name = self._get_param("indexName")
index_arn = self._get_param("indexArn")
if vector_bucket_name and index_arn:
raise ValidationError(
"Must specify either indexArn or both vectorBucketName and indexName"
)
index = self.s3vectors_backend.get_index(
vector_bucket_name=vector_bucket_name,
index_name=index_name,
index_arn=index_arn,
)
return ActionResult(result={"index": index})
def list_indexes(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
vector_bucket_arn = self._get_param("vectorBucketArn")
if vector_bucket_name and vector_bucket_arn:
raise ValidationError(
"Must specify either vectorBucketName or vectorBucketArn but not both"
)
indexes = self.s3vectors_backend.list_indexes(
vector_bucket_name=vector_bucket_name,
vector_bucket_arn=vector_bucket_arn,
)
return ActionResult(result={"indexes": indexes})
def delete_vector_bucket_policy(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
vector_bucket_arn = self._get_param("vectorBucketArn")
if vector_bucket_name and vector_bucket_arn:
raise ValidationError(
"Must specify either vectorBucketName or vectorBucketArn but not both"
)
self.s3vectors_backend.delete_vector_bucket_policy(
vector_bucket_name=vector_bucket_name,
vector_bucket_arn=vector_bucket_arn,
)
return EmptyResult()
def get_vector_bucket_policy(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
vector_bucket_arn = self._get_param("vectorBucketArn")
if vector_bucket_name and vector_bucket_arn:
raise ValidationError(
"Must specify either vectorBucketName or vectorBucketArn but not both"
)
policy = self.s3vectors_backend.get_vector_bucket_policy(
vector_bucket_name=vector_bucket_name,
vector_bucket_arn=vector_bucket_arn,
)
return ActionResult(result={"policy": policy})
def put_vector_bucket_policy(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
vector_bucket_arn = self._get_param("vectorBucketArn")
if vector_bucket_name and vector_bucket_arn:
raise ValidationError(
"Must specify either vectorBucketName or vectorBucketArn but not both"
)
vector_bucket_policy = self._get_param("policy")
self.s3vectors_backend.put_vector_bucket_policy(
vector_bucket_name=vector_bucket_name,
vector_bucket_arn=vector_bucket_arn,
policy=vector_bucket_policy,
)
return EmptyResult()
def put_vectors(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
index_arn = self._get_param("indexArn")
index_name = self._get_param("indexName")
self._validate_index_params(index_arn, index_name, vector_bucket_name)
vectors = self._get_param("vectors")
self.s3vectors_backend.put_vectors(
vector_bucket_name=vector_bucket_name,
index_arn=index_arn,
index_name=index_name,
vectors=vectors,
)
return EmptyResult()
def get_vectors(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
index_arn = self._get_param("indexArn")
index_name = self._get_param("indexName")
self._validate_index_params(index_arn, index_name, vector_bucket_name)
keys = self._get_param("keys")
return_data = self._get_bool_param("returnData", False)
return_metadata = self._get_bool_param("returnMetadata", False)
vectors = self.s3vectors_backend.get_vectors(
vector_bucket_name=vector_bucket_name,
index_arn=index_arn,
index_name=index_name,
keys=keys,
)
response = [
v.to_dict(return_data, return_metadata=return_metadata) for v in vectors
]
return ActionResult(result={"vectors": response})
def list_vectors(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
index_arn = self._get_param("indexArn")
index_name = self._get_param("indexName")
self._validate_index_params(index_arn, index_name, vector_bucket_name)
return_data = self._get_bool_param("returnData", False)
return_metadata = self._get_bool_param("returnMetadata", False)
vectors = self.s3vectors_backend.list_vectors(
vector_bucket_name=vector_bucket_name,
index_arn=index_arn,
index_name=index_name,
)
response = [
v.to_dict(return_data, return_metadata=return_metadata) for v in vectors
]
return ActionResult(result={"vectors": response})
def delete_vectors(self) -> ActionResult:
vector_bucket_name = self._get_param("vectorBucketName")
index_arn = self._get_param("indexArn")
index_name = self._get_param("indexName")
self._validate_index_params(index_arn, index_name, vector_bucket_name)
keys = self._get_param("keys")
self.s3vectors_backend.delete_vectors(
vector_bucket_name=vector_bucket_name,
index_arn=index_arn,
index_name=index_name,
keys=keys,
)
return EmptyResult()
def _validate_index_params(
self, index_arn: str, index_name: str, vector_bucket_name: str
) -> None:
if vector_bucket_name and index_name and not index_arn:
return # Valid
elif index_arn and not vector_bucket_name and not index_name:
return # Valid
raise ValidationError(
"Must specify either indexArn or both vectorBucketName and indexName"
)
|
