search

run-llama / create-llama

The easiest way to get started with LlamaIndex
MIT License
1.05k stars 135 forks source link

Feature: Update multi-agent template to use financial report use case #386

Closed leehuwuj closed 1 month ago

leehuwuj commented 1 month ago

Summary by CodeRabbit

Release Notes

changeset-bot[bot] commented 1 month ago

🦋 Changeset detected

Latest commit: 297b95a26bf807d568d183ad8adb1b5fd5edbb52

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 1 month ago

Walkthrough

The pull request introduces enhancements to the application's functionality by adding an agents parameter to various functions and types, particularly the createApp function. This addition allows for expanded capabilities in multi-agent configurations. The changes include updates to test structures, type definitions, and the introduction of new functions for downloading files and managing agent-specific logic. Additionally, several modules have undergone import restructuring to improve organization without altering existing functionality.

Changes

File Path Change Summary
create-app.ts Added agents parameter to createApp function, included in args object for template installations.
e2e/shared/multiagent_template.spec.ts Modified test structure to iterate over templateAgents, creating distinct test suites for each agent type.
e2e/utils.ts Added optional agents property to RunCreateLlamaOptions type; updated runCreateLlama function to handle multi-agent configurations.
helpers/datasources.ts Introduced EXAMPLE_10K_SEC_FILES constant, an array of TemplateDataSource objects for file sources.
helpers/index.ts Added downloadFile function to fetch files from URLs and modified prepareContextData to handle both local and remote data sources.
helpers/python.ts Added agents parameter to installPythonTemplate function for handling agent-specific logic.
helpers/types.ts Introduced TemplateAgents type and modified FileSourceConfig and InstallTemplateArgs to include new properties accommodating agents.
index.ts Added new CLI option --agents <agents> to specify agents for multi-agent templates.
questions/simple.ts Updated import statements, modified askSimpleQuestions function for app type selection, added getDefaultAgentTemplateParams function.
templates/components/agents/python/blog/README-template.md Removed introductory lines and streamlined instructions while retaining essential content.
templates/components/agents/python/blog/app/agents/choreography.py Updated import paths; create_choreography function logic remains unchanged.
templates/components/agents/python/blog/app/agents/orchestrator.py Updated import paths; create_orchestrator function logic remains unchanged.
templates/components/agents/python/blog/app/agents/publisher.py Updated import path for FunctionCallingAgent; no changes to existing functions.
templates/components/agents/python/blog/app/agents/researcher.py Updated import path for FunctionCallingAgent; no changes to existing functions.
templates/components/agents/python/blog/app/agents/workflow.py Updated import paths; create_workflow function logic remains unchanged.
templates/components/agents/python/financial_report/README-template.md Introduced README template detailing setup for multi-agent project using LlamaIndex.
templates/components/agents/python/financial_report/app/agents/analyst.py Added functionality for creating an analyst agent, including _get_analyst_params and create_analyst functions.
templates/components/agents/python/financial_report/app/agents/reporter.py Added functionality for generating financial reports, including _get_reporter_params and create_reporter functions.
templates/components/agents/python/financial_report/app/agents/researcher.py Added functionality for creating a researcher agent, including _create_query_engine_tools and create_researcher functions.
templates/components/agents/python/financial_report/app/agents/workflow.py Introduced a workflow for generating financial reports with create_workflow, ResearchEvent, AnalyzeEvent, and ReportEvent classes.
templates/components/agents/python/financial_report/app/engine/engine.py Added get_chat_engine function to generate an agent workflow based on chat history.
templates/components/multiagent/python/app/api/routers/vercel_response.py Updated import paths for AgentRunEvent and AgentRunResult; enhanced logging in content_generator.
templates/components/multiagent/python/app/workflows/multi.py Updated import paths for StructuredPlannerAgent and FunctionCallingAgent; core functionalities remain unchanged.
templates/components/multiagent/python/app/workflows/planner.py Updated import paths for AgentRunEvent, AgentRunResult, and FunctionCallingAgent; no significant changes to logic.

Possibly related PRs

🐰 In the meadow, changes bloom,
New agents gather, dispelling gloom.
With templates bright and workflows clear,
We hop along, spreading cheer!
Code now dances, agile and spry,
Multi-agent magic, oh my, oh my! 🌼✨

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://coderabbit.ai/docs) 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.