Skip to content

chore(wren-ai-service): minor updates #1695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 29, 2025
Merged

Conversation

cyyeh
Copy link
Member

@cyyeh cyyeh commented May 28, 2025

Summary by CodeRabbit

  • New Features
    • Introduced separate instruction categories for calculated fields and metrics in SQL generation and regeneration prompts, improving clarity and customization.
  • Improvements
    • Reformatted user instructions in prompts as numbered lists for better readability.
    • Enhanced prompt templates by removing redundant "current time" or "current date" fields.
    • Updated SQL reasoning prompts for more structured and explicit guidance.
    • Added clearer rules for SQL query generation, including proper use of aggregate functions.
    • Simplified prompt construction by centralizing system prompts and refining instruction handling.
  • Bug Fixes
    • Removed unused imports and obsolete methods related to time and date handling.

@cyyeh cyyeh added module/ai-service ai-service related ci/ai-service ai-service related labels May 28, 2025
Copy link
Contributor

coderabbitai bot commented May 28, 2025

Walkthrough

This update refactors prompt construction across several SQL-related pipelines by introducing distinct instruction categories for calculated fields and metrics, and reformatting user instructions as numbered lists. It also removes all references to current time or date from prompts and function signatures, and centralizes some prompt templates and rules into shared utilities.

Changes

Files/Paths Change Summary
wren-ai-service/src/pipelines/generation/sql_generation.py, followup_sql_generation.py, sql_regeneration.py Refactored prompt logic to separate calculated field and metric instructions, restructured user instructions, and removed current time from prompts and function signatures.
wren-ai-service/src/pipelines/generation/sql_generation_reasoning.py, followup_sql_generation_reasoning.py Delegated system prompt to shared utility, reformatted user instructions as numbered lists, and removed current time from prompts.
wren-ai-service/src/pipelines/generation/intent_classification.py Updated system prompt to include user instructions, added directive for time phrasing, reformatted user instructions, and removed current time.
wren-ai-service/src/pipelines/generation/question_recommendation.py, web/v1/services/question_recommendation.py Removed all handling of current date in prompt signatures, templates, and request dictionaries.
wren-ai-service/src/pipelines/generation/utils/sql.py Added new system prompt constant, updated SQL rules, refactored instruction construction to return lists and removed calculated/metric field logic.
wren-ai-service/src/web/v1/services/init.py Removed show_current_time method and related imports from Configuration.Timezone.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Pipeline
    participant PromptBuilder
    participant Utils

    User->>Pipeline: Submit query and context
    Pipeline->>Utils: construct_instructions(config, instructions)
    Utils-->>Pipeline: Return list of instructions
    Pipeline->>PromptBuilder: Build prompt with calculated_field_instructions, metric_instructions, user_instructions
    PromptBuilder-->>Pipeline: Return formatted prompt
    Pipeline-->>User: Return SQL or recommendations
Loading

Suggested reviewers

  • imAsterSun

Poem

A bunny hops through code so neat,
Splitting instructions for SQL’s feat.
No more time or date to chase,
Numbered lists now take their place.
Metrics and fields each get their say—
The prompt is clearer, hip-hip-hooray!
🐇✨


📜 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 1a24ff1 and 6a30f32.

📒 Files selected for processing (1)
  • wren-ai-service/src/web/v1/services/question_recommendation.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • wren-ai-service/src/web/v1/services/question_recommendation.py
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: pytest
  • GitHub Check: Analyze (go)
✨ 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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copy link
Contributor

@imAsterSun imAsterSun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@cyyeh cyyeh merged commit d6c45a4 into main May 29, 2025
12 checks passed
@cyyeh cyyeh deleted the chore/ai-service/minor-updates branch May 29, 2025 02:52
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 wren-ai-service
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants