docs: add documentation for async tool usage and error handling #9054
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
- Introduced a new section in tools.md detailing the use of async tools with examples for `acall` and synchronous calls using `allow_tool_async_sync_conversion`. - Updated error message in Tool class to clarify how to handle async tool calls. - Enhanced test for async tool call in sync mode to match the updated error message. Signed-off-by: TomuHirata <tomu.hirata@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation and error handling for async tool usage in DSPy. The changes improve clarity around how to work with asynchronous tools and provide better guidance when errors occur.
Key Changes:
- Added comprehensive documentation section explaining async tool usage with
acalland sync mode conversion - Updated error message to provide clearer instructions for handling async tools, including specific configuration examples
- Enhanced test coverage to verify the improved error message format
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/docs/learn/programming/tools.md | Adds new "Async Tools" section with examples demonstrating both acall usage and sync mode conversion with allow_tool_async_sync_conversion |
| dspy/adapters/types/tool.py | Improves error message clarity by providing specific configuration examples using dspy.configure() and dspy.context() |
| tests/adapters/test_tool.py | Updates test to validate the new error message format using regex pattern matching |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Added a new section on using async tools in synchronous contexts, including examples for temporary and global configuration of async-to-sync conversion. - Updated the Yahoo Finance tutorial to reflect the new async tool capabilities and link to the async tools documentation. Signed-off-by: TomuHirata <tomu.hirata@gmail.com>
- Included the `import asyncio` statement in the example for calling async tools from synchronous code to clarify usage. Signed-off-by: TomuHirata <tomu.hirata@gmail.com>
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.
acalland synchronous calls usingallow_tool_async_sync_conversion.