Refactor query engine tool code and use auto_routed mode for LlamaCloudIndex

leehuwuj commented 3 days ago

Fix: https://github.com/run-llama/create-llama/issues/434

Summary by CodeRabbit

New Features
- Introduced a streamlined query engine tool creation process across various components.
- Added support for a single query engine tool instead of multiple tools in workflows.
- Enhanced functionality for the LlamaCloudIndex with auto-routing capabilities.
Bug Fixes
- Improved error handling and parameter management in query engine functions.
Documentation
- Updated function signatures and descriptions to reflect changes in tool management.
Refactor
- Simplified the logic in multiple functions to enhance modularity and readability.
- Removed unnecessary parameters and improved the overall flow of tool creation.
Chores
- Cleaned up import statements and organized code structure for better maintainability.

changeset-bot[bot] commented 3 days ago

🦋 Changeset detected

Latest commit: 88f19646b0372c72013521ee1abb52fe1be7deb4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ------------ | ----- | | create-llama | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai[bot] commented 3 days ago

Walkthrough

This pull request introduces significant modifications across several files, primarily focusing on the creation and management of QueryEngineTool instances. Key changes include the removal and integration of functions for creating query engine tools, updates to existing function signatures, and the refactoring of workflows to streamline the handling of parameters. The changes aim to simplify the overall structure and enhance modularity in how query engines are instantiated and utilized across different components.

Changes

File Path	Change Summary
`templates/components/agents/python/blog/app/agents/researcher.py`	Removed `_create_query_engine_tool` and integrated its logic into `_get_research_tools`, which now creates an `IndexConfig` and manages tool creation directly.
`templates/components/agents/python/financial_report/app/workflows/financial_report.py`	Added `_create_query_engine_tool` function for managing query engine creation, simplifying the `create_workflow` logic.
`templates/components/agents/python/form_filling/app/workflows/form_filling.py`	Introduced `_create_query_engine_tool` function and restructured `create_workflow` to enhance modularity and remove inline index handling.
`templates/components/engines/python/agent/engine.py`	Modified `get_chat_engine` to remove the `filters` parameter and simplify query engine instantiation.
`templates/components/engines/python/agent/tools/query_engine.py`	Introduced `create_query_engine` and `get_query_engine_tool` functions for managing query engines.
`templates/components/multiagent/python/app/api/routers/chat.py`	Reformatted `create_workflow` call for readability without changing logic.
`templates/components/agents/typescript/blog/workflow/agents.ts`	Updated tool retrieval in `createResearcher` to focus on a single query engine tool.
`templates/components/agents/typescript/financial_report/workflow/factory.ts`	Changed tool handling in `createWorkflow` to utilize a single query engine tool.
`templates/components/agents/typescript/financial_report/workflow/fin-report.ts`	Updated `FinancialReportWorkflow` to manage a single query engine tool instead of an array.
`templates/components/agents/typescript/form_filling/workflow/factory.ts`	Modified `createWorkflow` to handle a single query engine tool, replacing previous plural references.
`templates/components/agents/typescript/form_filling/workflow/form-filling.ts`	Updated `FormFillingWorkflow` to manage a single query engine tool, simplifying the logic throughout the class.
`templates/components/engines/typescript/agent/chat.ts`	Simplified `createChatEngine` by removing `documentIds` parameter and altering query engine tool creation logic.
`templates/components/engines/typescript/agent/tools/query-engine.ts`	Introduced functions for creating and managing query engine tools, including `createQueryEngineTool` and `createQueryEngine`.
`templates/components/multiagent/typescript/workflow/tools.ts`	Renamed `getQueryEngineTools` to `getQueryEngineTool`, simplifying the return type and internal logic.
`templates/components/engines/python/chat/engine.py`	Updated `get_chat_engine` to remove `filters` parameter and streamline parameter handling through `kwargs`.
`.changeset/twenty-snakes-play.md`	Introduced a patch for implementing auto-routed retriever mode for `LlamaCloudIndex`.

Assessment against linked issues

Objective	Addressed	Explanation
Use a single query engine tool using auto routed mode (#434)	✅

Possibly related PRs

#200: The changes in this PR involve the addition of a new private function _create_query_engine_tool in financial_report.py, which is responsible for creating a QueryEngineTool. This is related to the main PR as it also involves the creation and management of query engine tools, similar to the modifications made in _get_research_tools in the main PR.
#350: This PR implements functionality to utilize a selected LlamaCloud index within a multi-agent template, which is directly related to the changes in the main PR that involve managing tools and their configurations.
#356: The modifications in this PR focus on ensuring that a new LlamaCloud index is created or that files are uploaded to an existing index. This is closely related to the main PR's changes regarding the management of query engine tools and their configurations.

Poem

🐰 In the meadow where tools align,
A single query engine, oh so fine!
With parameters clear and logic bright,
We hop along, in coding delight.
From arrays to singles, we make our way,
Simplifying tasks, come what may! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

run-llama / create-llama