langchain_community.vectorstores.elasticsearch.BaseRetrievalStrategy¶
- class langchain_community.vectorstores.elasticsearch.BaseRetrievalStrategy[source]¶
用于`Elasticsearch`检索策略的基类。
Methods
__init__()before_index_setup(client, text_field, ...)在索引创建之前执行。用于设置任何必需的Elasticsearch资源，如管道。
index(dims_length, vector_query_field, ...)当索引被创建时执行。
query(query_vector, query, *, k, fetch_k, ...)当在商店上执行搜索时执行。
返回策略是否需要在将文本添加到索引之前执行推理。
- __init__()¶
- before_index_setup(client: Elasticsearch, text_field: str, vector_query_field: str) None[source]¶
在索引创建之前执行。用于设置任何必需的Elasticsearch资源，如管道。
- 参数：
client：Elasticsearch客户端。 text_field：索引中包含文本数据的字段。 vector_query_field：索引中包含向量表示的字段。
- Parameters
client (Elasticsearch) –
text_field (str) –
vector_query_field (str) –
- Return type
None
- abstract index(dims_length: Optional[int], vector_query_field: str, similarity: Optional[DistanceStrategy]) Dict[source]¶
当索引被创建时执行。
- 参数：
- dims_length: 嵌入向量的数值长度，
如果不使用基于向量的查询则为None。
- vector_query_field: 包含向量表示的字段
在索引中。
- similarity: 要使用的相似性策略，
如果不使用则为None。
- 返回：
字典：策略的Elasticsearch设置和映射。
- Parameters
dims_length (Optional[int]) –
vector_query_field (str) –
similarity (Optional[DistanceStrategy]) –
- Return type
Dict
- abstract 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[source]¶
当在商店上执行搜索时执行。
- 参数：
- query_vector: 查询向量，
如果不使用基于向量的查询，则为None。
query: 文本查询，如果不使用基于文本的查询，则为None。 k: 要检索的结果总数。 fetch_k: 最初要获取的结果数。 vector_query_field: 索引中包含向量表示的字段。 text_field: 索引中包含文本数据的字段。 filter: 要应用于查询的过滤器子句列表。 similarity: 要使用的相似性策略，如果不使用则为None。
- 返回：
字典：Elasticsearch查询体。
- Parameters
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]) –
- Return type
Dict