feat: Improve FastAPI agentic template

leehuwuj commented 1 week ago

Summary by CodeRabbit

New Features
- Introduced default system prompts for improved prompt generation.
- Enhanced error handling and user-friendly messaging in streaming responses.
- Clarified capabilities of the DuckDuckGo search tool and streamlined configuration for other tools.
- Updated default tool for the agentic feature to focus on weather tasks.
Bug Fixes
- Improved robustness of the streaming process with better error logging and graceful termination.
- Enhanced error handling in the ChatSection component to prevent application crashes.
- Updated file upload process for better compatibility with sandbox requirements.
- Simplified instructions in README templates for clarity.

changeset-bot[bot] commented 1 week ago

🦋 Changeset detected

Latest commit: e0f224def611635d972fef24153f5de768149fd4

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 week ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduced in this pull request involve enhancements to the prompt generation process and improvements to error handling in streaming responses. Two new constants, DEFAULT_SYSTEM_PROMPT and DATA_SOURCES_PROMPT, have been added to streamline the construction of system prompts. Additionally, the content_generator method in the VercelStreamResponse class has been modified to include robust error handling and connection management, improving the overall reliability of the streaming process. Other changes include updates to tool configurations and error handling in various components.

Changes

File Path	Change Summary
helpers/env-variables.ts	Added constants `DEFAULT_SYSTEM_PROMPT` and `DATA_SOURCES_PROMPT`. Modified `getSystemPromptEnv` function to use these constants and improved prompt generation logic. Removed hardcoded default prompt.
templates/types/streaming/fastapi/app/api/routers/vercel_response.py	Enhanced `content_generator` method with error handling and connection management. Added logging for exceptions and ensured proper cleanup with a `finally` block. Adjusted order of checks in the streaming loop.
templates/components/multiagent/python/app/api/routers/vercel_response.py	Introduced `convert_error` method for consistent error message formatting in `content_generator`. Enhanced error handling logic.
helpers/tools.ts	Updated `envVars` for the DuckDuckGo tool and removed `envVars` for Wikipedia, Weather, OpenAPI Action, and Image Generator tools, simplifying their configurations.
templates/types/streaming/nextjs/app/components/chat-section.tsx	Modified error handling in `ChatSection` component to include a try-catch block for parsing errors, enhancing robustness.
templates/types/streaming/nextjs/app/api/sandbox/route.ts	Changed file writing method to convert content to `ArrayBuffer` before writing to the sandbox, ensuring correct format for file uploads.
templates/types/streaming/express/README-template.md	Minor textual modifications for clarity in instructions regarding generating embeddings.
templates/types/streaming/fastapi/README-template.md	Minor textual modifications for clarity in instructions regarding generating embeddings.
templates/types/streaming/nextjs/README-template.md	Minor textual modifications for clarity in instructions regarding generating embeddings.
templates/types/streaming/nextjs/app/api/sandbox/route.ts	Modified `initInterpreter` method to convert file content to `ArrayBuffer` using `Uint8Array`, enhancing compatibility during file uploads.
questions/simple.ts	Updated tools associated with the `rag` app type to use `weather` instead of `wikipedia`, reflecting a shift in functionality.
.changeset/moody-mangos-punch.md	Improved system prompt and modified default tool for the agentic feature to "weather."

Possibly related PRs

#94: The changes in this PR involve modifications to helpers/tools.ts, including the addition of a new tool "Interpreter" and related environment variables, which may interact with the constants introduced in the main PR.
#135: This PR adds an "Image Generator" tool in helpers/tools.ts, which is relevant as it also modifies the tool configurations similar to the changes in the main PR.
#149: This PR introduces changes related to LlamaCloud, which may connect with the environment variables and prompts defined in the main PR.
#158: The addition of an Azure Code Interpreter tool in helpers/tools.ts aligns with the modifications made in the main PR regarding environment variables and tool configurations.
#356: The modification of the LlamaCloudConfig class is relevant as it deals with configuration management, similar to the changes made in the main PR regarding environment variables.
#439: The update to the DuckDuckGo tool option in helpers/tools.ts is relevant as it involves changes to tool configurations, which is a focus of the main PR.

Suggested reviewers

leehuwuj

Poem

In the fields where prompts do play,
New constants bloom, bright as day.
With error logs and streams so fine,
Our code now dances, a joyful line.
Hooray for changes, let’s all cheer,
For clarity and strength, we hold dear! 🐇✨

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