openai-agents-python/docs/zh/sessions/index.md
2026-11-10 07:54:51 +00:00

32 KiB
Raw Permalink Blame History

search
exclude
true

会话

Agents SDK 提供内置的会话记忆功能,可在多次智能体运行之间自动维护对话历史记录,无需在轮次之间手动处理 .to_input_list()。

会话会存储特定会话的对话历史记录,使智能体无需显式进行手动记忆管理即可保持上下文。这对于构建聊天应用或多轮对话尤其有用,因为在这些场景中,您希望智能体记住之前的交互。

如果您希望由 SDK 管理客户端记忆,请使用会话。在同一次运行中,会话不能与运行级续接选项 conversation_id、previous_response_id 或 auto_previous_response_id 结合使用。如果您希望改用由OpenAI服务器管理的续接机制,请选择其中一种机制,而不要在其基础上叠加会话。

快速入门

from agents import Agent, Runner, SQLiteSession

# Create agent
agent = Agent(
    name="Assistant",
    instructions="Reply very concisely.",
)

# Create a session instance with a session ID
session = SQLiteSession("conversation_123")

# First turn
result = await Runner.run(agent, "What city is the Golden Gate Bridge in?", session=session)
print(result.final_output)  # "San Francisco"

# Second turn - agent automatically remembers previous context
result = await Runner.run(agent, "What state is it in?", session=session)
print(result.final_output)  # "California"

# Also works with synchronous runner
result = Runner.run_sync(agent, "What's the population?", session=session)
print(result.final_output)  # "Approximately 39 million"

使用同一会话恢复中断的运行

如果运行因等待批准而暂停,请使用同一会话实例恢复运行(或使用配置了相同会话 ID 和相同底层存储后端的另一实例),以便恢复后的轮次继续使用同一份已存储的对话历史记录。

result = await Runner.run(
    agent, "Delete temporary files that are no longer needed.", session=session
)

if result.interruptions:
    state = result.to_state()
    for interruption in result.interruptions:
        state.approve(interruption)
    result = await Runner.run(agent, state, session=session)

核心会话行为

启用会话记忆后:

  1. 每次运行前:运行器会自动检索该会话的对话历史记录,并将其添加到输入项之前。
  2. 每次运行后:运行期间生成的所有新项目(用户输入、助手响应、工具调用等)都会自动存储到会话中。
  3. 上下文保留:之后每次使用同一会话运行时,都会包含完整的对话历史记录,使智能体能够保持上下文。

因此,无需手动调用 .to_input_list(),也无需在运行之间管理对话状态。

历史记录与新输入的合并控制

传入会话时,运行器通常会按以下顺序准备模型输入:

  1. 会话历史记录(从 session.get_items(...) 检索)
  2. 新轮次输入

使用 [RunConfig.session_input_callback][agents.run.RunConfig.session_input_callback] 可在调用模型之前自定义该合并步骤。回调接收两个列表:

  • history:检索到的会话历史记录(已规范化为输入项格式)
  • new_input:当前轮次的新输入项

返回应发送给模型的最终输入项列表。

回调接收的是两个列表的副本,因此您可以安全地修改它们。返回的列表控制该轮次的模型输入,但 SDK 仍只会持久化属于新轮次的项目。因此,对旧历史记录重新排序或进行筛选,不会导致旧会话项目作为新输入再次保存。

from agents import Agent, RunConfig, Runner, SQLiteSession


def keep_recent_history(history, new_input):
    # Keep only the last 10 history items, then append the new turn.
    return history[-10:] + new_input


agent = Agent(name="Assistant")
session = SQLiteSession("conversation_123")

result = await Runner.run(
    agent,
    "Continue from the latest updates only.",
    session=session,
    run_config=RunConfig(session_input_callback=keep_recent_history),
)

当您需要自定义裁剪、重新排序或选择性包含历史记录,同时不改变会话存储项目的方式时,请使用此功能。如果您需要在调用模型前立即执行后续的最终处理,请使用运行智能体指南中的 [call_model_input_filter][agents.run.RunConfig.call_model_input_filter]。

检索历史记录的限制

