Skip to content

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

Closed
claudespice wants to merge 6 commits into
trunkfrom
docs/nsql-ux-improvements
Closed

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

Conversation

@claudespice

Copy link
Copy Markdown
Contributor

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

github-actions Bot commented May 8, 2026 •

Copy link
Copy Markdown
Contributor

✅ 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

github-actions Bot commented May 8, 2026

Copy link
Copy Markdown
Contributor

🔍 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

github-actions Bot commented May 8, 2026

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 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
Contributor

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

@Jeadie

Jeadie commented May 25, 2026

Copy link
Copy Markdown
Contributor

website/docs/api/HTTP/*.mdx is autogenerated from spiceai source code. This will get overriden by next update.

@github-actions

Copy link
Copy Markdown
Contributor

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

Jeadie and others added 2 commits May 26, 2026 08:46
The postcss-load-config package (peer dep of tailwindcss) requires
yaml@^2.4.2 as an optional peer dependency. npm 10 (used in CI)
attempts to install optional peers and fails when yaml is not in the
lock file. Adding yaml as a direct dependency resolves this.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

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

@lukekim lukekim closed this May 26, 2026

This branch was successfully deployed

1 active deployment
preview — 8c0fe4c8 Deployed May 25, 2026 by github-actions[bot]
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.

3 participants