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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334 | class RocksetVectorStore(BasePydanticVectorStore):
"""Rockset向量存储。
示例:
`pip install llama-index-vector-stores-rocksetdb`
```python
from llama_index.vector_stores.rocksetdb import RocksetVectorStore
# 使用必要的配置设置RocksetVectorStore
vector_store = RocksetVectorStore(
collection="my_collection",
api_key="your_rockset_api_key",
api_server="https://api.use1a1.rockset.com",
embedding_col="my_embedding",
metadata_col="node",
distance_func=RocksetVectorStore.DistanceFunc.DOT_PRODUCT
)
```"""
stores_text: bool = True
is_embedding_query: bool = True
flat_metadata: bool = False
class DistanceFunc(Enum):
COSINE_SIM = "COSINE_SIM"
EUCLIDEAN_DIST = "EUCLIDEAN_DIST"
DOT_PRODUCT = "DOT_PRODUCT"
rockset: ModuleType
rs: Any
workspace: str
collection: str
text_key: str
embedding_col: str
metadata_col: str
distance_func: DistanceFunc
distance_order: str
def __init__(
self,
collection: str,
client: Any | None = None,
text_key: str = DEFAULT_TEXT_KEY,
embedding_col: str = DEFAULT_EMBEDDING_KEY,
metadata_col: str = "metadata",
workspace: str = "commons",
api_server: str | None = None,
api_key: str | None = None,
distance_func: DistanceFunc = DistanceFunc.COSINE_SIM,
) -> None:
"""Rockset Vector Store 数据容器。
Args:
collection (str): 向量集合的名称
client (Optional[Any]): Rockset 客户端对象
text_key (str): 节点文本的键
(默认值: llama_index.core.vector_stores.utils.DEFAULT_TEXT_KEY)
embedding_col (str): 包含嵌入的数据库列
(默认值: llama_index.core.vector_stores.utils.DEFAULT_EMBEDDING_KEY))
metadata_col (str): 包含节点元数据的数据库列
(默认值: "metadata")
workspace (str): 包含向量集合的工作空间
(默认值: "commons")
api_server (Optional[str]): 要使用的 Rockset API 服务器
api_key (Optional[str]): 要使用的 Rockset API 密钥
distance_func (RocksetVectorStore.DistanceFunc): 用于衡量向量关系的度量标准
(默认值: RocksetVectorStore.DistanceFunc.COSINE_SIM)
"""
super().__init__(
rockset=_get_rockset(),
rs=_get_client(api_key, api_server, client),
collection=collection,
text_key=text_key,
embedding_col=embedding_col,
metadata_col=metadata_col,
workspace=workspace,
distance_func=distance_func,
distance_order=(
"ASC" if distance_func is distance_func.EUCLIDEAN_DIST else "DESC"
),
)
try:
self.rs.set_application("llama_index")
except AttributeError:
# set_application method does not exist.
# rockset version < 2.1.0
pass
@classmethod
def class_name(cls) -> str:
return "RocksetVectorStore"
@property
def client(self) -> Any:
return self.rs
def add(self, nodes: List[BaseNode], **add_kwargs: Any) -> List[str]:
"""存储集合中的向量。
Args:
nodes（List[BaseNode]）：带有嵌入的节点列表
Returns:
存储的节点ID（List[str])
"""
return [
row["_id"]
for row in self.rs.Documents.add_documents(
collection=self.collection,
workspace=self.workspace,
data=[
{
self.embedding_col: node.get_embedding(),
"_id": node.node_id,
self.metadata_col: node_to_metadata_dict(
node, text_field=self.text_key
),
}
for node in nodes
],
).data
]
def delete(self, ref_doc_id: str, **delete_kwargs: Any) -> None:
"""删除存储在集合中的节点，根据它们的ref_doc_id。
Args:
ref_doc_id（str）：要删除其节点的文档的ref_doc_id
"""
self.rs.Documents.delete_documents(
collection=self.collection,
workspace=self.workspace,
data=[
self.rockset.models.DeleteDocumentsRequestData(id=row["_id"])
for row in self.rs.sql(
f"""
SELECT
_id
FROM
"{self.workspace}"."{self.collection}" x
WHERE
x.{self.metadata_col}.ref_doc_id=:ref_doc_id
""",
params={"ref_doc_id": ref_doc_id},
).results
],
)
def query(self, query: VectorStoreQuery, **kwargs: Any) -> VectorStoreQueryResult:
"""获取与查询相关的节点。
Args:
query（llama_index.core.vector_stores.types.VectorStoreQuery）：查询
similarity_col（可选[str]）：选择余弦相似度的列（默认值：“_similarity”）
Returns:
查询结果（llama_index.core.vector_stores.types.VectorStoreQueryResult）
"""
similarity_col = kwargs.get("similarity_col", "_similarity")
res = self.rs.sql(
f"""
SELECT
_id,
{self.metadata_col}
{
f''', {self.distance_func.value}(
{query.query_embedding},
{self.embedding_col}
)
AS {similarity_col}'''
if query.query_embedding
else ''
}
FROM
"{self.workspace}"."{self.collection}" x
{"WHERE" if query.node_ids or (query.filters and len(query.filters.legacy_filters()) > 0) else ""} {
f'''({
' OR '.join([
f"_id='{node_id}'" for node_id in query.node_ids
])
})''' if query.node_ids else ""
} {
f''' {'AND' if query.node_ids else ''} ({
' AND '.join([
f"x.{self.metadata_col}.{filter.key}=:{filter.key}"
for filter
in query.filters.legacy_filters()
])
})''' if query.filters else ""
}
ORDER BY
{similarity_col} {self.distance_order}
LIMIT
{query.similarity_top_k}
""",
params=(
{filter.key: filter.value for filter in query.filters.legacy_filters()}
if query.filters
else {}
),
)
similarities: List[float] | None = [] if query.query_embedding else None
nodes, ids = [], []
for row in res.results:
if similarities is not None:
similarities.append(row[similarity_col])
nodes.append(metadata_dict_to_node(row[self.metadata_col]))
ids.append(row["_id"])
return VectorStoreQueryResult(similarities=similarities, nodes=nodes, ids=ids)
@classmethod
def with_new_collection(
cls: Type[T], dimensions: int | None = None, **rockset_vector_store_args: Any
) -> RocksetVectorStore:
"""创建一个新的集合并返回其RocksetVectorStore。
Args:
dimensions（可选[int]）：要在集合的摄入转换中强制执行的向量长度。默认情况下，集合不会执行向量强制。
collection（str）：要创建的集合的名称
client（可选[Any]）：Rockset客户端对象
workspace（str）：包含要创建的集合的工作区（默认值为“commons”）
text_key（str）：节点文本的键（默认值为llama_index.core.vector_stores.utils.DEFAULT_TEXT_KEY）
embedding_col（str）：包含嵌入的DB列（默认值为llama_index.core.vector_stores.utils.DEFAULT_EMBEDDING_KEY）
metadata_col（str）：包含节点元数据的DB列（默认值为“metadata”）
api_server（可选[str]）：要使用的Rockset API服务器
api_key（可选[str]）：要使用的Rockset API密钥
distance_func（RocksetVectorStore.DistanceFunc）：用于测量向量关系的度量标准
（默认值为RocksetVectorStore.DistanceFunc.COSINE_SIM）
"""
client = rockset_vector_store_args["client"] = _get_client(
api_key=rockset_vector_store_args.get("api_key"),
api_server=rockset_vector_store_args.get("api_server"),
client=rockset_vector_store_args.get("client"),
)
collection_args = {
"workspace": rockset_vector_store_args.get("workspace", "commons"),
"name": rockset_vector_store_args.get("collection"),
}
embeddings_col = rockset_vector_store_args.get(
"embeddings_col", DEFAULT_EMBEDDING_KEY
)
if dimensions:
collection_args[
"field_mapping_query"
] = _get_rockset().model.field_mapping_query.FieldMappingQuery(
sql=f"""
SELECT
*, VECTOR_ENFORCE(
{embeddings_col},
{dimensions},
'float'
) AS {embeddings_col}
FROM
_input
"""
)
client.Collections.create_s3_collection(**collection_args) # create collection
while (
client.Collections.get(
collection=rockset_vector_store_args.get("collection")
).data.status
!= "READY"
): # wait until collection is ready
sleep(0.1)
# TODO: add async, non-blocking method collection creation
return cls(
**dict(
filter( # filter out None args
lambda arg: arg[1] is not None, rockset_vector_store_args.items()
)
)
)
|