search

run-llama / create-llama

The easiest way to get started with LlamaIndex
MIT License
932 stars 119 forks source link

feat: Add Weaviate vector store for Typescript templates #228

Closed leehuwuj closed 2 months ago

leehuwuj commented 2 months ago

Summary by CodeRabbit

changeset-bot[bot] commented 2 months ago

🦋 Changeset detected

Latest commit: a1e8bbd7ba185f0da53284513b34fe716a39ef67

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

Walkthrough

This update introduces a new integration of a Weaviate vector store into the existing TypeScript application, enhancing its capabilities for managing vector embeddings essential for AI and machine learning tasks. It modifies document processing to explicitly manage metadata, impacting how documents are queried based on their visibility. Several enhancements streamline operations within vector databases, emphasizing improved data handling and filtering mechanisms.

Changes

Files Change Summary
.changeset/chilly-toys-bow.md Introduced Weaviate vector store integration, enhancing vector embedding management and retrieval processes.
templates/components/loaders/typescript/file/loader.ts
templates/components/loaders/typescript/llama_parse/loader.ts		 Updated getDocuments function to include metadata processing that marks all documents as public.
templates/components/vectordbs/typescript/llamacloud/generate.ts
templates/components/vectordbs/typescript/none/generate.ts		 Removed code setting documents as public, simplifying document privacy handling.
templates/components/vectordbs/typescript/weaviate/generate.ts Implemented loading and indexing of documents into Weaviate, including environment variable validation.
templates/components/vectordbs/typescript/weaviate/index.ts Added getDataSource function for vector storage retrieval and management.
templates/components/vectordbs/typescript/weaviate/queryFilter.ts Created generateFilters function for querying documents based on privacy status.
templates/components/vectordbs/typescript/weaviate/shared.ts Introduced environment variable management functions, ensuring all required variables are present.
templates/types/streaming/express/package.json
templates/types/streaming/nextjs/package.json		 Updated llamaindex dependency from version 0.5.14 to 0.5.17.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Weaviate

    User->>App: Request to load and index documents
    App->>App: Retrieve documents
    App->>Weaviate: Initialize Weaviate vector store
    App->>Weaviate: Upload documents as embeddings
    Weaviate-->>App: Acknowledge successful indexing
    App-->>User: Confirm documents indexed

🐰✨ In the garden of code, where changes bloom bright,
A Weaviate vector store brings new delight.
Documents now public, their secrets laid bare,
With filters and functions, we dance without care.
Hop along, dear coder, let the features take flight,
For in this brave update, our future's in sight! 🌼✨

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.