`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] [已弃用] 使用k-最近邻搜索(k-NN)向量存储的`Elasticsearch`。

建议改用`ElasticsearchStore`，它支持元数据过滤、自定义查询检索器等更多功能！

您可以在`ElasticsearchStore`中阅读更多信息： https://python.langchain.com/docs/integrations/vectorstores/elasticsearch

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

属性：

index_name (str): Elasticsearch索引的名称。 embedding (Embeddings): 用于将文本数据转换为向量嵌入的嵌入模型。 es_connection (Elasticsearch, 可选): 现有的Elasticsearch连接。 es_cloud_id (str, 可选): 您的Elasticsearch服务部署的Cloud ID。 es_user (str, 可选): 您的Elasticsearch服务部署的用户名。 es_password (str, 可选): 您的Elasticsearch服务部署的密码。 vector_query_field (str, 可选): Elasticsearch索引中包含向量嵌入的字段的名称。 query_field (str, 可选): Elasticsearch索引中包含原始文本数据的字段的名称。

用法：

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

Notes

Deprecated since version 0.0.1: Use Use ElasticsearchStore class in langchain-elasticsearch package instead.

Attributes

embeddings

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

Methods

`__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。
`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)	使用异步方式运行相似性搜索与距离。
`create_knn_index`(mapping)	在Elasticsearch中创建一个新的k-NN索引。
`delete`([ids])	根据向量ID或其他条件进行删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas])	创建一个新的ElasticKnnSearch实例，并将文本列表添加到Elasticsearch索引中。
`knn_hybrid_search`([query, k, query_vector, ...])	在Elasticsearch索引上执行混合k-NN和文本搜索。
`knn_search`([query, k, query_vector, ...])	在Elasticsearch索引上执行k-NN搜索。
`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`，包括分数

Parameters

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]) –

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

Parameters

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]): 要添加到向量存储中的文档。
返回:: List[str]: 添加的文本的ID列表。

Parameters

documents (List[Document]) –
kwargs (Any) –

Return type

List[str]

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

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

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

Return type

List[str]

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

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

参数:: documents (List[Document]): 要添加到向量存储中的文档。
返回:: List[str]: 添加的文本的ID列表。

Parameters

documents (List[Document]) –
kwargs (Any) –

Return type

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

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[Dict[Any, Any]]]) –
model_id (Optional[str]) –
refresh_indices (bool) –
kwargs (Any) –

Return type

List[str]

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

根据向量ID或其他条件进行删除。

参数：: ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

Optional[bool]

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

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

Parameters

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

Return type

VST

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

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

Parameters

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

Return type

VST

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

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

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

参数：: query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
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]¶

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

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从此VectorStore初始化的VectorStoreRetriever。

参数：

search_type（可选[str]）：定义Retriever应执行的搜索类型。: 可以是”similarity”（默认值）、”mmr”或”similarity_score_threshold”。
search_kwargs（可选[Dict]）：传递给搜索函数的关键字参数。可以包括：: k：要返回的文档数量（默认值：4） score_threshold：用于similarity_score_threshold的最小相关性阈值 fetch_k：传递给MMR算法的文档数量（默认值：20） lambda_mult：MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值：0.5） filter：按文档元数据筛选

返回：

VectorStoreRetriever：VectorStore的Retriever类。

示例：

# 检索更多具有更高多样性的文档
# 如果数据集中有许多相似的文档，则很有用
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# 为MMR算法考虑更多文档
# 但只返回前5个
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# 仅检索具有特定阈值以上相关性分数的文档
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# 仅从数据集中获取最相似的单个文档
docsearch.as_retriever(search_kwargs={'k': 1})

# 使用筛选器仅从特定论文中检索文档
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

Parameters: kwargs (Any) –
Return type: VectorStoreRetriever

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

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

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

embedding (List[float]) –
k (int) –
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：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集
返回：: 元组列表（doc，相似度分数）的列表

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

使用异步方式运行相似性搜索与距离。

Parameters

args (Any) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

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

参数:: mapping (字典): 用于新索引的映射。
返回:: 无

Parameters: mapping (Dict) –
Return type: None

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

根据向量ID或其他条件进行删除。

参数：: ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

Optional[bool]

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

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

Parameters

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

Return type

VST

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实例。

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[Dict[Any, Any]]]) –
kwargs (Any) –

Return type

ElasticKnnSearch

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-NN和文本搜索。

参数：: query（str，可选）：要搜索的查询文本。 k（int，可选）：要返回的最近邻居的数量。 query_vector（List[float]，可选）：要搜索的查询向量。 model_id（str，可选）：用于将查询文本转换为向量的模型的ID。 size（int，可选）：要返回的搜索结果数量。 source（bool，可选）：是否返回搜索结果的源。 knn_boost（float，可选）：应用于k-NN搜索结果的增强值。 query_boost（float，可选）：应用于文本搜索结果的增强值。 fields（List[Mapping[str, Any]]，可选）：要在搜索结果中返回的字段。 page_content（str，可选）：包含页面内容的字段的名称。
返回：: 一个元组列表，每个元组包含一个Document对象和一个分数。

Parameters

query (Optional[str]) –
k (Optional[int]) –
query_vector (Optional[List[float]]) –
model_id (Optional[str]) –
size (Optional[int]) –
source (Optional[bool]) –
knn_boost (Optional[float]) –
query_boost (Optional[float]) –
fields (Optional[Union[List[Mapping[str, Any]], Tuple[Mapping[str, Any], ...]]]) –
page_content (Optional[str]) –

Return type

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-NN搜索。

参数:: 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对象和一个分数。

Parameters

query (Optional[str]) –
k (Optional[int]) –
query_vector (Optional[List[float]]) –
model_id (Optional[str]) –
size (Optional[int]) –
source (Optional[bool]) –
fields (Optional[Union[List[Mapping[str, Any]], Tuple[Mapping[str, Any], ...]]]) –
page_content (Optional[str]) –

Return type

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：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
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：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

List[Document]

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

传递给`knn_search`

Parameters

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

Return type

List[Document]

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

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

参数：: embedding：要查找与之相似的文档的嵌入。 k：要返回的文档数量。默认为4。
返回：: 与查询向量最相似的文档列表。

Parameters

embedding (List[float]) –
k (int) –
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：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集
返回：: 元组列表（doc，相似性得分）

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

传递到`knn_search`，包括分数

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

langchain_community.vectorstores.elastic_vector_search.ElasticKnnSearch¶

`langchain_community.vectorstores.elastic_vector_search`.ElasticKnnSearch¶