autogen_ext.models.cache

class ChatCompletionCache(client: ChatCompletionClient, store: CacheStore[CreateResult | List[str | CreateResult]] | None = None)

基类： ChatCompletionClient, Component[ChatCompletionCacheConfig]

是 ChatCompletionClient 的一个包装器，用于缓存底层客户端的创建结果。缓存命中不会影响原始客户端的 token 使用量。

典型用法

让我们以在磁盘上使用缓存以及 openai 客户端为例。首先安装 autogen-ext 以及所需的软件包

pip install -U "autogen-ext[openai, diskcache]"

并像这样使用它

import asyncio
import tempfile

from autogen_core.models import UserMessage
from autogen_ext.models.openai import OpenAIChatCompletionClient
from autogen_ext.models.cache import ChatCompletionCache, CHAT_CACHE_VALUE_TYPE
from autogen_ext.cache_store.diskcache import DiskCacheStore
from diskcache import Cache


async def main():
    with tempfile.TemporaryDirectory() as tmpdirname:
        # Initialize the original client
        openai_model_client = OpenAIChatCompletionClient(model="gpt-4o")

        # 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)
        cache_store = DiskCacheStore[CHAT_CACHE_VALUE_TYPE](Cache(tmpdirname))
        cache_client = ChatCompletionCache(openai_model_client, cache_store)

        response = await cache_client.create([UserMessage(content="Hello, how are you?", source="user")])
        print(response)  # Should print response from OpenAI
        response = await cache_client.create([UserMessage(content="Hello, how are you?", source="user")])
        print(response)  # Should print cached response


asyncio.run(main())

您现在可以使用 cached_client，就像使用原始客户端一样，但启用了缓存。

参数:

• client (ChatCompletionClient) – 要包装的原始 ChatCompletionClient。

• store (CacheStore) – 一个实现了 get 和 set 方法的存储对象。 用户负责管理存储的生命周期并清理它（如果需要）。 默认为使用内存缓存。

classmethod _from_config(config: ChatCompletionCacheConfig) → Self

从配置对象创建一个组件的新实例。

参数:

config (T) – 配置对象。

返回:

Self – 组件的新实例。

_to_config() → ChatCompletionCacheConfig

转储创建与此实例的配置匹配的组件的新实例所需的配置。

返回:

T – 组件的配置。

actual_usage() → RequestUsage

property capabilities: ModelCapabilities

async close() → None

component_config_schema

ChatCompletionCacheConfig 的别名

component_provider_override: ClassVar[str | None] = 'autogen_ext.models.cache.ChatCompletionCache'

覆盖组件的提供者字符串。 这应该用于防止内部模块名称成为模块名称的一部分。

component_type: ClassVar[ComponentType] = 'chat_completion_cache'

组件的逻辑类型。

count_tokens(messages: Sequence[Annotated[SystemMessage | UserMessage | AssistantMessage | FunctionExecutionResultMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]], *, tools: Sequence[Tool | ToolSchema] = []) → int

async create(messages: Sequence[Annotated[SystemMessage | UserMessage | AssistantMessage | FunctionExecutionResultMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]], *, tools: Sequence[Tool | ToolSchema] = [], json_output: bool | type[BaseModel] | None = None, extra_create_args: Mapping[str, Any] = {}, cancellation_token: CancellationToken | None = None) → CreateResult

ChatCompletionClient.create 的缓存版本。如果对 create 的调用结果已被缓存，它将立即返回，而无需调用底层客户端。

注意：cancellation_token 对于缓存的结果将被忽略。

create_stream(messages: Sequence[Annotated[SystemMessage | UserMessage | AssistantMessage | FunctionExecutionResultMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]], *, tools: Sequence[Tool | ToolSchema] = [], json_output: bool | type[BaseModel] | None = None, extra_create_args: Mapping[str, Any] = {}, cancellation_token: CancellationToken | None = None) → AsyncGenerator[str | CreateResult, None]

ChatCompletionClient.create_stream 的缓存版本。 如果对 create_stream 的调用结果已被缓存，它将直接返回缓存结果，而无需从底层客户端进行流式传输。

注意：cancellation_token 对于缓存的结果将被忽略。

property model_info: ModelInfo

remaining_tokens(messages: Sequence[Annotated[SystemMessage | UserMessage | AssistantMessage | FunctionExecutionResultMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]], *, tools: Sequence[Tool | ToolSchema] = []) → int

total_usage() → RequestUsage