run-llama / create-llama

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

feat: add Weaviate vector database support #223

Closed leehuwuj closed 1 month ago

leehuwuj commented 1 month ago

Summary by CodeRabbit

changeset-bot[bot] commented 1 month ago

πŸ¦‹ Changeset detected

Latest commit: a29ddb8c3e5018f87a49eeaf9ac9d9d0349b84f5

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

This set of changes enhances the integration of the Weaviate vector database into a Python application, focusing on efficient handling of vector embeddings. Key improvements include new filtering capabilities for document retrieval, support for environment variable configurations, and streamlined control flow in FastAPI routes. The singleton management for the Weaviate client promotes resource efficiency, while new functions increase flexibility in querying and managing document visibility.

Changes

Files Summary
.changeset/great-games-behave.md Introduces Weaviate vector database support, enabling efficient vector data management, CRUD operations, and similarity search capabilities.
helpers/env-variables.ts, helpers/python.ts Adds environment variable handling for Weaviate configuration and manages additional dependencies related to Weaviate in Python.
helpers/types.ts Expands the TemplateVectorDB type to include "weaviate," enhancing flexibility in database representation.
questions.ts Introduces "Weaviate" as a new option for vector databases in the getVectorDbChoices function.
templates/components/vectordbs/python/llamacloud/query_filter.py, Implements a function for generating document filters based on visibility and specific IDs, enhancing querying capabilities in vector stores.
templates/components/vectordbs/python/weaviate/query_filter.py, Similar functionality for Weaviate, utilizing MetadataFilter and accommodating current limitations in Weaviate's filtering capabilities.
templates/components/vectordbs/python/weaviate/vectordb.py Establishes a client management system for Weaviate, ensuring efficient connection handling and retrieval of the Weaviate vector store.
templates/components/vectordbs/typescript/llamacloud/queryFilter.ts, Introduces TypeScript function for generating document filters, supporting dynamic retrieval based on document IDs.
templates/types/streaming/express/src/controllers/engine/queryFilter.ts, Similar functionality for Express, creating flexible filters for document retrieval.
templates/types/streaming/fastapi/app/api/routers/chat.py, Removes generate_filters function, streamlining chat routing logic, and updates logging for better clarity.
templates/types/streaming/fastapi/app/api/routers/chat_config.py Implements chat configuration endpoints, allowing dynamic retrieval of conversation starters and integration with LlamaCloud services.
templates/types/streaming/fastapi/app/api/routers/vercel_response.py Updates serialization method for source nodes in chat response generation.
templates/types/streaming/fastapi/app/engine/query_filter.py Introduces a new function for generating filters based on document IDs, enhancing querying capabilities.
templates/types/streaming/nextjs/app/api/chat/engine/queryFilter.ts Defines function for creating flexible document filters based on privacy status and document IDs in a Next.js application.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChatAPI
    participant WeaviateClient
    participant VectorStore

    User->>ChatAPI: Request chat with filters
    ChatAPI-->>WeaviateClient: Retrieve filters
    WeaviateClient-->>VectorStore: Apply filters
    VectorStore-->>WeaviateClient: Return filtered documents
    WeaviateClient-->>ChatAPI: Send filtered results
    ChatAPI-->>User: Display chat results

🐰 In a world of vectors, oh so bright,
I hop with glee, what a wonderful sight!
Weaviate's here, with filters that sing,
Managing data, oh what joy it brings!
With each new change, I dance and play,
Celebrating code in a whimsical way! ✨


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.