使用 [SessionSettings][agents.memory.SessionSettings] 控制每次运行前获取的历史记录量。

  • SessionSettings(limit=None)(默认):检索所有可用的会话项目
  • SessionSettings(limit=N):仅检索最近的 N 个项目

您可以通过 [RunConfig.session_settings][agents.run.RunConfig.session_settings] 为每次运行应用此设置:

from agents import Agent, RunConfig, Runner, SessionSettings, SQLiteSession

agent = Agent(name="Assistant")
session = SQLiteSession("conversation_123")

result = await Runner.run(
    agent,
    "Summarize our recent discussion.",
    session=session,
    run_config=RunConfig(session_settings=SessionSettings(limit=50)),
)

如果您的会话实现提供默认会话设置,RunConfig.session_settings 中每个非 None 值都会覆盖该次运行对应的默认值。对于长对话,这很有用,因为您可以限制检索量,而无需更改会话的默认行为。

记忆操作

基本操作

会话支持多种用于管理对话历史记录的操作:

from agents import SQLiteSession

session = SQLiteSession("user_123", "conversations.db")

# Get all items in a session
items = await session.get_items()

# Add new items to a session
new_items = [{"role": "user", "content": "Hello"}, {"role": "assistant", "content": "Hi there!"}]
await session.add_items(new_items)

# Remove and return the most recent item
last_item = await session.pop_item()
print(last_item)  # {"role": "assistant", "content": "Hi there!"}

# Clear all items from a session
await session.clear_session()

使用 pop_item 进行更正

当您想撤销或修改对话中的最后一个项目时,pop_item 方法尤其有用:

from agents import Agent, Runner, SQLiteSession

agent = Agent(name="Assistant")
session = SQLiteSession("correction_example")

# Initial conversation
result = await Runner.run(agent, "What's 2 + 2?", session=session)
print(f"Agent: {result.final_output}")

# User wants to correct their question
assistant_item = await session.pop_item()  # Remove agent's response
user_item = await session.pop_item()  # Remove user's question

# Ask a corrected question
result = await Runner.run(agent, "What's 2 + 3?", session=session)
print(f"Agent: {result.final_output}")

内置会话实现

SDK 针对不同用例提供了多种会话实现:

内置会话实现的选择

在阅读下方的详细代码示例之前,请使用此表选择起点。

会话类型 最适用场景 备注
SQLiteSession 本地开发和简单应用 内置、轻量,支持文件或内存后端
AsyncSQLiteSession 采用 aiosqlite 的异步 SQLite 支持异步驱动程序的扩展后端
RedisSession 跨工作进程或服务共享记忆 适合低延迟分布式部署
SQLAlchemySession 使用现有数据库的生产应用 适用于 SQLAlchemy 支持的数据库
MongoDBSession 已使用 MongoDB 或需要多进程存储的应用 异步 pymongo;通过原子序列计数器保证顺序
DaprSession 使用 Dapr sidecar 的云原生部署 支持多种状态存储,以及 TTL 和一致性控制
OpenAIConversationsSession OpenAI中的服务器托管存储 基于 OpenAI Conversations API 的历史记录
OpenAIResponsesCompactionSession 需要自动压缩的长对话 对其他会话后端的封装
AdvancedSQLiteSession SQLite 加分支与分析功能 功能集更丰富;请参阅专门页面
EncryptedSession 在其他会话之上增加加密与 TTL 封装;请先选择底层后端

部分实现有专门页面提供更多详细信息;其链接位于对应的小节中。

如果您正在为 ChatKit 实现 Python 服务器,请使用 chatkit.store.Store 实现来持久化 ChatKit 的线程和项目。SQLAlchemySession 等 Agents SDK 会话用于管理 SDK 侧的对话历史记录,但不能直接替代 ChatKit 的存储。请参阅有关实现 ChatKit 数据存储的 chatkit-python 指南。

OpenAI Conversations API 会话

通过 OpenAIConversationsSession 使用 OpenAI 的 Conversations API。

from agents import Agent, Runner, OpenAIConversationsSession

# Create agent
agent = Agent(
    name="Assistant",
    instructions="Reply very concisely.",
)

