`langchain_community.vectorstores.elastic_vector_search`.ElasticKnnSearch¶

class langchain_community.vectorstores.elastic_vector_search.ElasticKnnSearch(index_name: str, embedding: Embeddings, es_connection: Optional['Elasticsearch'] = None, es_cloud_id: Optional[str] = None, es_user: Optional[str] = None, es_password: Optional[str] = None, vector_query_field: Optional[str] = 'vector', query_field: Optional[str] = 'text')[source]¶

Deprecated since version 0.0.1: 使用 Use ElasticsearchStore class in langchain-elasticsearch package 代替。

[已弃用] 带有 k-近邻搜索 (k-NN) 向量存储的 Elasticsearch。

建议使用 ElasticsearchStore 代替，它支持元数据过滤、自定义查询检索器以及更多功能！

您可以在 ElasticsearchStore 上阅读更多信息： https://python.langchain.ac.cn/docs/integrations/vectorstores/elasticsearch

它创建一个 Elasticsearch 文本数据索引，可以使用 k-近邻搜索进行搜索。文本数据使用提供的嵌入模型转换为向量嵌入，这些嵌入存储在 Elasticsearch 索引中。

参数

index_name (str) –
embedding (Embeddings) –
es_connection (Optional['Elasticsearch']) –
es_cloud_id (Optional[str]) –
es_user (Optional[str]) –
es_password (Optional[str]) –
vector_query_field (Optional[str]) –
query_field (Optional[str]) –

index_name¶

Elasticsearch 索引的名称。

类型: str

embedding¶

用于将文本数据转换为向量嵌入的嵌入模型。

类型: Embeddings

es_connection¶

现有的 Elasticsearch 连接。

类型: Elasticsearch, 可选

es_cloud_id¶

Elasticsearch Service 部署的 Cloud ID。

类型: str, 可选

es_user¶

Elasticsearch Service 部署的用户名。

类型: str, 可选

es_password¶

Elasticsearch Service 部署的密码。

类型: str, 可选

vector_query_field¶

Elasticsearch 索引中包含向量嵌入的字段名称。

类型: str, 可选

query_field¶

Elasticsearch 索引中包含原始文本数据的字段名称。

类型: str, 可选

用法

>>> from embeddings import Embeddings
>>> embedding = Embeddings.load('glove')
>>> es_search = ElasticKnnSearch('my_index', embedding)
>>> es_search.add_texts(['Hello world!', 'Another text'])
>>> results = es_search.knn_search('Hello')
[(Document(page_content='Hello world!', metadata={}), 0.9)]

属性

embeddings

访问查询嵌入对象（如果可用）。

方法

