`langchain_elasticsearch.vectorstores`.ElasticsearchStore¶

class langchain_elasticsearch.vectorstores.ElasticsearchStore(index_name: str, *, embedding: ~typing.Optional[~langchain_core.embeddings.embeddings.Embeddings] = None, es_connection: ~typing.Optional[~elasticsearch.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: ~typing.Union[~langchain_elasticsearch.vectorstores.BaseRetrievalStrategy, ~elasticsearch.helpers.vectorstore._sync.strategies.RetrievalStrategy] = <langchain_elasticsearch.vectorstores.ApproxRetrievalStrategy object>, es_params: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = None)[source]¶

Elasticsearch 向量存储。

示例

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

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

参数

index_name (str) – 要创建的 Elasticsearch 索引的名称。
es_url (Optional[str]) – 要连接的 Elasticsearch 实例的 URL。
cloud_id – 要连接的 Elasticsearch 实例的 Cloud ID。
es_user (Optional[str]) – 连接到 Elasticsearch 时使用的用户名。
es_password (Optional[str]) – 连接到 Elasticsearch 时使用的密码。
es_api_key (Optional[str]) – 连接到 Elasticsearch 时使用的 API 密钥。
es_connection (Optional[Elasticsearch]) – 可选的预先存在的 Elasticsearch 连接。
vector_query_field (str) – 可选。用于存储嵌入向量的字段名称。
query_field (str) – 可选。用于存储文本的字段名称。
strategy (Union[BaseRetrievalStrategy, RetrievalStrategy]) – 可选。搜索索引时使用的检索策略。默认为 ApproxRetrievalStrategy。可以是 ExactRetrievalStrategy、ApproxRetrievalStrategy 或 SparseRetrievalStrategy 之一。
distance_strategy (Optional[Literal[<DistanceStrategy.COSINE: 'COSINE'>, <DistanceStrategy.DOT_PRODUCT: 'DOT_PRODUCT'>, <DistanceStrategy.EUCLIDEAN_DISTANCE: 'EUCLIDEAN_DISTANCE'>, <DistanceStrategy.MAX_INNER_PRODUCT: 'MAX_INNER_PRODUCT'>]]) – 可选。搜索索引时使用的距离策略。默认为 COSINE。可以是 COSINE、EUCLIDEAN_DISTANCE、MAX_INNER_PRODUCT 或 DOT_PRODUCT 之一。
embedding (Optional[Embeddings]) –
es_cloud_id (Optional[str]) –
es_params (Optional[Dict[str, Any]]) –

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

示例

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

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

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

示例

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

from elasticsearch import Elasticsearch

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

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

ElasticsearchStore 默认使用 ApproxRetrievalStrategy，它使用 HNSW 算法执行近似最近邻搜索。这是最快且内存效率最高的算法。

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

示例

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

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

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

示例

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores.utils import DistanceStrategy

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

属性

embeddings

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

方法

`ApproxRetrievalStrategy`([query_model_id, ...])	用于使用 HNSW 算法执行近似最近邻搜索。
`BM25RetrievalStrategy`([k1, b])	用于应用 BM25 而无需向量搜索。
`ExactRetrievalStrategy`()	用于通过 script_score 执行暴力/精确最近邻搜索。
`SparseVectorRetrievalStrategy`([model_id])	用于通过 text_expansion 执行稀疏向量搜索。
`__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。
`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)
`close`()
`connect_to_elasticsearch`(*[, es_url, ...])
`delete`([ids, refresh_indices])	从 Elasticsearch 索引中删除文档。
`from_documents`(documents[, embedding, ...])	从文档构造 ElasticsearchStore 包装器。
`from_texts`(texts[, embedding, metadatas, ...])	从原始文档构造 ElasticsearchStore 包装器。
`get_by_ids`(ids, /)	按 ID 获取文档。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回与使用指定搜索类型查询最相似的文档。
`similarity_search`(query[, k, fetch_k, ...])	返回与查询最相似的 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, ...])	返回与查询最相似的 Elasticsearch 文档，以及得分。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

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

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

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

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

如果使用 query_model_id，请勿提供嵌入函数。

参数

query_model_id (Optional[str]) – 可选。用于嵌入堆栈内查询文本的模型的 ID。需要将嵌入模型部署到 Elasticsearch。
hybrid (Optional[bool]) – 可选。如果为 True，将使用 knn 查询和文本查询执行混合搜索。默认为 False。
rrf (Optional[Union[dict, bool]]) –
可选。rrf 是倒数排名融合。当 hybrid 为 True 时，

并且 rrf 为 True，则 rrf: {}。并且 rrf 为 False，则省略 rrf。并且 isinstance(rrf, dict) 为 True，则传入 dict 值。

