Skip to content

docs: Update NSQL API for optional model, sample_data default change#1684

Open
claudespice wants to merge 3 commits into
trunkfrom
docs/nsql-ux-improvements
Open

docs: Update NSQL API for optional model, sample_data default change#1684
claudespice wants to merge 3 commits into
trunkfrom
docs/nsql-ux-improvements

Conversation

@claudespice
Copy link
Copy Markdown
Collaborator

Summary

  • NSQL model field is now optional — when omitted, Spice auto-selects the only compatible LLM model configured in the Spicepod
  • sample_data_enabled default changed from true to false
  • tools: auto mode now explicitly noted as excluding data sampling tools
  • Added prompt_cache_key field to NSQL request schema

Source PRs

Changes

  • website/public/openapi.json — Updated NSQL Request schema descriptions, defaults, and example
  • website/docs/api/HTTP/post-nsql.api.mdx — Updated inline schema and example to match
  • website/docs/features/large-language-models/tools.md — Clarified auto mode excludes data sampling tools

Test plan

  • Verified NSQL API page renders correctly
  • Links are valid

@claudespice claudespice self-assigned this May 8, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

🚀 deployed to https://84b46fa8.spiceai-org-website.pages.dev

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://b0321239.spiceai-org-website.pages.dev

…ments

# Conflicts:
#	website/docs/api/HTTP/post-nsql.api.mdx
@github-actions
Copy link
Copy Markdown

🚀 deployed to https://846e08f5.spiceai-org-website.pages.dev

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants