Skip to content

Improve the AI Assistant user prompt to be more descriptive of the actual functionality.#9733

Open
dpage wants to merge 1 commit intopgadmin-org:masterfrom
dpage:improve_ai_assistant_user_prompt
Open

Improve the AI Assistant user prompt to be more descriptive of the actual functionality.#9733
dpage wants to merge 1 commit intopgadmin-org:masterfrom
dpage:improve_ai_assistant_user_prompt

Conversation

@dpage
Copy link
Contributor

@dpage dpage commented Mar 11, 2026

Summary by CodeRabbit

  • Bug Fixes

  • Improvements

    • Enhanced SQL generation assistant interface messages to better guide users on available capabilities and supported operations.

@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026

Walkthrough

This PR updates user-facing copy in the NLQ Chat Panel component to provide clearer prompts and instructions to users. The changes include revised introductory text and input placeholder wording, along with corresponding test assertion updates and a release notes entry documenting the improvement.

Changes

Cohort / File(s) Summary
Release Notes
docs/en_US/release_notes_9_14.rst
Added entry to Bug fixes list for Issue #9732 regarding AI Assistant prompt clarity.
NLQ Chat Panel Component
web/pgadmin/tools/sqleditor/static/js/components/sections/NLQChatPanel.jsx
Updated user-facing UI strings: introductory gettext message expanded to include guidance on supported statement types; input placeholder text revised to "Ask a question or describe the SQL you need..." for better clarity.
NLQ Chat Panel Tests
web/regression/javascript/sqleditor/NLQChatPanel.spec.js
Updated test expectations and assertions to align with revised UI copy, including placeholder text and empty-state message updates.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: improving the AI Assistant user prompt to be more descriptive. The modifications across three files all center on enhancing user-facing text and prompts in the NLQChatPanel component.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/en_US/release_notes_9_14.rst (1)

34-35: Consider moving this entry to "Housekeeping" section.

This change improves user-facing copy for clarity rather than fixing a bug. The "Housekeeping" section (line 25) may be a more appropriate location for this entry.

Additionally, line 35 has trailing whitespace that could be removed.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/en_US/release_notes_9_14.rst` around lines 34 - 35, Move the
release-note entry for "Issue `#9732` - Improve the AI Assistant user prompt..."
out of the current location and insert it under the "Housekeeping" section (the
heading titled "Housekeeping") since it is copy clarity rather than a bug fix,
and also remove the trailing whitespace at the end of the entry line (the extra
space after the closing backticks on the line that contains the Issue `#9732`
reference).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/en_US/release_notes_9_14.rst`:
- Around line 34-35: Move the release-note entry for "Issue `#9732` - Improve the
AI Assistant user prompt..." out of the current location and insert it under the
"Housekeeping" section (the heading titled "Housekeeping") since it is copy
clarity rather than a bug fix, and also remove the trailing whitespace at the
end of the entry line (the extra space after the closing backticks on the line
that contains the Issue `#9732` reference).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e984af8b-d640-4dd2-ae9e-0f90d501d37b

📥 Commits

Reviewing files that changed from the base of the PR and between c8bd75c and 4b10544.

📒 Files selected for processing (3)
  • docs/en_US/release_notes_9_14.rst
  • web/pgadmin/tools/sqleditor/static/js/components/sections/NLQChatPanel.jsx
  • web/regression/javascript/sqleditor/NLQChatPanel.spec.js

@dpage
Copy link
Contributor Author

dpage commented Mar 12, 2026

The failed test here seems to be infrastructure related - the suite failed entirely due to timeouts

@dpage
Copy link
Contributor Author

dpage commented Mar 12, 2026

The test failure here is the flakey test fixed in #9723

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant