autogen icon indicating copy to clipboard operation
autogen copied to clipboard

Fix RedisStore class name typo in migration guide

Open bhaskargurram-ai opened this issue 2 months ago • 3 comments

Fixes #7084

Summary

Corrects a typo in the migration guide where RedisCacheStore was used instead of the correct class name RedisStore.

Problem

Users trying to use Redis cache following the migration guide example would encounter an error because RedisCacheStore doesn't exist - the correct class is RedisStore.

Changes

  • File: python/packages/autogen-agentchat/docs/src/user-guide/agentchat-user-guide/migration-guide.md
  • Line 217: Changed RedisCacheStore → RedisStore

Verification

  • ✅ Line 214 imports the correct class: from autogen_ext.cache_store.redis import RedisStore
  • ✅ Line 188 references the correct class: RedisStore
  • ✅ Line 217 now matches the correct import

Before:

# cache_store = RedisCacheStore[CHAT_CACHE_VALUE_TYPE](redis_instance)

After:

# cache_store = RedisStore[CHAT_CACHE_VALUE_TYPE](redis_instance)

This ensures users can correctly copy-paste the Redis cache example without encountering a NameError.

Thanks to @mhou7712 for reporting this issue!

bhaskargurram-ai avatar Oct 23 '25 17:10 bhaskargurram-ai

@microsoft-github-policy-service agree

bhaskargurram-ai avatar Oct 23 '25 17:10 bhaskargurram-ai

I analyzed this issue but couldn't identify the affected files. Could you please provide more details about which files need to be modified?

priteesshhh avatar Nov 09 '25 19:11 priteesshhh

The file name, called "_chat_completion_cache.py", under ~/autogen_ext/models/cache. The example of using redis:

                # Then initialize the CacheStore, in this case with diskcache.Cache.
                # You can also use redis like:
                # from autogen_ext.cache_store.redis import RedisStore
                # import redis
                # redis_instance = redis.Redis()
                # cache_store = RedisCacheStore[CHAT_CACHE_VALUE_TYPE](redis_instance)

"RedisCacheStore" should be "RedisStore" instead.

mhou7712 avatar Nov 10 '25 17:11 mhou7712