`langchain_community.vectorstores.elasticsearch`.ElasticsearchStore¶

class langchain_community.vectorstores.elasticsearch.ElasticsearchStore(index_name: str, *, embedding: ~typing.Optional[~langchain_core.embeddings.embeddings.Embeddings] = None, es_connection: ~typing.Optional[Elasticsearch] = None, es_url: ~typing.Optional[str] = None, es_cloud_id: ~typing.Optional[str] = None, es_user: ~typing.Optional[str] = None, es_api_key: ~typing.Optional[str] = None, es_password: ~typing.Optional[str] = None, vector_query_field: str = 'vector', query_field: str = 'text', distance_strategy: ~typing.Optional[~typing.Literal[<DistanceStrategy.COSINE: 'COSINE'>, <DistanceStrategy.DOT_PRODUCT: 'DOT_PRODUCT'>, <DistanceStrategy.EUCLIDEAN_DISTANCE: 'EUCLIDEAN_DISTANCE'>, <DistanceStrategy.MAX_INNER_PRODUCT: 'MAX_INNER_PRODUCT'>]] = None, strategy: ~langchain_community.vectorstores.elasticsearch.BaseRetrievalStrategy = <langchain_community.vectorstores.elasticsearch.ApproxRetrievalStrategy object>, es_params: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = None)[source]¶

[Deprecated] `Elasticsearch`向量存储。

示例:

from langchain_community.vectorstores import ElasticsearchStore
from langchain_community.embeddings.openai import OpenAIEmbeddings

vectorstore = ElasticsearchStore(
    embedding=OpenAIEmbeddings(),
    index_name="langchain-demo",
    es_url="http://localhost:9200"
)

参数:

index_name: 要创建的Elasticsearch索引的名称。 es_url: 要连接的Elasticsearch实例的URL。 cloud_id: 要连接的Elasticsearch实例的云ID。 es_user: 连接到Elasticsearch时要使用的用户名。 es_password: 连接到Elasticsearch时要使用的密码。 es_api_key: 连接到Elasticsearch时要使用的API密钥。 es_connection: 可选的现有Elasticsearch连接。 vector_query_field: 可选。用于存储嵌入向量的字段名称。 query_field: 可选。用于存储文本的字段名称。 strategy: 可选。在搜索索引时要使用的检索策略。

默认为ApproxRetrievalStrategy。可以是ExactRetrievalStrategy、ApproxRetrievalStrategy 或SparseRetrievalStrategy之一。

distance_strategy: 可选。在搜索索引时要使用的距离策略。: 默认为COSINE。可以是COSINE、EUCLIDEAN_DISTANCE、MAX_INNER_PRODUCT或DOT_PRODUCT之一。

如果要使用云托管的Elasticsearch实例，可以传入cloud_id参数而不是es_url参数。

示例:

from langchain_community.vectorstores import ElasticsearchStore
from langchain_community.embeddings.openai import OpenAIEmbeddings

vectorstore = ElasticsearchStore(
    embedding=OpenAIEmbeddings(),
    index_name="langchain-demo",
    es_cloud_id="<cloud_id>"
    es_user="elastic",
    es_password="<password>"
)

您还可以通过es_connection参数传入预先存在的Elasticsearch连接来连接到现有的Elasticsearch实例。

示例:

from langchain_community.vectorstores import ElasticsearchStore
from langchain_community.embeddings.openai import OpenAIEmbeddings

from elasticsearch import Elasticsearch

es_connection = Elasticsearch("http://localhost:9200")

vectorstore = ElasticsearchStore(
    embedding=OpenAIEmbeddings(),
    index_name="langchain-demo",
    es_connection=es_connection
)

ElasticsearchStore默认使用ApproxRetrievalStrategy，该策略使用HNSW算法执行近似最近邻搜索。这是最快速和最节省内存的算法。

如果要使用暴力/精确策略来搜索向量，可以将ExactRetrievalStrategy传递给ElasticsearchStore构造函数。

示例:

from langchain_community.vectorstores import ElasticsearchStore
from langchain_community.embeddings.openai import OpenAIEmbeddings

vectorstore = ElasticsearchStore(
    embedding=OpenAIEmbeddings(),
    index_name="langchain-demo",
    es_url="http://localhost:9200",
    strategy=ElasticsearchStore.ExactRetrievalStrategy()
)

这两种策略都要求在创建索引时知道要使用的相似度度量。默认为余弦相似度，但也可以使用点积或欧氏距离。

示例:

from langchain_community.vectorstores import ElasticsearchStore
from langchain_community.embeddings.openai import OpenAIEmbeddings
from langchain_community.vectorstores.utils import DistanceStrategy

