OpenAI Agents SDK 中文文档 中文教程 （8）

 英文文档原文详见 OpenAI Agents SDKhttps://openai.github.io/openai-agents-python/

本文是OpenAI-agents-sdk-python使用翻译软件翻译后的中文文档/教程。分多个帖子发布，帖子的目录如下：

(1) OpenAI 代理 SDK， 介绍及快速入门

(2)OpenAI agents sdk, agents，运行agents，结果，流，工具，交接

(3) OpenAi agents sdk, 跟踪，上下文管理，护栏

(4) Openai agents sdk, 编排多个代理，模型，配置SDK

(5)(6)..等等，后面的都放到openai agents sdk的这个专栏https://blog.youkuaiyun.com/wtsolutions/category_12916751.html里面了，大家可以到专栏里面看到所有的目录，欢迎订阅这个专栏。

目录

Items

TResponse module-attribute

TResponseInputItem module-attribute

TResponseOutputItem module-attribute

TResponseStreamEvent 模块属性

ToolCallItemTypes 模块属性

RunItem module-attribute

RunItemBase 数据类

agent instance-attribute

raw_item instance-attribute

to_input_item

MessageOutputItem 数据类

raw_item instance-attribute

HandoffCallItem 数据类

raw_item instance-attribute

HandoffOutputItem 数据类

raw_item instance-attribute

source_agent instance-attribute

target_agent instance-attribute

ToolCallItem 数据类

raw_item instance-attribute

ToolCallOutputItem 数据类

raw_item instance-attribute

output 实例属性

ReasoningItem 数据类

raw_item instance-attribute

ModelResponse 数据类

output 实例属性

usage 实例属性

referenceable_id instance-attribute

to_input_items

ItemHelpers

extract_last_content 类方法

extract_last_text 类方法

input_to_new_input_list 类方法

text_message_outputs 类方法

text_message_output 类方法

tool_call_output_item 类方法

Run context

RunContextWrapper 数据类

context 实例属性

usage 类-attribute 实例-属性

Usage

使用情况 数据类

requests 类-属性-实例-属性

input_tokens 类属性 instance-attribute

output_tokens 类属性实例属性

total_tokens 类属性 instance-attribute

Exceptions

AgentsException （代理例外）

超出最大转数

ModelBehaviorError

UserError （用户错误）

InputGuardrailTripwire触发

guardrail_result instance-attribute

OutputGuardrailTripwire触发

guardrail_result instance-attribute

Guardrails

GuardrailFunctionOutput 数据类

output_info instance-attribute

tripwire_triggered instance-attribute

InputGuardrailResult 数据类

护栏 实例属性

output 实例属性

OutputGuardrailResult 数据类

护栏 实例属性

agent_output instance-attribute

agent instance-attribute

output 实例属性

InputGuardrail 数据类

guardrail_function instance-attribute

name 类-属性-实例-属性

OutputGuardrail 数据类

guardrail_function instance-attribute

name 类-属性-实例-属性

input_guardrail

output_guardrail

---

---

 

Items

TResponse module-attribute

TResponse = Response

OpenAI SDK 中 Response 类型的类型别名。

TResponseInputItem module-attribute

TResponseInputItem = ResponseInputItemParam

OpenAI SDK 中 ResponseInputItemParam 类型的类型别名。

TResponseOutputItem module-attribute

TResponseOutputItem = ResponseOutputItem

OpenAI 开发工具包中 ResponseOutputItem 类型的类型别名。

TResponseStreamEvent 模块属性

TResponseStreamEvent = ResponseStreamEvent

OpenAI SDK 中 ResponseStreamEvent 类型的类型别名。

ToolCallItemTypes 模块属性

ToolCallItemTypes: TypeAlias = Union[
    ResponseFunctionToolCall,
    ResponseComputerToolCall,
    ResponseFileSearchToolCall,
    ResponseFunctionWebSearch,
]

表示工具调用项的类型。

RunItem module-attribute

RunItem: TypeAlias = Union[
    MessageOutputItem,
    HandoffCallItem,
    HandoffOutputItem,
    ToolCallItem,
    ToolCallOutputItem,
    ReasoningItem,
]

由代理生成的项目。

RunItemBase 数据类

基地：Generic[T]ABC

源码src/agents/items.py

agent instance-attribute

agent: Agent[Any]

运行导致生成此项目的代理。

raw_item instance-attribute

raw_item: T

运行中的原始 Responses 项。这将始终是一个输出项（即 或输入项 （即 ）。openai.types.responses.ResponseOutputItemopenai.types.responses.ResponseInputItemParam

to_input_item

to_input_item() -> TResponseInputItem

将此项转换为适合传递给模型的输入项。

源码src/agents/items.py

MessageOutputItem 数据类

基地：RunItemBase[ResponseOutputMessage]

表示来自 LLM 的消息。

源码src/agents/items.py

raw_item instance-attribute

raw_item: ResponseOutputMessage

原始响应输出消息。

HandoffCallItem 数据类

基地：RunItemBase[ResponseFunctionToolCall]

表示从一个代理切换到另一个代理的工具调用。

源码src/agents/items.py

raw_item instance-attribute

raw_item: ResponseFunctionToolCall

表示切换的原始响应函数工具调用。

HandoffOutputItem 数据类

基地：RunItemBase[TResponseInputItem]

表示 handoff 的输出。

源码src/agents/items.py

raw_item instance-attribute

raw_item: TResponseInputItem

表示正在进行的切换的原始输入项。

source_agent instance-attribute

source_agent: Agent[Any]

进行交接的代理。

target_agent instance-attribute

target_agent: Agent[Any]

正在移交给的代理。

ToolCallItem 数据类

基地：RunItemBase[ToolCallItemTypes]

表示工具调用，例如函数调用或计算机作调用。

源码src/agents/items.py

raw_item instance-attribute

raw_item: ToolCallItemTypes

原始工具调用项。

ToolCallOutputItem 数据类

基地：RunItemBase[Union[FunctionCallOutput, ComputerCallOutput]]

表示工具调用的输出。

源码src/agents/items.py

raw_item instance-attribute

raw_item: FunctionCallOutput | ComputerCallOutput

模型中的原始项。</