Skip to content

Commit

Permalink
add ttl to RedisCache (langchain-ai#9068)
Browse files Browse the repository at this point in the history
Add `ttl` (time to live) to `RedisCache`
  • Loading branch information
glaucocustodio authored and toshishjawale committed Aug 14, 2023
1 parent 636cf9d commit fdef53d
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 10 deletions.
43 changes: 33 additions & 10 deletions libs/langchain/langchain/cache.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,25 @@ def __init__(self, database_path: str = ".langchain.db"):
class RedisCache(BaseCache):
"""Cache that uses Redis as a backend."""

# TODO - implement a TTL policy in Redis

def __init__(self, redis_: Any):
"""Initialize by passing in Redis instance."""
def __init__(self, redis_: Any, *, ttl: Optional[int] = None):
"""
Initialize an instance of RedisCache.
This method initializes an object with Redis caching capabilities.
It takes a `redis_` parameter, which should be an instance of a Redis
client class, allowing the object to interact with a Redis
server for caching purposes.
Parameters:
redis_ (Any): An instance of a Redis client class
(e.g., redis.Redis) used for caching.
This allows the object to communicate with a
Redis server for caching operations.
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.
"""
try:
from redis import Redis
except ImportError:
Expand All @@ -230,6 +245,7 @@ def __init__(self, redis_: Any):
if not isinstance(redis_, Redis):
raise ValueError("Please pass in Redis object.")
self.redis = redis_
self.ttl = ttl

def _key(self, prompt: str, llm_string: str) -> str:
"""Compute key from prompt and llm_string"""
Expand Down Expand Up @@ -261,12 +277,19 @@ def update(self, prompt: str, llm_string: str, return_val: RETURN_VAL_TYPE) -> N
return
# Write to a Redis HASH
key = self._key(prompt, llm_string)
self.redis.hset(
key,
mapping={
str(idx): generation.text for idx, generation in enumerate(return_val)
},
)

with self.redis.pipeline() as pipe:
pipe.hset(
key,
mapping={
str(idx): generation.text
for idx, generation in enumerate(return_val)
},
)
if self.ttl is not None:
pipe.expire(key, self.ttl)

pipe.execute()

def clear(self, **kwargs: Any) -> None:
"""Clear cache. If `asynchronous` is True, flush asynchronously."""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@
REDIS_TEST_URL = "redis://localhost:6379"


def test_redis_cache_ttl() -> None:
import redis

langchain.llm_cache = RedisCache(redis_=redis.Redis.from_url(REDIS_TEST_URL), ttl=1)
langchain.llm_cache.update("foo", "bar", [Generation(text="fizz")])
key = langchain.llm_cache._key("foo", "bar")
assert langchain.llm_cache.redis.pttl(key) > 0


def test_redis_cache() -> None:
import redis

Expand Down

0 comments on commit fdef53d

Please sign in to comment.