langchain_community.vectorstores.infinispanvs
.InfinispanVS¶
- class langchain_community.vectorstores.infinispanvs.InfinispanVS(embedding: Optional[Embeddings] = None, ids: Optional[List[str]] = None, **kwargs: Any)[source]¶
Infinispan 向量存储接口。
此类公开了将 Infinispan 作为向量存储的方法。它依赖于 Infinispan 类(如下所示),该类负责与服务器的 REST 接口。
示例
- … code-block:: python
from langchain_community.vectorstores import InfinispanVS from mymodels import RGBEmbeddings … vectorDb = InfinispanVS.from_documents(docs,
embedding=RGBEmbeddings(), output_fields=[“texture”, “color”], lambda_key=lambda text,meta: str(meta[“_key”]), lambda_content=lambda item: item[“color”])
或者,如果填充存储之前需要初步设置,则可以创建空的 InfinispanVS 实例
- … code-block:: python
from langchain_community.vectorstores import InfinispanVS from mymodels import RGBEmbeddings … ispnVS = InfinispanVS() # 在此处配置 Infinispan # 例如,创建缓存和模式
# 然后填充存储 vectorDb = InfinispanVS.from_documents(docs,
embedding=RGBEmbeddings(), output_fields: [“texture”, “color”], lambda_key: lambda text,meta: str(meta[“_key”]), lambda_content: lambda item: item[“color”]})
属性
embeddings
如果可用,访问查询嵌入对象。
方法
__init__
([embedding, ids])aadd_documents
(documents, **kwargs)异步地通过嵌入运行更多文档并将它们添加到向量存储中。
aadd_texts
(texts[, metadatas])异步地通过嵌入运行更多文本并将它们添加到向量存储中。
add_documents
(documents, **kwargs)在向量存储中添加或更新文档。
add_texts
(texts[, metadatas, last_vector])通过嵌入运行更多文本并将它们添加到向量存储中。
adelete
([ids])异步地按向量 ID 或其他条件删除。
afrom_documents
(documents, embedding, **kwargs)异步地从文档和嵌入初始化并返回 VectorStore。
afrom_texts
(texts, embedding[, metadatas])异步地从文本和嵌入初始化并返回 VectorStore。
aget_by_ids
(ids, /)异步地按 ID 获取文档。
amax_marginal_relevance_search
(query[, k, ...])异步地返回使用最大边际相关性选择的文档。
异步地返回使用最大边际相关性选择的文档。
as_retriever
(**kwargs)返回从该 VectorStore 初始化的 VectorStoreRetriever。
asearch
(query, search_type, **kwargs)异步地返回使用指定搜索类型与查询最相似的文档。
asimilarity_search
(query[, k])异步地返回与查询最相似的文档。
asimilarity_search_by_vector
(embedding[, k])异步地返回与嵌入向量最相似的文档。
异步地返回文档和相关性分数,范围为 [0, 1]。
asimilarity_search_with_score
(*args, **kwargs)异步地运行带距离的相似性搜索。
astreaming_upsert
(items, /, batch_size, **kwargs)aupsert
(items, /, **kwargs)清除向量数据库的缓存 :returns: 包含操作结果的 http 响应
cache_create
([config])为向量数据库创建缓存 :param config: 缓存的配置。
删除向量数据库的缓存 :returns: 包含操作结果的 http 响应
检查缓存是否存在 :returns: 如果存在则为 true
清除向量数据库的索引 :returns: 包含操作结果的 http 响应
为向量数据库重建索引 :returns: 包含操作结果的 http 响应
configure
(metadata, dimension)delete
([ids])按向量 ID 或其他条件删除。
from_documents
(documents, embedding, **kwargs)返回从文档和嵌入初始化的 VectorStore。
from_texts
(texts, embedding[, metadatas, ...])返回从文本和嵌入初始化的 VectorStore。
get_by_ids
(ids, /)按 ID 获取文档。
max_marginal_relevance_search
(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
schema_builder
(templ, dimension)schema_create
(proto)部署向量数据库的模式 :param proto: protobuf 模式 :type proto: str
删除向量数据库的模式 :returns: 包含操作结果的 http 响应
search
(query, search_type, **kwargs)返回使用指定搜索类型与查询最相似的文档。
similarity_search
(query[, k])返回与查询最相似的文档。
similarity_search_by_vector
(embedding[, k])返回与嵌入向量最相似的文档。
返回文档和相关性分数,范围为 [0, 1]。
similarity_search_with_score
(query[, k])对查询字符串执行搜索,并返回带分数的結果。
similarity_search_with_score_by_vector
(embedding)返回与嵌入向量最相似的文档。
streaming_upsert
(items, /, batch_size, **kwargs)upsert
(items, /, **kwargs)- 参数
embedding (Optional[Embeddings]) –
ids (Optional[List[str]]) –
kwargs (Any) –
- __init__(embedding: Optional[Embeddings] = None, ids: Optional[List[str]] = None, **kwargs: Any)[source]¶
- 参数
embedding (Optional[Embeddings]) –
ids (Optional[List[str]]) –
kwargs (Any) –
- async aadd_documents(documents: List[Document], **kwargs: Any) List[str] ¶
异步地通过嵌入运行更多文档并将它们添加到向量存储中。
- 参数
documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 额外的关键字参数。
- Returns
添加文本的 ID 列表。
- Raises
ValueError – 如果 ID 的数量与文档的数量不匹配。
- Return type
List[str]
- async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) List[str] ¶
异步地通过嵌入运行更多文本并将它们添加到向量存储中。
- 参数
texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
**kwargs (Any) – 向量存储特定的参数。
- Returns
从将文本添加到向量存储中获取的 id 列表。
- Raises
ValueError – 如果元数据的数量与文本的数量不匹配。
ValueError – 如果 ID 的数量与文本的数量不匹配。
- Return type
List[str]
- add_documents(documents: List[Document], **kwargs: Any) List[str] ¶
在向量存储中添加或更新文档。
- 参数
documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 额外的关键字参数。如果 kwargs 包含 ids 并且 documents 包含 ids,则 kwargs 中的 ids 将优先。
- Returns
添加文本的 ID 列表。
- Raises
ValueError – 如果 ID 的数量与文档的数量不匹配。
- Return type
List[str]
- add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, last_vector: Optional[List[float]] = None, **kwargs: Any) List[str] [source]¶
通过嵌入运行更多文本并将它们添加到向量存储中。
- 参数
texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
**kwargs (Any) – 向量存储特定的参数。kwargs 之一应该是 ids,它是与文本关联的 id 列表。
last_vector (Optional[List[float]]) –
**kwargs –
- Returns
从将文本添加到向量存储中获取的 id 列表。
- Raises
ValueError – 如果元数据的数量与文本的数量不匹配。
ValueError – 如果 ID 的数量与文本的数量不匹配。
- Return type
List[str]
- async adelete(ids: Optional[List[str]] = None, **kwargs: Any) Optional[bool] ¶
异步地按向量 ID 或其他条件删除。
- 参数
ids (Optional[List[str]]) – 要删除的 id 列表。如果为 None,则删除所有。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键字参数。
- Returns
如果删除成功,则为 True,否则为 False,如果未实现,则为 None。
- Return type
Optional[bool]
- async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) VST ¶
异步地从文档和嵌入初始化并返回 VectorStore。
- 参数
documents (List[Document]) – 要添加到向量存储的文档列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 额外的关键字参数。
- Returns
从文档和嵌入初始化的 VectorStore。
- Return type
- async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) VST ¶
异步地从文本和嵌入初始化并返回 VectorStore。
- 参数
texts (List[str]) – 要添加到向量存储的文本列表。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
kwargs (Any) – 额外的关键字参数。
- Returns
从文本和嵌入初始化的 VectorStore。
- Return type
- async aget_by_ids(ids: Sequence[str], /) List[Document] ¶
异步地按 ID 获取文档。
返回的文档应设置 ID 字段为向量存储中文档的 ID。
如果某些 ID 未找到或存在重复 ID,则返回的文档可能少于请求的数量。
用户不应假定返回文档的顺序与输入 ID 的顺序匹配。相反,用户应依赖返回文档的 ID 字段。
如果没有找到某些 ID 对应的文档,此方法不应引发异常。
- 参数
ids (Sequence[str]) – 要检索的 ID 列表。
- Returns
文档列表。
- Return type
List[Document]
0.2.11 版本新增。
- async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
异步地返回使用最大边际相关性选择的文档。
最大边际相关性(MMR)在查询相似性和所选文档的多样性之间进行优化。
- 参数
query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字,决定结果多样性的程度,0 表示最大多样性,1 表示最小多样性。默认为 0.5。
kwargs (Any) –
- Returns
通过最大边际相关性选择的文档列表。
- Return type
List[Document]
- async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
异步地返回使用最大边际相关性选择的文档。
最大边际相关性(MMR)在查询相似性和所选文档的多样性之间进行优化。
- 参数
embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字,决定结果多样性的程度,0 表示最大多样性,1 表示最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
通过最大边际相关性选择的文档列表。
- Return type
List[Document]
- as_retriever(**kwargs: Any) VectorStoreRetriever ¶
返回从该 VectorStore 初始化的 VectorStoreRetriever。
- 参数
**kwargs (Any) –
传递给搜索函数的关键字参数。可以包括:search_type (Optional[str]): 定义
Retriever 应执行的搜索类型。可以是 “similarity”(默认)、“mmr” 或 “similarity_score_threshold”。
- search_kwargs (Optional[Dict]): 传递给
- 搜索函数的关键字参数。可以包括如下内容:
k: 要返回的文档数量 (默认: 4) score_threshold: 相似度分数阈值的最小相关性阈值
对于 similarity_score_threshold
- fetch_k: 要传递给 MMR 算法的文档数量
(默认: 20)
- lambda_mult: MMR 返回结果的多样性;
1 表示最小多样性,0 表示最大多样性。(默认: 0.5)
filter: 按文档元数据筛选
- Returns
VectorStore 的 Retriever 类。
- Return type
示例
# Retrieve more documents with higher diversity # Useful if your dataset has many similar documents docsearch.as_retriever( search_type="mmr", search_kwargs={'k': 6, 'lambda_mult': 0.25} ) # Fetch more documents for the MMR algorithm to consider # But only return the top 5 docsearch.as_retriever( search_type="mmr", search_kwargs={'k': 5, 'fetch_k': 50} ) # Only retrieve documents that have a relevance score # Above a certain threshold docsearch.as_retriever( search_type="similarity_score_threshold", search_kwargs={'score_threshold': 0.8} ) # Only get the single most similar document from the dataset docsearch.as_retriever(search_kwargs={'k': 1}) # Use a filter to only retrieve documents from a specific paper docsearch.as_retriever( search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}} )
- async asearch(query: str, search_type: str, **kwargs: Any) List[Document] ¶
异步地返回使用指定搜索类型与查询最相似的文档。
- 参数
query (str) – 输入文本。
search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
与查询最相似的文档列表。
- Raises
ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一,则抛出 ValueError 异常。
- Return type
List[Document]
- async asimilarity_search(query: str, k: int = 4, **kwargs: Any) List[Document] ¶
异步地返回与查询最相似的文档。
- 参数
query (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
与查询最相似的文档列表。
- Return type
List[Document]
- async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) List[Document] ¶
异步地返回与嵌入向量最相似的文档。
- 参数
embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
与查询向量最相似的文档列表。
- Return type
List[Document]
- async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) List[Tuple[Document, float]] ¶
异步地返回文档和相关性分数,范围为 [0, 1]。
0 表示不相似,1 表示最相似。
- 参数
query (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似性搜索的 kwargs。应包括:score_threshold: 可选,介于 0 到 1 之间的浮点值,用于
过滤检索到的文档结果集
- Returns
(文档,相似度分数)元组列表
- Return type
List[Tuple[Document, float]]
- async asimilarity_search_with_score(*args: Any, **kwargs: Any) List[Tuple[Document, float]] ¶
异步地运行带距离的相似性搜索。
- 参数
*args (Any) – 传递给搜索方法的参数。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
(文档,相似度分数)元组列表。
- Return type
List[Tuple[Document, float]]
- astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) AsyncIterator[UpsertResponse] ¶
Beta 版本
在 0.2.11 版本中添加。API 可能会发生变化。
以流式方式更新文档。streaming_upsert 的异步版本。
- 参数
items (AsyncIterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每次批量更新的大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。(例如,索引的超时时间、重试策略等)kwargs 不应包含 ID,以避免语义模糊。相反,ID 应作为 Document 对象的一部分提供。
- Yields
UpsertResponse – 一个响应对象,其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表,以及未能添加或更新的 ID 列表。
- Return type
AsyncIterator[UpsertResponse]
0.2.11 版本新增。
- async aupsert(items: Sequence[Document], /, **kwargs: Any) UpsertResponse ¶
Beta 版本
在 0.2.11 版本中添加。API 可能会发生变化。
在向量存储中添加或更新文档。upsert 的异步版本。
如果提供了 Document 对象的 ID 字段,则 upsert 功能应使用该字段。如果未提供 ID,则 upsert 方法可以自由地为文档生成 ID。
当指定了 ID 且文档已存在于向量存储中时,upsert 方法应使用新数据更新文档。如果文档不存在,则 upsert 方法应将文档添加到向量存储中。
- 参数
items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs (Any) – 额外的关键字参数。
- Returns
一个响应对象,其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表,以及未能添加或更新的 ID 列表。
- Return type
0.2.11 版本新增。
- cache_create(config: str = '') Response [source]¶
为向量数据库创建缓存 :param config: 缓存的配置。 :type config: str
- Returns
包含操作结果的 http Response
- 参数
config (str) –
- Return type
Response
- configure(metadata: dict, dimension: int) None [source]¶
- 参数
metadata (dict) –
dimension (int) –
- Return type
None
- delete(ids: Optional[List[str]] = None, **kwargs: Any) Optional[bool] ¶
按向量 ID 或其他条件删除。
- 参数
ids (Optional[List[str]]) – 要删除的 id 列表。如果为 None,则删除所有。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键字参数。
- Returns
如果删除成功,则为 True,否则为 False,如果未实现,则为 None。
- Return type
Optional[bool]
- classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) VST ¶
返回从文档和嵌入初始化的 VectorStore。
- 参数
documents (List[Document]) – 要添加到向量存储的文档列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 额外的关键字参数。
- Returns
从文档和嵌入初始化的 VectorStore。
- Return type
- classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, clear_old: Optional[bool] = True, auto_config: Optional[bool] = True, **kwargs: Any) InfinispanVS [source]¶
返回从文本和嵌入初始化的 VectorStore。
- 参数
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
clear_old (Optional[bool]) –
auto_config (Optional[bool]) –
kwargs (Any) –
- Return type
- get_by_ids(ids: Sequence[str], /) List[Document] ¶
按 ID 获取文档。
返回的文档应设置 ID 字段为向量存储中文档的 ID。
如果某些 ID 未找到或存在重复 ID,则返回的文档可能少于请求的数量。
用户不应假定返回文档的顺序与输入 ID 的顺序匹配。相反,用户应依赖返回文档的 ID 字段。
如果没有找到某些 ID 对应的文档,此方法不应引发异常。
- 参数
ids (Sequence[str]) – 要检索的 ID 列表。
- Returns
文档列表。
- Return type
List[Document]
0.2.11 版本新增。
- max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
返回使用最大边际相关性选择的文档。
最大边际相关性(MMR)在查询相似性和所选文档的多样性之间进行优化。
- 参数
query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字,决定结果多样性的程度,0 表示最大多样性,1 表示最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
通过最大边际相关性选择的文档列表。
- Return type
List[Document]
- max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
返回使用最大边际相关性选择的文档。
最大边际相关性(MMR)在查询相似性和所选文档的多样性之间进行优化。
- 参数
embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字,决定结果多样性的程度,0 表示最大多样性,1 表示最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
通过最大边际相关性选择的文档列表。
- Return type
List[Document]
- schema_builder(templ: dict, dimension: int) str [source]¶
- 参数
templ (dict) –
dimension (int) –
- Return type
str
- schema_create(proto: str) Response [source]¶
部署向量数据库的模式 :param proto: protobuf 模式 :type proto: str
- Returns
包含操作结果的 http Response
- 参数
proto (str) –
- Return type
Response
- search(query: str, search_type: str, **kwargs: Any) List[Document] ¶
返回使用指定搜索类型与查询最相似的文档。
- 参数
query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
与查询最相似的文档列表。
- Raises
ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一,则抛出 ValueError 异常。
- Return type
List[Document]
- similarity_search(query: str, k: int = 4, **kwargs: Any) List[Document] [source]¶
返回与查询最相似的文档。
- 参数
query (str) –
k (int) –
kwargs (Any) –
- Return type
List[Document]
- similarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) List[Document] [source]¶
返回与嵌入向量最相似的文档。
- 参数
embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns
与查询向量最相似的文档列表。
- Return type
List[Document]
- similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) List[Tuple[Document, float]] ¶
返回文档和相关性分数,范围为 [0, 1]。
0 表示不相似,1 表示最相似。
- 参数
query (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似性搜索的 kwargs。应包括:score_threshold: 可选,介于 0 到 1 之间的浮点值,用于
过滤检索到的文档结果集。
- Returns
(文档,相似度分数)元组列表。
- Return type
List[Tuple[Document, float]]
- similarity_search_with_score(query: str, k: int = 4, **kwargs: Any) List[Tuple[Document, float]] [source]¶
对查询字符串执行搜索,并返回带分数的結果。
- 参数
query (str) – 正在搜索的文本。
k (int, optional) – 返回结果的数量。默认为 4。
kwargs (Any) –
- Returns
List[Tuple[Document, float]]
- Return type
List[Tuple[Document, float]]
- similarity_search_with_score_by_vector(embedding: List[float], k: int = 4) List[Tuple[Document, float]] [source]¶
返回与嵌入向量最相似的文档。
- 参数
embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
- Returns
与查询向量最相似的(文档,分数)对列表。
- Return type
List[Tuple[Document, float]]
- streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) Iterator[UpsertResponse] ¶
Beta 版本
在 0.2.11 版本中添加。API 可能会发生变化。
以流式方式更新文档。
- 参数
items (Iterable[Document]) – 要添加到向量存储的可迭代文档。
batch_size (int) – 每次批量更新的大小。
kwargs (Any) – 额外的关键字参数。 kwargs 应该只包含所有文档通用的参数。(例如,索引超时,重试策略等)kwargs 不应包含 ids 以避免语义模糊。相反,ID 应该作为 Document 对象的一部分提供。
- Yields
UpsertResponse – 一个响应对象,其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表,以及未能添加或更新的 ID 列表。
- Return type
Iterator[UpsertResponse]
0.2.11 版本新增。
- upsert(items: Sequence[Document], /, **kwargs: Any) UpsertResponse ¶
Beta 版本
在 0.2.11 版本中添加。API 可能会发生变化。
在向量存储中添加或更新文档。
如果提供了 Document 对象的 ID 字段,则 upsert 功能应使用该字段。如果未提供 ID,则 upsert 方法可以自由地为文档生成 ID。
当指定了 ID 且文档已存在于向量存储中时,upsert 方法应使用新数据更新文档。如果文档不存在,则 upsert 方法应将文档添加到向量存储中。
- 参数
items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs (Any) – 额外的关键字参数。
- Returns
一个响应对象,其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表,以及未能添加或更新的 ID 列表。
- Return type
0.2.11 版本新增。