可以传递 rrf 以调整“rank_constant”和“window_size”。

返回类型

ApproxRetrievalStrategy

static BM25RetrievalStrategy(k1: Optional] = None, b: Optional] = None) → BM25RetrievalStrategy[source]¶

用于应用 BM25 而无需向量搜索。

参数

k1 (Optional[float]) – 可选。这对应于 BM25 参数 k1。默认为 None，它使用 Elasticsearch 的默认设置。
b (Optional[float]) – 可选。这对应于 BM25 参数 b。默认为 None，它使用 Elasticsearch 的默认设置。

返回类型

BM25RetrievalStrategy

static ExactRetrievalStrategy() → ExactRetrievalStrategy[source]¶

用于通过 script_score 执行暴力/精确最近邻搜索。

返回类型: ExactRetrievalStrategy

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

用于通过 text_expansion 执行稀疏向量搜索。用于当您想使用 ELSER 模型执行文档搜索时。

在构建索引时，此策略将创建一个管道，该管道将使用 ELSER 模型嵌入文本，并将生成的令牌存储在索引中。

在查询时，将使用 ELSER 模型嵌入文本，并且生成的令牌将用于执行 text_expansion 查询。

参数: model_id (Optional[str]) – 可选。默认为“.elser_model_1”。用于嵌入堆栈内查询文本的模型的 ID。需要将嵌入模型部署到 Elasticsearch。
返回类型: SparseRetrievalStrategy

__init__(index_name: str, *, embedding: ~typing.Optional[~langchain_core.embeddings.embeddings.Embeddings] = None, es_connection: ~typing.Optional[~elasticsearch.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: ~typing.Union[~langchain_elasticsearch.vectorstores.BaseRetrievalStrategy, ~elasticsearch.helpers.vectorstore._sync.strategies.RetrievalStrategy] = <langchain_elasticsearch.vectorstores.ApproxRetrievalStrategy object>, es_params: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = None)[source]¶

参数

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 (可选[str]) –
vector_query_field (str) –
query_field (str) –
distance_strategy (可选[Literal[<DistanceStrategy.COSINE: 'COSINE'>, <DistanceStrategy.DOT_PRODUCT: 'DOT_PRODUCT'>, <DistanceStrategy.EUCLIDEAN_DISTANCE: 'EUCLIDEAN_DISTANCE'>, <DistanceStrategy.MAX_INNER_PRODUCT: 'MAX_INNER_PRODUCT'>]]) –
strategy (Union[BaseRetrievalStrategy, RetrievalStrategy]) –
es_params (Optional[Dict[str, Any]]) –

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_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 (Iterable[Tuple[str, List[float]]]) – 要添加到存储的字符串和嵌入对的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
ids (Optional[List[str]]) – 可选的唯一 ID 列表。
refresh_indices (bool) – 在添加文本后是否刷新 Elasticsearch 索引。
create_index_if_not_exists (bool) – 是否在 Elasticsearch 索引尚不存在时创建它。
*bulk_kwargs (Optional[Dict]) –
要传递给 Elasticsearch bulk 的额外参数。 - chunk_size: 可选。一次添加到索引的文本数量。默认为 500。

索引一次添加的文本数量。默认为 500。
kwargs (Any) –

返回

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

返回类型

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 (Iterable[str]) – 要添加到存储的字符串的可迭代对象。
metadatas (Optional[List[Dict[Any, Any]]]) – 与文本关联的可选元数据列表。
ids (Optional[List[str]]) – 与文本关联的可选 ID 列表。
refresh_indices (bool) – 在添加文本后是否刷新 Elasticsearch 索引。
create_index_if_not_exists (bool) – 是否在 Elasticsearch 索引尚不存在时创建它。
*bulk_kwargs (Optional[Dict]) –
要传递给 Elasticsearch bulk 的额外参数。 - chunk_size: 可选。一次添加到索引的文本数量。默认为 500。

索引一次添加的文本数量。默认为 500。
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¶

异步返回从文档和嵌入初始化的 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]¶

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

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

参数

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

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

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

参数

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]): 传递给搜索函数的关键字参数。可以包括如下内容：

搜索函数的关键字参数。可以包括如下内容：

k: 要返回的文档数量 (默认: 4) score_threshold: similarity_score_threshold 的最小相关性阈值

similarity_score_threshold 的最小相关性阈值

