-
Notifications
You must be signed in to change notification settings - Fork 2.2k
docs: Add a comprehensive example for handling function tool errors. #1354
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.
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -320,3 +320,37 @@ When you create a function tool via `@function_tool`, you can pass a `failure_er | |
- If you explicitly pass `None`, then any tool call errors will be re-raised for you to handle. This could be a `ModelBehaviorError` if the model produced invalid JSON, or a `UserError` if your code crashed, etc. | ||
|
||
If you are manually creating a `FunctionTool` object, then you must handle errors inside the `on_invoke_tool` function. | ||
|
||
## Example: Custom Error Handling in Function Tools | ||
|
||
```python | ||
import asyncio | ||
from agents import Agent, Runner, function_tool, FunctionTool, Model | ||
|
||
def my_custom_error_function(error, *args) -> str: | ||
"""A custom function to provide a user-friendly error message.""" | ||
print(f"A tool call failed with the following error: {error}") | ||
return "An internal server error occurred. Please try again later." | ||
|
||
@function_tool(failure_error_function=my_custom_error_function) | ||
def risky_operation(data) -> str: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I feel "risky" is not the case here. It should be more of something that can fail. How about using an example to perform a backend API call (no need to use real backend; just pseudo code)? |
||
"""Performs a risky operation that might fail.""" | ||
if not data: | ||
raise ValueError("Data list cannot be empty.") | ||
return "Operation successful." | ||
|
||
async def main(): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To keep the document page as simple as possible, let's have only the tool and its error function in this code snippet. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please delete this main function part |
||
agent_with_error_tools = Agent( | ||
name="Assistant", | ||
instructions="Use the provided tools to answer.", | ||
model=model, | ||
tools=[risky_operation] | ||
) | ||
try: | ||
result = await Runner.run(agent_with_error_tools, "Run the risky operation with an empty list.") | ||
print("Final Output:", result.final_output) | ||
except Exception as e: | ||
print(f"An unexpected exception occurred: {e}") | ||
|
||
if _name_ == "_main_": | ||
asyncio.run(main()) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this method signature is correct.