# Create a new conversation
session = OpenAIConversationsSession()

# Optionally resume a previous conversation by passing a conversation ID
# session = OpenAIConversationsSession(conversation_id="conv_123")

# Start conversation
result = await Runner.run(agent, "What city is the Golden Gate Bridge in?", session=session)
print(result.final_output)  # "San Francisco"

# Continue the conversation
result = await Runner.run(agent, "What state is it in?", session=session)
print(result.final_output)  # "California"

OpenAI Responses 压缩会话

使用 OpenAIResponsesCompactionSession 通过 Responses API(responses.compact)压缩已存储的对话历史记录。它会封装一个底层会话,并可根据 should_trigger_compaction 在每个轮次后自动压缩。不要用它封装 OpenAIConversationsSession;这两项功能以不同方式管理历史记录。

典型用法(自动压缩)

from agents import Agent, Runner, SQLiteSession
from agents.memory import OpenAIResponsesCompactionSession

underlying = SQLiteSession("conversation_123")
session = OpenAIResponsesCompactionSession(
    session_id="conversation_123",
    underlying_session=underlying,
)

agent = Agent(name="Assistant")
result = await Runner.run(agent, "Hello", session=session)
print(result.final_output)

默认情况下,SDK 会在每个轮次结束后检查待压缩内容是否达到阈值,并仅在达到阈值时进行压缩。

运行自动压缩时,SDK 会等待其完成,然后 Runner.run(...) 才会返回,或者流式事件迭代器才会关闭。压缩请求报告的用量会计入该次运行的 Usage 总量。默认情况下,稍后手动调用 run_compaction() 时没有所属的运行上下文,因此不会更新已完成运行的用量对象。

compaction_mode="previous_response_id" 使用压缩会话保留的 Responses API 响应 ID,并且在该响应链仍然可用时效果最佳。compaction_mode="input" 则根据当前会话项目重新构建压缩请求,适用于响应链不可用或您希望以会话内容作为事实来源的情况。默认的 "auto" 会选择最安全的可用选项。

如果您的智能体使用 ModelSettings(store=False) 运行,Responses API 不会保留最后一个响应供以后查询。在这种无状态设置下,默认的 "auto" 模式会回退到基于输入的压缩,而不是依赖 previous_response_id。如需完整代码示例,请参阅 examples/memory/compaction_session_stateless_example.py。

自动压缩对流式传输的阻塞

压缩会清除并重写会话历史记录,因此 SDK 会等待压缩完成,然后才将运行视为已完成。在流式传输模式下,这意味着如果压缩任务较重,run.stream_events() 可能会在最后一个输出 token 之后继续保持打开数秒。

OpenAIResponsesCompactionSession.run_compaction() 会在封装层边界将清除并重写操作视为可恢复的替换。如果底层历史记录发生更改后,替换失败或被取消,封装会尝试恢复之前的历史记录,并等待该恢复尝试完成,然后才将原始异常或取消传递给调用方。如果底层后端在恢复期间也失败,之前的历史记录可能仍未恢复,SDK 会记录恢复失败。封装会将 add_items()、pop_item() 和 clear_session() 与整个压缩操作串行执行,包括远程请求以及替换或恢复阶段。并发的封装修改操作会等待压缩完成,然后应用到最终生成的历史记录,而不会被覆盖。自动压缩还会记录属于该次运行的封装版本;如果另一次运行在压缩开始前更改了历史记录,SDK 会跳过过期的压缩,而不会替换更新后的历史记录。压缩运行期间,请勿直接修改底层会话,因为直接修改会绕过这些封装保障。

如果您需要低延迟流式传输或快速轮次切换,请禁用自动压缩,并在轮次之间(或空闲时)自行调用 run_compaction()。您可以根据自己的标准决定何时强制压缩。

from agents import Agent, Runner, SQLiteSession
from agents.memory import OpenAIResponsesCompactionSession

underlying = SQLiteSession("conversation_123")
session = OpenAIResponsesCompactionSession(
    session_id="conversation_123",
    underlying_session=underlying,
    # Disable triggering the auto compaction
    should_trigger_compaction=lambda _: False,
)

