chore(wren-ai-service): allow retrieving sql pairs while retrieving historical questions

[cyyeh]

Summary by CodeRabbit

• New Features
  • Improved document retrieval processes deliver more consistent and comprehensive output, with enhanced handling of missing metadata.
  • Enhanced SQL responses now include a clear list of involved table names, providing additional context in result summaries.

[coderabbitai]

Warning

Rate limit exceeded

@cyyeh has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 36 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b7ad839 and fb5473d.

📒 Files selected for processing (2)

• wren-ai-service/src/pipelines/retrieval/historical_question_retrieval.py (7 hunks)
• wren-ai-service/src/web/v1/services/ask.py (1 hunks)

Walkthrough

This pull request revises the document retrieval pipeline and the AskService response handling. In the retrieval module, the modifications enable concurrent operations with two document stores and retrievers, update the output formatting defaults, and adjust method signatures accordingly. In the AskService, a new variable table_names is introduced to capture SQL generation details and is included in the response during relevant statuses.

Changes

File	Change Summary
wren-ai-service/.../historical_question_retrieval.py	- Updated the OutputFormatter to default missing metadata. - Refactored count_documents to concurrently aggregate counts from two stores using asyncio.gather. - Modified retrieval to combine results from two retrievers concurrently. - Adjusted the class constructor’s internal variable assignments.
wren-ai-service/.../ask.py	- Introduced a new table_names variable in the ask method. - Modified logic to include table_names in the AskResultResponse for statuses "planning" and "generating".

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant HQ as HistoricalQuestionRetrieval
    participant VQR as ViewQuestionsRetriever
    participant SPR as SQLPairRetriever
    C->>HQ: Call retrieval(embedding, id, view_questions_retriever, sql_pair_retriever)
    par Concurrent calls
        HQ->>VQR: Retrieve view questions
    and
        HQ->>SPR: Retrieve SQL pair questions
    end
    VQR-->>HQ: Return view questions
    SPR-->>HQ: Return SQL pair questions
    HQ->>C: Return merged retrieval results

Loading

sequenceDiagram
    participant U as User
    participant AS as AskService
    participant RP as Retrieval Pipeline
    U->>AS: Invoke ask method
    AS->>RP: Execute document retrieval
    RP-->>AS: Return documents with metadata
    AS->>AS: Extract table names from documents
    AS->>U: Return AskResultResponse with table_names

Loading

Possibly related PRs

• fix(wren-ai-service): column pruning step in retrieval pipeline and correct code for sql generation in evaluation #1225: Details a similar enhancement in handling document retrieval and SQL generation within the AskService, closely aligning with the changes in this PR.

Suggested reviewers

• paopa

Poem

I hop through code fields with delight,
Streamlining data in concurrent light.
Two paths merge in a seamless dance,
Fetching results with a swift advance.
Table names join the lively play,
A rabbit's cheer for a bug-free day!
Hop on, code, hop on!

---

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.

[paopa]

LGTM