WrenAI icon indicating copy to clipboard operation
WrenAI copied to clipboard

feat(wren-ai-service): Embed the SQL pairs in MDL

Open paopa opened this issue 11 months ago • 1 comments

Changes

  1. Pipeline Simplification

    • Removed SQL intention generation using LLM
    • Simplified document storage to use direct question-SQL pairs
    • Updated pipeline configuration to remove unnecessary LLM dependency
  2. Configuration Changes

    • Added SQL_PAIRS_PATH environment variable
    • Added pairs.json configuration file support
    • Updated deployment configurations to include new file mounts
  3. Sample Management

    • Added structured JSON format for storing SQL query examples
    • Updated sample format to use question-SQL pairs
    • Improved sample integration in SQL generation prompts
  4. Testing

    • Updated existing tests to reflect new pipeline structure
    • Added test data for pairs.json
    • Temporarily skipped outdated tests pending updates

Related Changes

  • Updated docker compose configurations
  • Modified kustomization files for deployment
  • Updated configuration examples
  • Added new utility tool for MDL string conversion

Summary by CodeRabbit

  • New Features

    • Added SQL pairs indexing functionality.
    • Introduced new configuration options for SQL pairs.
    • Enhanced SQL generation with sample query support.
  • Configuration Changes

    • Updated pipeline configurations to reflect new SQL pairs indexing.
    • Added new environment variables for SQL pairs path.
    • Introduced pairs.json configuration file.
  • Pipeline Modifications

    • Renamed SQL pairs preparation to SQL pairs indexing.
    • Updated SQL pairs handling in various service components.
    • Improved SQL generation prompt templates.
  • Testing

    • Added test data for SQL pairs.
    • Updated test cases to reflect new pipeline structure.
    • Skipped outdated tests related to SQL pairs preparation.

paopa avatar Jan 02 '25 09:01 paopa

Walkthrough

This pull request introduces significant changes to the Wren AI service, focusing on SQL pairs indexing and processing. The modifications span multiple files, introducing a new SqlPairs pipeline to replace the previous SqlPairsPreparation approach. Key changes include renaming pipeline stages, updating configuration files, adding new utility functions, and restructuring how SQL pairs are handled throughout the service. The changes aim to improve the flexibility and clarity of SQL pair management, with a more streamlined approach to indexing and processing.

Changes

File Path Change Summary
deployment/kustomizations/base/cm.yaml Renamed pipeline step from sql_pairs_preparation to sql_pairs_indexing
docker/config.example.yaml Updated pipeline configuration, removed llm from sql_pairs_indexing
wren-ai-service/src/config.py Added new configuration field sql_pairs_path
wren-ai-service/src/globals.py Updated service container with new SQL pairs handling
wren-ai-service/src/pipelines/indexing/ Introduced new SqlPairs pipeline, removed SqlPairsPreparation
wren-ai-service/tests/ Updated test files to match new SQL pairs indexing approach
wren-ai-service/tools/config/ Updated configuration files with new pipeline naming

Sequence Diagram

sequenceDiagram
    participant User
    participant SqlPairs
    participant DocumentConverter
    participant Embedder
    participant DocumentStore
    participant Cleaner

    User->>SqlPairs: Run with MDL string
    SqlPairs->>DocumentConverter: Convert SQL pairs to documents
    DocumentConverter-->>SqlPairs: Return documents
    SqlPairs->>Embedder: Embed documents
    Embedder-->>SqlPairs: Return embedded documents
    SqlPairs->>Cleaner: Clean SQL pairs
    Cleaner-->>SqlPairs: Return cleaned pairs
    SqlPairs->>DocumentStore: Write documents

Poem

🐰 SQL Pairs Dancing Free

In pipelines of code, a rabbit's glee From preparation to indexing we leap Transforming queries with magical sweep No LLM needed, just pure SQL spree!

🔍✨

Finishing Touches

  • [ ] 📝 Generate Docstrings (Beta)

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jan 02 '25 09:01 coderabbitai[bot]