agent = Agent(name="Assistant")
result = await Runner.run(agent, "Hello", session=session)

# Decide when to compact (e.g., on idle, every N turns, or size thresholds).
await session.run_compaction({"force": True})

SQLite 会话

使用 SQLite 的默认轻量级会话实现:

from agents import SQLiteSession

# In-memory database (lost when process ends)
session = SQLiteSession("user_123")

# Persistent file-based database
session = SQLiteSession("user_123", "conversations.db")

# Use the session
result = await Runner.run(agent, "Hello", session=session)

异步 SQLite 会话

当您需要由 aiosqlite 支持的 SQLite 持久化时,请使用 AsyncSQLiteSession。

pip install aiosqlite
from agents import Agent, Runner
from agents.extensions.memory import AsyncSQLiteSession

agent = Agent(name="Assistant")
session = AsyncSQLiteSession("user_123", db_path="conversations.db")
result = await Runner.run(agent, "Hello", session=session)

Redis 会话

使用 RedisSession 可在多个工作进程或服务之间共享会话记忆。

pip install openai-agents[redis]
from agents import Agent, Runner
from agents.extensions.memory import RedisSession

agent = Agent(name="Assistant")
session = RedisSession.from_url(
    "user_123",
    url="redis://localhost:6379/0",
)
result = await Runner.run(agent, "Hello", session=session)
await session.close()

from_url(...) 会创建并拥有 Redis 客户端。调用 close() 后,该会话将进入终止状态,后续会话操作会引发 RuntimeError;重复或并发调用 close() 是安全的。如果您的应用已经管理 Redis 客户端,请使用 redis_client=... 直接构造 RedisSession(...)。在这种情况下,close() 不执行任何操作,调用方仍拥有客户端,且会话仍可使用。

SQLAlchemy 会话

使用任何受 SQLAlchemy 支持的数据库,实现可用于生产环境的 Agents SDK 会话持久化:

from agents.extensions.memory import SQLAlchemySession

# Using database URL
session = SQLAlchemySession.from_url(
    "user_123", url="postgresql+asyncpg://user:pass@localhost/db", create_tables=True
)

# Using existing engine
from sqlalchemy.ext.asyncio import create_async_engine

engine = create_async_engine("postgresql+asyncpg://user:pass@localhost/db")
session = SQLAlchemySession("user_123", engine=engine, create_tables=True)

详细文档请参阅 SQLAlchemy 会话。

Dapr 会话

如果您已经运行 Dapr sidecar,或希望在不更改智能体代码的情况下切换已配置的状态存储后端,请使用 DaprSession。

pip install openai-agents[dapr]
from agents import Agent, Runner
from agents.extensions.memory import DaprSession

agent = Agent(name="Assistant")

async with DaprSession.from_address(
    "user_123",
    state_store_name="statestore",
    dapr_address="localhost:50001",
) as session:
    result = await Runner.run(agent, "Hello", session=session)
    print(result.final_output)

注意事项:

  • from_address(...) 会为您创建并拥有 Dapr 客户端。如果您的应用已经管理客户端,请使用 dapr_client=... 直接构造 DaprSession(...)。
  • 退出上下文或调用 close() 会使拥有客户端的会话进入终止状态;后续会话操作会引发 RuntimeError,而重复或并发调用 close() 是安全的。使用注入的客户端时,close() 不执行任何操作,且会话仍可使用。
  • 如果后端状态存储支持 TTL,请传入 ttl=...,以自动对会话数据应用 TTL 过期机制。
  • 传入 consistency=DAPR_CONSISTENCY_STRONG 可请求对状态写入和删除采用强一致性(取决于存储)。请注意,线路级读取一致性需要上游 Dapr Python 客户端支持为 get_state 设置一致性。
  • Dapr Python SDK 还会检查 HTTP sidecar 端点。在本地开发中,启动 Dapr 时,除了 dapr_address 中使用的 gRPC 端口外,还应指定 --dapr-http-port 3500。
  • 如需包含本地组件和故障排除的完整设置演练,请参阅 examples/memory/dapr_session_example.py。

MongoDB 会话

