docs: clarify OpenAI Agents tool execution - #1741
Open
jaeyoung0509 wants to merge 3 commits into
Open
Conversation
|
|
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was changed
Clarify how tools execute in the OpenAI Agents integration.
FunctionTools, and tools backed by Temporal Activities.activity_as_tool()should be used and that the underlying Activity must still be registered with a Worker.@functiontooltypo.Why?
While using custom tools, I found it easy to assume they were handled the same way as model calls.
Model calls are automatically routed through Temporal Activities, but user-defined
FunctionTools run in the Workflow unless they are explicitly backed by an Activity. The existing docs cover both approaches, but this distinction was easy to miss, especially for tools that perform external I/O.Checklist
Related to [Feature Request] Improve custom function-tool ergonomics and safety in the OpenAI Agents integration #1718
How was this tested:
Documentation-only change. I checked the updated descriptions against the current OpenAI Agents integration implementation.
Updated
temporalio/contrib/openai_agents/README.mdin this PR.