结果
RunResultBase
dataclass
基类: ABC
Source code in src/agents/result.py
输入
instance-attribute
input: str | list[TResponseInputItem]
原始输入项,即在调用run()之前的项。如果存在修改输入的手动输入过滤器,这可能是输入的一个变异版本。
input_guardrail_results
instance-attribute
input_guardrail_results: list[InputGuardrailResult]
输入消息的护栏结果。
output_guardrail_results
instance-attribute
output_guardrail_results: list[OutputGuardrailResult]
代理最终输出的防护栏结果。
final_output_as
一个便捷方法,用于将最终输出转换为特定类型。默认情况下,该转换仅用于类型检查器。如果将raise_if_incorrect_type设置为True,当最终输出不符合给定类型时,我们将抛出TypeError异常。
参数:
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
cls
|
type[T]
|
将最终输出转换成的类型。 |
required |
raise_if_incorrect_type
|
bool
|
如果为True,当最终输出不是给定类型时,我们将抛出TypeError。 |
False
|
返回值:
| 类型 | 描述 |
|---|---|
T
|
最终输出转换为指定类型。 |
Source code in src/agents/result.py
to_input_list
to_input_list() -> list[TResponseInputItem]
创建一个新的输入列表,将原始输入与所有新生成的项合并。
Source code in src/agents/result.py
运行结果
dataclass
Source code in src/agents/result.py
输入
instance-attribute
input: str | list[TResponseInputItem]
原始输入项,即在调用run()之前的项。如果存在修改输入的手动输入过滤器,这可能是输入的一个变异版本。
input_guardrail_results
instance-attribute
input_guardrail_results: list[InputGuardrailResult]
输入消息的防护栏结果。
output_guardrail_results
instance-attribute
output_guardrail_results: list[OutputGuardrailResult]
代理最终输出的防护栏结果。
final_output_as
一个便捷方法,用于将最终输出转换为特定类型。默认情况下,该转换仅用于类型检查器。如果将raise_if_incorrect_type设为True,当最终输出不符合给定类型时,我们会抛出TypeError异常。
参数:
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
cls
|
type[T]
|
将最终输出转换成的类型。 |
required |
raise_if_incorrect_type
|
bool
|
如果为True,当最终输出不是给定类型时,我们将抛出TypeError。 |
False
|
返回值:
| 类型 | 描述 |
|---|---|
T
|
最终输出转换为指定类型。 |
Source code in src/agents/result.py
to_input_list
to_input_list() -> list[TResponseInputItem]
创建一个新的输入列表,将原始输入与所有新生成的项合并。
Source code in src/agents/result.py
运行结果流
dataclass
在流模式下运行的代理结果。您可以使用stream_events方法来接收实时生成的语义事件。
流式处理方法将引发以下异常: - 如果代理超过max_turns限制,将引发MaxTurnsExceeded异常。 - 如果触发防护栏,将引发GuardrailTripwireTriggered异常。
Source code in src/agents/result.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | |
输入
instance-attribute
input: str | list[TResponseInputItem]
原始输入项,即在调用run()之前的项。如果存在修改输入的手动输入过滤器,这可能是输入的一个变异版本。
input_guardrail_results
instance-attribute
input_guardrail_results: list[InputGuardrailResult]
输入消息的护栏结果。
output_guardrail_results
instance-attribute
output_guardrail_results: list[OutputGuardrailResult]
代理最终输出的防护栏结果。
final_output_as
一个便捷方法,用于将最终输出转换为特定类型。默认情况下,该转换仅用于类型检查器。如果将raise_if_incorrect_type设为True,当最终输出不符合给定类型时,我们会抛出TypeError异常。
参数:
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
cls
|
type[T]
|
将最终输出转换成的类型。 |
required |
raise_if_incorrect_type
|
bool
|
如果为True,当最终输出不是给定类型时,我们将抛出TypeError。 |
False
|
返回值:
| 类型 | 描述 |
|---|---|
T
|
最终输出转换为指定类型。 |
Source code in src/agents/result.py
to_input_list
to_input_list() -> list[TResponseInputItem]
创建一个新的输入列表,将原始输入与所有新生成的项合并。
Source code in src/agents/result.py
stream_events
async
stream_events() -> AsyncIterator[StreamEvent]
当新项目生成时流式传输增量数据。我们使用的是OpenAI Responses API中的类型,因此这些是语义事件:每个事件都有一个type字段来描述事件类型,以及该事件的数据。
这将引发: - 如果代理超过max_turns限制,会抛出MaxTurnsExceeded异常。 - 如果触发防护栏,会抛出GuardrailTripwireTriggered异常。