Version Notice
(dmontagu/graph-run-object preview) This documentation is ahead of the last release by 31 commits. You may see documentation for features not yet supported in the latest release v0.0.49 2025-04-01.
pydantic_ai.result
ResultDataT
module-attribute
ResultDataT = TypeVar(
"ResultDataT", default=str, covariant=True
)
Covariant type variable for the result data type of a run.
StreamedRunResult
dataclass
Bases: Generic[AgentDepsT, ResultDataT]
Result of a streamed run that returns structured data via a tool call.
Source code in pydantic_ai_slim/pydantic_ai/result.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 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 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
|
is_complete
class-attribute
instance-attribute
Whether the stream has all been received.
This is set to True
when one of
stream
,
stream_text
,
stream_structured
or
get_data
completes.
all_messages
all_messages(
*, result_tool_return_content: str | None = None
) -> list[ModelMessage]
Return the history of _messages.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
result_tool_return_content
|
str | None
|
The return content of the tool call to set in the last message.
This provides a convenient way to modify the content of the result tool call if you want to continue
the conversation and want to set the response to the result tool call. If |
None
|
Returns:
Type | Description |
---|---|
list[ModelMessage]
|
List of messages. |
Source code in pydantic_ai_slim/pydantic_ai/result.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
|
all_messages_json
Return all messages from all_messages
as JSON bytes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
result_tool_return_content
|
str | None
|
The return content of the tool call to set in the last message.
This provides a convenient way to modify the content of the result tool call if you want to continue
the conversation and want to set the response to the result tool call. If |
None
|
Returns:
Type | Description |
---|---|
bytes
|
JSON bytes representing the messages. |
Source code in pydantic_ai_slim/pydantic_ai/result.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
|
new_messages
new_messages(
*, result_tool_return_content: str | None = None
) -> list[ModelMessage]
Return new messages associated with this run.
Messages from older runs are excluded.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
result_tool_return_content
|
str | None
|
The return content of the tool call to set in the last message.
This provides a convenient way to modify the content of the result tool call if you want to continue
the conversation and want to set the response to the result tool call. If |
None
|
Returns:
Type | Description |
---|---|
list[ModelMessage]
|
List of new messages. |
Source code in pydantic_ai_slim/pydantic_ai/result.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
|
new_messages_json
Return new messages from new_messages
as JSON bytes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
result_tool_return_content
|
str | None
|
The return content of the tool call to set in the last message.
This provides a convenient way to modify the content of the result tool call if you want to continue
the conversation and want to set the response to the result tool call. If |
None
|
Returns:
Type | Description |
---|---|
bytes
|
JSON bytes representing the new messages. |
Source code in pydantic_ai_slim/pydantic_ai/result.py
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
|
stream
async
stream(
*, debounce_by: float | None = 0.1
) -> AsyncIterator[ResultDataT]
Stream the response as an async iterable.
The pydantic validator for structured data will be called in partial mode on each iteration.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
debounce_by
|
float | None
|
by how much (if at all) to debounce/group the response chunks by. |
0.1
|
Returns:
Type | Description |
---|---|
AsyncIterator[ResultDataT]
|
An async iterable of the response data. |
Source code in pydantic_ai_slim/pydantic_ai/result.py
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
|
stream_text
async
stream_text(
*, delta: bool = False, debounce_by: float | None = 0.1
) -> AsyncIterator[str]
Stream the text result as an async iterable.
Note
Result validators will NOT be called on the text result if delta=True
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
delta
|
bool
|
if |
False
|
debounce_by
|
float | None
|
by how much (if at all) to debounce/group the response chunks by. |
0.1
|
Source code in pydantic_ai_slim/pydantic_ai/result.py
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 |
|
stream_structured
async
stream_structured(
*, debounce_by: float | None = 0.1
) -> AsyncIterator[tuple[ModelResponse, bool]]
Stream the response as an async iterable of Structured LLM Messages.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
debounce_by
|
float | None
|
by how much (if at all) to debounce/group the response chunks by. |
0.1
|
Returns:
Type | Description |
---|---|
AsyncIterator[tuple[ModelResponse, bool]]
|
An async iterable of the structured response message and whether that is the last message. |
Source code in pydantic_ai_slim/pydantic_ai/result.py
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 |
|
get_data
async
get_data() -> ResultDataT
Stream the whole response, validate and return it.
Source code in pydantic_ai_slim/pydantic_ai/result.py
225 226 227 228 229 230 231 232 233 234 235 |
|
usage
usage() -> Usage
Return the usage of the whole run.
Note
This won't return the full usage until the stream is finished.
Source code in pydantic_ai_slim/pydantic_ai/result.py
237 238 239 240 241 242 243 |
|
timestamp
timestamp() -> datetime
Get the timestamp of the response.
Source code in pydantic_ai_slim/pydantic_ai/result.py
245 246 247 |
|
validate_structured_result
async
validate_structured_result(
message: ModelResponse, *, allow_partial: bool = False
) -> ResultDataT
Validate a structured result message.
Source code in pydantic_ai_slim/pydantic_ai/result.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
|