vectorstore = ElasticsearchStore(
    "langchain-demo",
    embedding=OpenAIEmbeddings(),
    es_url="http://localhost:9200",
    distance_strategy="DOT_PRODUCT"
)

Notes

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

Attributes

embeddings

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

Methods

`ApproxRetrievalStrategy`([query_model_id, ...])	用于使用HNSW算法执行近似最近邻搜索。
`ExactRetrievalStrategy`()	用于通过脚本评分执行暴力/精确最近邻搜索。
`SparseVectorRetrievalStrategy`([model_id])	用于通过文本扩展执行稀疏向量搜索。用于希望使用ELSER模型执行文档搜索时。
`__init__`(index_name, *[, embedding, ...])
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`add_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`add_embeddings`(text_embeddings[, metadatas, ...])	将给定的文本和嵌入添加到向量存储中。
`add_texts`(texts[, metadatas, ids, ...])	运行更多的文本通过嵌入并添加到向量存储中。
`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)	使用异步方式运行相似性搜索与距离。
`connect_to_elasticsearch`(*[, es_url, ...])
`delete`([ids, refresh_indices])	从Elasticsearch索引中删除文档。
`from_documents`(documents[, embedding, ...])	从文档构建ElasticsearchStore包装器。
`from_texts`(texts[, embedding, metadatas, ...])	从原始文档构建ElasticsearchStore包装器。
`get_user_agent`()
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, fetch_k, filter])	返回与查询最相似的Elasticsearch文档。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_by_vector_with_relevance_scores`(...)	返回与查询最相似的Elasticsearch文档，以及分数。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性得分在[0, 1]范围内。
`similarity_search_with_score`(query[, k, filter])	返回与查询最相似的Elasticsearch文档，以及分数。

Parameters

index_name (str) –
embedding (Optional[Embeddings]) –
es_connection (Optional[Elasticsearch]) –
es_url (Optional[str]) –
es_cloud_id (Optional[str]) –
es_user (Optional[str]) –
es_api_key (Optional[str]) –
es_password (Optional[str]) –
vector_query_field (str) –
query_field (str) –
distance_strategy (Optional[Literal[<DistanceStrategy.COSINE: 'COSINE'>, <DistanceStrategy.DOT_PRODUCT: 'DOT_PRODUCT'>, <DistanceStrategy.EUCLIDEAN_DISTANCE: 'EUCLIDEAN_DISTANCE'>, <DistanceStrategy.MAX_INNER_PRODUCT: 'MAX_INNER_PRODUCT'>]]) –
strategy (BaseRetrievalStrategy) –
es_params (Optional[Dict[str, Any]]) –

static ApproxRetrievalStrategy(query_model_id: Optional[str] = None, hybrid: Optional[bool] = False, rrf: Optional[Union[dict, bool]] = True) → ApproxRetrievalStrategy[source]¶

用于使用HNSW算法执行近似最近邻搜索。

在构建索引时，此策略将在索引中创建一个密集向量字段，并将嵌入向量存储在索引中。

在查询时，文本将使用提供的嵌入函数进行嵌入，或者将使用query_model_id来使用部署到Elasticsearch的模型对文本进行嵌入。

如果使用query_model_id，则不要提供嵌入函数。

参数：: query_model_id：可选。用于在堆栈内嵌入查询文本的模型的ID。需要将嵌入模型部署到Elasticsearch。 hybrid：可选。如果为True，则将使用knn查询和文本查询执行混合搜索。默认为False。 rrf：可选。rrf是Reciprocal Rank Fusion。当`hybrid`为True时，

并且`rrf`为True时，然后rrf: {}。并且`rrf`为False时，然后省略rrf。并且isinstance(rrf, dict)为True时，然后传递字典值。

可以传递rrf以调整’rank_constant’和’window_size’。

Parameters

query_model_id (Optional[str]) –
hybrid (Optional[bool]) –
rrf (Optional[Union[dict, bool]]) –

Return type

ApproxRetrievalStrategy

static ExactRetrievalStrategy() → ExactRetrievalStrategy[source]¶

用于通过脚本评分执行暴力/精确最近邻搜索。

Return type: ExactRetrievalStrategy

static SparseVectorRetrievalStrategy(model_id: Optional[str] = None) → SparseRetrievalStrategy[source]¶

用于通过文本扩展执行稀疏向量搜索。用于希望使用ELSER模型执行文档搜索时。

在构建索引时，此策略将创建一个流水线，将使用ELSER模型嵌入文本并将生成的标记存储在索引中。

在查询时，文本将使用ELSER模型嵌入，生成的标记将用于执行文本扩展查询。

参数：

model_id：可选。默认为”.elser_model_1”。: 要用于嵌入查询文本的模型的ID 在Elasticsearch中部署嵌入模型。

Parameters: model_id (Optional[str]) –
Return type: SparseRetrievalStrategy

__init__(index_name: str, *, embedding: ~typing.Optional[~langchain_core.embeddings.embeddings.Embeddings] = None, es_connection: ~typing.Optional[Elasticsearch] = None, es_url: ~typing.Optional[str] = None, es_cloud_id: ~typing.Optional[str] = None, es_user: ~typing.Optional[str] = None, es_api_key: ~typing.Optional[str] = None, es_password: ~typing.Optional[str] = None, vector_query_field: str = 'vector', query_field: str = 'text', distance_strategy: ~typing.Optional[~typing.Literal[<DistanceStrategy.COSINE: 'COSINE'>, <DistanceStrategy.DOT_PRODUCT: 'DOT_PRODUCT'>, <DistanceStrategy.EUCLIDEAN_DISTANCE: 'EUCLIDEAN_DISTANCE'>, <DistanceStrategy.MAX_INNER_PRODUCT: 'MAX_INNER_PRODUCT'>]] = None, strategy: ~langchain_community.vectorstores.elasticsearch.BaseRetrievalStrategy = <langchain_community.vectorstores.elasticsearch.ApproxRetrievalStrategy object>, es_params: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = None)[source]¶

Parameters

index_name (str) –
embedding (Optional[Embeddings]) –
es_connection (Optional[Elasticsearch]) –
es_url (Optional[str]) –
es_cloud_id (Optional[str]) –
es_user (Optional[str]) –
es_api_key (Optional[str]) –
es_password (Optional[str]) –
vector_query_field (str) –
query_field (str) –
distance_strategy (Optional[Literal[<DistanceStrategy.COSINE: 'COSINE'>, <DistanceStrategy.DOT_PRODUCT: 'DOT_PRODUCT'>, <DistanceStrategy.EUCLIDEAN_DISTANCE: 'EUCLIDEAN_DISTANCE'>, <DistanceStrategy.MAX_INNER_PRODUCT: 'MAX_INNER_PRODUCT'>]]) –
strategy (BaseRetrievalStrategy) –
es_params (Optional[Dict[str, Any]]) –

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_embeddings(text_embeddings: Iterable[Tuple[str, List[float]]], metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, refresh_indices: bool = True, create_index_if_not_exists: bool = True, bulk_kwargs: Optional[Dict] = None, **kwargs: Any) → List[str][source]¶

将给定的文本和嵌入添加到向量存储中。

参数：

text_embeddings：要添加到向量存储中的字符串和嵌入的可迭代对。 metadatas：与文本相关的元数据的可选列表。 ids：唯一ID的可选列表。 refresh_indices：在添加文本后是否刷新Elasticsearch索引。 create_index_if_not_exists：如果索引尚不存在，是否创建Elasticsearch索引。 *bulk_kwargs：传递给Elasticsearch批量操作的其他参数。

chunk_size：可选。一次添加到索引的文本数量。默认为500。

返回：

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

Parameters

text_embeddings (Iterable[Tuple[str, List[float]]]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
refresh_indices (bool) –
create_index_if_not_exists (bool) –
bulk_kwargs (Optional[Dict]) –
kwargs (Any) –

Return type

List[str]

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

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

参数：

texts：要添加到向量存储中的字符串的可迭代对象。 metadatas：与文本相关联的元数据的可选列表。 ids：与文本关联的可选id列表。 refresh_indices：在添加文本后是否刷新Elasticsearch索引。 create_index_if_not_exists：如果索引不存在是否创建Elasticsearch索引。 *bulk_kwargs：传递给Elasticsearch批量操作的其他参数。

chunk_size：可选。一次添加到索引的文本数量。默认为500。

返回：

将文本添加到向量存储中的id列表。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[Dict[Any, Any]]]) –
ids (Optional[List[str]]) –
refresh_indices (bool) –
create_index_if_not_exists (bool) –
bulk_kwargs (Optional[Dict]) –
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]]

static connect_to_elasticsearch(*, es_url: Optional[str] = None, cloud_id: Optional[str] = None, api_key: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, es_params: Optional[Dict[str, Any]] = None) → Elasticsearch[source]¶

Parameters

es_url (Optional[str]) –
cloud_id (Optional[str]) –
api_key (Optional[str]) –
username (Optional[str]) –
password (Optional[str]) –
es_params (Optional[Dict[str, Any]]) –

Return type

Elasticsearch

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

从Elasticsearch索引中删除文档。

参数：: ids：要删除的文档的id列表。 refresh_indices：在删除文档后是否刷新索引。默认为True。

Parameters

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

Return type

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Optional[Embeddings] = None, bulk_kwargs: Optional[Dict] = None, **kwargs: Any) → ElasticsearchStore[source]¶

从文档构建ElasticsearchStore包装器。

示例：

from langchain_community.vectorstores import ElasticsearchStore
from langchain_community.embeddings.openai import OpenAIEmbeddings

db = ElasticsearchStore.from_documents(
    texts,
    embeddings,
    index_name="langchain-demo",
    es_url="http://localhost:9200"
)

参数：

texts: 要添加到Elasticsearch索引的文本列表。 embedding: 用于嵌入文本的嵌入函数。

如果使用不需要推理的策略，则不要提供。

metadatas: 与文本相关的元数据的可选列表。 index_name: 要创建的Elasticsearch索引的名称。 es_url: 要连接的Elasticsearch实例的URL。 cloud_id: 要连接的Elasticsearch实例的Cloud ID。 es_user: 连接到Elasticsearch时要使用的用户名。 es_password: 连接到Elasticsearch时要使用的密码。 es_api_key: 连接到Elasticsearch时要使用的API密钥。 es_connection: 可选的现有Elasticsearch连接。 vector_query_field: 可选。用于存储嵌入向量的字段名称。 query_field: 可选。用于存储文本的字段名称。 bulk_kwargs: 可选。传递给Elasticsearch批量操作的其他参数。

Parameters

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

Return type

ElasticsearchStore

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

从原始文档构建ElasticsearchStore包装器。

示例：

from langchain_community.vectorstores import ElasticsearchStore
from langchain_community.embeddings.openai import OpenAIEmbeddings

db = ElasticsearchStore.from_texts(
    texts,
    // 如果使用不需要推理的策略，则嵌入是可选的
    embeddings,
    index_name="langchain-demo",
    es_url="http://localhost:9200"
)

参数：

texts：要添加到Elasticsearch索引的文本列表。 embedding：用于嵌入文本的嵌入函数。 metadatas：与文本相关联的元数据的可选列表。 index_name：要创建的Elasticsearch索引的名称。 es_url：要连接的Elasticsearch实例的URL。 cloud_id：要连接的Elasticsearch实例的云ID。 es_user：连接到Elasticsearch时要使用的用户名。 es_password：连接到Elasticsearch时要使用的密码。 es_api_key：连接到Elasticsearch时要使用的API密钥。 es_connection：可选的现有Elasticsearch连接。 vector_query_field：可选。存储嵌入向量的字段名称。 query_field：可选。存储文本的字段名称。 distance_strategy：可选。要使用的距离策略的名称。默认为”COSINE”。可以是”COSINE”、”EUCLIDEAN_DISTANCE”、”DOT_PRODUCT”、”MAX_INNER_PRODUCT”之一。 bulk_kwargs：可选。传递给Elasticsearch批量操作的附加参数。

Parameters

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

Return type

ElasticsearchStore

static get_user_agent() → str[source]¶

Return type: str

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

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

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

参数:

query (str): 要查找类似文档的文本。 k (int): 要返回的文档数量。默认为4。 fetch_k (int): 要获取以传递给MMR算法的文档数量。 lambda_mult (float): 0到1之间的数字，确定结果之间多样性的程度，

0对应最大多样性，1对应最小多样性。默认为0.5。

fields: 从elasticsearch源获取的其他字段。这些字段将添加到文档元数据中。

返回:

List[Document]: 通过最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
fields (Optional[List[str]]) –
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, fetch_k: int = 50, filter: Optional[List[dict]] = None, **kwargs: Any) → List[Document][source]¶

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

参数：: query: 要查找与之相似的文档的文本。 k: 要返回的文档数量。默认为4。 fetch_k (int): 要获取的文档数量，以传递给knn num_candidates。 filter: 要应用于查询的Elasticsearch过滤器子句数组。
返回：: 与查询最相似的文档列表，按相似度降序排列。

Parameters

query (str) –
k (int) –
fetch_k (int) –
filter (Optional[List[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_by_vector_with_relevance_scores(embedding: List[float], k: int = 4, filter: Optional[List[Dict]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回与查询最相似的Elasticsearch文档，以及分数。

参数：: embedding: 要查找与之相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 要应用于查询的Elasticsearch过滤子句数组。
返回：: 与嵌入最相似的文档列表，以及每个文档的分数。

Parameters

embedding (List[float]) –
k (int) –
filter (Optional[List[Dict]]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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 = 4, filter: Optional[List[dict]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回与查询最相似的Elasticsearch文档，以及分数。

参数：: query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filter：要应用于查询的Elasticsearch过滤子句数组。
返回：: 返回与查询最相似的文档列表，以及每个文档的分数。

Parameters

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

Return type

List[Tuple[Document, float]]

Examples using ElasticsearchStore¶

langchain_community.vectorstores.elasticsearch.ElasticsearchStore¶

Examples using ElasticsearchStore¶

`langchain_community.vectorstores.elasticsearch`.ElasticsearchStore¶