对于已经使用 MongoDB 或需要可横向扩展的多进程会话存储的应用,请使用 MongoDBSession。

pip install openai-agents[mongodb]
from agents import Agent, Runner
from agents.extensions.memory import MongoDBSession

agent = Agent(name="Assistant")

# Create from URI — owns the client and closes it when session.close() is called
session = MongoDBSession.from_uri(
    "user-123",
    uri="mongodb://localhost:27017",
    database="agents",
)
result = await Runner.run(agent, "Hello", session=session)
print(result.final_output)
await session.close()

注意事项:

  • from_uri(...) 会创建并拥有 AsyncMongoClient,并在调用 session.close() 时将其关闭。拥有客户端的会话会在调用 close() 后进入终止状态,后续会话操作会引发 RuntimeError。如果您的应用已经管理客户端,请使用 client=... 直接构造 MongoDBSession(...);在这种情况下,session.close() 不执行任何操作,调用方仍负责管理客户端生命周期,且会话仍可使用。
  • 将 mongodb+srv://user:password@cluster.example.mongodb.net URI 传入 from_uri(...) 即可连接到 MongoDB Atlas,无需进行其他更改。
  • 系统会使用两个集合,且可分别通过 sessions_collection=(默认值为 agent_sessions)和 messages_collection=(默认值为 agent_messages)配置其名称。首次使用时会自动创建索引。每次非空的 add_items() 调用都会写入一个逻辑批次文档,其中单调递增的 seq 会按批次的最后一个项目对批次排序;旧版逐项目消息文档仍可读取。逻辑批次必须符合 MongoDB 的单文档大小限制;过大的批次将以原子方式失败,不会存储部分批次。
  • 在首次运行前,使用 await session.ping() 验证连接。

高级 SQLite 会话

增强型 SQLite 会话,支持对话分支、用量分析和结构化查询:

from agents.extensions.memory import AdvancedSQLiteSession

# Create with advanced features
session = AdvancedSQLiteSession(
    session_id="user_123", db_path="conversations.db", create_tables=True
)

# Automatic usage tracking
result = await Runner.run(agent, "Hello", session=session)
await session.store_run_usage(result)  # Track token usage

# Conversation branching
await session.create_branch_from_turn(2)  # Branch from turn 2

详细文档请参阅高级 SQLite 会话。

加密会话

适用于任何会话实现的透明加密封装:

from agents.extensions.memory import EncryptedSession, SQLAlchemySession

# Create underlying session
underlying_session = SQLAlchemySession.from_url(
    "user_123", url="sqlite+aiosqlite:///conversations.db", create_tables=True
)

# Wrap with encryption and TTL
session = EncryptedSession(
    session_id="user_123",
    underlying_session=underlying_session,
    encryption_key="your-secret-key",
    ttl=600,  # 10 minutes
)

result = await Runner.run(agent, "Hello", session=session)

详细文档请参阅加密会话。

其他会话类型

此外还有一些内置选项。请参阅 examples/memory/ 和 extensions/memory/ 下的源代码。

运维模式

会话 ID 命名

使用有意义的会话 ID,以便组织对话:

  • 基于用户:"user_12345"
  • 基于线程:"thread_abc123"
  • 基于上下文:"support_ticket_456"

记忆持久化

  • 对于临时对话,使用内存型 SQLite(SQLiteSession("session_id"))
  • 对于持久化对话,使用文件型 SQLite(SQLiteSession("session_id", "path/to/db.sqlite"))
  • 当您需要基于 aiosqlite 的实现时,使用异步 SQLite(AsyncSQLiteSession("session_id", db_path="..."))
  • 对于共享的低延迟会话记忆,使用 Redis 后端会话(RedisSession.from_url("session_id", url="redis://..."))
  • 对于使用 SQLAlchemy 所支持现有数据库的生产系统,使用由 SQLAlchemy 驱动的会话(SQLAlchemySession("session_id", engine=engine, create_tables=True))
  • 对于已经使用 MongoDB 或需要多进程、可横向扩展会话存储的应用,使用 MongoDB 会话(MongoDBSession.from_uri("session_id", uri="mongodb://localhost:27017"))
  • 对于需要内置遥测、追踪和数据隔离,并支持 30 多种数据库后端的生产级云原生部署,使用 Dapr 状态存储会话(DaprSession.from_address("session_id", state_store_name="statestore", dapr_address="localhost:50001"))
  • 如果您希望将历史记录存储在 OpenAI Conversations API 中,请使用由OpenAI托管的存储(OpenAIConversationsSession())
  • 使用加密会话(EncryptedSession(session_id, underlying_session, encryption_key))封装任意会话,以获得透明加密和基于 TTL 的过期机制
  • 对于更高级的用例,请考虑为其他生产系统(例如 Django)实现自定义会话后端

