Skip to content

chore(wren-ai-service): fix historical question query input - #1064

Merged
cyyeh merged 1 commit into
mainfrom
chore/ai-service/fix-historical-question-bug
Dec 26, 2024
Merged

cyyeh merged 1 commit into
mainfrom
chore/ai-service/fix-historical-question-bug

Conversation

@cyyeh

@cyyeh cyyeh commented Dec 26, 2024 •

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • New Features

    • Enhanced the processing of historical questions in the ask service, improving the accuracy of results based on user queries.
  • Bug Fixes

    • Improved error handling and logging for various statuses of ask requests.
  • Refactor

    • Streamlined the logic flow for managing ask request statuses and intents.

@cyyeh cyyeh added module/ai-service ai-service related ci/ai-service ai-service related labels Dec 26, 2024
@cyyeh
cyyeh requested a review from paopa December 26, 2024 06:09
@coderabbitai

coderabbitai Bot commented Dec 26, 2024 •

Copy link
Copy Markdown
Contributor

Walkthrough

The pull request introduces a subtle modification in the ask method of the AskService class within the Wren AI service. The change specifically alters the input parameter for the historical_question pipeline, switching from user_query to ask_request.query. This adjustment impacts the historical question generation process while maintaining the existing error handling and request processing logic. The overall structure of the method remains consistent, with the core functionality of handling different query intents and managing ask results preserved.

Changes

File Change Summary
wren-ai-service/src/web/v1/services/ask.py Modified input parameter for historical question pipeline from user_query to ask_request.query

Poem

🐰 A Rabbit's Code Whisper 🔍

In pipelines deep and queries bright,
A subtle shift takes gentle flight
From user_query to request's own way
The historical questions find their sway
A tiny change, yet code's delight! 🌟

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 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 bd66a8f and ffbc0b8.

📒 Files selected for processing (1)
  • wren-ai-service/src/web/v1/services/ask.py (1 hunks)
🔇 Additional comments (1)
wren-ai-service/src/web/v1/services/ask.py (1)

248-248: Ensure consistent usage of the (rephrased) user query here.

You are passing ask_request.query directly to the historical_question pipeline, whereas above you use:

user_query = ask_request.query if not rephrased_question else rephrased_question

If the historical_question pipeline also needs the rephrased question, consider passing user_query instead to ensure consistency. Otherwise, confirm that the pipeline specifically needs the original user query in this step.

✅ Verification successful

Let me gather more information about the usage of queries in the codebase.


Use original query for historical question lookup

Based on the code analysis, the current implementation is correct. The historical_question pipeline specifically needs the original user query (ask_request.query) and not the rephrased question. This is evident from the flow:

  1. The rephrased question (user_query) is used for the retrieval pipeline to find relevant context
  2. The original query is used for the historical_question pipeline to find matching historical queries
  3. If no historical matches are found, then either followup_sql_generation or sql_generation pipeline is used with the rephrased query (user_query)

This design allows the system to first check if the exact same question was asked before (using original query) before attempting to generate new SQL using the rephrased question.

🏁 Scripts executed

The following scripts were executed for the analysis:

Error: No shell scripts found


Script:

#!/bin/bash
# Search for the context around the query usage
rg -B 10 -A 10 "query=ask_request.query" wren-ai-service/src/web/v1/services/ask.py

Length of output: 1865


Script:

#!/bin/bash
# Search for rephrased_question usage
rg -B 5 -A 5 "rephrased_question" wren-ai-service/src/web/v1/services/ask.py

Length of output: 5577


Script:

#!/bin/bash
# Search for historical_question pipeline usage
rg -B 5 -A 5 "historical_question" wren-ai-service/src/web/v1/services/ask.py

Length of output: 1907


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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/ai-service ai-service related module/ai-service ai-service related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants