langchain_elasticsearch.vectorstores.SparseRetrievalStrategy

class langchain_elasticsearch.vectorstores.SparseRetrievalStrategy(model_id: Optional[str] = None)

自版本 0.2.0 已弃用: 请使用 SparseVectorStrategy 代替。

使用 text_expansion 处理器的稀疏检索策略。

方法

__init__([model_id])
before_index_setup(client, text_field, ...)	在创建索引之前执行。
index(dims_length, vector_query_field, ...)	在创建索引时执行。
query(query_vector, query, k, fetch_k, ...)	在在存储中进行搜索时执行。
require_inference()	返回该策略是否需要在将文本添加到索引之前执行推理。

参数

model_id (Optional[str]) –

__init__(model_id: Optional[str] = None)

参数

model_id (Optional[str]) –

before_index_setup(client: Elasticsearch, text_field: str, vector_query_field: str) → None

在创建索引之前执行。用于设置任何所需的 Elasticsearch 资源，如管道。

参数

• client (Elasticsearch) – Elasticsearch 客户端。

• text_field (str) – 包含索引中文本数据的字段。

• vector_query_field (str) – 包含索引中向量表示的字段。

返回类型

None

index(dims_length: Optional[int], vector_query_field: str, text_field: str, similarity: Optional[DistanceStrategy]) → Dict

在创建索引时执行。

参数

• dims_length (可选[int]) – 嵌入向量的数字长度，或者如果未使用基于向量的查询则为 None。

• vector_query_field (str) – 包含索引中向量表示的字段。

• text_field (str) – 包含索引中文本数据的字段。

• similarity (可选[DistanceStrategy]) – 要使用的相似度策略，或者如果未使用则使用 None。

返回

策略的 Elasticsearch 设置和映射。

返回类型

Dict

query(query_vector: Optional[List[float]], query: Optional[str], k: int, fetch_k: int, vector_query_field: str, text_field: str, filter: List[dict], similarity: Optional[DistanceStrategy]) → Dict

在在存储中进行搜索时执行。

参数

• query_vector (可选[[float]]) – 查询向量，如果未使用基于向量的查询则为 None。

• query (可选[str]) – 文本查询，如果未使用基于文本的查询则为 None。

• k (int) – 要检索的总结果数。

• fetch_k (int) – 初始检索的结果数。

• vector_query_field (str) – 包含索引中向量表示的字段。

• text_field (str) – 包含索引中文本数据的字段。

• filter ([dict]) – 应用到查询的过滤器子句列表。

• similarity (可选[DistanceStrategy]) – 要使用的相似度策略，或者如果未使用则使用 None。

返回

Elasticsearch 查询体。

返回类型

Dict

require_inference() → bool

返回该策略是否需要在将文本添加到索引之前执行推理。

返回

该策略是否需要在将文本添加到索引之前对其进行推理。

返回类型

布尔型