Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve titles and order of Features #449

Merged
merged 7 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions spiceaidocs/docs/features/ai-gateway/index.md
Original file line number Diff line number Diff line change
@@ -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/overview.md).
lukekim marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion spiceaidocs/docs/features/caching/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/features/cdc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
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
---
Expand Down
17 changes: 0 additions & 17 deletions spiceaidocs/docs/features/configurable-llms/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
5 changes: 2 additions & 3 deletions spiceaidocs/docs/features/data-ingestion/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

:::
:::
2 changes: 1 addition & 1 deletion spiceaidocs/docs/features/federated-queries/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/features/search/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
20 changes: 10 additions & 10 deletions spiceaidocs/docs/reference/sql/select.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand All @@ -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:

Expand All @@ -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:

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down
Loading