`langchain_community.vectorstores.hologres`.Hologres¶

class langchain_community.vectorstores.hologres.Hologres(connection_string: str, embedding_function: Embeddings, ndims: int = 1536, table_name: str = 'langchain_pg_embedding', pre_delete_table: bool = False, logger: Optional[Logger] = None)[source]¶

Hologres API 向量存储。

connection_string 是 Hologres 连接字符串。
embedding_function 任何实现了以下功能的嵌入函数
langchain.embeddings.base.Embeddings 接口。
ndims 是嵌入输出的维度数量。
table_name 是用于存储嵌入和数据的表名。
(默认值：langchain_pg_embedding) - 注意：表将在初始化存储时创建（如果不存在）

因此，请确保用户具有创建表的正确权限。
pre_delete_table 如果为 True，则会删除已存在的表。
（默认值：False）- 用于测试很有用。

属性

embeddings

如果可用，则访问查询嵌入对象。

方法

`__init__`(connection_string, embedding_function)
`aadd_documents`(documents, **kwargs)	异步地通过嵌入运行更多文档，并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	异步地通过嵌入运行更多文本，并添加到向量存储中。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_embeddings`(texts, embeddings, metadatas, ...)	向向量存储添加嵌入。
`add_texts`(texts[, metadatas, ids])	通过嵌入运行更多文本，并添加到向量存储中。
`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, ...])	异步地返回使用最大边际相关性选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	异步地返回使用最大边际相关性选择的文档。
`as_retriever`(**kwargs)	从该 VectorStore 返回初始化的 VectorStoreRetriever。
`asearch`(query, search_type, **kwargs)	异步地返回使用指定搜索类型与查询最相似的文档。
`asimilarity_search`(query[, k])	异步地返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k])	异步地返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	异步地返回范围在 [0, 1] 内的文档和相关性得分。
`asimilarity_search_with_score`(args, *kwargs)	异步地运行带距离的相似性搜索。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **kwargs)
`connection_string_from_db_params`(host, port, ...)	从数据库参数返回连接字符串。
`delete`([ids])	通过向量 ID 或其他条件删除。
`from_documents`(documents, embedding[, ...])	从文档和嵌入初始化并返回 VectorStore。
`from_embeddings`(text_embeddings, embedding)	从原始文档和预生成的嵌入构建 Hologres 包装器。
`from_existing_index`(embedding[, ndims, ...])	获取现有 Hologres 存储的实例。此方法将返回存储的实例，而无需插入任何新的嵌入。
`from_texts`(texts, embedding[, metadatas, ...])	从文本和嵌入初始化并返回 VectorStore。
`get_by_ids`(ids, /)	通过 ID 获取文档。
`get_connection_string`(kwargs)
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回使用指定搜索类型与查询最相似的文档。
`similarity_search`(query[, k, filter])	使用 Hologres 运行带距离的相似性搜索。
`similarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回范围在 [0, 1] 内的文档和相关性得分。
`similarity_search_with_score`(query[, k, filter])	返回与查询最相似的文档。
`similarity_search_with_score_by_vector`(embedding)
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

参数

connection_string (str) –
embedding_function (Embeddings) –
ndims (int) –
table_name (str) –
pre_delete_table (bool) –
logger (Optional[logging.Logger]) –

__init__(connection_string: str, embedding_function: Embeddings, ndims: int = 1536, table_name: str = 'langchain_pg_embedding', pre_delete_table: bool = False, logger: Optional[Logger] = None) → None[source]¶

参数

connection_string (str) –
embedding_function (Embeddings) –
ndims (int) –
table_name (str) –
pre_delete_table (bool) –
logger (Optional[Logger]) –

Return type

None

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

异步地通过嵌入运行更多文档，并添加到向量存储中。

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 附加关键字参数。

返回值

添加文本的 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) – 向量存储特定的参数。

返回值

从将文本添加到向量存储中获取的 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 将优先。

返回值

添加文本的 ID 列表。

Raises

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

Return type

List[str]

add_embeddings(texts: Iterable[str], embeddings: List[List[float]], metadatas: List[dict], ids: List[str], **kwargs: Any) → None[source]¶

向向量存储添加嵌入。

参数

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

Return type

None

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

通过嵌入运行更多文本，并添加到向量存储中。

参数

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

返回值

从将文本添加到向量存储中获取的 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) – 子类可能使用的其他关键字参数。

返回值

如果删除成功，则返回 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) – 附加关键字参数。

返回值

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

Return type

VectorStore (向量存储)

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) – 附加关键字参数。

返回值

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

Return type

VectorStore (向量存储)

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

异步地通过 ID 获取文档。

返回的文档应将其 ID 字段设置为向量存储中文档的 ID。

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

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

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

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

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

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

参数

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

返回值

通过最大边际相关性选择的文档列表。

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

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

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

参数

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

返回值

通过最大边际相关性选择的文档列表。

Return type

List[Document] (文档列表)

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

从该 VectorStore 返回初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括：search_type (Optional[str]): 定义检索器应执行的搜索类型。

可以是 “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: 按文档元数据过滤

返回值

VectorStore 的检索器类。

Return type

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

返回值

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

Raises

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

Return type

List[Document] (文档列表)

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

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

参数

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

返回值

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

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

返回值

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

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 之间的浮点值，用于

过滤检索到的文档结果集

返回值

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

Return type

List[Tuple[Document, float]] (（文档，相似度分数）元组列表)

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

异步地运行带距离的相似性搜索。

参数

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

返回值

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

Return type

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 列表。

Return type

AsyncIterator[UpsertResponse] (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 列表。

Return type

UpsertResponse (Upsert 响应)

0.2.11 版本新增。

classmethod connection_string_from_db_params(host: str, port: int, database: str, user: str, password: str) → str[source]¶

从数据库参数返回连接字符串。

参数

host (str) –
port (int) –
database (str) –
user (str) –
password (str) –

Return type

str (字符串)

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

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

参数

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

返回值

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

Return type

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Embeddings, ndims: int = 1536, table_name: str = 'langchain_pg_embedding', ids: Optional[List[str]] = None, pre_delete_collection: bool = False, **kwargs: Any) → Hologres[source]¶

返回从文档和嵌入初始化的 VectorStore。需要 Hologres 连接字符串 “可以将其作为参数传递，或者设置 HOLOGRES_CONNECTION_STRING 环境变量。通过调用 HologresVector.connection_string_from_db_params 创建连接字符串

参数

documents (List[Document]) –
embedding (Embeddings) –
ndims (int) –
table_name (str) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
kwargs (Any) –

Return type

Hologres

类方法 from_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, metadatas: Optional[List[dict]] = None, ndims: int = 1536, table_name: str = 'langchain_pg_embedding', ids: Optional[List[str]] = None, pre_delete_table: bool = False, **kwargs: Any) → Hologres[source]¶

从原始文档和预生成的嵌入构建 Hologres 包装器。

返回从文档和嵌入初始化的 VectorStore。需要 Hologres 连接字符串 “可以将其作为参数传递，或者设置 HOLOGRES_CONNECTION_STRING 环境变量。通过调用 HologresVector.connection_string_from_db_params 创建连接字符串

示例

from langchain_community.vectorstores import Hologres
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
text_embeddings = embeddings.embed_documents(texts)
text_embedding_pairs = list(zip(texts, text_embeddings))
faiss = Hologres.from_embeddings(text_embedding_pairs, embeddings)

参数

text_embeddings (List[Tuple[str, List[float]]]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
ndims (int) –
table_name (str) –
ids (Optional[List[str]]) –
pre_delete_table (bool) –
kwargs (Any) –

Return type

Hologres

类方法 from_existing_index(embedding: Embeddings, ndims: int = 1536, table_name: str = 'langchain_pg_embedding', pre_delete_table: bool = False, **kwargs: Any) → Hologres[source]¶

获取现有 Hologres 存储的实例。此方法将返回存储的实例，而无需插入任何新的嵌入。

参数

embedding (Embeddings) –
ndims (int) –
table_name (str) –
pre_delete_table (bool) –
kwargs (Any) –

Return type

Hologres

类方法 from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, ndims: int = 1536, table_name: str = 'langchain_pg_embedding', ids: Optional[List[str]] = None, pre_delete_table: bool = False, **kwargs: Any) → Hologres[source]¶

从文本和嵌入向量初始化向量存储。需要 Hologres 连接字符串“可以将其作为参数传递，或设置 HOLOGRES_CONNECTION_STRING 环境变量。通过调用 HologresVector.connection_string_from_db_params 创建连接字符串

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
ndims (int) –
table_name (str) –
ids (Optional[List[str]]) –
pre_delete_table (bool) –
kwargs (Any) –

Return type

Hologres

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

通过 ID 获取文档。

返回的文档应将其 ID 字段设置为向量存储中文档的 ID。

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

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

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

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回值: 文档列表。
Return type: List[Document] (文档列表)

0.2.11 版本新增。

类方法 get_connection_string(kwargs: Dict[str, Any]) → str[source]¶

参数: kwargs (Dict[str, Any]) –
Return type: str (字符串)

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

返回使用最大边际相关性选择的文档。

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

参数

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

返回值

通过最大边际相关性选择的文档列表。

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

返回使用最大边际相关性选择的文档。

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

参数

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

返回值

通过最大边际相关性选择的文档列表。

Return type

List[Document] (文档列表)

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

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

参数

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

返回值

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

Raises

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

Return type

List[Document] (文档列表)

similarity_search(query: str, k: int = 4, filter: Optional[dict] = None, **kwargs: Any) → List[Document][source]¶

使用 Hologres 运行带距离的相似性搜索。

参数

query (str) – 要搜索的查询文本。
k (int) – 返回的结果数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
kwargs (Any) –

返回值

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

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[dict] = None, **kwargs: Any) → List[Document][source]¶

返回与嵌入向量最相似的文档。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
kwargs (Any) –

返回值

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

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 之间的浮点值，用于

过滤检索到的文档结果集。

返回值

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

Return type

List[Tuple[Document, float]] (（文档，相似度分数）元组列表)

similarity_search_with_score(query: str, k: int = 4, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。

返回值

最相似于查询的文档列表以及每个文档的分数

Return type

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶

参数

embedding (List[float]) –
k (int) –
filter (Optional[dict]) –

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) – 每次 upsert 的批次大小。
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) – 附加关键字参数。

返回值

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

Return type

UpsertResponse (Upsert 响应)

0.2.11 版本新增。

langchain_community.vectorstores.hologres.Hologres¶

使用 Hologres 的示例¶

`langchain_community.vectorstores.hologres`.Hologres¶