Add error function example in tools #1371
Conversation
|
|
||
| ```python | ||
| def sync_error_handler(ctx: RunContextWrapper[Any], error: Exception) -> str: | ||
| """Custom error handler that provides a formatted error message.""" | ||
| return f"An error occurred: {error.__class__.__name__} - {str(error)}" | ||
|
|
||
| @function_tool(failure_error_function=sync_error_handler) | ||
| def get_latest_news(): | ||
| """Get the latest news from the web.""" | ||
| # This function might fail due to network issues, API limits, etc. | ||
| raise ConnectionError("Failed to connect to news service") | ||
|
|
||
| # The error handler will be called if the tool fails | ||
| # and will return: "An error occurred: ConnectionError - Failed to connect to news service" | ||
| ``` |
There was a problem hiding this comment.
Can we put it before If you are manually creating a FunctionToolobject, then you must handle errors inside theon_invoke_tool function. line?
With this example, it will be even harder to notice that line for class FunctionTool
There was a problem hiding this comment.
its duplicate #1354 Add a comprehensive example for handling function tool errors and you made more comlicated it's hard for beginner
|
Hello @kankute-sameer I appreciate your contribution. I've reviewed the example, and while it's accurate, I'm concerned it might be a bit complex for a beginner to fully grasp. I've been working with PR #1354, which has a very clear and simple example for handling function tool errors. I tested it by passing user_id: 'user_456' and it successfully produced an error, which the error function then handled gracefully. This type of straightforward example is perfect for beginners to understand the core concept of a failure_error_function. Perhaps we could consider using a more beginner-friendly approach like the one in #1354 to make the documentation more accessible to a wider audience. |
|
Yup. That looks great. Closing this as it is a duplicate. |
seratch
added
documentation
Fixes #1367 - Add code example for custom error handling in function tools
Adds a practical code example demonstrating how to use the
failure_error_function parameterwith@function_tooldecorator. The example shows:This addresses the need for better documentation around error handling in function tools, making it easier for developers to implement custom error responses for their tools.