如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题

管理会话

查找会话、处理所需操作并删除已保存的工作记录。

请将每个会话的 ID 保存到应用的数据存储中。您可以使用该 ID 获取会话的当前状态、处理智能体发出的请求或删除会话。

查找会话

列出项目中的会话,即可浏览之前的工作记录。使用 SDK 的分页辅助方法可以获取后续各页的结果:

列出会话并获取下一页结果
from openai import OpenAI

client = OpenAI()
page = client.beta.agents.sessions.list(limit=20)
print(page.to_json())
if page.has_next_page():
    page = page.get_next_page()
    print(page.to_json())

查看会话详情

获取会话后,您可以查看会话状态、智能体配置、环境以及 required_actions。请传入您的 API 客户端和该对话的会话 ID:

获取会话
# Pass your saved session ID to this helper.
def retrieve_session(client: OpenAI, session_id: str):
    return client.beta.agents.sessions.retrieve(session_id)

如需查看完整的响应模式,请参阅获取会话 API 参考。

处理所需操作

当会话状态为 requires_action 时,您的应用必须先执行所需操作,会话才能继续。收到 agent.session.requires_action 事件后,请获取会话并逐项检查 required_actions 中的条目:

  • function_call: 调用 name 指定的函数,并传入 arguments 中的参数。使用该操作的 turn_id 和 call_id 将结果返回到同一会话。请参阅函数工具。
  • environment_connection: 连接到 environment_id 指定的环境。请参阅连接环境。

应用根据事件判断何时检查会话,再根据获取的会话详情确定要执行哪些操作。应用重启或事件流断开后,请重新获取会话,查看是否有待处理的操作。处理完毕后,请继续监听事件以了解本轮结果。

如需查看已保存的消息、工具调用和各轮结果,请参阅获取条目和轮次。如需确定某条命令由哪个智能体执行,请参阅查看委派情况。

删除会话

当您的应用不再需要某个会话时,可以将其删除。删除后,您将无法再通过 API 访问该会话。底层数据的清理可能仍会异步进行。

删除会话
# Replace the illustrative IDs and URLs below with your own resource values.

from openai import OpenAI


def delete_session(client: OpenAI, session_id: str):
    return client.beta.agents.sessions.delete(session_id)


if __name__ == "__main__":
    result = delete_session(OpenAI(), "sess_123")
    print(result.to_json())

如果您想停止当前工作并保留对话,请取消正在进行的轮次。如需查看删除操作的响应,请参阅删除会话 API 参考。