`langchain_community.vectorstores.pgvecto_rs`.PGVecto_rs¶

class langchain_community.vectorstores.pgvecto_rs.PGVecto_rs(embedding: Embeddings, dimension: int, db_url: str, collection_name: str, new_table: bool = False)[source]¶

由 pgvecto_rs 支持的向量数据库。

初始化 PGVecto_rs 向量数据库。

参数

embedding (Embeddings) – 要使用的嵌入 (Embeddings)。
dimension (int) – 嵌入 (embeddings) 的维度。
db_url (str) – 数据库 URL。
collection_name (str) – 集合 (collection) 的名称。
new_table (bool) – 是否创建新表或连接到现有表。
True (如果) –
存在 (如果表已存在，则会删除该表如果) –
重新创建。 (然后) –
False. (默认为) –

属性

embeddings

如果可用，则访问查询嵌入 (query embedding) 对象。

方法

`__init__`(embedding, dimension, db_url, ...)	初始化 PGVecto_rs 向量数据库。
`aadd_documents`(documents, **kwargs)	异步地通过嵌入 (embeddings) 运行更多文档，并添加到向量数据库。
`aadd_texts`(texts[, metadatas])	异步地通过嵌入 (embeddings) 运行更多文本，并添加到向量数据库。
`add_documents`(documents, **kwargs)	通过嵌入 (embeddings) 运行更多文档，并添加到向量数据库。
`add_texts`(texts[, metadatas])	通过嵌入 (embeddings) 运行更多文本，并添加到向量数据库。
`adelete`([ids])	异步地通过向量 ID 或其他条件删除。
`afrom_documents`(documents, embedding, **kwargs)	异步地从文档和嵌入 (embeddings) 初始化并返回 VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	异步地从文本和嵌入 (embeddings) 初始化并返回 VectorStore。
`aget_by_ids`(ids, /)	异步地通过 ID 获取文档。
`amax_marginal_relevance_search`(query[, k, ...])	异步地返回使用最大边际相关性 (maximal marginal relevance) 选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	异步地返回使用最大边际相关性 (maximal marginal relevance) 选择的文档。
`as_retriever`(**kwargs)	返回由此 VectorStore 初始化的 VectorStoreRetriever。
`asearch`(query, search_type, **kwargs)	异步地使用指定的搜索类型返回与查询最相似的文档。
`asimilarity_search`(query[, k])	异步地返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k])	异步地返回与嵌入向量 (embedding vector) 最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	异步地返回文档和 [0, 1] 范围内的相关性得分 (relevance scores)。
`asimilarity_search_with_score`(args, *kwargs)	异步地运行带距离的相似性搜索 (similarity search)。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **kwargs)
`delete`([ids])	通过向量 ID 或其他条件删除。
`from_collection_name`(embedding, db_url, ...)	使用 collection_name 创建新的空向量数据库。
`from_documents`(documents, embedding[, ...])	返回从文档初始化的 VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	返回从文本和可选元数据 (metadatas) 初始化的 VectorStore。
`get_by_ids`(ids, /)	通过 ID 获取文档。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性 (maximal marginal relevance) 选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性 (maximal marginal relevance) 选择的文档。
`search`(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
`similarity_search`(query[, k, distance_func])	返回与查询最相似的文档。
`similarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量 (embedding vector) 最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和 [0, 1] 范围内的相关性得分 (relevance scores)。
`similarity_search_with_score`(query[, k, ...])	运行带距离的相似性搜索 (similarity search)。
`similarity_search_with_score_by_vector`(...)	返回与查询向量最相似的文档，并附带其得分。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

__init__(embedding: Embeddings, dimension: int, db_url: str, collection_name: str, new_table: bool = False) → None[source]¶

初始化 PGVecto_rs 向量数据库。

参数

embedding (Embeddings) – 要使用的嵌入 (Embeddings)。
dimension (int) – 嵌入 (embeddings) 的维度。
db_url (str) – 数据库 URL。
collection_name (str) – 集合 (collection) 的名称。
new_table (bool) – 是否创建新表或连接到现有表。
True (如果) –
存在 (如果表已存在，则会删除该表如果) –
重新创建。 (然后) –
False. (默认为) –

返回类型

None

async aadd_documents(documents: List[Document], **kwargs: Any) → List>[str]¶

异步地通过嵌入 (embeddings) 运行更多文档，并添加到向量数据库。

参数

documents (List[Document]) – 要添加到向量数据库的文档列表。
kwargs (Any) – 额外的关键字参数。

返回

添加的文本的 ID 列表。

引发

ValueError – 如果 ID 的数量与文档的数量不匹配。

返回类型

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List>[dict]] = None, **kwargs: Any) → List>[str]¶

异步地通过嵌入 (embeddings) 运行更多文本，并添加到向量数据库。

参数

texts (Iterable[str]) – 要添加到向量数据库的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据 (metadatas) 列表。默认为 None。
**kwargs (Any) – 向量数据库特定的参数。

返回

将文本添加到向量数据库后返回的 ID 列表。

引发

ValueError – 如果元数据 (metadatas) 的数量与文本的数量不匹配。
ValueError – 如果 ID 的数量与文本的数量不匹配。

返回类型

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List>[str][source]¶

通过嵌入 (embeddings) 运行更多文档，并添加到向量数据库。

参数

documents (List[Document]) – 要添加到向量数据库的文档列表。
kwargs (Any) –

返回

添加的文档的 ID 列表。

返回类型

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List>[dict]] = None, **kwargs: Any) → List>[str]¶

通过嵌入 (embeddings) 运行更多文本，并添加到向量数据库。

参数

texts (Iterable[str]) – 要添加到向量数据库的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据 (metadatas) 列表。
kwargs (Any) – 向量数据库特定的参数

返回

添加的文本的 ID 列表。

返回类型

List[str]

async adelete(ids: Optional[List>[str]] = None, **kwargs: Any) → Optional[bool]¶

异步地通过向量 ID 或其他条件删除。

参数

ids (Optional[List[str]]) – 要删除的 ID 列表。如果为 None，则删除所有。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功，则为 True，否则为 False；如果未实现，则为 None。

返回类型

Optional[bool]

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST¶

异步地从文档和嵌入 (embeddings) 初始化并返回 VectorStore。

参数

documents (List[Document]) – 要添加到向量数据库的文档列表。
embedding (Embeddings) – 要使用的嵌入 (Embedding) 函数。
kwargs (Any) – 额外的关键字参数。

返回

从文档和嵌入 (embeddings) 初始化的 VectorStore。

返回类型

VectorStore

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List>[dict]] = None, **kwargs: Any) → VST¶

异步地从文本和嵌入 (embeddings) 初始化并返回 VectorStore。

参数

texts (List[str]) – 要添加到向量数据库的文本列表。
embedding (Embeddings) – 要使用的嵌入 (Embedding) 函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据 (metadatas) 列表。默认为 None。
kwargs (Any) – 额外的关键字参数。

返回

从文本和嵌入 (embeddings) 初始化的 VectorStore。

返回类型

VectorStore

async aget_by_ids(ids: Sequence[str], /) → List>[Document]¶

异步地通过 ID 获取文档。

返回的文档应将其 ID 字段设置为文档在向量数据库中的 ID。

如果某些 ID 未找到或存在重复 ID，则返回的文档可能少于请求的数量。

用户不应假定返回文档的顺序与输入 ID 的顺序匹配。相反，用户应依赖返回文档的 ID 字段。

如果某些 ID 没有找到文档，此方法不应引发异常。

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: 文档列表。
返回类型: 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]¶

异步地返回使用最大边际相关性 (maximal marginal relevance) 选择的文档。

最大边际相关性 (MMR) 优化查询相似性和所选文档之间的多样性。

参数

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为 4。
fetch_k (int) – 获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，决定结果之间多样性的程度，0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
kwargs (Any) –

返回

由最大边际相关性 (MMR) 选择的文档列表。

返回类型

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]¶

异步地返回使用最大边际相关性 (maximal marginal relevance) 选择的文档。

最大边际相关性 (MMR) 优化查询相似性和所选文档之间的多样性。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 返回的文档数量。默认为 4。
fetch_k (int) – 获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，决定结果之间多样性的程度，0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

由最大边际相关性 (MMR) 选择的文档列表。

返回类型

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回由此 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括：search_type (Optional[str]): 定义检索器应执行的搜索类型。可以是 “similarity”（默认）、“mmr” 或 “similarity_score_threshold”。

检索器应执行的搜索类型。可以是 “similarity”（默认）、“mmr” 或 “similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给

搜索函数的关键字参数。可以包括：

k: 返回的文档数量（默认值：4） score_threshold: 相似度分数阈值的最小相关性阈值

相似度分数阈值的最小相关性阈值

fetch_k: 传递给 MMR 算法的文档数量: (默认值：20)
lambda_mult: MMR 返回结果的多样性；: 1 表示最小多样性，0 表示最大多样性。（默认值：0.5）

filter: 按文档元数据过滤

返回

VectorStore 的检索器类。

返回类型

VectorStoreRetriever

示例

# 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) – 传递给搜索方法的参数。

返回

与查询最相似的文档列表。

引发

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

返回类型

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document]¶

异步地返回与查询最相似的文档。

参数

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

与查询最相似的文档列表。

返回类型

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]¶

异步地返回与嵌入向量 (embedding vector) 最相似的文档。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

与查询向量最相似的文档列表。

返回类型

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

异步地返回文档和 [0, 1] 范围内的相关性得分 (relevance scores)。

0 表示不相似，1 表示最相似。

参数

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为 4。
**kwargs (Any) –
传递给相似性搜索的 kwargs。应包括：score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

过滤检索到的文档结果集

返回

（文档，相似度分数）元组列表

返回类型

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

异步地运行带距离的相似性搜索 (similarity search)。

参数

*args (Any) – 传递给搜索方法的参数。
**kwargs (Any) – 传递给搜索方法的参数。

返回

（文档，相似度分数）元组列表。

返回类型

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式 Upsert 文档。streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每次 Upsert 的批量大小。
kwargs (Any) – 额外的关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引的超时时间、重试策略等）kwargs 不应包含 IDs 以避免语义模糊。ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到或更新到向量存储的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

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) – 额外的关键字参数。

返回

响应对象，其中包含已成功添加到或更新到向量存储的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增。

delete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]¶

通过向量 ID 或其他条件删除。

参数

ids (Optional[List[str]]) – 要删除的 ID 列表。如果为 None，则删除所有。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功，则为 True，否则为 False；如果未实现，则为 None。

返回类型

Optional[bool]

classmethod from_collection_name(embedding: Embeddings, db_url: str, collection_name: str) → PGVecto_rs[source]¶

使用 collection_name 创建新的空向量存储。或者连接到数据库中已存在的现有向量存储。参数应与创建向量存储时相同。

参数

embedding (Embeddings) –
db_url (str) –
collection_name (str) –

返回类型

PGVecto_rs

classmethod from_documents(documents: List[Document], embedding: Embeddings, db_url: str = '', collection_name: str = '8f56e87d36444400bd6845cb614c29c2', **kwargs: Any) → PGVecto_rs[source]¶

返回从文档初始化的 VectorStore。

参数

documents (List[Document]) –
embedding (Embeddings) –
db_url (str) –
collection_name (str) –
kwargs (Any) –

返回类型

PGVecto_rs

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, db_url: str = '', collection_name: str = '7350b6fbc57d48eebc54d992f1a5b3e4', **kwargs: Any) → PGVecto_rs[source]¶

返回从文本和可选元数据 (metadatas) 初始化的 VectorStore。

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
db_url (str) –
collection_name (str) –
kwargs (Any) –

返回类型

PGVecto_rs

get_by_ids(ids: Sequence[str], /) → List[Document]¶

通过 ID 获取文档。

返回的文档应将其 ID 字段设置为文档在向量数据库中的 ID。

如果某些 ID 未找到或存在重复 ID，则返回的文档可能少于请求的数量。

用户不应假定返回文档的顺序与输入 ID 的顺序匹配。相反，用户应依赖返回文档的 ID 字段。

如果某些 ID 没有找到文档，此方法不应引发异常。

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: 文档列表。
返回类型: 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]¶

返回使用最大边际相关性 (maximal marginal relevance) 选择的文档。

最大边际相关性 (MMR) 优化查询相似性和所选文档之间的多样性。

参数

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为 4。
fetch_k (int) – 获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，决定结果之间多样性的程度，0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

由最大边际相关性 (MMR) 选择的文档列表。

返回类型

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]¶

返回使用最大边际相关性 (maximal marginal relevance) 选择的文档。

最大边际相关性 (MMR) 优化查询相似性和所选文档之间的多样性。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 返回的文档数量。默认为 4。
fetch_k (int) – 获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，决定结果之间多样性的程度，0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

由最大边际相关性 (MMR) 选择的文档列表。

返回类型

List[Document]

search(query: str, search_type: str, **kwargs: Any) → List[Document]¶

使用指定的搜索类型返回与查询最相似的文档。

参数

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回

与查询最相似的文档列表。

引发

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

返回类型

List[Document]

similarity_search(query: str, k: int = 4, distance_func: Literal['sqrt_euclid', 'neg_dot_prod', 'ned_cos'] = 'sqrt_euclid', **kwargs: Any) → List[Document][source]¶

返回与查询最相似的文档。

参数

query (str) –
k (int) –
distance_func (Literal['sqrt_euclid', 'neg_dot_prod', 'ned_cos']) –
kwargs (Any) –

返回类型

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, distance_func: Literal['sqrt_euclid', 'neg_dot_prod', 'ned_cos'] = 'sqrt_euclid', filter: Optional[Any] = None, **kwargs: Any) → List[Document][source]¶

返回与嵌入向量 (embedding vector) 最相似的文档。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。
distance_func (Literal['sqrt_euclid', 'neg_dot_prod', 'ned_cos']) –
filter (Optional[Any]) –
**kwargs –

返回

与查询向量最相似的文档列表。

返回类型

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

返回文档和 [0, 1] 范围内的相关性得分 (relevance scores)。

0 表示不相似，1 表示最相似。

参数

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为 4。
**kwargs (Any) –
传递给相似性搜索的 kwargs。应包括：score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

filter the resulting set of retrieved docs.

返回

（文档，相似度分数）元组列表。

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, distance_func: Literal['sqrt_euclid', 'neg_dot_prod', 'ned_cos'] = 'sqrt_euclid', **kwargs: Any) → List[Tuple[Document, float]][source]¶

运行带距离的相似性搜索 (similarity search)。

参数

*args – Arguments to pass to the search method.
**kwargs (Any) – 传递给搜索方法的参数。
query (str) –
k (int) –
distance_func (Literal['sqrt_euclid', 'neg_dot_prod', 'ned_cos']) –
**kwargs –

返回

（文档，相似度分数）元组列表。

返回类型

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(query_vector: List[float], k: int = 4, distance_func: Literal['sqrt_euclid', 'neg_dot_prod', 'ned_cos'] = 'sqrt_euclid', filter: Union[None, Dict[str, Any], Any] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回与查询向量最相似的文档，并附带其得分。

参数

query_vector (List[float]) –
k (int) –
distance_func (Literal['sqrt_euclid', 'neg_dot_prod', 'ned_cos']) –
filter (Union[None, Dict[str, Any], Any]) –
kwargs (Any) –

返回类型

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) – 每次 Upsert 的批量大小。
kwargs (Any) – 附加关键字参数。 kwargs 应仅包含所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包含 ids 以避免语义模糊。相反，ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到或更新到向量存储的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

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) – 额外的关键字参数。

返回

响应对象，其中包含已成功添加到或更新到向量存储的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增。

Examples using PGVecto_rs¶

PGVecto.rs

langchain_community.vectorstores.pgvecto_rs.PGVecto_rs¶

Examples using PGVecto_rs¶

`langchain_community.vectorstores.pgvecto_rs`.PGVecto_rs¶