docs(caching): the cache metrics table was missing misses and the two stale-while-revalidate counters
a month ago
Improve documentation formatting for clarity and consistency (#1389)
* Refine documentation across various sections for clarity and consistency
- Updated descriptions in datasets, models, runtime, and views documentation to enhance readability and precision.
- Improved explanations regarding retry mechanisms and refresh attempts in acceleration settings.
- Clarified the purpose and functionality of the `WITH` clause in SQL documentation.
- Enhanced troubleshooting guidance with detailed common issues and solutions for dataset loading, query performance, and AI chat results.
- Revised use case descriptions for agentic apps, edge AI, federated MCP server, object-store AI engine, and more to improve clarity and impact.
- Streamlined language throughout the documentation to ensure consistency and better user understanding.
* Improve documentation formatting for clarity and consistency across multiple sections
* Apply suggestion from @lukekim
* Update documentation links for consistency and clarity across multiple sections
7 months ago
docs(caching): a declared primary_key is a row constraint, not the cache key
The caching refresh-mode page said a declared `acceleration.primary_key`
replaces request metadata as the cache key, and its worked example passed
a YAML list. Neither is true.
A cache lookup is built from the request alone, so a key over response
fields could not serve one even in principle; `primary_key` is a
uniqueness constraint on the rows the accelerator stores. And
`primary_key` deserializes as a string in every release, so the list form
never parsed — the whole Spicepod is rejected at load.
The example now projects the response fields it keys on with a
`columns:` block and passes the key as a parenthesized string. That
projection is only available from v2.0.0, so the 1.10.x and 1.11.x copies
drop the example instead and state what a key can name there.
a month ago
Improve documentation formatting for clarity and consistency (#1389)
* Refine documentation across various sections for clarity and consistency
- Updated descriptions in datasets, models, runtime, and views documentation to enhance readability and precision.
- Improved explanations regarding retry mechanisms and refresh attempts in acceleration settings.
- Clarified the purpose and functionality of the `WITH` clause in SQL documentation.
- Enhanced troubleshooting guidance with detailed common issues and solutions for dataset loading, query performance, and AI chat results.
- Revised use case descriptions for agentic apps, edge AI, federated MCP server, object-store AI engine, and more to improve clarity and impact.
- Streamlined language throughout the documentation to ensure consistency and better user understanding.
* Improve documentation formatting for clarity and consistency across multiple sections
* Apply suggestion from @lukekim
* Update documentation links for consistency and clarity across multiple sections
7 months ago
docs(cluster): runtime.scheduler.params keys take the s3_ prefix
17 days ago
Improve documentation formatting for clarity and consistency (#1389)
* Refine documentation across various sections for clarity and consistency
- Updated descriptions in datasets, models, runtime, and views documentation to enhance readability and precision.
- Improved explanations regarding retry mechanisms and refresh attempts in acceleration settings.
- Clarified the purpose and functionality of the `WITH` clause in SQL documentation.
- Enhanced troubleshooting guidance with detailed common issues and solutions for dataset loading, query performance, and AI chat results.
- Revised use case descriptions for agentic apps, edge AI, federated MCP server, object-store AI engine, and more to improve clarity and impact.
- Streamlined language throughout the documentation to ensure consistency and better user understanding.
* Improve documentation formatting for clarity and consistency across multiple sections
* Apply suggestion from @lukekim
* Update documentation links for consistency and clarity across multiple sections
7 months ago
docs(models): the chat-completion override list did not match OPENAI_DEFAULT_PARAM_KEYS
`tools` was dropped from the OpenAI request-body auto-defaults in
spiceai/spiceai#8725 (first released v1.11.0); since then a `tools`
value in a model's `params` is read only as Spice's tool-group
selector (`extract_secret!(params, "tools")` -> `SpiceToolsOptions`),
never as a default for OpenAI's `tools` request field. Remove the row
from v1.11.x onward; it stays correct in v1.10.x and older.
`reasoning_effort` has been in `OPENAI_DEFAULT_PARAM_KEYS` since
before v1.5.0 and was never listed — add it to every doc set.
`prompt_cache_key` joined the set at v2.0.0 and is already documented
in this page's Prompt Caching section — add it to the list for v2.0.x
and later so the enumeration matches the code.
a month ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
docs: Sync the cookbook page and recipe links with spiceai/cookbook (#2318)
* Sync the cookbook page with the current spiceai/cookbook recipes
List all 122 current recipes (up from 79) and leave out evals, llm-judge, and websearch, which the cookbook marks deprecated in v2.0+.
- Correct entries that pointed at the wrong recipe or described an old version: Results Caching linked the Caching Accelerator recipe, Nvidia NIM on Kubernetes linked the EC2 recipe, Hashed Partitioning now uses Cayenne, and Federated SQL Query no longer uses Dremio.
- Add the missing recipes, including Cayenne, async queries, native PostgreSQL/MySQL/MongoDB CDC, DynamoDB Streams, HTTP, Redshift, ScyllaDB, SMB, the catalog connectors, full-text search, distributed query, and Spice as an MCP server.
- Add Change Data Capture and Advanced Topics sections. Local Dataset Replication was tagged for no rendered section, so it never appeared.
- Show guides in Sample Applications and Guides instead of Security.
- Align Core Features with the cookbook's core scenarios and feature Cayenne as the data accelerator.
- Label recipes that need Spice.ai Enterprise.
- Remove forbidden words (enhance, leverage, utilize, robust) from section intros.
* Fix broken and stale cookbook recipe references across doc versions
Every version links to the recipes on cookbook trunk, so these corrections apply to each version that carries them.
- Query Federation: replace the walkthrough with the current Federated SQL Query recipe, which joins NYC taxi trips in S3 with taxi zones in PostgreSQL. The old walkthrough logged in to a demo Dremio, ran 'spice add spiceai/fed-demo' (that Spicepod no longer exists on Spicerack), and ran 'cd demo' twice. The new steps and output come from a run of the recipe on Spice v2.3.2.
- FAQ: the RAG recipe link (cookbook/tree/trunk/rag) never existed; link the RAG use-case page instead.
- Use cases: fix duckdb/accelerator/README and federation/README links that were missing the .md extension.
- PostgreSQL connector: link the connector recipe instead of the accelerator recipe, and fix 'configure Supabase a data connector'.
- ODBC connector: the recipe now connects to MySQL with the MariaDB driver, not Postgres.
- Glue catalog connector: its recipe configures the Glue Catalog Connector, not the Data Connector.
- Release notes: fix three recipe links that pointed at moved or malformed paths.
* Link docs pages to their cookbook recipes
49 cookbook recipes had no link from any docs page. Add a Cookbook section, or a bullet in an existing one, on the matching page in vNext and 2.3.x. Covered pages include CDC (PostgreSQL, MySQL, Aurora MySQL, MongoDB), the catalog connectors (DuckLake, MySQL, SQL Server, Unity Catalog, Databricks, Iceberg Hadoop, PostgreSQL CDC), acceleration (partitioning, snapshots, indexes, constraints, views, caching, cron refresh, dual-dataset registration), search, distributed query and async queries, MCP, LLM memory, text-to-SQL, the ai() function, models (OpenAI, DeepSeek, filesystem, xAI, NVIDIA NIM on Kubernetes), API keys, ADBC, JDBC, the SDKs, and Cloud Connect. The sidecar and microservice architecture partials, which every version shares, link their recipes too.
Related updates:
- The docs landing page lists Cayenne among the accelerators and links the Cayenne recipe.
- The Cayenne Transactions intro also covers tables configured for durable write-back, matching the section's own requirements.
- The FAQ says the cookbook has over 120 recipes, up from over 65.
docs(embeddings): the chunk offset column is <column>_offset, not _offsets (#2170)
Every page that documents bring-your-own chunked embeddings named the required
offset column '<column_name>_offsets'. The runtime looks for '<column>_offset':
offset_col! in runtime-search generates '{col}_offset', ChunkedSearchIndex
::chunking_offset_col formats the same, and base_col strips '_offset'.
The consequence is silent. EmbeddingTable::base_table_has_embedding_column
looks the column up by that exact name and, unlike the two neighbouring
early-returns, logs nothing when it is missing - it just returns false, so the
column is not treated as precomputed and Spice re-embeds it from scratch.
A user who followed the docs pays for embeddings they already had and gets no
diagnostic explaining why.
The vector-search page already contradicted itself: its 'describe sales'
example for the chunked case shows 'address_offset', matching the code, one
section below the constraint that asked for '_offsets'.
Swept all 11 doc sets and all three page types that carry the claim.
a month ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Improve documentation formatting for clarity and consistency (#1389)
* Refine documentation across various sections for clarity and consistency
- Updated descriptions in datasets, models, runtime, and views documentation to enhance readability and precision.
- Improved explanations regarding retry mechanisms and refresh attempts in acceleration settings.
- Clarified the purpose and functionality of the `WITH` clause in SQL documentation.
- Enhanced troubleshooting guidance with detailed common issues and solutions for dataset loading, query performance, and AI chat results.
- Revised use case descriptions for agentic apps, edge AI, federated MCP server, object-store AI engine, and more to improve clarity and impact.
- Streamlined language throughout the documentation to ensure consistency and better user understanding.
* Improve documentation formatting for clarity and consistency across multiple sections
* Apply suggestion from @lukekim
* Update documentation links for consistency and clarity across multiple sections
7 months ago