SQLite 存储信任边界

SQLiteSession 假定应用信任 SQLite 数据库及其存储。该后端不会验证已存储行的真实性,也不会检测外部编辑、删除、重新排序或重放操作。会话 ID 用于选择对话历史记录;会话 ID 不会验证用户身份,也不会授权访问该历史记录。

当 get_items() 读取历史记录时,该方法会按 session_id 选择行,根据行的插入 ID 排序,并将每行的 message_data 解码为 JSON。因此,直接对数据库所做的更改可能会出现在返回给应用并供下一次智能体运行使用的历史记录中。如果某行的 message_data 无法解码为 JSON,系统会跳过该行,而不会引发完整性错误。更改某行的 created_at 值不会改变返回的项目或其顺序。

应用必须对每个会话的访问进行授权,并限制对数据库文件、其所在存储和备份的访问。对于需要在共享或不受信任的存储上进行篡改检测的部署,请使用存储控制措施,或使用能够强制实施所需完整性保障的自定义 [Session][agents.memory.session.Session] 实现。EncryptedSession 封装提供加密功能,但不会验证对话历史记录的完整性或顺序,并且会接受未加密的项目;该封装不能替代这些完整性控制措施。

多会话

from agents import Agent, Runner, SQLiteSession

agent = Agent(name="Assistant")

# Different sessions maintain separate conversation histories
session_1 = SQLiteSession("user_123", "conversations.db")
session_2 = SQLiteSession("user_456", "conversations.db")

result1 = await Runner.run(agent, "Help me with my account", session=session_1)
result2 = await Runner.run(agent, "What are my charges?", session=session_2)

会话共享

# Different agents can share the same session
support_agent = Agent(name="Support")
billing_agent = Agent(name="Billing")
session = SQLiteSession("user_123")

# Both agents will see the same conversation history
result1 = await Runner.run(support_agent, "Help me with my account", session=session)
result2 = await Runner.run(billing_agent, "What are my charges?", session=session)

完整代码示例

以下是一个展示会话记忆实际运行方式的完整代码示例:

import asyncio
from agents import Agent, Runner, SQLiteSession


async def main():
    # Create an agent
    agent = Agent(
        name="Assistant",
        instructions="Reply very concisely.",
    )

    # Create a session instance that will persist across runs
    session = SQLiteSession("conversation_123", "conversation_history.db")

    print("=== Sessions Example ===")
    print("The agent will remember previous messages automatically.\n")

    # First turn
    print("First turn:")
    print("User: What city is the Golden Gate Bridge in?")
    result = await Runner.run(agent, "What city is the Golden Gate Bridge in?", session=session)
    print(f"Assistant: {result.final_output}")
    print()

    # Second turn - the agent will remember the previous conversation
    print("Second turn:")
    print("User: What state is it in?")
    result = await Runner.run(agent, "What state is it in?", session=session)
    print(f"Assistant: {result.final_output}")
    print()

    # Third turn - continuing the conversation
    print("Third turn:")
    print("User: What's the population of that state?")
    result = await Runner.run(agent, "What's the population of that state?", session=session)
    print(f"Assistant: {result.final_output}")
    print()

    print("=== Conversation Complete ===")
    print("Notice how the agent remembered the context from previous turns!")
    print("Sessions automatically handles conversation history.")


if __name__ == "__main__":
    asyncio.run(main())

自定义会话实现