`__init__`(index_name, embedding[, ...])
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储。
`aadd_texts`(texts[, metadatas])	异步运行更多文本通过嵌入并添加到向量存储。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas, model_id, ...])	将文本列表添加到 Elasticsearch 索引。
`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)
`create_knn_index`(mapping)	在 Elasticsearch 中创建一个新的 k-近邻索引。
`delete`([ids])	通过向量 ID 或其他条件删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的 VectorStore。
`from_texts`(texts, embedding[, metadatas])	创建一个新的 ElasticKnnSearch 实例并将文本列表添加到
`get_by_ids`(ids, /)	按 ID 获取文档。
`knn_hybrid_search`([query, k, query_vector, ...])	在 Elasticsearch 索引上执行混合 k-近邻和文本搜索。
`knn_search`([query, k, query_vector, ...])	在 Elasticsearch 索引上执行 k-近邻搜索。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回与查询最相似的文档，使用指定的搜索类型。
`similarity_search`(query[, k, filter])	传递到 knn_search
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回范围在 [0, 1] 内的文档和相关性得分。
`similarity_search_with_score`(query[, k])	传递到 knn_search including score
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

__init__(index_name: str, embedding: Embeddings, es_connection: Optional['Elasticsearch'] = None, es_cloud_id: Optional[str] = None, es_user: Optional[str] = None, es_password: Optional[str] = None, vector_query_field: Optional[str] = 'vector', query_field: Optional[str] = 'text')[source]¶

参数

index_name (str) –
embedding (Embeddings) –
es_connection (Optional['Elasticsearch']) –
es_cloud_id (Optional[str]) –
es_user (Optional[str]) –
es_password (Optional[str]) –
vector_query_field (Optional[str]) –
query_field (Optional[str]) –

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

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

参数

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

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

参数

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

返回值

从将文本添加到向量存储中获取的 ID 列表。

引发

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

返回类型

List[str]

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

在向量存储中添加或更新文档。

参数

documents (List[Document]) – 要添加到向量存储的文档。
kwargs (Any) – 附加关键字参数。如果 kwargs 包含 ids 并且 documents 包含 ids，则 kwargs 中的 ids 将优先。

返回值

添加的文本的 ID 列表。

引发

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

返回类型

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[Dict[Any, Any]]] = None, model_id: Optional[str] = None, refresh_indices: bool = False, **kwargs: Any) → List[str][source]¶

将文本列表添加到 Elasticsearch 索引。

参数

texts (Iterable[str]) – 要添加到索引的文本。
metadatas (List[Dict[Any, Any]], optional) – 与文本关联的元数据字典列表（可选）。
model_id (str, optional) – 用于将文本转换为向量的模型的 ID（可选）。
refresh_indices (bool, optional) – 是否在添加文本后刷新 Elasticsearch 索引。
**kwargs – 任意关键字参数。

返回值

添加文本的 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¶

异步返回从文档和嵌入初始化的 VectorStore。

参数

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

返回值

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

返回类型

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。

返回类型

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

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

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

参数

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

返回值

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

返回类型

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

返回值

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

返回类型

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]): 传递给搜索函数的关键字参数。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。可以包括诸如

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

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

fetch_k: 要传递给MMR算法的文档数量: (默认值：20)
lambda_mult: MMR返回结果的多样性；: 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”之一，则会引发ValueError。

返回类型

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 (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] 内的文档和相关性得分。

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

参数

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

过滤检索到的文档结果集

返回值

(doc, similarity_score) 元组的列表

返回类型

List[Tuple[Document, float]]

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

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

参数

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

返回值

(doc, similarity_score) 元组的列表。

返回类型

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不应包含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字段，则更新功能应使用该字段。如果未提供ID，则更新方法可以自由地为文档生成ID。

当指定ID且文档已存在于向量存储中时，更新方法应使用新数据更新文档。如果文档不存在，则更新方法应将文档添加到向量存储中。

参数

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

返回值

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

返回类型

UpsertResponse

0.2.11版本新增功能。

create_knn_index(mapping: Dict) → None[source]¶

在 Elasticsearch 中创建一个新的 k-近邻索引。

参数: mapping (Dict) – 新索引要使用的映射。
返回值: None
返回类型: None

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_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST¶

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

参数

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

返回值

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

返回类型

VectorStore

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[Dict[Any, Any]]] = None, **kwargs: Any) → ElasticKnnSearch[source]¶

创建一个新的 ElasticKnnSearch 实例并将文本列表添加到: Elasticsearch 索引。

参数

texts (List[str]) – 要添加到索引的文本列表。
embedding (Embeddings) – 用于将文本转换为向量的嵌入模型。
metadatas (List[Dict[Any, Any]], optional) – 与文本关联的元数据字典列表（可选）。
**kwargs – 任意关键字参数。

返回值

一个新的 ElasticKnnSearch 实例。

返回类型

ElasticKnnSearch

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版本新增功能。

knn_hybrid_search(query: Optional[str] = None, k: Optional[int] = 10, query_vector: Optional[List[float]] = None, model_id: Optional[str] = None, size: Optional[int] = 10, source: Optional[bool] = True, knn_boost: Optional[float] = 0.9, query_boost: Optional[float] = 0.1, fields: Optional[Union[List[Mapping[str, Any]], Tuple[Mapping[str, Any], ...]]] = None, page_content: Optional[str] = 'text') → List[Tuple[Document, float]][source]¶

在 Elasticsearch 索引上执行混合 k-近邻和文本搜索。

参数

query (str, optional) – 要搜索的查询文本。
k (int, optional) – 返回的最近邻数量。
query_vector (List[float], optional) – 要搜索的查询向量。
model_id (str, optional) – 用于将查询文本转换为向量的模型的 ID。
size (int, optional) – 返回的搜索结果数量。
source (bool, optional) – 是否返回搜索结果的源。
knn_boost (float, optional) – 应用于 k-NN 搜索结果的提升值。
query_boost (float, optional) – 应用于文本搜索结果的提升值。
fields (List[Mapping[str, Any]], optional) – 搜索结果中返回的字段。
page_content (str, optional) – 包含页面内容的字段名称。

返回值

元组列表，其中每个元组包含一个 Document 对象和一个分数。

返回类型

List[Tuple[Document, float]]

knn_search(query: Optional[str] = None, k: Optional[int] = 10, query_vector: Optional[List[float]] = None, model_id: Optional[str] = None, size: Optional[int] = 10, source: Optional[bool] = True, fields: Optional[Union[List[Mapping[str, Any]], Tuple[Mapping[str, Any], ...]]] = None, page_content: Optional[str] = 'text') → List[Tuple[Document, float]][source]¶

在 Elasticsearch 索引上执行 k-近邻搜索。

参数

query (str, optional) – 要搜索的查询文本。
k (int, optional) – 返回的最近邻数量。
query_vector (List[float], optional) – 要搜索的查询向量。
model_id (str, optional) – 用于将查询文本转换为向量的模型的 ID。
size (int, optional) – 返回的搜索结果数量。
source (bool, optional) – 是否返回搜索结果的源。
fields (List[Mapping[str, Any]], optional) – 搜索结果中返回的字段。
page_content (str, optional) – 包含页面内容的字段名称。

返回值

元组列表，其中每个元组包含一个 Document 对象和一个分数。

返回类型

List[Tuple[Document, float]]

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

返回值

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

返回类型

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

返回值

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

返回类型

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”之一，则会引发ValueError。

返回类型

List[Document]

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

传递到 knn_search

参数

query (str) –
k (int) –
filter (Optional[dict]) –
kwargs (Any) –

返回类型

List[Document]

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

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

参数

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

返回值

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

返回类型

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

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

返回值

(doc, similarity_score) 元组的列表。

返回类型

List[Tuple[Document, float]]

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

传递到 knn_search including score

参数

query (str) –
k (int) –
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]) – 要添加到向量存储的可迭代 Document 对象。
batch_size (int) – 每次批量更新的大小。
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字段，则更新功能应使用该字段。如果未提供ID，则更新方法可以自由地为文档生成ID。

当指定ID且文档已存在于向量存储中时，更新方法应使用新数据更新文档。如果文档不存在，则更新方法应将文档添加到向量存储中。

参数

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

返回值

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

返回类型

UpsertResponse

0.2.11版本新增功能。

langchain_community.vectorstores.elastic_vector_search.ElasticKnnSearch¶

`langchain_community.vectorstores.elastic_vector_search`.ElasticKnnSearch¶