Toggle Menu
Prev Up Next

# `langchain_community.cache`.UpstashRedisCache

class langchain_community.cache.UpstashRedisCache(redis_: Any, *, ttl: Optional[int] = None)

  Cache that uses Upstash Redis as a backend.

  Initialize an instance of UpstashRedisCache.

  This method initializes an object with Upstash Redis caching capabilities. It takes a redis_ parameter, which should be an instance of an Upstash Redis client class, allowing the object to interact with Upstash Redis server for caching purposes.

  Parameters

    - redis – An instance of Upstash Redis client class (e.g., Redis) used for caching. This allows the object to communicate with Redis server for caching operations on.

    - ttl (int, optional) – Time-to-live (TTL) for cached items in seconds. If provided, it sets the time duration for how long cached items will remain valid. If not provided, cached items will not have an automatic expiration.

    - redis_ (Any) –

  Methods

  `__init__`(redis_, *[, ttl]) | Initialize an instance of UpstashRedisCache.
  `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.
  `clear`(**kwargs) | Clear cache.
  `lookup`(prompt, llm_string) | Look up based on prompt and llm_string.
  `update`(prompt, llm_string, return_val) | Update cache based on prompt and llm_string.

  __init__(redis_: Any, *, ttl: Optional[int] = None)

    Initialize an instance of UpstashRedisCache.

    This method initializes an object with Upstash Redis caching capabilities. It takes a redis_ parameter, which should be an instance of an Upstash Redis client class, allowing the object to interact with Upstash Redis server for caching purposes.

    Parameters

      - redis – An instance of Upstash Redis client class (e.g., Redis) used for caching. This allows the object to communicate with Redis server for caching operations on.

      - ttl (int, optional) – Time-to-live (TTL) for cached items in seconds. If provided, it sets the time duration for how long cached items will remain valid. If not provided, cached items will not have an automatic expiration.

      - redis_ (Any) –

  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

  clear(**kwargs: Any) → None

    Clear cache. If asynchronous is True, flush asynchronously. This flushes the whole db.

    Parameters

      kwargs (Any) –

    Return type

      None

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

    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

    Update cache based on prompt and llm_string.

    Parameters

      - prompt (str) –

      - llm_string (str) –

      - return_val (Sequence[Generation]) –

    Return type

      None

# Examples using UpstashRedisCache

- To make the caching really obvious, lets use a slower model.

- Upstash Redis