您可以创建一个在结构上遵循 [Session][agents.memory.session.Session] 协议的类,实现自己的会话记忆。您无需继承 SessionABC;只需定义 session_id 和 session_settings,并直接实现四个历史记录方法:

from agents import Agent, Runner, SessionSettings
from agents.items import TResponseInputItem


class MyCustomSession:
    """Custom session implementation following the Session protocol."""

    session_settings: SessionSettings | None = None

    def __init__(self, session_id: str) -> None:
        self.session_id = session_id
        self.items: list[TResponseInputItem] = []

    async def get_items(self, limit: int | None = None) -> list[TResponseInputItem]:
        if limit is None:
            return list(self.items)
        if limit <= 0:
            return []
        return list(self.items[-limit:])

    async def add_items(self, items: list[TResponseInputItem]) -> None:
        self.items.extend(items)

    async def pop_item(self) -> TResponseInputItem | None:
        return self.items.pop() if self.items else None

    async def clear_session(self) -> None:
        self.items.clear()


# Use your custom session
agent = Agent(name="Assistant")
result = await Runner.run(agent, "Hello", session=MyCustomSession("my_session"))

从自定义会话访问运行上下文

Agents SDK 可以将当前的 [RunContextWrapper][agents.run_context.RunContextWrapper] 传递给自定义会话,以用于租户路由、授权或其他特定于应用的存储决策。要让 Agents SDK 传递该封装,请为全部四个历史记录方法添加一个显式命名且与关键字兼容的 wrapper 参数:

from typing import Any

from agents import RunContextWrapper
from agents.items import TResponseInputItem


class ContextAwareSession:
    async def get_items(
        self,
        limit: int | None = None,
        *,
        wrapper: RunContextWrapper[Any] | None = None,
    ) -> list[TResponseInputItem]: ...

    async def add_items(
        self,
        items: list[TResponseInputItem],
        *,
        wrapper: RunContextWrapper[Any] | None = None,
    ) -> None: ...

    async def pop_item(
        self,
        *,
        wrapper: RunContextWrapper[Any] | None = None,
    ) -> TResponseInputItem | None: ...

    async def clear_session(
        self,
        *,
        wrapper: RunContextWrapper[Any] | None = None,
    ) -> None: ...

仅当 get_items、add_items、pop_item 和 clear_session 均声明 wrapper 时,Agents SDK 才会启用此集成。通用的 **kwargs 参数不满足此签名检查。省略 wrapper 的现有会话实现会保留其已发布的调用形式,并可继续使用,无需更改。

社区会话实现

社区已开发了其他会话实现:

软件包 说明
openai-django-sessions 基于 Django ORM 的会话,适用于任何受 Django 支持的数据库(PostgreSQL、MySQL、SQLite 等)

如果您已构建会话实现,欢迎提交文档 PR,将其添加到此处!

API 参考

有关详细的 API 文档,请参阅:

  • [Session][agents.memory.session.Session] - 协议接口
  • [OpenAIConversationsSession][agents.memory.OpenAIConversationsSession] - OpenAI Conversations API 实现
  • [OpenAIResponsesCompactionSession][agents.memory.openai_responses_compaction_session.OpenAIResponsesCompactionSession] - Responses API 压缩封装
  • [SQLiteSession][agents.memory.sqlite_session.SQLiteSession] - 基础 SQLite 实现
  • [AsyncSQLiteSession][agents.extensions.memory.async_sqlite_session.AsyncSQLiteSession] - 基于 aiosqlite 的异步 SQLite 实现
  • [RedisSession][agents.extensions.memory.redis_session.RedisSession] - Redis 后端会话实现
  • [SQLAlchemySession][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - 由 SQLAlchemy 驱动的实现
  • [MongoDBSession][agents.extensions.memory.mongodb_session.MongoDBSession] - MongoDB 后端会话实现
  • [DaprSession][agents.extensions.memory.dapr_session.DaprSession] - Dapr 状态存储实现
  • [AdvancedSQLiteSession][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - 支持分支和分析功能的增强型 SQLite
  • [EncryptedSession][agents.extensions.memory.encrypt_session.EncryptedSession] - 适用于任何会话的加密封装