langchain_elasticsearch.cache.ElasticsearchCache¶

class langchain_elasticsearch.cache.ElasticsearchCache(index_name: str, store_input: bool = True, store_input_params: bool = True, metadata: Optional[Dict[str, Any]] = None, *, es_connection: Optional[Elasticsearch] = None, es_url: Optional[str] = None, es_cloud_id: Optional[str] = None, es_user: Optional[str] = None, es_api_key: Optional[str] = None, es_password: Optional[str] = None, es_params: Optional[Dict[str, Any]] = None)[source]¶

An Elasticsearch cache integration for LLMs.

Initialize the Elasticsearch cache store by specifying the index/alias to use and determining which additional information (like input, timestamp, input parameters, and any other metadata) should be stored in the cache.

Parameters

  • index_name (str) – The name of the index or the alias to use for the cache. If they do not exist an index is created, according to the default mapping defined by the mapping property.

  • store_input (bool) – Whether to store the LLM input in the cache, i.e., the input prompt. Default to True.

  • store_input_params (bool) – Whether to store the input parameters in the cache, i.e., the LLM parameters used to generate the LLM response. Default to True.

  • metadata (Optional[dict]) – Additional metadata to store in the cache, for filtering purposes. This must be JSON serializable in an Elasticsearch document. Default to None.

  • es_connection (Optional[Elasticsearch]) – Optional pre-existing Elasticsearch connection.

  • es_url (Optional[str]) – URL of the Elasticsearch instance to connect to.

  • es_cloud_id (Optional[str]) – Cloud ID of the Elasticsearch instance to connect to.

  • es_user (Optional[str]) – Username to use when connecting to Elasticsearch.

  • es_password (Optional[str]) – Password to use when connecting to Elasticsearch.

  • es_api_key (Optional[str]) – API key to use when connecting to Elasticsearch.

  • es_params (Optional[Dict[str, Any]]) – Other parameters for the Elasticsearch client.

Attributes

mapping

Get the default mapping for the index.

Methods

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

Initialize the Elasticsearch cache store by specifying the index/alias to use and determining which additional information (like input, timestamp, input parameters, and any other metadata) should be stored in the cache.

aclear(**kwargs)

Clear cache that can take additional keyword arguments.

alookup(prompt, llm_string)

Look up based on prompt and llm_string.

aupdate(prompt, llm_string, return_val)

Update cache based on prompt and llm_string.

build_document(prompt, llm_string, return_val)

Build the Elasticsearch document for storing a single LLM interaction

clear(**kwargs)

Clear cache.

lookup(prompt, llm_string)

Look up based on prompt and llm_string.

update(prompt, llm_string, return_val)

Update based on prompt and llm_string.
__init__(index_name: str, store_input: bool = True, store_input_params: bool = True, metadata: Optional[Dict[str, Any]] = None, *, es_connection: Optional[Elasticsearch] = None, es_url: Optional[str] = None, es_cloud_id: Optional[str] = None, es_user: Optional[str] = None, es_api_key: Optional[str] = None, es_password: Optional[str] = None, es_params: Optional[Dict[str, Any]] = None)[source]¶

Initialize the Elasticsearch cache store by specifying the index/alias to use and determining which additional information (like input, timestamp, input parameters, and any other metadata) should be stored in the cache.

Parameters

  • index_name (str) – The name of the index or the alias to use for the cache. If they do not exist an index is created, according to the default mapping defined by the mapping property.

  • store_input (bool) – Whether to store the LLM input in the cache, i.e., the input prompt. Default to True.

  • store_input_params (bool) – Whether to store the input parameters in the cache, i.e., the LLM parameters used to generate the LLM response. Default to True.

  • metadata (Optional[dict]) – Additional metadata to store in the cache, for filtering purposes. This must be JSON serializable in an Elasticsearch document. Default to None.

  • es_connection (Optional[Elasticsearch]) – Optional pre-existing Elasticsearch connection.

  • es_url (Optional[str]) – URL of the Elasticsearch instance to connect to.

  • es_cloud_id (Optional[str]) – Cloud ID of the Elasticsearch instance to connect to.

  • es_user (Optional[str]) – Username to use when connecting to Elasticsearch.

  • es_password (Optional[str]) – Password to use when connecting to Elasticsearch.

  • es_api_key (Optional[str]) – API key to use when connecting to Elasticsearch.

  • es_params (Optional[Dict[str, Any]]) – Other parameters for the Elasticsearch client.

async aclear(**kwargs: Any) → None¶

Clear cache that can take additional keyword arguments.

Parameters

kwargs (Any) –

Return type

None

async alookup(prompt: str, llm_string: str) → Optional[Sequence[Generation]]¶

Look up based on prompt and llm_string.

A cache implementation is expected to generate a key from the 2-tuple of prompt and llm_string (e.g., by concatenating them with a delimiter).

Parameters

  • prompt (str) – a string representation of the prompt. In the case of a Chat model, the prompt is a non-trivial serialization of the prompt into the language model.

  • llm_string (str) – A string representation of the LLM configuration. This is used to capture the invocation parameters of the LLM (e.g., model name, temperature, stop tokens, max tokens, etc.). These invocation parameters are serialized into a string representation.

Returns

On a cache miss, return None. On a cache hit, return the cached value. The cached value is a list of Generations (or subclasses).

Return type

Optional[Sequence[Generation]]

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

Update cache based on prompt and llm_string.

The prompt and llm_string are used to generate a key for the cache. The key should match that of the look up method.

Parameters

  • prompt (str) – a string representation of the prompt. In the case of a Chat model, the prompt is a non-trivial serialization of the prompt into the language model.

  • llm_string (str) – A string representation of the LLM configuration. This is used to capture the invocation parameters of the LLM (e.g., model name, temperature, stop tokens, max tokens, etc.). These invocation parameters are serialized into a string representation.

  • return_val (Sequence[Generation]) – The value to be cached. The value is a list of Generations (or subclasses).

Return type

None

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

Build the Elasticsearch document for storing a single LLM interaction

Parameters

  • prompt (str) –

  • llm_string (str) –

  • return_val (Sequence[Generation]) –

Return type

Dict[str, Any]

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

Clear cache.

Parameters

kwargs (Any) –

Return type

None

lookup(prompt: str, llm_string: str) → Optional[Sequence[Generation]][source]¶

Look up based on prompt and llm_string.

Parameters

  • prompt (str) –

  • llm_string (str) –

Return type

Optional[Sequence[Generation]]

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

Update based on prompt and llm_string.

Parameters

  • prompt (str) –

  • llm_string (str) –

  • return_val (Sequence[Generation]) –

Return type

None