From 68a6528443254a95d9fec83081f971c4b79b197b Mon Sep 17 00:00:00 2001 From: Luke Kim <80174+lukekim@users.noreply.github.com> Date: Mon, 7 Oct 2024 18:31:49 -0700 Subject: [PATCH] Improve titles and order of Features (#449) * Clarify Arrow engine usage * Tweak title and order of Features in sidebar --- .../default_overrides.md | 0 spiceaidocs/docs/features/ai-gateway/index.md | 25 +++++++++++++++++++ .../runtime_tools.md | 0 spiceaidocs/docs/features/caching/index.md | 2 +- spiceaidocs/docs/features/cdc/index.md | 4 +-- .../docs/features/configurable-llms/index.md | 17 ------------- .../constraints.md | 0 .../index.md | 8 +++--- .../indexes.md | 0 .../docs/features/data-ingestion/index.md | 5 ++-- .../docs/features/federated-queries/index.md | 2 +- spiceaidocs/docs/features/search/index.md | 2 +- .../docs/reference/spicepod/datasets.md | 7 +++--- spiceaidocs/docs/reference/sql/select.md | 20 +++++++-------- spiceaidocs/docusaurus.config.ts | 4 +-- 15 files changed, 52 insertions(+), 44 deletions(-) rename spiceaidocs/docs/features/{configurable-llms => ai-gateway}/default_overrides.md (100%) create mode 100644 spiceaidocs/docs/features/ai-gateway/index.md rename spiceaidocs/docs/features/{configurable-llms => ai-gateway}/runtime_tools.md (100%) delete mode 100644 spiceaidocs/docs/features/configurable-llms/index.md rename spiceaidocs/docs/features/{local-acceleration => data-acceleration}/constraints.md (100%) rename spiceaidocs/docs/features/{local-acceleration => data-acceleration}/index.md (95%) rename spiceaidocs/docs/features/{local-acceleration => data-acceleration}/indexes.md (100%) diff --git a/spiceaidocs/docs/features/configurable-llms/default_overrides.md b/spiceaidocs/docs/features/ai-gateway/default_overrides.md similarity index 100% rename from spiceaidocs/docs/features/configurable-llms/default_overrides.md rename to spiceaidocs/docs/features/ai-gateway/default_overrides.md diff --git a/spiceaidocs/docs/features/ai-gateway/index.md b/spiceaidocs/docs/features/ai-gateway/index.md new file mode 100644 index 00000000..c486d098 --- /dev/null +++ b/spiceaidocs/docs/features/ai-gateway/index.md @@ -0,0 +1,25 @@ +--- +title: 'AI Gateway - Configuring LLMs' +sidebar_label: 'AI Gateway' +description: 'Learn how to configure language models and use Spice as an AI Gateway.' +sidebar_position: 5 +pagination_prev: null +pagination_next: null +--- + +Spice provides a high-performance, OpenAI API-compatible AI Gateway optimized for managing and scaling large language models (LLMs). + +Additionally, Spice offers tools for Enterprise Retrieval-Augmented Generation (RAG), such as SQL query across federated datasets and an advanced search feature (see [Search](/features/search)). + +Spice also supports **full OpenTelemetry observability**, enabling detailed tracking of data flows and requests for full transparency and easier debugging. + +## Configuring Language Models + +Spice supports a variety of LLMs (see [Model Components](/components/models/index.md)). + +### Core Features + +- **Custom Tools**: Equip models with tools to interact with the Spice runtime. +- **System Prompts**: Customize system prompts and override defaults for [`v1/chat/completion`](/api/http/chat-completions.md). + +For detailed configuration and API usage, refer to the [API Documentation](/api). diff --git a/spiceaidocs/docs/features/configurable-llms/runtime_tools.md b/spiceaidocs/docs/features/ai-gateway/runtime_tools.md similarity index 100% rename from spiceaidocs/docs/features/configurable-llms/runtime_tools.md rename to spiceaidocs/docs/features/ai-gateway/runtime_tools.md diff --git a/spiceaidocs/docs/features/caching/index.md b/spiceaidocs/docs/features/caching/index.md index 21a56c24..04bb4afa 100644 --- a/spiceaidocs/docs/features/caching/index.md +++ b/spiceaidocs/docs/features/caching/index.md @@ -2,7 +2,7 @@ title: 'Results Caching' sidebar_label: 'Results Caching' description: 'Learn how to use Spice in-memory caching of query results' -sidebar_position: 5 +sidebar_position: 3 pagination_prev: null pagination_next: null --- diff --git a/spiceaidocs/docs/features/cdc/index.md b/spiceaidocs/docs/features/cdc/index.md index 2232a3a0..f0402cd6 100644 --- a/spiceaidocs/docs/features/cdc/index.md +++ b/spiceaidocs/docs/features/cdc/index.md @@ -2,12 +2,12 @@ title: 'Change Data Capture (CDC)' sidebar_label: 'Change Data Capture' description: 'Learn how to use Change Data Capture (CDC) in Spice.' -sidebar_position: 6 +sidebar_position: 4 pagination_prev: null pagination_next: null --- -Change Data Capture (CDC) is a technique to capture changed rows from a database's transaction log and deliver to consumers with low latency. Leveraging this technique allows Spice to keep [locally accelerated](../local-acceleration/index.md) datasets up-to-date in real-time with the source data, and is highly efficient by only transferring the changed rows instead of re-fetching the entire dataset on refresh. +Change Data Capture (CDC) is a technique to capture changed rows from a database's transaction log and deliver to consumers with low latency. Leveraging this technique allows Spice to keep [locally accelerated](../data-acceleration/index.md) datasets up-to-date in real-time with the source data, and is highly efficient by only transferring the changed rows instead of re-fetching the entire dataset on refresh. ## Benefits diff --git a/spiceaidocs/docs/features/configurable-llms/index.md b/spiceaidocs/docs/features/configurable-llms/index.md deleted file mode 100644 index 134eb959..00000000 --- a/spiceaidocs/docs/features/configurable-llms/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 'Configuring Language Models' -sidebar_label: 'Configuring LLMs' -description: 'Learn how to configure language models in Spice.' -sidebar_position: 7 -pagination_prev: null -pagination_next: null ---- - -Spice supports language models (LLMs) from several sources (see [model components](/components/models/index.md)) and provides configuration for how inference will be performed in the Spice runtime. This includes: - - Providing tools to the language model, enabling it to interact with the Spice runtime. - - Specifying system prompts and overriding defaults for [`v1/chat/completion`](/api/http/chat-completions.md). - - -import DocCardList from '@theme/DocCardList'; - - diff --git a/spiceaidocs/docs/features/local-acceleration/constraints.md b/spiceaidocs/docs/features/data-acceleration/constraints.md similarity index 100% rename from spiceaidocs/docs/features/local-acceleration/constraints.md rename to spiceaidocs/docs/features/data-acceleration/constraints.md diff --git a/spiceaidocs/docs/features/local-acceleration/index.md b/spiceaidocs/docs/features/data-acceleration/index.md similarity index 95% rename from spiceaidocs/docs/features/local-acceleration/index.md rename to spiceaidocs/docs/features/data-acceleration/index.md index 5c2f09c5..de44141e 100644 --- a/spiceaidocs/docs/features/local-acceleration/index.md +++ b/spiceaidocs/docs/features/data-acceleration/index.md @@ -1,8 +1,8 @@ --- -title: 'Local Acceleration' -sidebar_label: 'Local Acceleration' -description: 'Learn how to use local acceleration in Spice.' -sidebar_position: 3 +title: 'Data Acceleration' +sidebar_label: 'Data Acceleration' +description: 'Learn how to use local data acceleration in Spice.' +sidebar_position: 2 pagination_prev: null --- diff --git a/spiceaidocs/docs/features/local-acceleration/indexes.md b/spiceaidocs/docs/features/data-acceleration/indexes.md similarity index 100% rename from spiceaidocs/docs/features/local-acceleration/indexes.md rename to spiceaidocs/docs/features/data-acceleration/indexes.md diff --git a/spiceaidocs/docs/features/data-ingestion/index.md b/spiceaidocs/docs/features/data-ingestion/index.md index b077749c..3c4e227b 100644 --- a/spiceaidocs/docs/features/data-ingestion/index.md +++ b/spiceaidocs/docs/features/data-ingestion/index.md @@ -2,12 +2,11 @@ title: 'Data Ingestion' sidebar_label: 'Data Ingestion' description: 'Learn how to ingest data in Spice.' -sidebar_position: 4 +sidebar_position: 7 pagination_prev: null pagination_next: null --- - Data can be ingested by the Spice runtime for replication to a Data Connector, like PostgreSQL or the Spice.ai Cloud platform. By default, the runtime exposes an [OpenTelemety](https://opentelemetry.io) (OTEL) endpoint at grpc://127.0.0.1:50052 for data ingestion. @@ -63,4 +62,4 @@ SMART data will be available in the `smart_attribute_raw_value` dataset in Spice - Only Spice.ai replication is supported for now. -::: \ No newline at end of file +::: diff --git a/spiceaidocs/docs/features/federated-queries/index.md b/spiceaidocs/docs/features/federated-queries/index.md index 4293c20f..721fa41f 100644 --- a/spiceaidocs/docs/features/federated-queries/index.md +++ b/spiceaidocs/docs/features/federated-queries/index.md @@ -2,7 +2,7 @@ title: 'Federated Queries' sidebar_label: 'Federated Queries' description: 'Learn how to use federated queries in Spice.' -sidebar_position: 2 +sidebar_position: 1 pagination_prev: null pagination_next: null --- diff --git a/spiceaidocs/docs/features/search/index.md b/spiceaidocs/docs/features/search/index.md index 77cd6761..c311f2ab 100644 --- a/spiceaidocs/docs/features/search/index.md +++ b/spiceaidocs/docs/features/search/index.md @@ -2,7 +2,7 @@ title: 'Search Functionality' sidebar_label: 'Search' description: 'Learn how Spice can search across datasets using database-native and vector-search methods.' -sidebar_position: 8 +sidebar_position: 6 pagination_prev: null pagination_next: null --- diff --git a/spiceaidocs/docs/reference/spicepod/datasets.md b/spiceaidocs/docs/reference/spicepod/datasets.md index f82e81da..13a57a3d 100644 --- a/spiceaidocs/docs/reference/spicepod/datasets.md +++ b/spiceaidocs/docs/reference/spicepod/datasets.md @@ -132,6 +132,7 @@ Required to enable a retention policy on the dataset. ## `time_format` Optional. The format of the `time_column`. The following values are supported: + - `timestamp` - Default. Timestamp without a timezone. E.g. `2016-06-22 19:10:25` with data type `timestamp`. - `timestamptz` - Timestamp with a timezone. E.g. `2016-06-22 19:10:25-07` with data type `timestamptz`. - `unix_seconds` - Unix timestamp in seconds. E.g. `1718756687`. @@ -269,7 +270,7 @@ The `indexes` field is a map where the key is the column reference and the value A column reference can be a single column name or a multicolumn key. The column reference must be enclosed in parentheses if it is a multicolumn key. -See [Indexes](../../features/local-acceleration/indexes.md) +See [Indexes](../../features/data-acceleration/indexes.md) ```yaml datasets: @@ -289,7 +290,7 @@ Optional. Specify the primary key constraint on the locally accelerated table. N The `primary_key` field is a string that represents the column reference that should be used as the primary key. The column reference can be a single column name or a multicolumn key. The column reference must be enclosed in parentheses if it is a multicolumn key. -See [Constraints](../../features/local-acceleration/constraints.md) +See [Constraints](../../features/data-acceleration/constraints.md) ```yaml datasets: @@ -316,7 +317,7 @@ The possible conflict resolution strategies are: - `upsert` - Upsert the incoming data when the primary key constraint is violated. - `drop` - Drop the data when the primary key constraint is violated. -See [Constraints](../../features/local-acceleration/constraints.md) +See [Constraints](../../features/data-acceleration/constraints.md) ```yaml datasets: diff --git a/spiceaidocs/docs/reference/sql/select.md b/spiceaidocs/docs/reference/sql/select.md index c641ca0d..54b73cf7 100644 --- a/spiceaidocs/docs/reference/sql/select.md +++ b/spiceaidocs/docs/reference/sql/select.md @@ -1,6 +1,6 @@ --- -title: "SELECT" -sidebar_label: "SELECT" +title: 'SELECT' +sidebar_label: 'SELECT' pagination_prev: 'reference/sql/index' pagination_next: null sidebar_position: 1 @@ -27,7 +27,7 @@ Spice supports the following syntax for queries: [ [UNION](#union-clause) [ ALL | select ] [ [ORDER BY](#order-by-clause) expression \[ ASC | DESC \][, ...] ] [ [LIMIT](#limit-clause) count ] -[ [EXCLUDE | EXCEPT](#exclude-and-except-clause) ] +[ [EXCLUDE | EXCEPT](#exclude-and-except-clause) ] ### WITH clause @@ -40,8 +40,8 @@ SELECT a, b FROM x; ### SELECT clause -The `SELECT` clause is used to select data from a database by defining the colummns it returns. Each `select_expr` in the - SELECT list can be an expression or wildcards. +The `SELECT` clause is used to select data from a database by defining the colummns it returns. Each `select_expr` in the +SELECT list can be an expression or wildcards. Example: @@ -68,7 +68,7 @@ SELECT t.a FROM table AS t ### WHERE clause -The `WHERE` clause is used define the conditions to filter the query results. +The `WHERE` clause is used define the conditions to filter the query results. Example: @@ -178,10 +178,10 @@ select * from x cross join x y; ### GROUP BY clause -The `GROUP BY` clause groups together input rows that have the same value into summary rows. +The `GROUP BY` clause groups together input rows that have the same value into summary rows. `GROUP BY` is typically used with aggregrate functions (`COUNT()`, `MAX()`, `SUM()`), but if no aggregate functions are - included, the query with a `GROUP BY` clause is the same as `SELECT DISTINCT`. +included, the query with a `GROUP BY` clause is the same as `SELECT DISTINCT`. Example: @@ -210,8 +210,8 @@ SELECT a, b, MAX(c) FROM table GROUP BY a, b HAVING MAX(c) > 10 ### UNION clause -The `UNION` clause combines the results of two or more `SELECT` statments. By default `UNION` removes - duplicates. To include duplicates, use `UNION ALL`. +The `UNION` clause combines the results of two or more `SELECT` statments. By default `UNION` removes +duplicates. To include duplicates, use `UNION ALL`. Example: diff --git a/spiceaidocs/docusaurus.config.ts b/spiceaidocs/docusaurus.config.ts index 74db23b6..b308501e 100644 --- a/spiceaidocs/docusaurus.config.ts +++ b/spiceaidocs/docusaurus.config.ts @@ -165,8 +165,8 @@ const config: Config = { to: '/features/data-ingestion', }, { - from: '/local-acceleration', - to: '/features/local-acceleration', + from: '/data-acceleration', + to: '/features/data-acceleration', }, ], },