run-llama / create-llama

The easiest way to get started with LlamaIndex
MIT License
886 stars 111 forks source link

feat: support uploading pdf, docx, txt #140

Closed thucpn closed 2 months ago

thucpn commented 3 months ago

Summary by CodeRabbit

changeset-bot[bot] commented 3 months ago

🦋 Changeset detected

Latest commit: 8068ad5c8bd0b2d197072efe7b96a1cba08fd9c3

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

Walkthrough

The changes focus on enhancing functionalities across various files and modules. Key updates include directory creation logic, introducing documentIds parameter in chat engine functions, setting the "private" metadata field in Python, and refining the management of document files and annotations. Additionally, a new Next.js API endpoint for file uploads and updates to FastAPI models and routes are included, along with minor version updates and streamlined import paths.

Changes

Files/Paths Change Summary
helpers/index.ts Updated directory creation logic to create output/tools and output/uploaded directories based on conditions.
templates/.../typescript/agent/chat.ts createChatEngine function now accepts an optional documentIds parameter for filtering documents by IDs.
templates/.../vectordbs/python/none/generate.py Added logic to set the "private" metadata field to "false" for each document before creating the VectorStoreIndex.
templates/.../typescript/streaming/annotations.ts Introduced types and functions for managing document files and annotations in messaging systems.
templates/.../streaming/express/index.ts Updated the route for serving static files from /api/files/tool-output to /api/files/output.
templates/.../nextjs/app/api/chat/upload/route.ts Added a new API endpoint for uploading user documents to a vector database using Next.js serverless functions.
templates/.../fastapi/app/api/routers/chat.py Updated imports and added logic for fetching chat document IDs and creating metadata filters.
templates/.../fastapi/app/api/routers/models.py Renamed classes and attributes, added new methods, and updated existing methods for handling file content and annotations.
templates/.../fastapi/app/api/routers/vercel_response.py Added imports and modified VercelStreamResponse to accept additional parameters and generate streaming content.
templates/.../fastapi/gitignore Added output to the list of ignored directories.
templates/.../fastapi/pyproject.toml Updated llama-index version from 0.10.53 to 0.10.54post1.
templates/.../nextjs/app/api/chat/route.ts Refactored imports related to chat functionality and updated the creation of chatEngine to depend on document IDs.
templates/.../nextjs/app/components/ui/document-preview.tsx Updated imports, interface, and function names to handle various document types and display content accordingly.
templates/.../express/src/controllers/chat.controller.ts Updated imports and logic flow to retrieve document IDs before creating the chat engine.
templates/.../express/src/controllers/engine/chat.ts createChatEngine function now accepts an optional documentIds parameter for customizing chat engine creation.

Poem

In code's vast realm where functions soar,
We added new paths to explore.
With IDs to filter and docs to preview,
Our engines now smarter, a vision anew.
FastAPI, Next.js, all in the mix,
A rabbit's delight in code's clever tricks.
🐰✨


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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.