Session Persistence
Session persistence helpers for the run pipeline. Only internal persistence/retry helpers live here; public session interfaces stay in higher-level modules.
resolve_nested_history_owned_session_item_refs
resolve_nested_history_owned_session_item_refs(
session_items: Sequence[RunItem],
current_input: str | Sequence[TResponseInputItem],
history_owned_items: Sequence[NestedHistoryOwnedItem],
) -> list[NestedHistoryOwnedItemRef]
Locate explicitly owned nested-history occurrences in full session history.
ソースコード位置: src/agents/run_internal/session_persistence.py
reconcile_nested_history_owned_session_item_refs
reconcile_nested_history_owned_session_item_refs(
session_items: Sequence[RunItem],
previous_refs: Sequence[NestedHistoryOwnedItemRef],
previous_input: str | Sequence[TResponseInputItem],
current_input: str | Sequence[TResponseInputItem],
history_owned_items: Sequence[NestedHistoryOwnedItem],
) -> list[NestedHistoryOwnedItemRef]
Retain surviving ownership and add provenance introduced by a history rewrite.
ソースコード位置: src/agents/run_internal/session_persistence.py
prepare_input_with_session
async
prepare_input_with_session(
input: str | list[TResponseInputItem],
session: Session | None,
session_input_callback: SessionInputCallback | None,
session_settings: SessionSettings | None = None,
*,
include_history_in_prepared_input: bool = True,
preserve_dropped_new_items: bool = False,
) -> tuple[
str | list[TResponseInputItem], list[TResponseInputItem]
]
Prepare model input from session history plus the new turn input.
Returns a tuple of:
- The prepared input that should be sent to the model after normalization and dedupe.
- The subset of items that should be appended to the session store for this turn.
The second value is intentionally not "everything returned by the callback". When a
session_input_callback reorders or filters history, we still need to persist only the
items that belong to the new turn. This function therefore compares the callback output
against deep-copied history and new-input lists, first by object identity and then by
content frequency, so retries and custom merge strategies do not accidentally re-persist
old history as fresh input.
ソースコード位置: src/agents/run_internal/session_persistence.py
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 | |
persist_session_items_for_guardrail_trip
async
persist_session_items_for_guardrail_trip(
session: Session | None,
server_conversation_tracker: OpenAIServerConversationTracker
| None,
session_input_items_for_persistence: list[
TResponseInputItem
]
| None,
original_user_input: str
| list[TResponseInputItem]
| None,
run_state: RunState | None,
store: bool | None = None,
) -> list[TResponseInputItem] | None
Persist input items when a guardrail tripwire is triggered.
ソースコード位置: src/agents/run_internal/session_persistence.py
session_items_for_turn
session_items_for_turn(
turn_result: SingleStepResult,
) -> list[RunItem]
Return the items to persist for a turn, preferring session_step_items when set.
ソースコード位置: src/agents/run_internal/session_persistence.py
resumed_turn_items
resumed_turn_items(
turn_result: SingleStepResult,
) -> tuple[list[RunItem], list[RunItem]]
Return generated and session items for a resumed turn.
ソースコード位置: src/agents/run_internal/session_persistence.py
update_run_state_after_resume
update_run_state_after_resume(
run_state: RunState,
*,
turn_result: SingleStepResult,
generated_items: list[RunItem],
session_items: list[RunItem] | None = None,
) -> None
Update run state fields after resolving an interruption.
ソースコード位置: src/agents/run_internal/session_persistence.py
save_result_to_session
async
save_result_to_session(
session: Session | None,
original_input: str | list[TResponseInputItem],
new_items: list[RunItem],
run_state: RunState | None = None,
*,
response_id: str | None = None,
reasoning_item_id_policy: ReasoningItemIdPolicy
| None = None,
store: bool | None = None,
) -> int
Persist a turn to the session store, keeping track of what was already saved so retries during streaming do not duplicate tool outputs or inputs.
戻り値:
| タイプ | デスクリプション |
|---|---|
int
|
The number of new run items persisted for this call. |
ソースコード位置: src/agents/run_internal/session_persistence.py
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 | |
save_resumed_turn_items
async
save_resumed_turn_items(
*,
session: Session | None,
items: list[RunItem],
persisted_count: int,
response_id: str | None,
reasoning_item_id_policy: ReasoningItemIdPolicy
| None = None,
store: bool | None = None,
) -> int
Persist resumed turn items and return the updated persisted count.
ソースコード位置: src/agents/run_internal/session_persistence.py
rewind_session_items
async
rewind_session_items(
session: Session | None,
items: Sequence[TResponseInputItem],
server_tracker: OpenAIServerConversationTracker
| None = None,
) -> None
Best-effort helper to roll back items recently persisted to a session when a conversation retry is needed, so we do not accumulate duplicate inputs on lock errors.
ソースコード位置: src/agents/run_internal/session_persistence.py
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 | |
wait_for_session_cleanup
async
wait_for_session_cleanup(
session: Session | None,
serialized_targets: Sequence[str],
*,
max_attempts: int = 5,
ignore_ids_for_matching: bool = False,
) -> None
Confirm that rewound items are no longer present in the session tail so the store stays consistent before the next retry attempt begins.