run-llama / create-llama

The easiest way to get started with LlamaIndex
MIT License
799 stars 96 forks source link

refactor: make components resuable for chat llm #202

Closed thucpn closed 1 month ago

thucpn commented 1 month ago

Note: update latest create-llama in PRs: https://github.com/run-llama/chat-llamaindex/pull/101 https://github.com/thucpn/chat-llamaindex/pull/5

Summary by CodeRabbit

changeset-bot[bot] commented 1 month ago

🦋 Changeset detected

Latest commit: eeddc777aa0ad83ded352157ebc88cd3c18af39f

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 recent updates enhance the modularity and usability of the codebase, particularly for document upload and processing functionalities. Key changes include making specific functions public for wider accessibility, adjusting parameters for new indexing options, and improving metadata management. Collectively, these modifications streamline interactions and strengthen the architecture for better maintainability and flexibility in handling chat-based large language models.

Changes

Files Change Summary
.changeset/cool-jeans-bake.md Introduces "create-llama" patch to enhance component reusability for chat LLMs, improving code organization and maintainability.
templates/components/engines/typescript/agent/chat.ts
templates/components/engines/typescript/chat/chat.ts
Changes visibility of generateFilters from private to public by adding export, allowing broader access across modules.
templates/components/llamaindex/typescript/documents/pipeline.ts Alters runPipeline parameters, replacing filename with currentIndex (either VectorStoreIndex or LlamaCloudIndex), simplifying document processing.
templates/components/llamaindex/typescript/documents/upload.ts Updates uploadDocument to accept an index parameter, enhancing document metadata management with additional fields for uploads.
templates/components/vectordbs/typescript/milvus/shared.ts Modifies checkRequiredEnvVars to accept an optional opts parameter, allowing conditional checks for the MILVUS_COLLECTION environment variable.
templates/types/streaming/express/src/controllers/chat-upload.controller.ts Modifies chatUpload to retrieve an index using getDataSource() before calling uploadDocument, enhancing the upload process.
templates/types/streaming/nextjs/app/api/chat/upload/route.ts Changes POST function to first retrieve index from getDataSource(), then pass it to uploadDocument, altering the upload workflow.
templates/types/streaming/nextjs/app/components/ui/chat/chat-input.tsx Introduces optional requestParams in ChatInput, allowing for enhanced upload configurations.
templates/types/streaming/nextjs/app/components/ui/chat/hooks/use-file.ts Updates uploadContent and uploadFile to accept an optional requestParams, improving the flexibility of file uploads and API interactions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UploadController
    participant DataSource
    participant DocumentService

    User->>UploadController: Initiate Upload
    UploadController->>DataSource: getDataSource()
    DataSource-->>UploadController: Return Index
    UploadController->>DocumentService: uploadDocument(index, base64)
    DocumentService-->>UploadController: Confirm Upload
    UploadController-->>User: Upload Successful

🐇 In the code, a change did sprout,
Functions now share, without a doubt.
With indexes and params, oh so bright,
Our uploads now take flight!
A hop, a skip, to organize,
Making code cleaner is quite the prize!


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 Configuration 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.