Skip to content

Add run context to handoff input filter to align with Python SDK #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 4, 2025
Merged

Add run context to handoff input filter to align with Python SDK #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6ec2c0
Add run context to handoff input filter to align with Python SDK
seratch Jul 30, 2025
d1095f9
Create shiny-months-smoke.md
seratch Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-months-smoke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@openai/agents-core": patch
---

Add run context to handoff input filter to align with Python SDK
4 changes: 3 additions & 1 deletion packages/agents-core/src/extensions/handoffFilters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ const TOOL_TYPES = new Set([
export function removeAllTools(
handoffInputData: HandoffInputData,
): HandoffInputData {
const { inputHistory, preHandoffItems, newItems } = handoffInputData;
const { inputHistory, preHandoffItems, newItems, runContext } =
handoffInputData;

const filteredHistory = Array.isArray(inputHistory)
? removeToolTypesFromInput(inputHistory)
Expand All @@ -37,6 +38,7 @@ export function removeAllTools(
inputHistory: filteredHistory,
preHandoffItems: filteredPreHandoffItems,
newItems: filteredNewItems,
runContext,
};
}

Expand Down
5 changes: 5 additions & 0 deletions packages/agents-core/src/handoff.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ export type HandoffInputData = {
* handoff and the tool output message representing the response from the handoff output.
*/
newItems: RunItem[];
/**
* The context of the handoff.
* Note that, since this property was added later on, it's optional to pass from users.
*/
runContext?: RunContext<any>;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

before merging this PR, check the review result at openai/openai-agents-python#1302; the name should be consistent

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, the name is run_context in python; so this is ready to go

};

export type HandoffInputFilter = (input: HandoffInputData) => HandoffInputData;
Expand Down
1 change: 1 addition & 0 deletions packages/agents-core/src/runImplementation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1025,6 +1025,7 @@ export async function executeHandoffCalls<
: originalInput,
preHandoffItems: [...preStepItems],
newItems: [...newStepItems],
runContext,
};

const filtered = inputFilter(handoffInputData);
Expand Down