diff --git a/README.md b/README.md index 2bd818e9..bf3e8e5d 100644 --- a/README.md +++ b/README.md @@ -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 %} -
πŸš€Get StartedSign up and run your first query in minutesget-started
⚑Federated SQL QueryQuery across any data source with one SQL interfacefederated-sql-query.md
πŸ€–AI GatewayOpenAI-compatible API for LLM inferenceai-gateway.md
πŸ”Search & RetrievalVector and hybrid search for RAG workflowssearch-and-retrieval.md
πŸ”ŒData ConnectorsConnect to 30+ databases, warehouses, and lakesdata-connectors
πŸ“ŠMonitoringObserve performance with Grafana, Datadog, and moremonitoring
+
πŸš€Get StartedSign up and run your first query in minutesget-started
⚑Federated SQL QueryQuery across any data source with one SQL interfacefederated-sql-query.md
πŸ€–AI GatewayOpenAI-compatible API for LLM inferenceai-gateway.md
πŸ”Search & RetrievalVector and hybrid search for RAG workflowssearch-and-retrieval.md
πŸ”ŒData ConnectorsConnect to 30+ databases, warehouses, and lakesdata-connectors
πŸ“ŠMonitoringObserve performance with Grafana, Datadog, and moremonitoring
## What You Can Do @@ -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) -Get started API reference +Get started API reference {% endcolumn %} {% column %} @@ -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. diff --git a/building-blocks/data-connectors/abfs.md b/building-blocks/data-connectors/abfs.md index cb889b3a..17e0db08 100644 --- a/building-blocks/data-connectors/abfs.md +++ b/building-blocks/data-connectors/abfs.md @@ -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: @@ -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` | @@ -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 diff --git a/building-blocks/data-connectors/file.md b/building-blocks/data-connectors/file.md index ed458e7a..fb1198e7 100644 --- a/building-blocks/data-connectors/file.md +++ b/building-blocks/data-connectors/file.md @@ -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` @@ -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: diff --git a/building-blocks/data-connectors/ftp.md b/building-blocks/data-connectors/ftp.md index 3638987f..712eb385 100644 --- a/building-blocks/data-connectors/ftp.md +++ b/building-blocks/data-connectors/ftp.md @@ -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: @@ -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}`. | @@ -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}`. | diff --git a/building-blocks/data-connectors/github.md b/building-blocks/data-connectors/github.md index 08680d54..9d2da074 100644 --- a/building-blocks/data-connectors/github.md +++ b/building-blocks/data-connectors/github.md @@ -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 %} diff --git a/building-blocks/data-connectors/https.md b/building-blocks/data-connectors/https.md index e1003934..30f586ad 100644 --- a/building-blocks/data-connectors/https.md +++ b/building-blocks/data-connectors/https.md @@ -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: @@ -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` diff --git a/building-blocks/data-connectors/s3.md b/building-blocks/data-connectors/s3.md index 94e00a6a..7ec7f0b0 100644 --- a/building-blocks/data-connectors/s3.md +++ b/building-blocks/data-connectors/s3.md @@ -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: @@ -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`. | diff --git a/building-blocks/data-connectors/spiceai.md b/building-blocks/data-connectors/spiceai.md index f63785e6..fb3c9b5a 100644 --- a/building-blocks/data-connectors/spiceai.md +++ b/building-blocks/data-connectors/spiceai.md @@ -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 diff --git a/building-blocks/embeddings/huggingface.md b/building-blocks/embeddings/huggingface.md index ebce8e5e..9dcc0ca4 100644 --- a/building-blocks/embeddings/huggingface.md +++ b/building-blocks/embeddings/huggingface.md @@ -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: diff --git a/building-blocks/model-providers/spiceai.md b/building-blocks/model-providers/spiceai.md index d7e91082..b2d83289 100644 --- a/building-blocks/model-providers/spiceai.md +++ b/building-blocks/model-providers/spiceai.md @@ -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: diff --git a/building-blocks/spice-models.md b/building-blocks/spice-models.md index 0cd058c8..86ca4e72 100644 --- a/building-blocks/spice-models.md +++ b/building-blocks/spice-models.md @@ -13,15 +13,15 @@ Spice Models enable the training and use of ML models natively on the Spice plat The platform currently supports time-series forecasting models, with other categories of models planned. -Hosted models have first-class access to co-located data for training and inferencing including: [Spice managed datasets](/broken/pages/JnKPswDs1OXhUD2OxR0K), [user managed datasets](../portal/external-data-sources.md), and [custom datasets and views](../portal/datasets-and-views.md). Additionally, [Spice Firecache](../features/federated-sql-query.md) can be leveraged to train and infer up to 10x faster. +Hosted models have first-class access to co-located data for training and inferencing including: [Spice managed datasets](https://github.com/spiceai/datasets), [user managed datasets](../cloud/portal/external-data-sources.md), and [custom datasets and views](../cloud/portal/datasets-and-views.md). Additionally, [Spice Firecache](../features/federated-sql-query.md) can be leveraged to train and infer up to 10x faster. ### Defining a Model -Models are defined using a [model manifest](/broken/pages/kBNlZsrTXSmL6zaiY8bm) YAML file. Model details such as data requirements, architecture, training parameters, and other important hyperparameters are defined in the `model.yaml.` +Models are defined using a [model manifest](https://github.com/spiceai/samples/tree/trunk/.spice/models) YAML file. Model details such as data requirements, architecture, training parameters, and other important hyperparameters are defined in the `model.yaml.` -Add a `model.yaml` file to the repository path `/models/[model_name]/model.yaml` of a [GitHub connected Spice app](../portal/apps/connect-github.md), replacing `[model_name]` with the desired model name. +Add a `model.yaml` file to the repository path `/models/[model_name]/model.yaml` of a [GitHub connected Spice app](../cloud/portal/apps/connect-github.md), replacing `[model_name]` with the desired model name. -Refer to the [Models YAML specification](/broken/pages/kBNlZsrTXSmL6zaiY8bm) for all available configuration options. +Refer to the [Models YAML specification](https://github.com/spiceai/samples/tree/trunk/.spice/models) for all available configuration options. For example model manifests, see the [models samples repo](https://github.com/spiceai/samples/tree/trunk/.spice/models). @@ -73,6 +73,6 @@ Clicking **Predict** will demonstrate calling the predictions API using lookback The **Training Runs** page provides training details including a copyable `curl` command to make a prediction from the command line. -For details on the API, see [Prediction Documentation](/broken/pages/2C09l89bwNrM5jRF0xSx). +For details on the API, see Prediction Documentation.

Detailed training run page with the predictions API

