Skip to content
Draft
Show file tree
Hide file tree
Changes from all 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
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This documentation covers the **Spice.ai Cloud Platform**.
For the self-hostable **Spice.ai OSS** runtime, visit [**docs.spiceai.org**](https://docs.spiceai.org).
{% endhint %}

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>🚀</strong></td><td><strong>Get Started</strong></td><td>Sign up and run your first query in minutes</td><td><a href="getting-started/get-started/">get-started</a></td></tr><tr><td><strong>⚡</strong></td><td><strong>Federated SQL Query</strong></td><td>Query across any data source with one SQL interface</td><td><a href="features/federated-sql-query.md">federated-sql-query.md</a></td></tr><tr><td><strong>🤖</strong></td><td><strong>AI Gateway</strong></td><td>OpenAI-compatible API for LLM inference</td><td><a href="features/ai-gateway.md">ai-gateway.md</a></td></tr><tr><td><strong>🔍</strong></td><td><strong>Search &#x26; Retrieval</strong></td><td>Vector and hybrid search for RAG workflows</td><td><a href="features/search-and-retrieval.md">search-and-retrieval.md</a></td></tr><tr><td><strong>🔌</strong></td><td><strong>Data Connectors</strong></td><td>Connect to 30+ databases, warehouses, and lakes</td><td><a href="building-blocks/data-connectors/">data-connectors</a></td></tr><tr><td><strong>📊</strong></td><td><strong>Monitoring</strong></td><td>Observe performance with Grafana, Datadog, and more</td><td><a href="monitoring/">monitoring</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>🚀</strong></td><td><strong>Get Started</strong></td><td>Sign up and run your first query in minutes</td><td><a href="cloud/getting-started/get-started/">get-started</a></td></tr><tr><td><strong>⚡</strong></td><td><strong>Federated SQL Query</strong></td><td>Query across any data source with one SQL interface</td><td><a href="features/federated-sql-query.md">federated-sql-query.md</a></td></tr><tr><td><strong>🤖</strong></td><td><strong>AI Gateway</strong></td><td>OpenAI-compatible API for LLM inference</td><td><a href="features/ai-gateway.md">ai-gateway.md</a></td></tr><tr><td><strong>🔍</strong></td><td><strong>Search &#x26; Retrieval</strong></td><td>Vector and hybrid search for RAG workflows</td><td><a href="features/search-and-retrieval.md">search-and-retrieval.md</a></td></tr><tr><td><strong>🔌</strong></td><td><strong>Data Connectors</strong></td><td>Connect to 30+ databases, warehouses, and lakes</td><td><a href="building-blocks/data-connectors/">data-connectors</a></td></tr><tr><td><strong>📊</strong></td><td><strong>Monitoring</strong></td><td>Observe performance with Grafana, Datadog, and more</td><td><a href="cloud/monitoring/">monitoring</a></td></tr></tbody></table>

## What You Can Do

Expand All @@ -56,12 +56,12 @@ With the **Spice.ai Cloud Platform** you can:

Get up and running in minutes:

1. [Sign in with GitHub](getting-started/get-started/portal-login.md)
2. [Create a Spice app](getting-started/getting-started/portal-login-1.md)
3. [Add a dataset and query data](getting-started/get-started/step-2-add-dataset-and-query-data.md)
4. [Add an AI model and chat](getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md)
1. [Sign in with GitHub](cloud/getting-started/get-started/portal-login.md)
2. [Create a Spice app](cloud/getting-started/getting-started/portal-login-1.md)
3. [Add a dataset and query data](cloud/getting-started/get-started/step-2-add-dataset-and-query-data.md)
4. [Add an AI model and chat](cloud/getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md)

<a href="getting-started/get-started/" class="button primary" data-icon="rocket-launch">Get started</a> <a href="api/sql-query/" class="button secondary" data-icon="terminal">API reference</a>
<a href="cloud/getting-started/get-started/" class="button primary" data-icon="rocket-launch">Get started</a> <a href="cloud/api/sql-query/" class="button secondary" data-icon="terminal">API reference</a>
{% endcolumn %}

{% column %}
Expand All @@ -84,5 +84,5 @@ print(df)

* **Slack** — Ask questions and get help from the team at [spice.ai/slack](https://spice.ai/slack).
* **GitHub** — File issues and contribute at [github.com/spiceai/spiceai](https://github.com/spiceai/spiceai).
* **Enterprise support** — [Paid plans](pricing/plans.md) include priority support with an SLA.
* **Enterprise support** — [Paid plans](cloud/pricing/plans.md) include priority support with an SLA.
* **Help Center** — Browse the [Help Center](help/) for troubleshooting, guides, and FAQs.
6 changes: 3 additions & 3 deletions building-blocks/data-connectors/abfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Azure BlobFS (ABFS) Data Connector enables federated SQL queries on files st

When a folder path is provided, all the contained files will be loaded.

File formats are specified using the `file_format` parameter, as described in [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats).
File formats are specified using the `file_format` parameter, as described in [Object Store File Formats](./README.md#object-store-file-formats).

```yaml
datasets:
Expand Down Expand Up @@ -60,7 +60,7 @@ SELECT COUNT(*) FROM cool_dataset;

| Parameter name | Description |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_format` | Specifies the data format. Required if not inferrable from `from`. Options: `parquet`, `csv`. Refer to [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats) for details. |
| `file_format` | Specifies the data format. Required if not inferrable from `from`. Options: `parquet`, `csv`. Refer to [Object Store File Formats](./README.md#object-store-file-formats) for details. |
| `abfs_account` | Azure storage account name |
| `abfs_sas_string` | SAS (Shared Access Signature) Token to use for authorization |
| `abfs_endpoint` | Storage endpoint, default: `https://{account}.blob.core.windows.net` |
Expand Down Expand Up @@ -123,7 +123,7 @@ Configure service principal authentication by setting the `abfs_access_key` para

## Supported file formats

Specify the file format using `file_format` parameter. More details in [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats).
Specify the file format using `file_format` parameter. More details in [Object Store File Formats](./README.md#object-store-file-formats).

## Examples

Expand Down
6 changes: 3 additions & 3 deletions building-blocks/data-connectors/file.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ hidden: true

The File Data Connector enables federated SQL queries on files stored by locally accessible filesystems. It supports querying individual files or entire directories, where all child files within the directory will be loaded and queried.

File formats are specified using the `file_format` parameter, as described in [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats).
File formats are specified using the `file_format` parameter, as described in [Object Store File Formats](./README.md#object-store-file-formats).

Example `spicepod.yml`

Expand Down Expand Up @@ -54,14 +54,14 @@ SELECT COUNT(*) FROM cool_dataset;

| Parameter name | Description |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_format` | Specifies the data file format. Required if the format cannot be inferred from the `from` path. Refer to [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats) for details. |
| `file_format` | Specifies the data file format. Required if the format cannot be inferred from the `from` path. Refer to [Object Store File Formats](./README.md#object-store-file-formats) for details. |
| `hive_partitioning_enabled` | Enable partitioning using hive-style partitioning from the folder structure. Defaults to `false` |

For CSV-specific parameters, see [CSV Parameters](../../reference/file-format.md#csv).

## Trigger data refresh on file change

In addition to standard [Data Refresh](/features/data-acceleration/data-refresh.md), a data refresh can also be triggered when the source file is modified. The File Data Connector uses a file system watcher to be notified the file has changed. The file watcher is disabled by default and can be enabled by setting the `file_watcher` parameter to `enabled` in the acceleration parameters.
In addition to standard [Data Refresh](../../features/data-acceleration/data-refresh.md), a data refresh can also be triggered when the source file is modified. The File Data Connector uses a file system watcher to be notified the file has changed. The file watcher is disabled by default and can be enabled by setting the `file_watcher` parameter to `enabled` in the acceleration parameters.

```yaml
datasets:
Expand Down
6 changes: 3 additions & 3 deletions building-blocks/data-connectors/ftp.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: 'FTP/SFTP Data Connector Documentation'

FTP (File Transfer Protocol) and SFTP (SSH File Transfer Protocol) are network protocols used for transferring files between a client and server, with FTP being less secure and SFTP providing encrypted file transfer over SSH.

The FTP/SFTP Data Connector enables federated/accelerated SQL query across [supported file formats](/building-blocks/data-connectors#object-store-file-formats) stored in FTP/SFTP servers.
The FTP/SFTP Data Connector enables federated/accelerated SQL query across [supported file formats](./README.md#object-store-file-formats) stored in FTP/SFTP servers.

```yaml
datasets:
Expand Down Expand Up @@ -58,7 +58,7 @@ SELECT COUNT(*) FROM cool_dataset;

| Parameter Name | Description |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_format` | Specifies the data file format. Required if the format cannot be inferred by from the `from` path. See [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats). |
| `file_format` | Specifies the data file format. Required if the format cannot be inferred by from the `from` path. See [Object Store File Formats](./README.md#object-store-file-formats). |
| `ftp_port` | Optional, specifies the port of the FTP server. Default is 21. E.g. `ftp_port: 21` |
| `ftp_user` | The username for the FTP server. E.g. `ftp_user: my-ftp-user` |
| `ftp_pass` | The password for the FTP server. Use the [secret replacement syntax](../secret-stores/index.md) to load the password from a secret store, e.g. `${secrets:my_ftp_pass}`. |
Expand All @@ -69,7 +69,7 @@ SELECT COUNT(*) FROM cool_dataset;

| Parameter Name | Description |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_format` | Specifies the data file format. Required if the format cannot be inferred by from the `from` path. See [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats). |
| `file_format` | Specifies the data file format. Required if the format cannot be inferred by from the `from` path. See [Object Store File Formats](./README.md#object-store-file-formats). |
| `sftp_port` | Optional, specifies the port of the SFTP server. Default is 22. E.g. `sftp_port: 22` |
| `sftp_user` | The username for the SFTP server. E.g. `sftp_user: my-sftp-user` |
| `sftp_pass` | The password for the SFTP server. Use the [secret replacement syntax](../secret-stores/index.md) to load the password from a secret store, e.g. `${secrets:my_sftp_pass}`. |
Expand Down
2 changes: 1 addition & 1 deletion building-blocks/data-connectors/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ All other filters are supported when `github_query_mode` is set to `search`, but
**Limitations**

- GitHub has a limitation in the Search API where it may return more stale data than the standard API used in the default query mode.
- GitHub has a limitation in the Search API where it only returns a maximum of 1000 results for a query. Use [append mode acceleration](/features/data-acceleration/data-refresh.md) to retrieve more results over time. See the [append example](#append-example) for pull requests.
- GitHub has a limitation in the Search API where it only returns a maximum of 1000 results for a query. Use [append mode acceleration](../../features/data-acceleration/data-refresh.md) to retrieve more results over time. See the [append example](#append-example) for pull requests.

{% endhint %}

Expand Down
4 changes: 2 additions & 2 deletions building-blocks/data-connectors/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 'HTTP(s) Data Connector Documentation'

# HTTP(s) Data Connector

The HTTP(s) Data Connector enables federated SQL query across [supported file formats](/building-blocks/data-connectors#object-store-file-formats) stored at an HTTP(s) endpoint.
The HTTP(s) Data Connector enables federated SQL query across [supported file formats](./README.md#object-store-file-formats) stored at an HTTP(s) endpoint.

```yaml
datasets:
Expand All @@ -18,7 +18,7 @@ datasets:

### `from`

The `from` field must contain a valid URI to the location of a [supported file](/building-blocks/data-connectors#object-store-file-formats). For example, `http://static_username@my-http-api/report.csv`.
The `from` field must contain a valid URI to the location of a [supported file](./README.md#object-store-file-formats). For example, `http://static_username@my-http-api/report.csv`.

### `name`

Expand Down
4 changes: 2 additions & 2 deletions building-blocks/data-connectors/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The S3 Data Connector enables federated SQL querying on files stored in S3 or S3

If a folder path is specified as the dataset source, all files within the folder will be loaded.

File formats are specified using the `file_format` parameter, as described in [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats).
File formats are specified using the `file_format` parameter, as described in [Object Store File Formats](./README.md#object-store-file-formats).

```yaml
datasets:
Expand Down Expand Up @@ -56,7 +56,7 @@ SELECT COUNT(*) FROM cool_dataset;

| Parameter Name | Description |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_format` | Specifies the data format. Required if it cannot be inferred from the object URI. Options: `parquet`, `csv`, `json`. Refer to [Object Store File Formats](/building-blocks/data-connectors#object-store-file-formats) for details. |
| `file_format` | Specifies the data format. Required if it cannot be inferred from the object URI. Options: `parquet`, `csv`, `json`. Refer to [Object Store File Formats](./README.md#object-store-file-formats) for details. |
| `s3_endpoint` | S3 endpoint URL (e.g., for MinIO). Default is the region endpoint. E.g. `s3_endpoint: https://my.minio.server` |
| `s3_region` | S3 bucket region. Default: `us-east-1`. |
| `client_timeout` | Timeout for S3 operations. Default: `30s`. |
Expand Down
2 changes: 1 addition & 1 deletion building-blocks/data-connectors/spiceai.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pagination_next: null

# Spice.ai Data Connector

The [Spice.ai](https://spice.ai/) Data Connector enables federated SQL query across datasets in the [Spice.ai Cloud Platform](https://docs.spice.ai/building-blocks/datasets). Access to these datasets requires a free [Spice.ai account](https://spice.ai/login).
The [Spice.ai](https://spice.ai/) Data Connector enables federated SQL query across datasets in the [Spice.ai Cloud Platform](../datasets.md). Access to these datasets requires a free [Spice.ai account](https://spice.ai/login).

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion building-blocks/embeddings/huggingface.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Supported models include:
- All models tagged as [text-embeddings-inference](https://huggingface.co/models?other=text-embeddings-inference) on Huggingface
- Any Huggingface repository with the correct files to be loaded as a [local embedding model](local.md).

With the same semantics as [language models](/docs/building-blocks/model-providers/huggingface.md#access-tokens), `spice` can run private HuggingFace embedding models:
With the same semantics as [language models](../../cloud/building-blocks/model-providers/huggingface.md#access-tokens), `spice` can run private HuggingFace embedding models:

```yaml
embeddings:
Expand Down
2 changes: 1 addition & 1 deletion building-blocks/model-providers/spiceai.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 'Instructions for using models hosted on the Spice Cloud Platform w

# Spice Cloud Platform

To use a model hosted on the [Spice Cloud Platform](https://docs.spice.ai/building-blocks/spice-models), specify the `spice.ai` path in the `from` field.
To use a model hosted on the [Spice Cloud Platform](../spice-models.md), specify the `spice.ai` path in the `from` field.

Example:

Expand Down
Loading