AsyncElasticsearchStore#

class langchain_elasticsearch.vectorstores.AsyncElasticsearchStore(index_name: str, *, embedding: ~langchain_core.embeddings.embeddings.Embeddings | None = None, es_connection: ~elasticsearch.AsyncElasticsearch | None = None, es_url: str | None = None, es_cloud_id: str | None = None, es_user: str | None = None, es_api_key: str | None = None, es_password: str | None = None, vector_query_field: str = 'vector', query_field: str = 'text', distance_strategy: ~typing.Literal[DistanceStrategy.COSINE, DistanceStrategy.DOT_PRODUCT, DistanceStrategy.EUCLIDEAN_DISTANCE, DistanceStrategy.MAX_INNER_PRODUCT] | None = None, strategy: ~langchain_elasticsearch._utilities.BaseRetrievalStrategy | ~elasticsearch.helpers.vectorstore._async.strategies.AsyncRetrievalStrategy = <langchain_elasticsearch._utilities.ApproxRetrievalStrategy object>, es_params: ~typing.Dict[str, ~typing.Any] | None = None, custom_index_settings: ~typing.Dict[str, ~typing.Any] | None = None)[来源]#

属性

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_embeddings`(text_embeddings[, ...])	将给定的文本和嵌入添加到存储中。
`aadd_texts`(texts[, metadatas, ids, ...])	通过嵌入运行更多文本并将其添加到存储中。
`aclose`()
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas, ids])	通过嵌入运行更多文本并将其添加到向量存储中。
`adelete`([ids, refresh_indices])	从Elasticsearch索引中删除文档。
`afrom_documents`(documents[, embedding, ...])	从文档构建ElasticsearchStore包装器。
`afrom_texts`(texts[, embedding, metadatas, ...])	从原始文档构建ElasticsearchStore包装器。
`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, fetch_k, ...])	返回与查询最相似的Elasticsearch文档。
`asimilarity_search_by_vector`(embedding[, k])	异步返回与嵌入向量最相似的文档。
`asimilarity_search_by_vector_with_relevance_scores`(...)	返回与查询最相似的Elasticsearch文档，并附带分数。
`asimilarity_search_with_relevance_scores`(query)	异步返回文档和相关分数，范围在[0, 1]之间。
`asimilarity_search_with_score`(query[, k, ...])	返回与查询最相似的Elasticsearch文档及其分数。
`connect_to_elasticsearch`(*[, es_url, ...])
`delete`([ids])	通过向量ID或其他条件删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas, ids])	返回从文本和嵌入初始化的VectorStore。
`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])	返回与查询最相似的文档。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关度分数，分数范围在[0, 1]之间。
`similarity_search_with_score`(args, *kwargs)	运行带有距离的相似性搜索。

Parameters:

index_name (str)
embedding (Embeddings | None)
es_connection (AsyncElasticsearch | None)
es_url (str | None)
es_cloud_id (str | None)
es_user (str | None)
es_api_key (str | None)
es_password (str | None)
vector_query_field (str)
query_field (str)
distance_strategy (Literal[DistanceStrategy.COSINE, DistanceStrategy.DOT_PRODUCT, DistanceStrategy.EUCLIDEAN_DISTANCE, DistanceStrategy.MAX_INNER_PRODUCT] | None)
strategy (BaseRetrievalStrategy | AsyncRetrievalStrategy)
es_params (Dict[str, Any] | None)
custom_index_settings (Dict[str, Any] | None)

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

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

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

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

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

Parameters:

query_model_id (str | None) – 可选。用于在堆栈中嵌入查询文本的模型ID。需要将嵌入模型部署到Elasticsearch。
hybrid (bool | None) – 可选。如果为True，将执行混合搜索使用knn查询和文本查询。默认为False。
rrf (dict | bool | None) –
可选。rrf 是 Reciprocal Rank Fusion。当 hybrid 为 True 时，

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

rrf 可以用于调整 'rank_constant' 和 'window_size'。

Return type:

ApproxRetrievalStrategy

static BM25RetrievalStrategy(k1: float | None = None, b: float | None = None) → BM25RetrievalStrategy[来源]#

用于在不使用向量搜索的情况下应用BM25。

Parameters:

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

Return type:

BM25检索策略

static ExactRetrievalStrategy() → ExactRetrievalStrategy[source]#

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

Return type:: ExactRetrievalStrategy

static SparseVectorRetrievalStrategy(model_id: str | None = None) → SparseRetrievalStrategy[source]#

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

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

在查询时，文本将使用ELSR模型进行嵌入，生成的标记将用于执行text_expansion查询。

Parameters:: model_id (str | None) – 可选。默认值为“.elser_model_1”。用于在堆栈中嵌入查询文本的模型ID。需要将嵌入模型部署到Elasticsearch。
Return type:: SparseRetrievalStrategy

__init__(index_name: str, *, embedding: ~langchain_core.embeddings.embeddings.Embeddings | None = None, es_connection: ~elasticsearch.AsyncElasticsearch | None = None, es_url: str | None = None, es_cloud_id: str | None = None, es_user: str | None = None, es_api_key: str | None = None, es_password: str | None = None, vector_query_field: str = 'vector', query_field: str = 'text', distance_strategy: ~typing.Literal[DistanceStrategy.COSINE, DistanceStrategy.DOT_PRODUCT, DistanceStrategy.EUCLIDEAN_DISTANCE, DistanceStrategy.MAX_INNER_PRODUCT] | None = None, strategy: ~langchain_elasticsearch._utilities.BaseRetrievalStrategy | ~elasticsearch.helpers.vectorstore._async.strategies.AsyncRetrievalStrategy = <langchain_elasticsearch._utilities.ApproxRetrievalStrategy object>, es_params: ~typing.Dict[str, ~typing.Any] | None = None, custom_index_settings: ~typing.Dict[str, ~typing.Any] | None = None)[源代码]#

Parameters:

index_name (str)
embedding (Embeddings | None)
es_connection (AsyncElasticsearch | None)
es_url (str | None)
es_cloud_id (str | None)
es_user (str | None)
es_api_key (str | None)
es_password (str | None)
vector_query_field (str)
query_field (str)
distance_strategy (Literal[DistanceStrategy.COSINE, DistanceStrategy.DOT_PRODUCT, DistanceStrategy.EUCLIDEAN_DISTANCE, DistanceStrategy.MAX_INNER_PRODUCT] | None)
strategy (BaseRetrievalStrategy | AsyncRetrievalStrategy)
es_params (Dict[str, Any] | None)
custom_index_settings (Dict[str, Any] | None)

async aadd_documents(documents: list[Document], **kwargs: Any) → list[str]#

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

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档。
kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

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

Return type:

列表[字符串]

async aadd_embeddings(text_embeddings: Iterable[Tuple[str, List[float]]], metadatas: List[dict] | None = None, ids: List[str] | None = None, refresh_indices: bool = True, create_index_if_not_exists: bool = True, bulk_kwargs: Dict | None = None, **kwargs: Any) → List[str][source]#

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

Parameters:

text_embeddings (Iterable[Tuple[str, List[float]]]) – 可迭代的字符串和嵌入对，用于添加到存储中。
metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。
ids (List[str] | None) – 可选的唯一ID列表。
refresh_indices (bool) – 是否在添加文本后刷新Elasticsearch索引。
create_index_if_not_exists (bool) – 如果Elasticsearch索引不存在，是否创建它。
*bulk_kwargs (Dict | None) –
传递给Elasticsearch bulk的额外参数。 - chunk_size: 可选。每次添加到

索引的文本数量。默认为500。
kwargs (Any)

Returns:

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

Return type:

列表[str]

async aadd_texts(texts: Iterable[str], metadatas: List[Dict[Any, Any]] | None = None, ids: List[str] | None = None, refresh_indices: bool = True, create_index_if_not_exists: bool = True, bulk_kwargs: Dict | None = None, **kwargs: Any) → List[str][source]#

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

Parameters:

texts (Iterable[str]) – 要添加到存储中的字符串的可迭代对象。
metadatas (List[Dict[Any, Any]] | None) – 可选的与文本关联的元数据列表。
ids (List[str] | None) – 可选的id列表，用于与文本关联。
refresh_indices (bool) – 是否在添加文本后刷新Elasticsearch索引。
create_index_if_not_exists (bool) – 如果Elasticsearch索引不存在，是否创建它。
*bulk_kwargs (Dict | None) –
传递给Elasticsearch bulk的额外参数。 - chunk_size: 可选。每次添加到

索引的文本数量。默认为500。
kwargs (Any)

Returns:

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

Return type:

列表[str]

async aclose() → None[source]#

Return type:: 无

add_documents(documents: list[Document], **kwargs: Any) → list[str]#

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

Parameters:

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

Returns:

已添加文本的ID列表。

Raises:

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

Return type:

列表[字符串]

add_texts(texts: Iterable[str], metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → list[str]#

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

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。
ids (list[str] | None) – 可选的与文本关联的ID列表。
**kwargs (Any) – 向量存储特定参数。其中一个 kwargs 应该是 ids，这是一个与文本相关联的 ID 列表。

Returns:

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

Raises:

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

Return type:

列表[字符串]

async adelete(ids: List[str] | None = None, refresh_indices: bool | None = True, **kwargs: Any) → bool | None[source]#

从Elasticsearch索引中删除文档。

Parameters:

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

Return type:

布尔值 | 无

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings | None = None, bulk_kwargs: Dict | None = None, **kwargs: Any) → AsyncElasticsearchStore[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"
)

Parameters:

texts – 要添加到Elasticsearch索引的文本列表。
embedding (Embeddings | None) – 用于嵌入文本的嵌入函数。如果使用的策略不需要推理，请不要提供。
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 – 可选。存储文本的字段名称。
bulk_kwargs (Dict | None) – 可选的。传递给Elasticsearch bulk的额外参数。
文档 (列表[Document])
kwargs (Any)

Return type:

AsyncElasticsearchStore

async classmethod afrom_texts(texts: List[str], embedding: Embeddings | None = None, metadatas: List[Dict[str, Any]] | None = None, bulk_kwargs: Dict | None = None, **kwargs: Any) → AsyncElasticsearchStore[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"
)

Parameters:

texts (List[str]) – 要添加到Elasticsearch索引中的文本列表。
embedding (Embeddings | None) – 用于嵌入文本的嵌入函数。
metadatas (List[Dict[str, Any]] | None) – 可选的与文本关联的元数据列表。
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 (Dict | None) – 可选的。传递给Elasticsearch bulk的额外参数。
kwargs (Any)

Return type:

AsyncElasticsearchStore

async aget_by_ids(ids: Sequence[str], /) → list[Document]#

通过ID异步获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

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

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

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

Parameters:: ids (Sequence[str]) – 要检索的ID列表。
Returns:: 文档列表。
Return type:: 列表[Document]

在版本0.2.11中添加。

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, fields: List[str] | None = None, *, custom_query: Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None = None, doc_builder: Callable[[Dict], Document] | None = None, **kwargs: Any) → List[Document][source]#

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

Maximal marginal relevance optimizes for similarity to query AND diversity: 在选定的文档中。

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的文档数量。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
fields (List[str] | None) – 从elasticsearch源获取的其他字段。这些字段将被添加到文档元数据中。
custom_query (可调用[[字典[字符串, 任意类型], 字符串 | 无], 字典[字符串, 任意类型]] | 无)
doc_builder (可调用[[字典], 文档] | 无)
kwargs (Any)

Returns:

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

Return type:

列表[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) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

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

Return type:

列表[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever#

返回从此VectorStore初始化的VectorStoreRetriever。

Parameters:

**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

fetch_k: 传递给MMR算法的文档数量: （默认：20）
lambda_mult: MMR返回结果的多样性；: 1表示最小多样性，0表示最大多样性。（默认：0.5）

filter: 按文档元数据过滤

Returns:

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

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

Parameters:

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

Returns:

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

Raises:

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

Return type:

列表[Document]

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

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要获取的文档数量，以传递给 knn num_candidates。
filter (List[dict] | None) – 应用于查询的Elasticsearch过滤子句数组。
custom_query (可调用[[字典[字符串, 任意类型], 字符串 | 无], 字典[字符串, 任意类型]] | 无)
doc_builder (可调用[[字典], 文档] | 无)
kwargs (Any)

Returns:

与查询最相似的文档列表，按相似度降序排列。

Return type:

列表[文档]

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

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

Parameters:

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

Returns:

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

Return type:

列表[Document]

async asimilarity_search_by_vector_with_relevance_scores(embedding: List[float], k: int = 4, filter: List[Dict] | None = None, *, custom_query: Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None = None, doc_builder: Callable[[Dict], Document] | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

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

Parameters:

embedding (List[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
filter (List[Dict] | None) – 应用于查询的Elasticsearch过滤子句数组。
custom_query (可调用[[字典[字符串, 任意类型], 字符串 | 无], 字典[字符串, 任意类型]] | 无)
doc_builder (可调用[[字典], 文档] | 无)
kwargs (Any)

Returns:

与嵌入最相似的文档列表及每个文档的分数

Return type:

列表[元组[文档, 浮点数]]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

异步返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

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

过滤检索到的文档集

Returns:

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

Return type:

列表[元组[Document, 浮点数]]

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

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
filter (List[dict] | None) – 应用于查询的Elasticsearch过滤子句数组。
custom_query (可调用[[字典[字符串, 任意类型], 字符串 | 无], 字典[字符串, 任意类型]] | 无)
doc_builder (可调用[[字典], 文档] | 无)
kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[文档, 浮点数]]

Parameters:

es_url (str | None)
cloud_id (str | None)
api_key (str | None)
username (str | None)
password (str | None)
es_params (Dict[str, Any] | None)

Return type:

异步Elasticsearch

delete(ids: list[str] | None = None, **kwargs: Any) → bool | None#

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

Parameters:

ids (list[str] | None) – 要删除的id列表。如果为None，则删除所有。默认值为None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真，否则为假，如果未实现则为无。

Return type:

可选[布尔]

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

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

Parameters:

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

Returns:

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

Return type:

VectorStore

classmethod from_texts(texts: list[str], embedding: Embeddings, metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → AsyncElasticsearchStore[source]#

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

Parameters:

texts (list[str]) – 要添加到向量存储中的文本。
embedding (Embeddings) – 使用的嵌入函数。
metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。
ids (list[str] | None) – 可选的与文本关联的ID列表。
kwargs (Any) – 额外的关键字参数。

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

get_by_ids(ids: Sequence[str], /) → list[Document]#

通过ID获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

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

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

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

Parameters:: ids (Sequence[str]) – 要检索的ID列表。
Returns:: 文档列表。
Return type:: 列表[Document]

在版本0.2.11中添加。

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

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

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

Parameters:

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

Returns:

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

Return type:

列表[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]#

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

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

Parameters:

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

Returns:

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

Return type:

列表[Document]

search(query: str, search_type: str, **kwargs: Any) → list[Document]#

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

Parameters:

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

Returns:

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

Raises:

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

Return type:

列表[Document]

similarity_search(query: str, k: int = 4, **kwargs: Any) → list[Document][来源]#

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

Parameters:

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

Returns:

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

Return type:

列表[Document]

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

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

Parameters:

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

Returns:

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

Return type:

列表[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

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

用于过滤检索到的文档集。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

similarity_search_with_score(*args: Any, **kwargs: Any) → list[tuple[Document, float]]#

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

Parameters:

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

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]