diff --git a/changelog/README.md b/changelog/README.md index a118e20e..81abd08d 100644 --- a/changelog/README.md +++ b/changelog/README.md @@ -356,7 +356,7 @@ Spice runtime [v1.10.3](https://spiceai.org/releases/v1.10.3) (Dec 29, 2025): * **Iceberg Table Write Support (Preview)** – Write directly to Iceberg tables using standard SQL `INSERT INTO` commands, no Spark required. * **Acceleration Snapshots** – Faster startup with cached acceleration states from S3. * **Partitioned** [**S3 Vector Indexes**](../building-blocks/data-connectors/s3.md) – Improved scalability and query performance for large datasets. -* **AI SQL Function (Preview)** – Query LLMs directly in [SQL](../portal/playground/sql-query-editor.md) with `ai()` for summarization, classification, or translation. +* **AI SQL Function (Preview)** – Query LLMs directly in [SQL](../cloud/portal/playground/sql-query-editor.md) with `ai()` for summarization, classification, or translation. * **Remote CLI Execution** – Run `spice sql`, `spice search`, and `spice chat` against remote endpoints. * **Spice.js SDK v3.0.3** – Updated SDK for Node.js and browsers with simplified query APIs and better compatibility. * **Tabbed SQL Editor** – Multi-tab SQL editor in the playground with persistent tab state. @@ -371,7 +371,7 @@ Spice runtime [v1.10.3](https://spiceai.org/releases/v1.10.3) (Dec 29, 2025): * Improved reliability for Iceberg writes and acceleration snapshots. * Fixed partition pruning and empty partition handling in queries. * Improved [vector search](../use-cases/enterprise-search.md#vector-similarity-search-across-disparate-and-legacy-data-systems) stability and default limits (now up to 1,000 results). -* Improved AI [SQL query](../portal/playground/sql-query-editor.md) consistency and async handling. +* Improved AI [SQL query](../cloud/portal/playground/sql-query-editor.md) consistency and async handling. * General performance and startup time optimizations across data connectors and runtime. @@ -478,13 +478,13 @@ Spice runtime [v1.10.3](https://spiceai.org/releases/v1.10.3) (Dec 29, 2025): * **New Data Connectors**\ Access [Iceberg](https://spiceai.org/docs/components/data-connectors/iceberg) and [Glue](https://spiceai.org/docs/components/data-connectors/glue) data sources directly; step-by-step documentation provided. * **Databricks Integration**\ - OAuth for [Databricks](../integrations/databricks.md) is fully automatic; your tokens are handled behind the scenes for all catalog, SQL, and chat actions. + OAuth for [Databricks](../cloud/integrations/databricks.md) is fully automatic; your tokens are handled behind the scenes for all catalog, SQL, and chat actions. * **Organization Flexibility**\ Invite members with any email connected to a GitHub account; set specific app limits (e.g., 5 apps per org for Community, 20 for Enterprise). * **Observability**\ Supports up to 1,000 tasks in [Observability](../features/observability/). * **Data & Secrets**\ - [All secret](../portal/apps/secrets.md) names must be uppercaseβ€”system now enforces this for new and updated secrets. + [All secret](../cloud/portal/apps/secrets.md) names must be uppercaseβ€”system now enforces this for new and updated secrets.
@@ -533,7 +533,7 @@ Spice runtime [v1.10.3](https://spiceai.org/releases/v1.10.3) (Dec 29, 2025): * **AI Model Support**\ Added [Grok-3 series](https://spiceai.org/docs/components/models/xai) and [GPT-4.1](https://spiceai.org/docs/components/models/openai) support for all users. Models are selectable in the Spicepod and chat interface as soon as they become available. * **Activity Analytics**\ - [Integration with Google Analytics](/broken/pages/HfZAhJ1SCZnNoCGiEtOa) allows users to track app activity (sessions, completions, and installations) directly in the usage dashboard. UTM parameters for app installs are automatically recorded. + Integration with Google Analytics allows users to track app activity (sessions, completions, and installations) directly in the usage dashboard. UTM parameters for app installs are automatically recorded. * **User Interface Experience**\ Simplified error messages and cleaned up UI for benchmark reports, progress views, and data display. @@ -560,7 +560,7 @@ Spice runtime [v1.10.3](https://spiceai.org/releases/v1.10.3) (Dec 29, 2025): * **AI Chat Logs & History**\ Improved loading and navigation for chat logs; message skeletons, progress bars, and artifact previews added. Message history now supports up to 500 prior messages. * **Monitoring Enhancements**\ - [New app and model performance views](../portal/monitoring-and-request-logs.md) allow users to see live status and recent activity for the apps and models they own. + [New app and model performance views](../cloud/portal/monitoring-and-request-logs.md) allow users to see live status and recent activity for the apps and models they own.
@@ -579,7 +579,7 @@ Spice runtime [v1.10.3](https://spiceai.org/releases/v1.10.3) (Dec 29, 2025): ### Highlights * **AI Chat & Playground**\ - New session handling: users can revisit prior conversations and access a catalog explorer from [Playground](../portal/playground/ai-chat.md). Improvements to chat UI display make longer chat sessions and code completions easier to review. Markdown and progress rendering are now supported in chat. + New session handling: users can revisit prior conversations and access a catalog explorer from [Playground](../cloud/portal/playground/ai-chat.md). Improvements to chat UI display make longer chat sessions and code completions easier to review. Markdown and progress rendering are now supported in chat. * **Spicepod Editor**\ Choose from multiple AI models and tools directly in the editor sidebar. YAML safety checks alert users about indentation or formatting issues before saving. @@ -622,7 +622,7 @@ Spice runtime [v1.10.3](https://spiceai.org/releases/v1.10.3) (Dec 29, 2025): ### Highlights * **Spicepod.yaml Configuration**\ - [Spicepods](../portal/app-spicepod/spicepod-configuration.md) now display unique content identifiers (CIDs) for each version deployed, and retaining CID tracking improves history and rollback accuracy. The editor sidebar is more intuitive, supports flexible editing even if no repository is connected, and surfaces volume claim template types. + [Spicepods](../cloud/portal/app-spicepod/spicepod-configuration.md) now display unique content identifiers (CIDs) for each version deployed, and retaining CID tracking improves history and rollback accuracy. The editor sidebar is more intuitive, supports flexible editing even if no repository is connected, and surfaces volume claim template types. * **Status & History**\ Deployment status, history, and new monitoring tab allow users to see all current and prior deployments and their identifiers. * **User Interface Updates**\ @@ -669,7 +669,7 @@ Spice runtime [v1.10.3](https://spiceai.org/releases/v1.10.3) (Dec 29, 2025): ### Highlights * **Copilot & Spicepod Integration**\ - [The Copilot onboarding flow](../integrations/github-copilot.md) is now unified and leverages shared spicepod instances for organizational consistency. Deployment status and logs are directly viewable in the Copilot UI. + [The Copilot onboarding flow](../cloud/integrations/github-copilot.md) is now unified and leverages shared spicepod instances for organizational consistency. Deployment status and logs are directly viewable in the Copilot UI. * **Editor Enhancements**\ The code editor now highlights YAML formatting errors and enables editing even when a repository isn’t connected. Sample dataset previews and component mapping have been improved. Side panel includes quick access to all relevant settings. * **Model & Activity Tracking**\ @@ -791,7 +791,7 @@ The June release included a [C# SDK](../sdks/dotnet-sdk.md) for Spice AI and Spi {% update date="2024-05-31" %} ## May 2024 -The May release included [EigenLayer Delegation Manager datasets.](/broken/pages/szea7RdCSxE1KLlrSpca) The datasets can be explored in the portal Playground and queried via SQL. +The May release included EigenLayer Delegation Manager datasets. The datasets can be explored in the portal Playground and queried via SQL. **Changes** @@ -832,7 +832,7 @@ After the shutdown, JSON RPC and Beacon requests to **/goerli** returned 404 Not [Goerli SQL Tables](https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fspice.us5.list-manage.com%2Ftrack%2Fclick%3Fu%3De853435dd452a4d343ea1133d%26id%3D8eb3381cbc%26e%3D9d81a8fb5f\&data=05%7C02%7Cluke%40spice.ai%7C2ecaa574022c4aac7f8c08dc4833dd51%7C925431232b6a4eec9b6f595720cd1c8f%7C0%7C0%7C638464634819763981%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C\&sdata=I%2BdPMW%2FBgLUJXMio7efzCxu3l2R1ju9RLE%2FcvxK0w54%3D\&reserved=0) will remain available for historical query purposes. -The [Ethereum](/broken/pages/nLS2MJKcNRnMbanBVJUv) and [Beacon](/broken/pages/8JwabwGgl0JmUvtCO5Su) datasets now include fields from the Cancun and Dencun network upgrade. +The Ethereum and Beacon datasets now include fields from the Cancun and Dencun network upgrade. **Changes** @@ -856,14 +856,14 @@ The February release focused on stability and performance improvements. {% update date="2024-01-31" %} ## January 2024 -The January release added support for the Ethereum [Holesky](https://github.com/eth-clients/holesky) testnet in preview. Holesky data can be explored in the portal Playground, queried by [SQL](/broken/pages/KGqUTzMzBWIdFzG1BHDh) and Firecache, and made available to applications by JSON-RPC [API](/broken/pages/3f8HPEKNoLHoVlikewdd). +The January release added support for the Ethereum [Holesky](https://github.com/eth-clients/holesky) testnet in preview. Holesky data can be explored in the portal Playground, queried by SQL and Firecache, and made available to applications by JSON-RPC API.

Holesky Testnet APIs and datasets available in preview

**New in this release** -1. \[Platform] Added Ethereum [Holesky](/broken/pages/KGqUTzMzBWIdFzG1BHDh) testnet data and API's. -2. \[Platform] Achieved [SOC 2 Type II compliance](../security/security.md). +1. \[Platform] Added Ethereum Holesky testnet data and API's. +2. \[Platform] Achieved [SOC 2 Type II compliance](../enterprise/production/security.md). **Changes** @@ -886,7 +886,7 @@ The December release focused on stability and performance improvements. {% update date="2023-11-30" %} ## November 2023 -The November release focused on [External Data Sources](../portal/external-data-sources.md) and overall performance improvements following the [General Availability (GA)](https://blog.spice.ai/spice-ai-is-generally-available-d76c4289960c) release in October. +The November release focused on [External Data Sources](../cloud/portal/external-data-sources.md) and overall performance improvements following the [General Availability (GA)](https://blog.spice.ai/spice-ai-is-generally-available-d76c4289960c) release in October. You can now connect external data sources like PostgreSQL and MySQL to Spice.ai, which are then available to query with SQL including joining with any other Spice.ai dataset in the Spice.ai platform. @@ -898,10 +898,10 @@ Navigation is also easier with the addition of the Command Bar. Simply use **Cmd **New In this Release** -1. \[Portal] Added PostgreSQL and MySQL external data sources. See the [docs](../portal/external-data-sources.md) for details. -2. \[Portal] Added Dark Mode! Configure via [Profile Settings](../portal/profile/#dark-mode). +1. \[Portal] Added PostgreSQL and MySQL external data sources. See the [docs](../cloud/portal/external-data-sources.md) for details. +2. \[Portal] Added Dark Mode! Configure via [Profile Settings](../cloud/portal/profile/README.md#dark-mode). 3. \[Portal] Added Command Bar navigation. -4. \[Data] Added [`eth.wallet_lst_balances`](/broken/pages/H9cSfmiXpD7DEg8uDBkJ) including rETH, stETH, and cbETH LSTs. +4. \[Data] Added `eth.wallet_lst_balances` including rETH, stETH, and cbETH LSTs. 5. \[Firecache] Upgraded to DuckDB 0.92. 6. \[Platform] Performance, reliability, and security improvements. 7. \[Go SDK] Released v3.0.0, [learn more](https://github.com/spiceai/gospice/releases/tag/v3.0.0). @@ -913,17 +913,17 @@ Navigation is also easier with the addition of the Command Bar. Simply use **Cmd Spice.ai is now generally available! [Read the announcement](https://blog.spice.ai/spice-ai-is-generally-available-d76c4289960c). -General Availability launches a brand-new collaborative developer experience, v1 APIs and SDKs, over [100 open-source community](https://github.com/spiceai/datasets) and [EigenLayer](/broken/pages/szea7RdCSxE1KLlrSpca) datasets, and a removal of the waitlist. Any developer can now sign-up and use Spice.ai with one of the new [pricing plans](../pricing/plans.md), including the $99 developer plan and the complementary [Community Edition](/broken/pages/TswKQuxvMpeSWfvqFhxa). +General Availability launches a brand-new collaborative developer experience, v1 APIs and SDKs, over [100 open-source community](https://github.com/spiceai/datasets) and EigenLayer datasets, and a removal of the waitlist. Any developer can now sign-up and use Spice.ai with one of the new [pricing plans](../cloud/pricing/plans.md), including the $99 developer plan and the complementary [Community Edition](../cloud/pricing/community.md). **New In this Release** 1. \[HTTP API] Add v1 API: - 1. [SQL Query API ](../api/sql-query/http-api.md) - 2. [Prices API](/broken/pages/S6tHtEgbsxtkFBnX2RHy) - 3. [Gas Fees API](/broken/pages/FHKcRCIcE0WOJCsGUnlq) - 4. [Predictions API](/broken/pages/2C09l89bwNrM5jRF0xSx) + 1. [SQL Query API ](../cloud/api/sql-query/http-api.md) + 2. Prices API + 3. Gas Fees API + 4. Predictions API 2. \[Portal] New Portal and developer experience, without waitlist limitations. -3. \[Portal] New pricing plans are available, [learn more](https://docs.spice.ai/getting-started/pricing). +3. \[Portal] New pricing plans are available, [learn more](../cloud/getting-started/pricing.md). 4. \[Portal] Datasets and Views generally available, [learn more](release-notes.md#datasets-and-views). 5. \[Firecache] Upgraded to DuckDB 0.91. 6. \[Functions] Upgraded to DuckDB 0.91. @@ -942,16 +942,16 @@ General Availability launches a brand-new collaborative developer experience, v1 In the September release, Crypto/Token Prices data has been significantly expanded and improved upon. -Historical and latest prices are available via [REST API](/broken/pages/S6tHtEgbsxtkFBnX2RHy) and [SQL Query](/broken/pages/zXpdOConoLcf9VN61mY5). +Historical and latest prices are available via REST API and SQL Query. The number of token pairs supported by the REST API has greatly increased. In addition, if a pair does not have swap data, the platform will attempt to calculate a synthetic price for the pair, routed via swaps across different exchanges. For example, if a price for the pair BAO-AUD does not exist, but the pairs BAO-USDT and USDT-AUD do, then the API will calculate the routed price across the two swaps to determine a synthetic price, which will be returned in the payload as the `spiceai` price. The API will use data cross both centralized and decentralized exchanges. This enables pricing data where it was not possible before. Additional tables have been added for token prices and assets. -* [prices.assets](/broken/pages/TfcC8V5XWaq9Vy5yz8du) list all assets tracked and available via SQL Query. 8,856 assets are currently available. -* [prices.all\_pairs](/broken/pages/SHY0O3esX5xy1WapCz4s) list all the token pairs with prices available via SQL Query. 3,342 pairs are currently available. +* prices.assets list all assets tracked and available via SQL Query. 8,856 assets are currently available. +* prices.all\_pairs list all the token pairs with prices available via SQL Query. 3,342 pairs are currently available. -In addition to the existing [prices.\[tokenA-tokenB\]](/broken/pages/8bSm6urWvwm7YFuhgfN5) a table of prices for each token pair. +In addition to the existing prices.[tokenA-tokenB] a table of prices for each token pair. Note: In both cases, the list is a subset of what is available via the REST API. @@ -968,7 +968,7 @@ Note: In both cases, the list is a subset of what is available via the REST API. {% update date="2023-08-31" %} ## August 2023 -The August release expands the functionality of [Spice Functions](/broken/pages/aBmaUV0vHCWOQ4ioYk6o) (beta) and [Datasets and Views](../portal/datasets-and-views.md). +The August release expands the functionality of Spice Functions (beta) and [Datasets and Views](../cloud/portal/datasets-and-views.md). #### Spice Functions @@ -976,7 +976,7 @@ The August release expands the functionality of [Spice Functions](/broken/pages/ Spice Functions is in beta and initially available for Design Partners. Get in touch for more info. {% endhint %} -Developers can now author [Spice Functions](/broken/pages/aBmaUV0vHCWOQ4ioYk6o) in [Golang](/broken/pages/DbdqJ1WzZbndCfju4Yi0) with the Go1.x runtime in addition to [Python](/broken/pages/KjlSDA3olIHJPXR5Ycbh). +Developers can now author Spice Functions in Golang with the Go1.x runtime in addition to Python. Combine Spice Functions with expanded Datasets and Views support to generate custom datasets "ETL-less" in the Spice platform that can be kept private or shared with others. @@ -997,7 +997,7 @@ Spice now supports SQL migrations to enable creation of custom user-authored dat {% update date="2023-07-31" %} ## July 2023 -The July release enables new compute over data capability with [Spice Functions](/broken/pages/aBmaUV0vHCWOQ4ioYk6o) including application data storage, the ability to define and create custom datasets, and deep integration with GitHub. +The July release enables new compute over data capability with Spice Functions including application data storage, the ability to define and create custom datasets, and deep integration with GitHub. #### Spice Functions @@ -1005,9 +1005,9 @@ The July release enables new compute over data capability with [Spice Functions] Spice Functions is in beta and initially available for Design Partners. Get in touch for more info. {% endhint %} -[Spice Functions](/broken/pages/aBmaUV0vHCWOQ4ioYk6o) is a hosted compute experience that enables developers to write code in their preferred language and run it on the Spice platform, co-located with Spice data. +Spice Functions is a hosted compute experience that enables developers to write code in their preferred language and run it on the Spice platform, co-located with Spice data. -See [Broken link](/broken/pages/aBmaUV0vHCWOQ4ioYk6o "mention") for full documentation on creating and deploying Spice Functions. +Spice Functions has been discontinued. #### Spice Firecache @@ -1019,19 +1019,19 @@ Spice Firecache is in beta and initially available for Design Partners. Get in t The Spice platform completely manages the Spice Firecache data lifecycle, ensuring datasets are real-time updated on triggers like new blocks and with stale data being automatically evicted. -See [federated-sql-query.md](../features/federated-sql-query.md "mention") for full documentation on deploying datasets to the Spice Firecache. +See [federated-sql-query.md](/features/federated-sql-query "mention") for full documentation on deploying datasets to the Spice Firecache. #### Custom Datasets Spice now supports the definition and creation of your own private Datasets and Views, which can then be queried with SQL, cached in Spice Firecache, and published publicly to be shared with others. -See [datasets-and-views.md](../portal/datasets-and-views.md "mention") for full documentation on creating private Datasets and Views. +See [datasets-and-views.md](/docs/portal/datasets-and-views "mention") for full documentation on creating private Datasets and Views. #### Connecting Github Repos Connecting your Spice.xyz app to a GitHub repository allows you to create custom Datasets and Views, add datasets to Spice Firecache, author Spice Functions, and train AI Models. -See [connect-github.md](../portal/apps/connect-github.md "mention") for full documentation on connecting your Github Repo to a Spice App. +See [connect-github.md](/docs/portal/apps/connect-github "mention") for full documentation on connecting your Github Repo to a Spice App. **New In this Release** @@ -1040,7 +1040,7 @@ See [connect-github.md](../portal/apps/connect-github.md "mention") for full doc 3. \[Platform/Portal] Support for custom datasets and views beyond those curated by Spice 4. \[Portal] Connect your Github repo to manage all your Spice code with version control 5. \[Flow] RPCs can now be sent to the Spice Flow node using the [Flow Access API](https://developers.flow.com/concepts/nodes/access-api) -6. \[Flow] Added datasets detailing transfers of NFTs and tokens on the Flow blockchain, for more details see [Broken link](/broken/pages/G6NYPF18ou1tMQpmQ0PU "mention") +6. \[Flow] Added datasets detailing transfers of NFTs and tokens on the Flow blockchain, for more details see **Changes** @@ -1061,23 +1061,23 @@ The wallet balances datasets contains a block-level view of all Ether balance ch Wallet Balances datasets do not yet have full historical data. {% endhint %} -* [`eth.wallet_balances`](/broken/pages/2SrRafV0ZWlvWnPA4xZQ) -* [`goerli.wallet_balances`](/broken/pages/ZDflHe148WqmIB9aqwLo) +* `eth.wallet_balances` +* `goerli.wallet_balances` #### Flow Datasets -[Flow](/broken/pages/0app6ZAzlVznTC9fkIv2) is a fast, decentralized, and developer-friendly blockchain, designed as the foundation for a new generation of games, apps, and the digital assets that power them. Supercharge your Flow apps with these datasets indexed by Spice.xyz. +Flow is a fast, decentralized, and developer-friendly blockchain, designed as the foundation for a new generation of games, apps, and the digital assets that power them. Supercharge your Flow apps with these datasets indexed by Spice.xyz. {% hint style="info" %} Flow support is in preview. Contact us to let us know if Flow support is important to you! {% endhint %} -* [`flow.blocks`](/broken/pages/YVeXYU4WmaPd565Tntc0) -* [`flow.transactions`](/broken/pages/iMYEbh5MIFpZxtM0BJDZ) -* [`flow.events`](/broken/pages/ohZTimfj9N7FsJ34IjMr) -* [`flow.nfts`](/broken/pages/ppt5H1UNxAzUZVoRik9P) -* [`flow.nft_transfers`](/broken/pages/6LrEnUAavrsFKrZo7SlV) -* [`flow.token_transfers`](/broken/pages/k3FdCsd7c8YahZSNUzGv) +* `flow.blocks` +* `flow.transactions` +* `flow.events` +* `flow.nfts` +* `flow.nft_transfers` +* `flow.token_transfers` #### Portal @@ -1109,9 +1109,9 @@ Portal UX improvements include the ability to search the dataset reference for s The May release includes significant platform performance upgrades with the rollout of Spice AI's **second generation platform architecture (Gen. 2)** along with several usability and user-experience improvements. -[Ethereum](/broken/pages/nLS2MJKcNRnMbanBVJUv) and [Polygon](/broken/pages/iyngGYSqtXIiSELjLtA5) block latency (the time to process a block and make it available for query) is now **subsecond** for core data like blocks, transactions, and logs, and less than **2.5 seconds** for enriched data like [NFTs](/broken/pages/ZErqCI8yrvc9N9MLiR2b), [ENS](/broken/pages/BPicAdfXhg6ZdvP21FJ5), [Uniswap](/broken/pages/cuTP7dY2UDHfe4l0HlUq), and [Sushiswap](/broken/pages/GjiVdvTeA1UVRPs0hXsM). Query execution speed is now **1.5x-10x faster!** +Ethereum and Polygon block latency (the time to process a block and make it available for query) is now **subsecond** for core data like blocks, transactions, and logs, and less than **2.5 seconds** for enriched data like NFTs, ENS, Uniswap, and Sushiswap. Query execution speed is now **1.5x-10x faster!** -

Example Queries referenced in docs are now 1.5x-10x faster!

+

Example Queries referenced in docs are now 1.5x-10x faster!

Portal UX improvements include the ability to collapse the sidebar, resize the SQL query input and results pane, and expand to a fullscreen focus mode. SQL query errors are now highlighted with red underline swiggles along with a more readable error pane. Finally, results render faster and app switching is faster. @@ -1131,7 +1131,7 @@ Portal UX improvements include the ability to collapse the sidebar, resize the S **Changes** 1. \[Portal] The portal now uses a [GitHub App](https://docs.github.com/en/apps) to integrate with GitHub. This will result in a request for re-authorization on the next sign-in. -2. \[Go SDK] [gospice v0.2.1](https://github.com/spiceai/gospice) released with [Prices API](/broken/pages/pPqfNHXdBsKFsmclcUaV) and [Apache Arrow v12](https://pkg.go.dev/github.com/apache/arrow/go/v12) support. +2. \[Go SDK] [gospice v0.2.1](https://github.com/spiceai/gospice) released with Prices API and [Apache Arrow v12](https://pkg.go.dev/github.com/apache/arrow/go/v12) support. 3. \[Node.js SDK] [spice.js v0.3.2](https://github.com/spiceai/spice.js/releases) released with a fix to re-support Node 16. {% endupdate %} @@ -1152,7 +1152,7 @@ This includes accessing the latest, minute-precision data on `transaction_hash`, Data for for [Curve](https://classic.curve.fi/whitepaper), [Balancer](https://balancer.fi/), [Aave](https://aave.com/), [Yearn](https://yearn.finance/), [DAI](https://makerdao.com/en/), [Tether USD](https://tether.to/en/about-us/) and 30 other top assets is available. See the full list of supported data feeds [here](https://docs.spice.xyz/reference/sql-query-tables/sql-query-tables/chainlink-tables/prices-tables). \ -**Aave V2 Dataset:** In addition to the Aave token prices data feed on the Chainlink network, we have released indexed [Aave V2](/broken/pages/JmNf5vtOxn9GC7qHCisC) data for loans, collaterals and prices. You can query for the latest updates to Aave loans and collateral by querying `eth.aave_v2.loan_updates` and `eth.aave_v2.collateral_updates`. +**Aave V2 Dataset:** In addition to the Aave token prices data feed on the Chainlink network, we have released indexed Aave V2 data for loans, collaterals and prices. You can query for the latest updates to Aave loans and collateral by querying `eth.aave_v2.loan_updates` and `eth.aave_v2.collateral_updates`.

Latest view of all Aave V2 loans query, sample output

@@ -1176,7 +1176,7 @@ from eth_withdrawn

Get ETH withdrawn after the Ethereum Shanghai upgrade, sample output

-Explore detailed sample SQL queries for [DEX](/broken/pages/ILJgG6I3h4WEEH4nPbcA), [Cross-Chain](/broken/pages/6RadYv5EAfvtPqVQJAme), [Ethereum](/broken/pages/QQSPO1wNT4F9NsfQKzQd), [Beacon](/broken/pages/Qr9ifd9IY5E75sX5VPh9), and [Bitcoin](/broken/pages/YphzWK8SmAbgWoDBCGMW) in the Spice Docs.
+Explore detailed sample SQL queries for DEX, Cross-Chain, Ethereum, Beacon, and Bitcoin in the Spice Docs.
**Goerli Testnet:** Full support for the Goerli testnet has been added, including hosted beacon and execution nodes, and fully indexed datasets, helping developers test their applications before mainnet launch. @@ -1188,15 +1188,15 @@ For example, you can query from `goerli.beacon.validators` to retrieve recently **Goerli Beacon API:** You can easily retrieve requests like "[get validator balances from state](https://docs.spice.xyz/api/goerli/beacon-http-api)" using the **`https://data.spiceai.io/goerli/beacon`** API, which is compatible with the read-only GET requests from the [Beacon Node API specification](https://ethereum.github.io/beacon-APIs/). -All [Goerli testnet data APIs](/broken/pages/ZH7I0D6n3CAQkAjJPB2i) are available at **/goerli/v0.1** including the following: +All Goerli testnet data APIs are available at **/goerli/v0.1** including the following: -* [JSON RPC Methods](/broken/pages/LoF0K9hGwCUsufHFL99c) -* [Beacon HTTP API](/broken/pages/fw7PSsDUjk2312IkDcgQ) -* [Blocks](/broken/pages/XBjZvzOO9SsXcSnSbLjp) -* [Contracts](/broken/pages/0Dd11fCEPKWHVO8fG7YG) -* [Gas Fees](/broken/pages/cF1fACaign3olU4TtGai) +* JSON RPC Methods +* Beacon HTTP API +* Blocks +* Contracts +* Gas Fees -**Ethereum Beacon API:** The [Ethereum API](/broken/pages/mqB7Hs5dPwenu4OtY6QX) is now updated to support Beacon requests via the **`https://data.spiceai.io/eth/beacon`** API. This is compatible with the read-only GET requests from the [Beacon Node API specification](https://ethereum.github.io/beacon-APIs/). +**Ethereum Beacon API:** The Ethereum API is now updated to support Beacon requests via the **`https://data.spiceai.io/eth/beacon`** API. This is compatible with the read-only GET requests from the [Beacon Node API specification](https://ethereum.github.io/beacon-APIs/). See the full list of Beacon API requests [here](https://docs.spice.xyz/api/ethereum/beacon-http-api). @@ -1233,7 +1233,7 @@ See the full list of Beacon API requests [here](https://docs.spice.xyz/api/ether * \[Aave V2] added `eth.aave_v2.loan_updates`, `eth.aave_v2.loans` * \[Aave V2] added `eth.aave_v2.collateral_updates`, `eth.aave_v2.collateral` * \[Chainlink] added `eth.chainlink.prices`, `eth.chainlink.recent_prices` -* \[Chainlink] added [price feed support](/broken/pages/wHEvZjBoobfKzFCNaX0E) for the following assets: +* \[Chainlink] added price feed support for the following assets: * USD Coin (USDC) * 1INCH Token (1INCH) * Yearn.finance (YFI) @@ -1438,7 +1438,7 @@ Read the announcement post at [blog.spice.ai](https://blog.spice.ai/spice-xyz-ja {% update date="2022-12-31" %} ## December 2022 -Spice supports querying [Polygon data](/broken/pages/iyngGYSqtXIiSELjLtA5) in addition to the existing [Ethereum](/broken/pages/nLS2MJKcNRnMbanBVJUv) and [BItcoin](/broken/pages/TGHKku5PSEIlCSApa727) datasets. +Spice supports querying Polygon data in addition to the existing Ethereum and BItcoin datasets. Read more on the [Spice AI Blog](https://blog.spice.ai/build-multi-chain-with-spice-ai-now-with-polygon-support-9db156f36d80). @@ -1465,12 +1465,12 @@ Read more on the [Spice AI Blog](https://blog.spice.ai/build-multi-chain-with-sp **DEX Liquidity & Events Dataset** -Spice now features DEX Liquidity and Events Dataset where users can access indexed liquidity data from UniSwap \[[V2](/broken/pages/uaSlGYUUtkb2FJZh6p9d), [V3](/broken/pages/mIc6VZGqHQoS7EhH1W3b)] and [SushiSwap](/broken/pages/DeA1ZPzU5c1VZzyQouRF) liquidity pools, _within seconds_. +Spice now features DEX Liquidity and Events Dataset where users can access indexed liquidity data from UniSwap \[V2, V3] and SushiSwap liquidity pools, _within seconds_. Data is available both historically and in real time, providing unparalleled visibility on DEX liquidity pools. **ENS (Preview)**\ -You can now preview the new dataset for [Ethereum Name Service events](/broken/pages/BPicAdfXhg6ZdvP21FJ5), available by querying `eth.ens`. Within the dataset, you’ll find that each ENS event will have its own table as immutable data. +You can now preview the new dataset for Ethereum Name Service events, available by querying `eth.ens`. Within the dataset, you’ll find that each ENS event will have its own table as immutable data. This also includes the new `ens.domains` dataset, which is updated in real-time to have the latest `eth_address` whenever a transfer or name-registered event happens @@ -1478,8 +1478,8 @@ Read more on the [Spice AI blog](https://blog.spice.ai/whats-new-b7f637897df8). **Changes** -* [Prices dataset](/broken/pages/zXpdOConoLcf9VN61mY5) now out of preview -* Added export to CSV results format in addition to existing formats [JSON](/broken/pages/w4hRmvPIKXDjLDknyEl6) and [Apache Arrow](../api/sql-query/apache-arrow-flight-api.md), for easy use with apps, ML, or libraries like NumPy and Pandas +* Prices dataset now out of preview +* Added export to CSV results format in addition to existing formats JSON and [Apache Arrow](../cloud/api/sql-query/apache-arrow-flight-api.md), for easy use with apps, ML, or libraries like NumPy and Pandas * Added performance improvements for faster queries across existing datasets including `eth.traces` #### Resources @@ -1493,7 +1493,7 @@ Read more on the [Spice AI blog](https://blog.spice.ai/whats-new-b7f637897df8). {% update date="2022-10-31" %} ## October 2022 -Spice now has [prices dataset](/broken/pages/zXpdOConoLcf9VN61mY5) in preview. +Spice now has prices dataset in preview. * Query historical High-Low-Open-Close (HILO) prices to minute precision * Join with other real-time and historical web3 data to do calculations and conversions back to USD @@ -1520,7 +1520,7 @@ Spice launches the `eth.traces` dataset for both Ethereum and Polygon. The Ether **Polygon Support (Preview)** -Spice launches and tests [Polygon support](/broken/pages/iyngGYSqtXIiSELjLtA5). +Spice launches and tests Polygon support. **Changes** @@ -1559,7 +1559,7 @@ Key infrastructure improvements were made for Spice's query performance, securit {% update date="2022-07-31" %} ## July 2022 -Spice supports querying [Bitcoin data](/broken/pages/TGHKku5PSEIlCSApa727) in addition to the existing [Ethereum datasets](/broken/pages/nLS2MJKcNRnMbanBVJUv). +Spice supports querying Bitcoin data in addition to the existing Ethereum datasets. Read more on the [Spice AI blog](https://medium.com/spice-ai/). @@ -1570,7 +1570,7 @@ Read more on the [Spice AI blog](https://medium.com/spice-ai/). * `btc.transactions` / `btc.recent_transactions` * `btc.transaction_inputs` / `btc.recent_transaction_inputs` * `btc.transaction_outputs` / `btc.recent_transaction_outputs` -* [Broken link](/broken/pages/YphzWK8SmAbgWoDBCGMW "mention") for querying Bitcoin data. +* for querying Bitcoin data. #### Resources @@ -1585,7 +1585,7 @@ Read more on the [Spice AI blog](https://medium.com/spice-ai/). This update includes a new [Javascript/Typescript SDK](../sdks/node.js-sdk/) for Node.js, an improved [Python SDK](../sdks/python-sdk/), and performance improvements for Ethereum tokens and NFT datasets. -[Ethereum Name Service (ENS)](/broken/pages/BPicAdfXhg6ZdvP21FJ5) support is also available in beta with the new `ens.domains` dataset. +Ethereum Name Service (ENS) support is also available in beta with the new `ens.domains` dataset. Read more on the [Spice AI blog](https://medium.com/spice-ai/spice-xyz-june-update-f74d60faff61). @@ -1608,9 +1608,9 @@ Read more on the [Spice AI blog](https://medium.com/spice-ai/spice-xyz-june-upda {% update date="2022-05-31" %} ## May 2022 -Spice now has some of the best automated token standard detection for erc20, erc721, and erc1155 tokens available. Tokens are detected by their signatures and as they emit events over time, so Spice provides a probability of standards compliance to each contract. Along with this support are now token-specific tables like `eth.tokens_erc1155` and `eth.token_transfers_erc20`. See the entire list [Tokens Tables](/broken/pages/WJRmqmAyo4hX6F5tRL2d). +Spice now has some of the best automated token standard detection for erc20, erc721, and erc1155 tokens available. Tokens are detected by their signatures and as they emit events over time, so Spice provides a probability of standards compliance to each contract. Along with this support are now token-specific tables like `eth.tokens_erc1155` and `eth.token_transfers_erc20`. See the entire list Tokens Tables. -Performance is now even better, especially for larger queries, and for results over the HTTP API. We still recommend the [Apache Arrow Flight API](../api/sql-query/apache-arrow-flight-api.md) that's easily accessible via the [Python SDK](../sdks/python-sdk/) for production use though. +Performance is now even better, especially for larger queries, and for results over the HTTP API. We still recommend the [Apache Arrow Flight API](../cloud/api/sql-query/apache-arrow-flight-api.md) that's easily accessible via the [Python SDK](../sdks/python-sdk/) for production use though. WebSocket support is now available in private preview to Design Partners - get in touch if you are interested in custom limits, early access features, and dedicated support. diff --git a/cloud/README.md b/cloud/README.md index 2296a4c7..44836dad 100644 --- a/cloud/README.md +++ b/cloud/README.md @@ -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 %} -
:rocket:Get StartedSign up and run your first query in minutesget-started
:zap:Federated SQL QueryQuery across any data source with one SQL interfaceBroken link
:robot:AI GatewayOpenAI-compatible API for LLM inferenceBroken link
:mag:Search & RetrievalVector and hybrid search for RAG workflowsBroken link
:plug:Data ConnectorsConnect to 30+ databases, warehouses, and lakesBroken link
:bar_chart:MonitoringObserve performance with Grafana, Datadog, and moremonitoring
+
πŸš€Get StartedSign up and run your first query in minutesget-started
⚑Federated SQL QueryQuery across any data source with one SQL interfacefederated-sql-query
πŸ€–AI GatewayOpenAI-compatible API for LLM inferenceai-gateway
πŸ”Search & RetrievalVector and hybrid search for RAG workflowssearch-and-retrieval
πŸ”ŒData ConnectorsConnect to 30+ databases, warehouses, and lakesdata-connectors
πŸ“ŠMonitoringObserve performance with Grafana, Datadog, and moremonitoring
## What You Can Do @@ -42,13 +42,13 @@ With the **Spice.ai Cloud Platform** you can: ## Use Cases -| Use Case | Description | -| ------------------------------------------------------- | ---------------------------------------------------------- | -| [Agentic AI Apps](/broken/pages/Htbt6mfTcYSy0azWnmpj) | Build AI agent backends with unified data and model access | -| [Database CDN](/broken/pages/US5IOWJ5hGfesfTfdBDI) | Cache and accelerate hot data for low-latency applications | -| [Data Lakehouse](/broken/pages/vH4nBFHrLZZwb5ztSydo) | Federated queries across warehouses, lakes, and databases | -| [Enterprise Search](/broken/pages/QRldH6OhgWuSs1LYU3b0) | Semantic search across enterprise data sources | -| [Enterprise RAG](/broken/pages/RBFXqV0lWDKWsBjt8yT5) | Retrieval-augmented generation with your own data | +| Use Case | Description | +| --------------------------------------------------------------------- | ---------------------------------------------------------- | +| [Agentic AI Apps](../use-cases/agentic-ai-apps.md) | Build AI agent backends with unified data and model access | +| [Database CDN](../use-cases/database-cdn.md) | Cache and accelerate hot data for low-latency applications | +| [Data Lakehouse](../use-cases/data-lakehouse.md) | Federated queries across warehouses, lakes, and databases | +| [Enterprise Search](../use-cases/enterprise-search.md) | Semantic search across enterprise data sources | +| [Enterprise RAG](../use-cases/enterprise-rag.md) | Retrieval-augmented generation with your own data | {% columns %} {% column %} @@ -61,7 +61,7 @@ Get up and running in minutes: 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) -Get started API reference +Get started API reference {% endcolumn %} {% column %} @@ -85,4 +85,4 @@ 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. -* **Help Center** β€” Browse the [Help Center](help/) for troubleshooting, guides, and FAQs. +* **Help Center** β€” Browse the [Help Center](../help/) for troubleshooting, guides, and FAQs. diff --git a/cloud/api/README.md b/cloud/api/README.md index d0c0f5aa..378889b5 100644 --- a/cloud/api/README.md +++ b/cloud/api/README.md @@ -28,14 +28,14 @@ The Management API is served at `https://api.spice.ai` and authenticated with [P | Endpoint | Documentation | | ---------------- | ---------------------------------------------------------- | -| Apps | [Apps API](/broken/pages/Cxualhhbj3JVjFycQplA) | -| Deployments | [Deployments API](/broken/pages/cW4Y9zvF1YF9X2ExU15D) | -| Secrets | [Secrets API](/broken/pages/jux7LfeRfZnBFKMpjIXA) | -| API Keys | [API Keys API](/broken/pages/C2SEPG58kdQqhs4SL9B7) | -| Members | [Members API](/broken/pages/fDcgKtae3y2pEzLWtbVg) | -| Regions | [Regions API](/broken/pages/6ZPPX3ncuyaq7usBYCzO) | -| Container Images | [Container Images API](/broken/pages/5fsccwHHHi12wJt5s0Ca) | -| Health | [Health API](/broken/pages/MMiAVKRYaydEPCc1zdZU) | +| Apps | [Apps API](./management/) | +| Deployments | [Deployments API](./management/) | +| Secrets | [Secrets API](./management/) | +| API Keys | [API Keys API](./management/) | +| Members | [Members API](./management/) | +| Regions | [Regions API](./management/) | +| Container Images | [Container Images API](../portal/app-spicepod/spice-runtime-versions.md) | +| Health | [Health API](./management/) | See the full [Management API reference](management/) for authentication, scopes, rate limits, and examples. diff --git a/cloud/api/management/README.md b/cloud/api/management/README.md index 46735c33..ab880a6f 100644 --- a/cloud/api/management/README.md +++ b/cloud/api/management/README.md @@ -47,7 +47,7 @@ curl -H "Authorization: Bearer " \ https://api.spice.ai/v1/apps ``` -Learn more: [Personal Access Tokens](../../../portal/profile/personal-access-tokens.md) +Learn more: [Personal Access Tokens](../../portal/profile/personal-access-tokens.md) ### 2. OAuth 2.0 Client Credentials @@ -196,21 +196,21 @@ https://api.spice.ai/v1/docs/openapi.json Official SDKs are available for popular languages: * [Python SDK](../../../sdks/python-sdk/) -* [Node.js SDK](../../../sdks/node.js-sdk) +* [Node.js SDK](../../../sdks/node.js-sdk/) * [Go SDK](../../../sdks/go.md) * [Rust SDK](../../../sdks/rust-sdk/) ## Endpoints -* [Health](/broken/pages/MMiAVKRYaydEPCc1zdZU) - API health check -* [Regions](/broken/pages/6ZPPX3ncuyaq7usBYCzO) - List available deployment regions -* [Apps](/broken/pages/Cxualhhbj3JVjFycQplA) - Manage Spice apps -* [Deployments](/broken/pages/cW4Y9zvF1YF9X2ExU15D) - Deploy and manage app deployments -* [Secrets](/broken/pages/jux7LfeRfZnBFKMpjIXA) - Manage app secrets -* [API Keys](/broken/pages/C2SEPG58kdQqhs4SL9B7) - Manage app API keys -* [Members](/broken/pages/fDcgKtae3y2pEzLWtbVg) - Manage organization members +* [Health](./) - API health check +* [Regions](./) - List available deployment regions +* [Apps](./) - Manage Spice apps +* [Deployments](./) - Deploy and manage app deployments +* [Secrets](./) - Manage app secrets +* [API Keys](./) - Manage app API keys +* [Members](./) - Manage organization members * [Metrics](../metrics.md) - Scrape per-app runtime metrics -* [Container Images](/broken/pages/5fsccwHHHi12wJt5s0Ca) - List available runtime versions +* [Container Images](../../portal/app-spicepod/spice-runtime-versions.md) - List available runtime versions ## Terraform Provider @@ -272,4 +272,4 @@ Have questions or running into issues? * [GitHub Issues](https://github.com/spicehq/spiceai/issues) * [Community Discord](https://discord.gg/spiceai) -* [Support](../../../support/support.md) +* [Support](../../../help/support.md) diff --git a/cloud/api/metrics.md b/cloud/api/metrics.md index 08ea7a84..eb919ff4 100644 --- a/cloud/api/metrics.md +++ b/cloud/api/metrics.md @@ -62,8 +62,8 @@ curl https://us-west-2-prod-aws-data.spiceai.io/v1/metrics \ The metrics output is compatible with standard monitoring systems. Pre-built dashboards and setup guides are available: -* [Grafana & Prometheus](../../monitoring/grafana.md) - Scrape metrics with Prometheus, visualize in Grafana -* [Datadog](../../monitoring/datadog.md) - Scrape metrics with the Datadog Agent's OpenMetrics integration +* [Grafana & Prometheus](../monitoring/grafana.md) - Scrape metrics with Prometheus, visualize in Grafana +* [Datadog](../monitoring/datadog.md) - Scrape metrics with the Datadog Agent's OpenMetrics integration * **OpenTelemetry** - Use the OTEL Prometheus receiver {% hint style="warning" %} @@ -242,7 +242,7 @@ In addition to these core metrics, individual components can expose their own me See also: -* [Monitoring](../../monitoring/) - Set up dashboards with Grafana, Prometheus, or Datadog -* [Apps API](/broken/pages/Cxualhhbj3JVjFycQplA) - Manage your apps -* [API Keys](/broken/pages/C2SEPG58kdQqhs4SL9B7) - Manage app API keys +* [Monitoring](../monitoring/) - Set up dashboards with Grafana, Prometheus, or Datadog +* [Apps API](./management/) - Manage your apps +* [API Keys](./management/) - Manage app API keys * [Observability](../../features/observability/) - Observability features in the portal diff --git a/cloud/api/openai-api.md b/cloud/api/openai-api.md index b2550f32..f8bc5a09 100644 --- a/cloud/api/openai-api.md +++ b/cloud/api/openai-api.md @@ -6,7 +6,7 @@ icon: brain-circuit ## Chat Completions -Spice provides an OpenAI compatible chat completion AI at [https://data.spiceai.io/v1/chat/completions](https://data.spiceai.io/v1/chat/completions). Authorize with the endpoint using an [App API key](../../portal/apps/api-keys.md). +Spice provides an OpenAI compatible chat completion AI at [https://data.spiceai.io/v1/chat/completions](https://data.spiceai.io/v1/chat/completions). Authorize with the endpoint using an [App API key](../portal/apps/api-keys.md). The App requires a configured and deployed model to respond to chat completion requests. diff --git a/cloud/api/sql-query/apache-arrow-flight-api.md b/cloud/api/sql-query/apache-arrow-flight-api.md index bf345dcc..f3b2742f 100644 --- a/cloud/api/sql-query/apache-arrow-flight-api.md +++ b/cloud/api/sql-query/apache-arrow-flight-api.md @@ -29,7 +29,7 @@ You may also use Apache's `pyarrow` library directly. ### Samples -Find code samples in Python in [Arrow Flight Samples](/broken/pages/5qm4BZtfFlkx9Sp2qtGi). +Find code samples in Python in [Arrow Flight Samples](https://github.com/spicehq/samples). ### Troubleshooting diff --git a/cloud/api/sql-query/http-api.md b/cloud/api/sql-query/http-api.md index 7b646796..72ab621c 100644 --- a/cloud/api/sql-query/http-api.md +++ b/cloud/api/sql-query/http-api.md @@ -4,14 +4,14 @@ description: Query with SQL via the HTTP API # HTTP API -Data may be queried by posting SQL to the `/v1/sql` API and `/v1/firesql` API for Firecached data. For documentation on the Spice Firecache see [Broken link](/broken/pages/q4t8COjPZrT3eUwQXMBw "mention"). +Data may be queried by posting SQL to the `/v1/sql` API and `/v1/firesql` API for Firecached data. For documentation on federated / accelerated SQL query, see [Federated SQL Query](../../../features/federated-sql-query.md). -See [Tables](/broken/pages/raer32Dk4PPuKbzd1GLs) for a list of tables to query or browse the example queries listed in the menu. +See [Tables](../../portal/playground/sql-query-editor.md) for a list of tables to query or browse the example queries listed in the menu. #### Requirements and limitations * An API key is required for all SQL queries. -* Results are limited to 500 rows. Use the [Apache Arrow Flight API](apache-arrow-flight-api.md) to fetch up to 1M rows in a single query or the [Async HTTP API](/broken/pages/INalDm4gLljuBB16j2bY) to fetch results with paging. +* Results are limited to 500 rows. Use the [Apache Arrow Flight API](apache-arrow-flight-api.md) to fetch up to 1M rows in a single query or for paged / streaming results. * Requests are limited to 90 seconds. {% openapi-operation spec="spiceai-platform-api" path="/v1/sql" method="post" %} diff --git a/cloud/getting-started/get-started/next-steps.md b/cloud/getting-started/get-started/next-steps.md index 14cdcfdc..ac7316f8 100644 --- a/cloud/getting-started/get-started/next-steps.md +++ b/cloud/getting-started/get-started/next-steps.md @@ -2,5 +2,4 @@ Learn more about building AI applications and agents with the Spice.ai Cloud Platform. -
PlaygroundStart experimenting in the Playgroundhttps://spice.ai/login
FeaturesExplore the features of the platformapps
Use-CasesExplore use-cases for Spice.ai.Broken link
- +
PlaygroundStart experimenting in the Playgroundhttps://spice.ai/login
FeaturesExplore the features of the platformhome
Use-CasesExplore use-cases for Spice.ai.use-cases
diff --git a/cloud/monitoring/zipkin.md b/cloud/monitoring/zipkin.md index a588b934..299f0ef5 100644 --- a/cloud/monitoring/zipkin.md +++ b/cloud/monitoring/zipkin.md @@ -50,7 +50,7 @@ trace_id | task | execution_duration_ms 3c75d16b6b4b8da98c551d115e1c049c | sql_query | 0.1 | SQL error: ParserError("Expected:...") ``` -For more details, see [Task History](/broken/pages/s1kRO5emo7UGC2ZHAoXB). +For more details, see [Task History](../../features/observability/task-history.md). See also: diff --git a/cloud/portal/app-spicepod/README.md b/cloud/portal/app-spicepod/README.md index c0f860f8..887a36db 100644 --- a/cloud/portal/app-spicepod/README.md +++ b/cloud/portal/app-spicepod/README.md @@ -42,7 +42,7 @@ models: #### Datasets[​](https://docs.spiceai.org/getting-started/spicepods#datasets) -Datasets in a Spicepod can be sourced from various locations, including local files or remote databases. They can be materialized and accelerated using different engines such as DuckDB, SQLite, or PostgreSQL to optimize performance ([learn more](/broken/pages/8xwMOU9VIyOFhSqsYlsi)). +Datasets in a Spicepod can be sourced from various locations, including local files or remote databases. They can be materialized and accelerated using different engines such as DuckDB, SQLite, or PostgreSQL to optimize performance ([learn more](../../../features/data-acceleration/)). #### Catalogs[​](https://docs.spiceai.org/getting-started/spicepods#catalogs) diff --git a/cloud/portal/apps/delete.md b/cloud/portal/apps/delete.md index 419c558e..0eb91caf 100644 --- a/cloud/portal/apps/delete.md +++ b/cloud/portal/apps/delete.md @@ -25,4 +25,4 @@ Only app owners and organization admins can delete apps. ## Delete via API -Apps can also be deleted programmatically. See the [Apps Management API](../../api/management/apps.md#delete-app) for details. +Apps can also be deleted programmatically. See the [Apps Management API](../../api/management/README.md#delete-app) for details. diff --git a/cloud/portal/apps/transfer.md b/cloud/portal/apps/transfer.md index 8292334a..396609ba 100644 --- a/cloud/portal/apps/transfer.md +++ b/cloud/portal/apps/transfer.md @@ -4,7 +4,7 @@ icon: arrow-right-from-arc # Transfer -You can transfer an App's ownership to another [**organization**](/broken/pages/05CWejAJRFHeBbS9KyeQ)**.** +You can transfer an App's ownership to another [**organization**](../organizations.md)**.** {% hint style="info" %} App transfer is currently limited to organizations you have access to. diff --git a/cloud/portal/datasets-and-views.md b/cloud/portal/datasets-and-views.md index 25ae3e7d..f0ae32cf 100644 --- a/cloud/portal/datasets-and-views.md +++ b/cloud/portal/datasets-and-views.md @@ -6,13 +6,13 @@ icon: table # Datasets -The Spice.ai platform comes pre-loaded with a variety of community [datasets](/broken/pages/JnKPswDs1OXhUD2OxR0K). +The Spice.ai platform comes pre-loaded with a variety of community [datasets](https://github.com/spiceai/datasets). In addition, you can define and create your own custom and private Datasets and Views, which can then be queried with SQL, cached in Spice Firecache, and published publicly to be shared with others. ### Defining a Dataset -To define a dataset, first ensure your Spice app is connected to a [GitHub repository](apps/connect-github.md), then add a [dataset manifest](/broken/pages/456bbSbfRgMbQ9vqIRzq) file to the GitHub repository in the `.spice/datasets` path. +To define a dataset, first ensure your Spice app is connected to a [GitHub repository](apps/connect-github.md), then add a [dataset manifest](./datasets-and-views.md) file to the GitHub repository in the `.spice/datasets` path. For example: diff --git a/cloud/reference/sql-reference.md b/cloud/reference/sql-reference.md index 52d2cb7d..f4cfc37f 100644 --- a/cloud/reference/sql-reference.md +++ b/cloud/reference/sql-reference.md @@ -18,4 +18,4 @@ SELECT * FROM "MyTable"; SELECT * FROM "MyTable"."MixedCaseColumn"; ``` -This behavior also applies to [dataset names](/broken/pages/TqUYlnf0jpMU6k3dv9vL#identifier-case-sensitivity-and-quoting) configured in the `from` and `name` fields of the spicepod. +This behavior also applies to [dataset names](../../building-blocks/data-connectors/README.md#identifier-case-sensitivity-and-quoting) configured in the `from` and `name` fields of the spicepod. diff --git a/enterprise/features/distributed-query.md b/enterprise/features/distributed-query.md index 2bfae75a..025990dd 100644 --- a/enterprise/features/distributed-query.md +++ b/enterprise/features/distributed-query.md @@ -221,7 +221,7 @@ Because each fact row lives in exactly one partition and joins independently, th ### Iceberg catalog scans -Scans of [Iceberg catalog](../../building-blocks/catalogs/iceberg.md) tables are distributed across executors. An Iceberg scan holds a live table handle that cannot be serialized, so the scheduler ships a *recipe* instead β€” the table reference plus the scan's projection, filters, and limit. Each executor resolves the same table and replays the scan locally, which means catalog credentials are never sent over the wire. +Scans of [Iceberg catalog](../../building-blocks/data-connectors/delta-lake.md) tables are distributed across executors. An Iceberg scan holds a live table handle that cannot be serialized, so the scheduler ships a *recipe* instead β€” the table reference plus the scan's projection, filters, and limit. Each executor resolves the same table and replays the scan locally, which means catalog credentials are never sent over the wire. Single-node sessions are unaffected β€” the scan is planned exactly as it would be without a cluster. diff --git a/faq.md b/faq.md index 1f51b4ac..6d7416a3 100644 --- a/faq.md +++ b/faq.md @@ -11,7 +11,7 @@ icon: circle-question - **Spice.ai Cloud** β€” a managed, multi-tenant hosted service running Spice as a platform with additional building blocks (cloud data warehouse, model training/inference, AI gateway). - **Spice.ai Enterprise** β€” a self-hosted enterprise distribution of Spice with advanced features (HA, RBAC, SSO, governance, premium connectors), enterprise support, and an SLA. -See [Distributions](https://docs.spice.ai/docs/enterprise/getting-started/distributions) for a detailed comparison. +See [Distributions](enterprise/getting-started/distributions.md) for a detailed comparison. ### What's the difference between the Spice.ai Cloud Platform and Spice.ai OSS? @@ -25,19 +25,19 @@ See [Distributions](https://docs.spice.ai/docs/enterprise/getting-started/distri ### How much does Spice.ai Cloud cost? -It's free to [get an API key](https://spice.ai) to use the [Community Edition](/broken/pages/TswKQuxvMpeSWfvqFhxa). +It's free to [get an API key](https://spice.ai) to use the [Community Edition](cloud/pricing/community.md). -Customers who need resource limits, service-level guarantees, or priority support we offer [high-value paid tiers](../pricing/plans.md) based on usage. +Customers who need resource limits, service-level guarantees, or priority support we offer [high-value paid tiers](cloud/pricing/plans.md) based on usage. ### What level of support do you offer? -We offer enterprise-grade support with an SLA [for Enterprise Plans](../pricing/plans.md). +We offer enterprise-grade support with an SLA [for Enterprise Plans](cloud/pricing/plans.md). -For standard plans we offer [best-effort community support](https://github.com/spicehq/cloud-docs/blob/trunk/broken-reference/README.md) in Discord. +For standard plans we offer [best-effort community support](https://spice.ai/slack) in Discord. ### What's your approach to security and compliance? -See [Security](../security/security.md). The Spice.ai Cloud Platform is SOC 2 Type II compliant. +See [Security](enterprise/production/security.md). The Spice.ai Cloud Platform is SOC 2 Type II compliant. ### What SQL query engine/dialect do you support? @@ -45,15 +45,15 @@ Spice.ai OSS is built on [Apache DataFusion](https://datafusion.apache.org/) as ### What AI capabilities does Spice provide? -Spice provides unified APIs for data and AI workflows, including model inference, embeddings, and an [AI gateway](../features/ai-gateway.md) supporting OpenAI, Anthropic, Amazon Bedrock, and xAI. Spice also includes advanced tools such as [vector and hybrid search](../features/search-and-retrieval.md), text-to-SQL, and data sampling. +Spice provides unified APIs for data and AI workflows, including model inference, embeddings, and an [AI gateway](features/ai-gateway.md) supporting OpenAI, Anthropic, Amazon Bedrock, and xAI. Spice also includes advanced tools such as [vector and hybrid search](features/search-and-retrieval.md), text-to-SQL, and data sampling. ### What AI model providers does Spice support? -Spice supports local model serving (e.g. Llama) and gateways to hosted AI platforms including OpenAI, Anthropic, xAI, and Amazon Bedrock. See [Model Providers](../building-blocks/model-providers/) for details. +Spice supports local model serving (e.g. Llama) and gateways to hosted AI platforms including OpenAI, Anthropic, xAI, and Amazon Bedrock. See [Model Providers](building-blocks/model-providers/) for details. ### Can Spice handle federated queries? -Yes. Spice natively supports [federated SQL queries](../features/federated-sql-query.md) across disparate data sources with advanced query push-down capabilities, executing portions of queries directly on source databases to reduce data transfer and improve performance. +Yes. Spice natively supports [federated SQL queries](features/federated-sql-query.md) across disparate data sources with advanced query push-down capabilities, executing portions of queries directly on source databases to reduce data transfer and improve performance. ### Can Spice integrate with existing BI tools? @@ -64,13 +64,13 @@ Yes. Spice integrates with BI tools through standard SQL interfaces (ODBC, JDBC, Yes. Spice supports streaming ingestion from several sources: - **Native PostgreSQL logical replication** (recommended for PostgreSQL sources). Spice connects directly to the source using Postgres' `wal_level=logical` and streams `INSERT`/`UPDATE`/`DELETE` events into the accelerator. See [PostgreSQL Logical Replication](https://spiceai.org/docs/features/cdc/postgres-replication) in the OSS documentation. -- **[DynamoDB Streams](../building-blocks/data-connectors/dynamodb.md)** for Amazon DynamoDB sources β€” Spice consumes the table's change stream and applies `INSERT`/`UPDATE`/`DELETE` events to the accelerator with `refresh_mode: changes`. -- **[Apache Kafka](../building-blocks/data-connectors/kafka.md)** for event-streaming topics β€” Spice consumes records directly with `refresh_mode: append` for real-time, append-only acceleration. -- **[Debezium](../building-blocks/data-connectors/debezium.md)** (over Kafka) for sources where Debezium is already deployed, or for databases without a native Spice CDC path (MySQL, SQL Server, etc.). +- **[DynamoDB Streams](building-blocks/data-connectors/dynamodb.md)** for Amazon DynamoDB sources β€” Spice consumes the table's change stream and applies `INSERT`/`UPDATE`/`DELETE` events to the accelerator with `refresh_mode: changes`. +- **[Apache Kafka](building-blocks/data-connectors/debezium.md)** for event-streaming topics β€” Spice consumes records directly with `refresh_mode: append` for real-time, append-only acceleration. +- **[Debezium](building-blocks/data-connectors/debezium.md)** (over Kafka) for sources where Debezium is already deployed, or for databases without a native Spice CDC path (MySQL, SQL Server, etc.). ### How do I keep an accelerated dataset incrementally up-to-date? -For sources with a monotonically-increasing version column (e.g. `updated_at`), Spice incrementally ingests new and modified records using `time_column` + `refresh_mode: append`, with `refresh_append_overlap` to tolerate clock skew and `retention_period` to evict old or soft-deleted records. See [Incremental Ingestion](../features/data-acceleration/README.md#incremental-ingestion) for configuration details and examples. +For sources with a monotonically-increasing version column (e.g. `updated_at`), Spice incrementally ingests new and modified records using `time_column` + `refresh_mode: append`, with `refresh_append_overlap` to tolerate clock skew and `retention_period` to evict old or soft-deleted records. See [Incremental Ingestion](features/data-acceleration/README.md#incremental-ingestion) for configuration details and examples. ### Does Spice support schema evolution? diff --git a/features/federated-sql-query.md b/features/federated-sql-query.md index 1b6b13ca..22acb3ab 100644 --- a/features/federated-sql-query.md +++ b/features/federated-sql-query.md @@ -17,16 +17,16 @@ The Playground SQL Explorer is the fastest way to get started with federated que

The Playground SQL Query Editor.

-See [sql-query-editor.md](../portal/playground/sql-query-editor.md "mention") for further documentation on using the SQL Query Editor. +See [sql-query-editor.md](../cloud/portal/playground/sql-query-editor.md) for further documentation on using the SQL Query Editor. ### Apache Arrow Flight API -For production applications, leveraging the high-performance [Apache Arrow Flight](../api/sql-query/apache-arrow-flight-api.md) endpoint is recommended. The Spice SDKs always query using Arrow Flight. +For production applications, leveraging the high-performance [Apache Arrow Flight](../cloud/api/sql-query/apache-arrow-flight-api.md) endpoint is recommended. The Spice SDKs always query using Arrow Flight. -See [apache-arrow-flight-api.md](../api/sql-query/apache-arrow-flight-api.md "mention") for further documentation on using Apache Arrow Flight APIs. +See [apache-arrow-flight-api.md](../cloud/api/sql-query/apache-arrow-flight-api.md) for further documentation on using Apache Arrow Flight APIs. ### HTTP API SQL Query is also accessible via a standard HTTP API. -See [http-api.md](../api/sql-query/http-api.md "mention") for further documentation on using the HTTP SQL API. +See [http-api.md](../cloud/api/sql-query/http-api.md) for further documentation on using the HTTP SQL API. diff --git a/help/README.md b/help/README.md index 451874fb..4ec5d22c 100644 --- a/help/README.md +++ b/help/README.md @@ -9,23 +9,23 @@ icon: circle-info Browse the topics below to find answers to common questions, troubleshoot issues, or learn how to get the most out of the Spice.ai Cloud Platform. -
πŸ”§TroubleshootingDiagnose and fix common issuestroubleshooting.md
βš™οΈAccount & BillingAPI keys, organizations, and plansaccount-and-billing.md
πŸ’ΎConnecting DataData connectors and configurationconnecting-data.md
πŸ€–AI & ModelsAI Gateway, model providers, and inferenceai-and-models.md
πŸ’»APIs & SDKsEndpoints, SDKs, and query best practicesapis-and-sdks.md
☘️Getting StartedNew to Spice? Start hereget-started
+
πŸ”§TroubleshootingDiagnose and fix common issuestroubleshooting.md
βš™οΈAccount & BillingAPI keys, organizations, and plansaccount-and-billing.md
πŸ’ΎConnecting DataData connectors and configurationconnecting-data.md
πŸ€–AI & ModelsAI Gateway, model providers, and inferenceai-and-models.md
πŸ’»APIs & SDKsEndpoints, SDKs, and query best practicesapis-and-sdks.md
☘️Getting StartedNew to Spice? Start hereget-started
## Quick Links | Topic | Link | | --------------------- | ------------------------------------------------------- | -| Getting started guide | [Get Started](../getting-started/get-started/) | -| FAQ | [Frequently Asked Questions](../getting-started/faq.md) | +| Getting started guide | [Get Started](../cloud/getting-started/get-started/) | +| FAQ | [Frequently Asked Questions](../faq.md) | | Community support | [Slack](https://spice.ai/slack) | -| Enterprise support | [Support](../support/support.md) | -| Security & compliance | [Security](../security/security.md) | +| Enterprise support | [Support](./support.md) | +| Security & compliance | [Security](../enterprise/production/security.md) | | Changelog | [What's New](../changelog/) | -| Pricing | [Plans](../pricing/plans.md) | +| Pricing | [Plans](../cloud/pricing/plans.md) | ## Need More Help? * **Community support** β€” Ask questions and get help from the Spice.ai team and community in [Slack](https://spice.ai/slack). -* **Enterprise support** β€” [Enterprise plans](../pricing/plans.md) include priority support with an SLA. See [Support](../support/support.md) for details. +* **Enterprise support** β€” [Enterprise plans](../cloud/pricing/plans.md) include priority support with an SLA. See [Support](./support.md) for details. * **Report a bug** β€” File issues on [GitHub](https://github.com/spiceai/spiceai/issues). -* **Report a vulnerability** β€” See [Security Reporting](../security/report.md). +* **Report a vulnerability** β€” See [Security Reporting](https://github.com/spiceai/spiceai/security/advisories). diff --git a/help/SUMMARY.md b/help/SUMMARY.md index 9bff0faf..c406df0a 100644 --- a/help/SUMMARY.md +++ b/help/SUMMARY.md @@ -6,4 +6,4 @@ * [Connecting Data](connecting-data.md) * [AI & Models](ai-and-models.md) * [APIs & SDKs](apis-and-sdks.md) -* [Support](../support/support.md) +* [Support](./support.md) diff --git a/help/account-and-billing.md b/help/account-and-billing.md index c35dad98..661e63a2 100644 --- a/help/account-and-billing.md +++ b/help/account-and-billing.md @@ -13,7 +13,7 @@ Spice.ai Cloud uses **GitHub for authentication**. To create an account: 2. Click **Sign in with GitHub** and authorize the Spice.ai GitHub App. 3. A personal organization is created automatically for you. -See the full [Getting Started guide](../getting-started/get-started/) for a step-by-step walkthrough. +See the full [Getting Started guide](../cloud/getting-started/get-started/) for a step-by-step walkthrough. ## API Keys @@ -27,10 +27,10 @@ Navigate to your app in the [Portal](https://spice.ai) β†’ **Settings** β†’ **AP | API | Authentication | | --------------------------------------------------------------- | --------------------- | -| [SQL HTTP API](../api/sql-query/http-api.md) | `X-API-Key` header | -| [Arrow Flight API](../api/sql-query/apache-arrow-flight-api.md) | Password in handshake | -| [LLM API](../api/openai-api.md) | `X-API-Key` header | -| [Search API](../api/search.md) | `X-API-Key` header | +| [SQL HTTP API](../cloud/api/sql-query/http-api.md) | `X-API-Key` header | +| [Arrow Flight API](../cloud/api/sql-query/apache-arrow-flight-api.md) | Password in handshake | +| [LLM API](../cloud/api/openai-api.md) | `X-API-Key` header | +| [Search API](../cloud/api/search.md) | `X-API-Key` header | | [SDKs](../sdks/python-sdk/) | Client configuration | ### Rotating API keys @@ -45,11 +45,11 @@ Each app has two keys to support **zero-downtime rotation**: Regenerating a key **immediately invalidates** the old key. Ensure all clients are updated before regenerating. {% endhint %} -API keys can also be managed via the [Management API](../api/management/api-keys.md). +API keys can also be managed via the [Management API](../cloud/api/management/). ## Personal Access Tokens -The [Management API](../api/management/) uses **personal access tokens** (not app API keys) for authentication. Generate tokens in the Portal under [Profile β†’ Personal Access Tokens](../portal/profile/personal-access-tokens.md). +The [Management API](../cloud/api/management/) uses **personal access tokens** (not app API keys) for authentication. Generate tokens in the Portal under [Profile β†’ Personal Access Tokens](../cloud/portal/profile/personal-access-tokens.md). ## Organizations @@ -76,13 +76,13 @@ Organization admins can add members by: To remove a member, go to your organization's **Settings** β†’ **Members**. -See [Organizations](../portal/organizations.md) for full details. +See [Organizations](../cloud/portal/organizations.md) for full details. ## Plans & Billing ### Community Plan (Free) -The free [Community Plan](../pricing/community.md) includes: +The free [Community Plan](../cloud/pricing/community.md) includes: - One app per organization. - Access to all building blocks (data connectors, AI gateway, search, etc.). @@ -90,7 +90,7 @@ The free [Community Plan](../pricing/community.md) includes: ### Paid Plans -[Paid plans](../pricing/plans.md) provide: +[Paid plans](../cloud/pricing/plans.md) provide: - Higher request and query limits. - No auto-pause. @@ -112,7 +112,7 @@ App secrets store sensitive configuration values (API keys for data sources, mod - Secret changes require a **new deployment** to take effect. - Reference secrets in your Spicepod with: `${secrets:SECRET_NAME}`. -See [Secrets](../portal/apps/secrets.md) for details. +See [Secrets](../cloud/portal/apps/secrets.md) for details. ## Security & Compliance @@ -124,4 +124,4 @@ Spice.ai Cloud is **SOC 2 Type II** compliant. Key security measures include: - Auditable access logs. - Secure code scanning and third-party audits. -See [Security](../security/security.md) for the full security overview. Enterprise plan customers can request the SOC 2 report. +See [Security](../enterprise/production/security.md) for the full security overview. Enterprise plan customers can request the SOC 2 report. diff --git a/help/ai-and-models.md b/help/ai-and-models.md index 3f977bb1..ffb08c5c 100644 --- a/help/ai-and-models.md +++ b/help/ai-and-models.md @@ -29,7 +29,7 @@ See [Model Providers](../building-blocks/model-providers/) for the complete list ### 1. Add a model provider secret -Store your model provider API key as a [secret](../portal/apps/secrets.md) in your app (e.g., `OPENAI_API_KEY`). +Store your model provider API key as a [secret](../cloud/portal/apps/secrets.md) in your app (e.g., `OPENAI_API_KEY`). ### 2. Configure a model in your Spicepod @@ -47,7 +47,7 @@ Deploy your app to make the model available. ### 4. Use the API -Send requests to the [LLM API](../api/openai-api.md): +Send requests to the [LLM API](../cloud/api/openai-api.md): ```bash curl https://data.spiceai.io/v1/chat/completions \ @@ -73,8 +73,8 @@ Configure custom tools and system prompts in your model configuration to tailor Spice supports [vector and hybrid search](../features/search-and-retrieval.md) for retrieval-augmented generation (RAG) workflows: -- Configure [embeddings](../building-blocks/embeddings/) for your datasets. -- Use the [Search API](../api/search.md) for semantic search. +- Configure [embeddings](../building-blocks/embeddings.md) for your datasets. +- Use the [Search API](../cloud/api/search.md) for semantic search. ### Observability @@ -100,7 +100,7 @@ These typically come from the upstream model provider (e.g., OpenAI). Check your ## Further Reading - [AI Gateway](../features/ai-gateway.md) -- [LLM API reference](../api/openai-api.md) +- [LLM API reference](../cloud/api/openai-api.md) - [Search & Retrieval](../features/search-and-retrieval.md) - [Model Providers](../building-blocks/model-providers/) - [Semantic Models](../features/semantic-models.md) diff --git a/help/apis-and-sdks.md b/help/apis-and-sdks.md index 7e39dd87..36cb18d8 100644 --- a/help/apis-and-sdks.md +++ b/help/apis-and-sdks.md @@ -13,11 +13,11 @@ Spice.ai exposes two sets of APIs: **runtime APIs** (for querying data and AI) a | API | Endpoint | Auth | Documentation | | ------------------ | --------------------------------------------- | --------------------- | --------------------------------------------------------------- | -| SQL (HTTP) | `https://data.spiceai.io/v1/sql` | `X-API-Key` header | [HTTP API](../api/sql-query/http-api.md) | -| SQL (Arrow Flight) | `grpc+tls://flight.spiceai.io` | Password in handshake | [Arrow Flight API](../api/sql-query/apache-arrow-flight-api.md) | -| LLM Chat | `https://data.spiceai.io/v1/chat/completions` | `X-API-Key` header | [LLM API](../api/openai-api.md) | -| Search | `https://data.spiceai.io/v1/search` | `X-API-Key` header | [Search API](../api/search.md) | -| Health | `https://data.spiceai.io/health` | None | [Health API](../api/health.md) | +| SQL (HTTP) | `https://data.spiceai.io/v1/sql` | `X-API-Key` header | [HTTP API](../cloud/api/sql-query/http-api.md) | +| SQL (Arrow Flight) | `grpc+tls://flight.spiceai.io` | Password in handshake | [Arrow Flight API](../cloud/api/sql-query/apache-arrow-flight-api.md) | +| LLM Chat | `https://data.spiceai.io/v1/chat/completions` | `X-API-Key` header | [LLM API](../cloud/api/openai-api.md) | +| Search | `https://data.spiceai.io/v1/search` | `X-API-Key` header | [Search API](../cloud/api/search.md) | +| Health | `https://data.spiceai.io/health` | None | [Health API](../cloud/api/health.md) | ### Management API @@ -25,13 +25,13 @@ The Management API at `https://api.spice.ai/v1/` uses **personal access tokens** | Endpoint | Documentation | | ----------- | --------------------------------------------------- | -| Apps | [Apps API](../api/management/apps.md) | -| Deployments | [Deployments API](../api/management/deployments.md) | -| API Keys | [API Keys API](../api/management/api-keys.md) | -| Secrets | [Secrets API](../api/management/secrets.md) | -| Members | [Members API](../api/management/members.md) | +| Apps | [Apps API](../cloud/api/management/) | +| Deployments | [Deployments API](../cloud/api/management/) | +| API Keys | [API Keys API](../cloud/api/management/) | +| Secrets | [Secrets API](../cloud/api/management/) | +| Members | [Members API](../cloud/api/management/) | -See the full [Management API reference](../api/management/). +See the full [Management API reference](../cloud/api/management/). ## SDKs @@ -117,13 +117,13 @@ The HTTP API has built-in row and timeout limits. Switch to Arrow Flight or an S ### Management API returns `401` -The Management API uses **personal access tokens**, not app API keys. Generate a token under [Profile β†’ Personal Access Tokens](../portal/profile/personal-access-tokens.md). +The Management API uses **personal access tokens**, not app API keys. Generate a token under [Profile β†’ Personal Access Tokens](../cloud/portal/profile/personal-access-tokens.md). ## Further Reading -- [SQL Query API](../api/sql-query/) -- [LLM API](../api/openai-api.md) -- [Search API](../api/search.md) -- [Best Practices](../best-practices.md) +- [SQL Query API](../cloud/api/sql-query/) +- [LLM API](../cloud/api/openai-api.md) +- [Search API](../cloud/api/search.md) +- [Best Practices](../cloud/best-practices.md) - [SQL Reference](../reference/sql-reference.md) - [Arrow Flight Samples](../reference/arrow-flight-samples.md) diff --git a/help/connecting-data.md b/help/connecting-data.md index c83ad8da..17a195c4 100644 --- a/help/connecting-data.md +++ b/help/connecting-data.md @@ -20,13 +20,13 @@ For the full list of connectors and configuration options, see [Data Connectors] | **Data lakes & formats** | [S3](../building-blocks/data-connectors/s3.md), [Delta Lake](../building-blocks/data-connectors/delta-lake.md), [ABFS](../building-blocks/data-connectors/abfs.md) | | **APIs & other** | [GraphQL](../building-blocks/data-connectors/graphql.md), [GitHub](../building-blocks/data-connectors/github.md), [SharePoint](../building-blocks/data-connectors/sharepoint.md) | | **Streaming** | [Debezium CDC](../building-blocks/data-connectors/debezium.md) | -| **Embedded / local** | [DuckDB](../building-blocks/data-connectors/duckdb.md), [SQLite](../building-blocks/data-connectors/ftp.md) | +| **Embedded / local** | [DuckDB](../building-blocks/data-connectors/duckdb.md), [SQLite](../features/data-acceleration/sqlite-data-accelerator.md) | ## Adding a Data Source ### 1. Store credentials as secrets -Data source credentials should be stored as [secrets](../portal/apps/secrets.md) in your app. In the Portal, go to your app β†’ **Secrets** and create entries for connection strings, access keys, or tokens. +Data source credentials should be stored as [secrets](../cloud/portal/apps/secrets.md) in your app. In the Portal, go to your app β†’ **Secrets** and create entries for connection strings, access keys, or tokens. {% hint style="info" %} Secret values are write-only and cannot be retrieved after saving. @@ -102,4 +102,4 @@ Spice infers the schema at deployment time. If the source schema changes, refres - [Data Connectors reference](../building-blocks/data-connectors/) - [Data Acceleration](../features/data-acceleration/) - [Federated SQL Query](../features/federated-sql-query.md) -- [Catalogs](../building-blocks/catalogs/index.md) +- [Data Connectors](../building-blocks/data-connectors/) diff --git a/help/troubleshooting.md b/help/troubleshooting.md index 841bb786..d23dda8f 100644 --- a/help/troubleshooting.md +++ b/help/troubleshooting.md @@ -9,7 +9,7 @@ description: Solutions to common issues with the Spice.ai Cloud Platform. ### API requests return `401 Unauthorized` -- Verify you're using the correct API key for your app. Each app has its own keys β€” find them in the [Portal](../portal/apps/api-keys.md) under your app's settings. +- Verify you're using the correct API key for your app. Each app has its own keys β€” find them in the [Portal](../cloud/portal/apps/api-keys.md) under your app's settings. - If you recently regenerated a key, the old key is immediately invalidated. Update all clients to use the new key. - Ensure the API key is passed correctly: - **HTTP API**: Include the `X-API-Key` header. @@ -24,7 +24,7 @@ Each app has **two API keys**. To rotate without downtime: 2. Update all clients to use Key 2. 3. Regenerate **Key 1**. -See [API Keys](../portal/apps/api-keys.md) for details. +See [API Keys](../cloud/portal/apps/api-keys.md) for details. ## SQL Queries @@ -36,7 +36,7 @@ See [API Keys](../portal/apps/api-keys.md) for details. SELECT * FROM "MyTable" ``` -- Confirm the dataset is configured in your app's [Spicepod](../portal/app-spicepod/spicepod-configuration.md) and the app has been deployed. +- Confirm the dataset is configured in your app's [Spicepod](../cloud/portal/app-spicepod/spicepod-configuration.md) and the app has been deployed. - Ensure the data connector credentials (secrets) are correct and the source is accessible. ### Query times out or is slow @@ -44,20 +44,20 @@ See [API Keys](../portal/apps/api-keys.md) for details. - **Use data acceleration.** Accelerated datasets are cached locally and queries run significantly faster. See [Data Acceleration](../features/data-acceleration/). - **Use `LIMIT`** to reduce result set size during development. - **Use Arrow Flight** instead of HTTP for large result sets β€” it has no row-count limits and streams results efficiently. -- **Apply `ORDER BY` with `LIMIT`/`OFFSET`** when retrieving large datasets in chunks. See [Best Practices](../best-practices.md). +- **Apply `ORDER BY` with `LIMIT`/`OFFSET`** when retrieving large datasets in chunks. See [Best Practices](../cloud/best-practices.md). ### HTTP SQL API returns truncated results The HTTP SQL API has row and timeout limits. If you're hitting these: -- Use the [Arrow Flight API](../api/sql-query/apache-arrow-flight-api.md) or an [SDK](../sdks/python-sdk/) for unlimited streaming results. +- Use the [Arrow Flight API](../cloud/api/sql-query/apache-arrow-flight-api.md) or an [SDK](../sdks/python-sdk/) for unlimited streaming results. - Add `LIMIT` and `OFFSET` clauses to paginate results. ## Data Connectors ### Data connector fails to connect -- Verify the connection credentials are stored as [secrets](../portal/apps/secrets.md) in your app and referenced correctly in the Spicepod using `${secrets:SECRET_NAME}` syntax. +- Verify the connection credentials are stored as [secrets](../cloud/portal/apps/secrets.md) in your app and referenced correctly in the Spicepod using `${secrets:SECRET_NAME}` syntax. - Confirm the data source is network-accessible from Spice.ai Cloud (check firewalls, IP allowlists, VPC peering). - Check the [Data Connectors](../building-blocks/data-connectors/) documentation for connector-specific configuration requirements. @@ -80,14 +80,14 @@ When connecting to object stores (S3, ABFS, etc.): ### AI chat returns errors or empty responses - Confirm a [model is configured](../features/ai-gateway.md) in your app's Spicepod and the app is deployed. -- Ensure the model provider API key (e.g., OpenAI, Anthropic) is stored as a [secret](../portal/apps/secrets.md) and referenced correctly. +- Ensure the model provider API key (e.g., OpenAI, Anthropic) is stored as a [secret](../cloud/portal/apps/secrets.md) and referenced correctly. - After adding or changing a secret, **redeploy the app** β€” secret changes don't take effect until the next deployment. ### Model not available or not responding - Check the model name matches a supported model from your configured [model provider](../building-blocks/model-providers/). - Verify the provider's API is operational (e.g., check OpenAI's status page). -- Review request logs in the [Portal Monitoring](../portal/monitoring-and-request-logs.md) for error details. +- Review request logs in the [Portal Monitoring](../cloud/portal/monitoring-and-request-logs.md) for error details. ## Secrets @@ -101,18 +101,18 @@ This is by design. Secret values are **write-only** β€” they cannot be retrieved ### Changes to secrets not taking effect -Secret changes require a **new deployment** before they take effect. After updating secrets, trigger a new deployment in the [Portal](../portal/app-spicepod/deployments.md). +Secret changes require a **new deployment** before they take effect. After updating secrets, trigger a new deployment in the [Portal](../cloud/portal/app-spicepod/deployments.md). ## Deployments ### App is paused -On the [Community Plan](../pricing/community.md), applications that receive no API requests for 7 consecutive days are automatically paused. To restore: +On the [Community Plan](../cloud/pricing/community.md), applications that receive no API requests for 7 consecutive days are automatically paused. To restore: 1. Go to your app in the [Portal](https://spice.ai). 2. Resume the app. -[Paid plans](../pricing/plans.md) do not auto-pause. +[Paid plans](../cloud/pricing/plans.md) do not auto-pause. ## Arrow Flight @@ -126,6 +126,6 @@ If you encounter certificate verification errors when connecting via Arrow Fligh ## Still stuck? -- Search the [FAQ](../getting-started/faq.md) for your question. +- Search the [FAQ](../faq.md) for your question. - Ask in [Slack](https://spice.ai/slack) for community support. -- [Enterprise plans](../pricing/plans.md) include priority support with an SLA. +- [Enterprise plans](../cloud/pricing/plans.md) include priority support with an SLA. diff --git a/legal/terms-of-service.md b/legal/terms-of-service.md index 25280bc8..67976dcb 100644 --- a/legal/terms-of-service.md +++ b/legal/terms-of-service.md @@ -74,7 +74,7 @@ The following words will be interpreted as designated: (i) β€œor” connotes any **2.1 Provision of Spice AI Technology Subscription Services.** Customer may access and use the Spice AI Technology Subscription Services in accordance with these Terms of Service. Access to the Spice AI Technology Subscription Services is available through the Internet over an https connection, via a password-protected computer interface or access code and multi-factor authentication. -**2.2 Community Edition.** Spice AI makes available the Community Edition of the Spice AI Software with limited features and support as described [here](/broken/pages/TswKQuxvMpeSWfvqFhxa). Customers may use the Community Edition without payment of Subscription Fees, however, such use of Community Edition shall be subject to all other terms and conditions of this Terms of Service, including the Website Terms of Use and EULA. +**2.2 Community Edition.** Spice AI makes available the Community Edition of the Spice AI Software with limited features and support as described [here](../cloud/pricing/community.md). Customers may use the Community Edition without payment of Subscription Fees, however, such use of Community Edition shall be subject to all other terms and conditions of this Terms of Service, including the Website Terms of Use and EULA. **2.3 Authority and Capacity.** If you are entering into these Terms of Service on behalf of an entity, such as the company you work for, then you represent to Spice AI that you have the legal authority to bind the entity Customer to these Terms of Service. If you do not have that authority or if Customer does not agree with the terms of these Terms of Service, then you may not indicate acceptance of these Terms of Service, and neither you nor Customer may use or access any of Spice AI’s service offerings or other services.