feat: describegpt - refactor default prompt file; add --fewshot-examples option
#2955
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
jqnatividad
commented
Sep 1, 2025
- standardize replaceable parameters - enclosed with curly braces and capitaliza
- parameterize both DuckDB and Polars sql guidance
- include fewshot examples for both
- standardize replaceable parameters - enclosed with curly braces and capitaliza - parameterize both DuckDB and Polars sql guidance - include fewshot examples for both
- ensure defaults aligned with docopt defaults - add "Let's think step by step." to trigger step-by-step reasoning - add `---` separator before provided metadata - tuned DuckDB SQL generation guidelines - GENERATED_BY_SIGNATURE formt is now aligned with the standard replacaebles using curly braces
- aligned docopt defaults with default prompt file - tuned SQL prompt generation - GENERATED_BY_SIGNATURE now delimited by curly braces - set Diskcache to sync to disk on change - removed unneeded `cache_prefix_block` from diskcache - formatted SQL generation terminal messages - analysis results are now always cached by default
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the describegpt command to standardize prompt parameter formatting and introduce few-shot learning capabilities. The main purpose is to improve prompt consistency and add optional few-shot examples to enhance SQL query generation quality.
- Standardized all replaceable parameters to use uppercase with curly braces format (
{STATS},{FREQUENCY}, etc.) - Added
--fewshot-examplesflag to optionally include few-shot learning examples in LLM prompts - Separated SQL guidance for DuckDB and Polars with dedicated sections in the default prompt file
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/cmd/describegpt.rs | Added fewshot examples flag, refactored prompt parameter replacement, updated cache configuration, and improved error handling for SQL guidelines parsing |
| resources/describegpt_defaults.toml | Updated prompt file structure with standardized parameters, added separate DuckDB/Polars SQL guidance sections, and included comprehensive few-shot examples for both engines |
Comments suppressed due to low confidence (2)
src/cmd/describegpt.rs:1
- The
cache_prefix_blockline is being removed but there's no replacement provided. This could cause cache key conflicts or unexpected behavior if the cache prefix was serving a specific purpose.
static USAGE: &str = r#"
src/cmd/describegpt.rs:1
- Similar to the previous cache configuration, the
cache_prefix_blockis being removed without replacement, which could lead to cache key conflicts between different cache instances.
static USAGE: &str = r#"
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- add {DUCKDB_VERSION} parameter
- add fallback to INPUT_TABLE_NAME parsing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.