feat(wren-ai-service): Add a few properties in Prediction Result for Evaluation

[paopa]

This PR introduces several improvements and cleanups to the SQL generation pipeline:

Key Changes

• Deprecated AccuracyMultiCandidateMetric as it's no longer needed for Text to SQL tasks
• Added SQL reasoning step in AskPipeline with dedicated SQLGenerationReasoning component
• Added timing metrics to track elapsed time for predictions
• Improved type hints and documentation

Technical Details

1. Pipeline Enhancements:

   • Added elapsed time tracking for predictions
   • Integrated SQL reasoning step before generation
   • Removed unused multi-candidate metric from pipelines

2. Code Quality:

   • Added type hints for extract_units function parameters
   • Improved error handling for DDL parsing
   • Enhanced documentation for the flat method
   • Added proper handling of table_ddl in document processing

3. Performance Tracking:

   • Added elapsed_time field to prediction outputs
   • Improved trace metadata handling

Summary by CodeRabbit

• New Features

  • Evaluation output now includes processing duration for improved performance visibility.
  • Enhanced SQL reasoning functionality provides additional insights in SQL generation tasks.

• Refactor

  • Deprecated the multi-candidate accuracy metric to streamline performance measurements.
  • Improved data source handling with refined encoding for more robust configuration.
  • Updated method signatures for better clarity and functionality.

[coderabbitai[bot]]

Walkthrough

This pull request implements several changes across evaluation modules. It marks the AccuracyMultiCandidateMetric class as deprecated, updates the extract_units function to accept a list of dictionaries, enhances the Eval class with timing functionality, and introduces a new _sql_reasoner attribute in the AskPipeline. Additionally, it refines the handling of datasource settings while encoding model data, ensuring clearer control flow and updated functionality.

Changes

File(s)	Change Summary
wren-ai-service/eval/metrics/accuracy.py	Added a new import for the deprecated decorator and applied it to mark AccuracyMultiCandidateMetric as deprecated.
wren-ai-service/eval/pipelines.py	Updated the extract_units parameter type to list[dict]; modified Eval.process to include timing functionality and renamed the prediction dictionary to returned; removed AccuracyMultiCandidateMetric() from metrics list; and integrated a new _sql_reasoner attribute in AskPipeline utilizing SQLGenerationReasoning.
wren-ai-service/eval/prediction.py	Added a comment for planned refactoring; introduced variable _mdl for a base64-encoded JSON representation of dataset["mdl"]; and adjusted datasource assignment with conditional environment variable replacement.

Sequence Diagram(s)

sequenceDiagram
    actor User
    participant Eval as Evaluation Module
    participant Pipeline as AskPipeline / Other Pipelines
    participant SQLGen as SQLGenerationReasoning

    User->>Eval: Send evaluation request
    Eval->>Eval: Start timer (record start_time)
    Eval->>Pipeline: Process evaluation request
    alt AskPipeline flow
        Pipeline->>SQLGen: Retrieve SQL reasoning data
        SQLGen-->>Pipeline: Return reasoning output
    end
    Pipeline-->>Eval: Return prediction (with reasoning if applicable)
    Eval->>Eval: Compute elapsed_time and update result
    Eval-->>User: Return evaluation result with elapsed_time

Possibly related PRs

• Canner/WrenAI#1225: Similar changes involving deprecation of metrics and modifications in the AskPipeline class indicate a direct code-level connection.

Suggested reviewers

• cyyeh

Poem

I'm a coding rabbit, leaping with delight,
Hopping through changes both day and night.
Deprecated metrics now wave goodbye,
Pipelines and reasoners soar sky-high.
With ASCII hops, our code takes flight!

---

📜 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 5697e2b7e5ed59a0fe2144b2fd2b3932e6991893 and b45ac135e3980e4c9b80f0174f1e6ef6963c4b15.

📒 Files selected for processing (1)

• wren-ai-service/eval/pipelines.py (11 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• wren-ai-service/eval/pipelines.py

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

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

---

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
• 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. (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.