chore(wren-ai-service): minor updates

[cyyeh]

Summary by CodeRabbit

• New Features

  • Introduced an evaluation setting that enables the use of SQL functions in dynamic query processing.
  • Pipelines now conditionally integrate SQL functions for enhanced processing.

• Bug Fixes

  • Improved error handling in metadata retrieval to avoid issues when data is missing.
  • Refined configuration updates to ensure specific components remain unaltered.

[coderabbitai]

Walkthrough

This pull request adds support for SQL functions to the evaluation service. A new boolean attribute allow_sql_functions is introduced in the evaluation settings, while both the generation and ask pipelines now initialize SQL functions retrieval and control their execution based on the new setting. In addition, utility logic has been adjusted to skip modifications for the SQL functions pipe, and metadata retrieval in the SQL functions module has been improved for robustness and error handling.

Changes

File(s)	Change Summary
wren-ai-service/eval/__init__.py	Added new boolean attribute allow_sql_functions (default True) in the EvalSettings class.
wren-ai-service/eval/pipelines.py	Introduced _sql_functions_retrieval and _allow_sql_functions in GenerationPipeline and AskPipeline; updated _process to conditionally retrieve SQL functions and pass them to the generation process.
wren-ai-service/eval/utils.py	Modified replace_wren_engine_env_variables to exclude pipes named "sql_functions_retrieval" when updating the engine field.
wren-ai-service/src/.../sql_functions.py	Refined _retrieve_metadata in SqlFunctions by simplifying condition checks and adding error handling for empty document lists.

Sequence Diagram(s)

sequenceDiagram
    participant Pipeline as Generation/Ask Pipeline
    participant Settings as EvalSettings
    participant SQLFunc as SQLFunctionsRetrieval
    participant Generation as Generation Engine

    Pipeline->>Settings: Retrieve allow_sql_functions
    alt SQL Functions Allowed
        Pipeline->>SQLFunc: Execute async run()
        SQLFunc-->>Pipeline: Return SQL functions list
    else Not Allowed
        Pipeline-->>Pipeline: Use empty SQL functions list
    end
    Pipeline->>Generation: Call run() with SQL functions list

Loading

Possibly related PRs

• chore(wren-ai-service): allow retrieving sql pairs while retrieving historical questions #1318: Enhances SQL functions handling in pipelines by integrating retrieval and control logic similar to these changes.
• chore(wren-ai-service): Try to make evaluation work again #1085: Introduces a boolean flag for SQL functions in evaluation settings, directly related to the new attribute and its usage in pipelines.
• feat(wren-ai-service): Add a few properties in Prediction Result for Evaluation #1297: Focuses on SQL function management in evaluation settings and pipelines, complementing the modifications in this pull request.

Suggested labels

module/ai-service, ci/ai-service, wren-ai-service

Suggested reviewers

• paopa

Poem

I'm a rabbit, swift and free,
Hopping through pipelines with glee.
SQL functions now join our code,
Planting new seeds down the data road.
Celebrate the changes—let our processes flee!
🐇🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d0d7bda and 80c87c2.

📒 Files selected for processing (4)

• wren-ai-service/eval/__init__.py (1 hunks)
• wren-ai-service/eval/pipelines.py (6 hunks)
• wren-ai-service/eval/utils.py (1 hunks)
• wren-ai-service/src/pipelines/retrieval/sql_functions.py (3 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

wren-ai-service/eval/pipelines.py (2)

wren-ai-service/src/pipelines/retrieval/sql_functions.py (3) (3)

• SqlFunctions (96-166)
• sql_functions (77-80)
• run (144-166)

wren-ai-service/src/pipelines/generation/sql_generation.py (1) (1)

• run (149-179)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Analyze (go)

🔇 Additional comments (13)

wren-ai-service/eval/__init__.py (1)

15-15: LGTM: New setting for SQL functions support

This new setting follows the same pattern as the existing boolean flags and enables SQL functions by default.

wren-ai-service/eval/utils.py (1)

587-587: LGTM: Skip engine modification for SQL functions retrieval pipe

Good adjustment to prevent overriding the engine configuration for the SQL functions retrieval pipe.

wren-ai-service/src/pipelines/retrieval/sql_functions.py (3)

125-125: LGTM: Simplified condition check

Simplified condition from project_id is not None to just project_id which is more idiomatic Python.

---

137-141: LGTM: Improved error handling for empty documents

Good defensive programming by checking if documents list is not empty before accessing the first element, preventing potential IndexError.

---

152-152: LGTM: Safer parameter handling

Using project_id or "" ensures a valid string is always passed to _retrieve_metadata, preventing None values from being processed.

wren-ai-service/eval/pipelines.py (8)

259-261: LGTM: SQL Functions retrieval initialization

Good implementation of the SQL functions retrieval component in the GenerationPipeline.

---

265-265: LGTM: SQL Functions flag configuration

Properly retrieving the allow_sql_functions setting from the configuration.

---

298-302: LGTM: Conditional SQL functions retrieval

Good implementation of the conditional logic to retrieve SQL functions only when enabled.

---

311-311: LGTM: Passing SQL functions to generation

Correctly passing the SQL functions to the generation run method.

---

386-388: LGTM: SQL Functions retrieval initialization in AskPipeline

Consistent implementation of the SQL functions retrieval component in the AskPipeline.

---

395-395: LGTM: SQL Functions flag in AskPipeline

Properly retrieving the allow_sql_functions setting in the AskPipeline.

---

442-446: LGTM: Conditional SQL functions retrieval in AskPipeline

Consistent implementation of the conditional logic for SQL functions retrieval in the AskPipeline.

---

455-455: LGTM: Passing SQL functions to generation in AskPipeline

Correctly passing the SQL functions to the generation run method in the AskPipeline.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @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.