fetch_k: 要传递给 MMR 算法的文档数量 (默认: 20): (默认: 20)
lambda_mult: MMR 返回结果的多样性；1 表示最小多样性，0 表示最大多样性。(默认: 0.5): 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 (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 之间的浮点值，用于筛选检索到的文档结果集

筛选检索到的文档结果集

返回

（文档，相似性得分）元组的列表

返回类型

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

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

参数

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

返回

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

返回类型

UpsertResponse

0.2.11 版本新增。

close() → None[source]¶

返回类型: None

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

参数

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

返回类型

Elasticsearch

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

从 Elasticsearch 索引中删除文档。

参数

ids (Optional[List[str]]) – 要删除的文档的 id 列表。
refresh_indices (Optional[bool]) – 是否在删除文档后刷新索引。默认为 True。
kwargs (Any) –

返回类型

Optional[bool]

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

从文档构造 ElasticsearchStore 包装器。

示例

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

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

参数

texts – 要添加到 Elasticsearch 索引的文本列表。
embedding (Optional[Embeddings]) – 用于嵌入文本的嵌入函数。如果使用不需要推理的策略，请勿提供。
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 (Optional[Dict]) – 可选。传递给 Elasticsearch bulk 的其他参数。
documents (List[Document]) –
kwargs (Any) –

返回类型

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_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

db = ElasticsearchStore.from_texts(
    texts,
    // embeddings optional if using
    // a strategy that doesn't require inference
    embeddings,
    index_name="langchain-demo",
    es_url="http://localhost:9200"
)

参数

texts (List[str]) – 要添加到 Elasticsearch 索引的文本列表。
embedding (Optional[Embeddings]) – 用于嵌入文本的嵌入函数。
metadatas (Optional[List[Dict[str, Any]]]) – 与文本关联的可选元数据列表。
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 – 可选。用于存储文本的字段名称。
distance_strategy – 可选。要使用的距离策略的名称。默认为“COSINE”。可以是“COSINE”、“EUCLIDEAN_DISTANCE”、“DOT_PRODUCT”、“MAX_INNER_PRODUCT”之一。
bulk_kwargs (Optional[Dict]) – 可选。传递给 Elasticsearch bulk 的其他参数。
kwargs (Any) –

返回类型

ElasticsearchStore

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, fields: Optional[List[str]] = None, *, custom_query: Optional[Callable[[Dict[str, Any], Optional[str]], Dict[str, Any]]] = None, doc_builder: Optional[Callable[[Dict], Document]] = 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 (Optional[List[str]]) – 从 elasticsearch 源获取的其他字段。这些字段将添加到文档元数据中。
custom_query (Optional[Callable[[Dict[str, Any], Optional[str]], Dict[str, Any]]]) –
doc_builder (Optional[Callable[[Dict], Document]]) –
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]¶

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

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

参数

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” 之一。

返回类型

List[Document]

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 knn num_candidates 的文档数量。
filter (Optional[List[dict]]) – 应用于查询的 Elasticsearch 过滤器子句数组。
custom_query (Optional[Callable[[Dict[str, Any], Optional[str]], Dict[str, Any]]]) –
doc_builder (Optional[Callable[[Dict], Document]]) –
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_by_vector_with_relevance_scores(embedding: List[float], k: int = 4, filter: Optional[List[Dict]] = None, *, custom_query: Optional[Callable[[Dict[str, Any], Optional[str]], Dict[str, Any]]] = None, doc_builder: Optional[Callable[[Dict], Document]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[List[Dict]]) – Array of Elasticsearch filter clauses to apply to the query.
custom_query (Optional[Callable[[Dict[str, Any], Optional[str]], Dict[str, Any]]]) –
doc_builder (Optional[Callable[[Dict], Document]]) –
kwargs (Any) –

返回

List of Documents most similar to the embedding and score for each

返回类型

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 (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似性搜索的 kwargs。应包括： score_threshold: 可选，介于 0 到 1 之间的浮点值，用于筛选检索到的文档结果集

filter the resulting set of retrieved docs.

返回

元组列表，包含 (doc, similarity_score)。

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filter: Optional[List[dict]] = None, *, custom_query: Optional[Callable[[Dict[str, Any], Optional[str]], Dict[str, Any]]] = None, doc_builder: Optional[Callable[[Dict], Document]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[List[dict]]) – 应用于查询的 Elasticsearch 过滤器子句数组。
custom_query (Optional[Callable[[Dict[str, Any], Optional[str]], Dict[str, Any]]]) –
doc_builder (Optional[Callable[[Dict], Document]]) –
kwargs (Any) –

返回

List of Documents most similar to the query and score for each

返回类型

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) – 每次批量更新的大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引超时，重试策略等）kwargs 不应包含 id，以避免语义模糊。相反，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 版本新增。

langchain_elasticsearch.vectorstores.ElasticsearchStore¶

`langchain_elasticsearch.vectorstores`.ElasticsearchStore¶