TResponse = Response

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

TResponseInputItem = ResponseInputItemParam

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

TResponseOutputItem = ResponseOutputItem

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

TResponseStreamEvent = ResponseStreamEvent

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

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

表示工具调用项的类型。

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

由代理生成的项目。

基地：Generic[T]ABC

agent: Agent[Any]

raw_item: T

to_input_item() -> TResponseInputItem

基地：RunItemBase[ResponseOutputMessage]

表示来自 LLM 的消息。

raw_item: ResponseOutputMessage

基地：RunItemBase[ResponseFunctionToolCall]

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

raw_item: ResponseFunctionToolCall

基地：RunItemBase[TResponseInputItem]

表示 handoff 的输出。

raw_item: TResponseInputItem

source_agent: Agent[Any]

target_agent: Agent[Any]

基地：RunItemBase[ToolCallItemTypes]

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

raw_item: ToolCallItemTypes

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

表示工具调用的输出。

raw_item: FunctionCallOutput | ComputerCallOutput

output: str

基地：RunItemBase[ResponseReasoningItem]

表示推理项。

raw_item: ResponseReasoningItem

基地：Generic[TContext]

这将包装您传递给 的 context 对象。它还包含 到目前为止代理运行的使用情况的信息。Runner.run()

注意：上下文不会传递给 LLM。它们是将依赖项和数据传递给代码的一种方式 您实现工具函数、回调、钩子等。

context: TContext

usage: Usage = field(default_factory=Usage)

基地：Exception

代理 SDK 中所有异常的基类。

基地：AgentsException

当超过最大圈数时引发异常。

基地：AgentsException

当模型执行意外作时引发异常，例如调用未执行 存在或提供格式错误的 JSON。

基地：AgentsException

当用户使用 SDK 出错时引发异常。

基地：AgentsException

触发护栏绊线时引发异常。

guardrail_result: InputGuardrailResult = guardrail_result

基地：AgentsException

触发护栏绊线时引发异常。

guardrail_result: OutputGuardrailResult = guardrail_result

护栏函数的输出。

output_info: Any

tripwire_triggered: bool

护栏运行的结果。

guardrail: InputGuardrail[Any]

output: GuardrailFunctionOutput

护栏运行的结果。

guardrail: OutputGuardrail[Any]

agent_output: Any

agent: Agent[Any]

output: GuardrailFunctionOutput

基地：Generic[TContext]

输入护栏是与代理执行并行运行的检查。 它们可用于执行以下作： - 检查输入的消息是否偏离主题 - 如果检测到意外输入，则接管代理执行的控制权

你可以使用装饰器将函数转换为 ， 或 手动创建。@input_guardrail()InputGuardrailInputGuardrail

护栏返回 .如果 是 ，则代理 执行将立即停止并引发异常GuardrailResultresult.tripwire_triggeredTrueInputGuardrailTripwireTriggered

guardrail_function: Callable[
    [
        RunContextWrapper[TContext],
        Agent[Any],
        str | list[TResponseInputItem],
    ],
    MaybeAwaitable[GuardrailFunctionOutput],
]

name: str | None = None

基地：Generic[TContext]

输出护栏是在代理的最终输出上运行的检查。 它们可用于检查输出是否通过某些验证标准

你可以使用装饰器将函数转换为 ， 或手动创建一个。@output_guardrail()OutputGuardrailOutputGuardrail

护栏返回 .如果是 ，将引发异常。GuardrailResultresult.tripwire_triggeredTrueOutputGuardrailTripwireTriggered

guardrail_function: Callable[
    [RunContextWrapper[TContext], Agent[Any], Any],
    MaybeAwaitable[GuardrailFunctionOutput],
]

name: str | None = None

input_guardrail(
    func: _InputGuardrailFuncSync[TContext_co]
    | _InputGuardrailFuncAsync[TContext_co]
    | None = None,
    *,
    name: str | None = None,
) -> (
    InputGuardrail[TContext_co]
    | Callable[
        [
            _InputGuardrailFuncSync[TContext_co]
            | _InputGuardrailFuncAsync[TContext_co]
        ],
        InputGuardrail[TContext_co],
    ]
)

将 sync 或 async 函数转换为 . 它可以直接使用（无括号）或与关键字 args 一起使用，例如：InputGuardrail

@input_guardrail
def my_sync_guardrail(...): ...

@input_guardrail(name="guardrail_name")
async def my_async_guardrail(...): ...

output_guardrail(
    func: _OutputGuardrailFuncSync[TContext_co]
    | _OutputGuardrailFuncAsync[TContext_co]
    | None = None,
    *,
    name: str | None = None,
) -> (
    OutputGuardrail[TContext_co]
    | Callable[
        [
            _OutputGuardrailFuncSync[TContext_co]
            | _OutputGuardrailFuncAsync[TContext_co]
        ],
        OutputGuardrail[TContext_co],
    ]
)

将 sync 或 async 函数转换为 . 它可以直接使用（无括号）或与关键字 args 一起使用，例如：OutputGuardrail

@output_guardrail
def my_sync_guardrail(...): ...

@output_guardrail(name="guardrail_name")
async def my_async_guardrail(...): ...