AsyncElasticsearchCache#

class langchain_elasticsearch.cache.AsyncElasticsearchCache(index_name: str, store_input: bool = True, store_input_params: bool = True, metadata: Dict[str, Any] | 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, es_params: Dict[str, Any] | None = None)[source]#

通过指定要使用的索引/别名并确定应存储在缓存中的其他信息（如输入、输入参数和任何其他元数据）来初始化Elasticsearch缓存存储。

Parameters:

  • index_name (str) – 用于缓存的索引名称或别名。 如果它们不存在，则会根据mapping属性定义的默认映射创建一个索引。

  • store_input (bool) – 是否在缓存中存储LLM输入，即输入提示。默认为True。

  • store_input_params (bool) – 是否在缓存中存储输入参数，即用于生成LLM响应的LLM参数。默认为True。

  • metadata (Optional[dict]) – 用于存储在缓存中的附加元数据，用于过滤目的。这必须是Elasticsearch文档中可JSON序列化的。默认为None。

  • es_url (str | None) – 要连接的Elasticsearch实例的URL。

  • es_cloud_id (str | None) – 要连接的Elasticsearch实例的云ID。

  • es_user (str | None) – 连接到Elasticsearch时使用的用户名。

  • es_password (str | None) – 连接到Elasticsearch时使用的密码。

  • es_api_key (str | None) – 连接到Elasticsearch时使用的API密钥。

  • es_params (Dict[str, Any] | None) – Elasticsearch 客户端的其他参数。

属性

mapping

获取索引的默认映射。

方法

__init__(index_name[, store_input, ...])

通过指定要使用的索引/别名并确定应存储在缓存中的其他信息（如输入、输入参数和任何其他元数据）来初始化Elasticsearch缓存存储。

aclear(**kwargs)

清除缓存。

alookup(prompt, llm_string)

根据提示和llm_string进行查找。

aupdate(prompt, llm_string, return_val)

根据提示和llm_string进行更新。

build_document(prompt, llm_string, return_val)

构建用于存储单个LLM交互的Elasticsearch文档

clear(**kwargs)

清除缓存，可以接受额外的关键字参数。

is_alias()

lookup(prompt, llm_string)

根据提示和llm_string进行查找。

update(prompt, llm_string, return_val)

根据提示和llm_string更新缓存。
__init__(index_name: str, store_input: bool = True, store_input_params: bool = True, metadata: Dict[str, Any] | 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, es_params: Dict[str, Any] | None = None)[source]#

通过指定要使用的索引/别名并确定应存储在缓存中的其他信息（如输入、输入参数和任何其他元数据）来初始化Elasticsearch缓存存储。

Parameters:

  • index_name (str) – 用于缓存的索引名称或别名。 如果它们不存在，则会根据mapping属性定义的默认映射创建一个索引。

  • store_input (bool) – 是否在缓存中存储LLM输入，即输入提示。默认为True。

  • store_input_params (bool) – 是否在缓存中存储输入参数，即用于生成LLM响应的LLM参数。默认为True。

  • metadata (Optional[dict]) – 用于存储在缓存中的附加元数据，用于过滤目的。这必须是Elasticsearch文档中可JSON序列化的。默认为None。

  • es_url (str | None) – 要连接的Elasticsearch实例的URL。

  • es_cloud_id (str | None) – 要连接的Elasticsearch实例的云ID。

  • es_user (str | None) – 连接到Elasticsearch时使用的用户名。

  • es_password (str | None) – 连接到Elasticsearch时使用的密码。

  • es_api_key (str | None) – 连接到Elasticsearch时使用的API密钥。

  • es_params (Dict[str, Any] | None) – Elasticsearch客户端的其他参数。

async aclear(**kwargs: Any) → None[source]#

清除缓存。

Parameters:

kwargs (任意)

Return type:

无

async alookup(prompt: str, llm_string: str) → Sequence[Generation] | None[source]#

根据提示和llm_string进行查找。

Parameters:

  • prompt (str)

  • llm_string (str)

Return type:

序列[生成] | 无

async aupdate(prompt: str, llm_string: str, return_val: Sequence[Generation]) → None[来源]#

根据提示和llm_string进行更新。

Parameters:

  • prompt (str)

  • llm_string (str)

  • return_val (Sequence[Generation])

Return type:

无

build_document(prompt: str, llm_string: str, return_val: Sequence[Generation]) → Dict[str, Any][source]#

构建用于存储单个LLM交互的Elasticsearch文档

Parameters:

  • prompt (str)

  • llm_string (str)

  • return_val (Sequence[Generation])

Return type:

Dict[str, Any]

clear(**kwargs: Any) → None[source]#

清除可以接受额外关键字参数的缓存。

Parameters:

kwargs (任意)

Return type:

无

async is_alias() → bool[source]#
Return type:

布尔

lookup(prompt: str, llm_string: str) → Sequence[Generation] | None[来源]#

根据提示和llm_string进行查找。

缓存实现预计会从提示和llm_string的二元组生成一个键（例如，通过用分隔符连接它们）。

Parameters:

  • prompt (str) – 提示的字符串表示。 在聊天模型的情况下，提示是将提示非平凡地序列化为语言模型。

  • llm_string (str) – LLM配置的字符串表示。 这用于捕获LLM的调用参数 （例如，模型名称、温度、停止标记、最大标记等）。 这些调用参数被序列化为字符串 表示。

Returns:

在缓存未命中时，返回 None。在缓存命中时，返回缓存的值。 缓存的值是 Generations（或其子类）的列表。

Return type:

序列[生成] | 无

update(prompt: str, llm_string: str, return_val: Sequence[Generation]) → None[source]#

根据提示和llm_string更新缓存。

提示和llm_string用于生成缓存的键。 该键应与查找方法的键匹配。

Parameters:

  • prompt (str) – 提示的字符串表示。 在聊天模型的情况下，提示是将提示非平凡地序列化为语言模型。

  • llm_string (str) – LLM配置的字符串表示。 这用于捕获LLM的调用参数 （例如，模型名称、温度、停止标记、最大标记等）。 这些调用参数被序列化为字符串 表示。

  • return_val (Sequence[Generation]) – 要缓存的值。该值是一个Generations（或其子类）的列表。

Return type:

无