From c7291cd5aa0512d5026a33aba9351b342c1b7054 Mon Sep 17 00:00:00 2001 From: Tudor Golubenco Date: Wed, 4 Dec 2024 20:37:16 +0100 Subject: [PATCH] Add warnings about functionality not being in the free tier (#387) --- .github/workflows/preview.yml | 2 +- 040-SDK/150-search.mdx | 6 ++++++ 040-SDK/151-vector-search.mdx | 6 ++++++ 040-SDK/152-aggregate.mdx | 6 ++++++ 040-SDK/160-ask.mdx | 6 ++++++ 040-SDK/170-file-attachments.mdx | 6 ++++++ 040-SDK/171-image-transformations.mdx | 6 ++++++ 7 files changed, 37 insertions(+), 1 deletion(-) diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml index 2fbcaa6f..c6f34812 100644 --- a/.github/workflows/preview.yml +++ b/.github/workflows/preview.yml @@ -41,7 +41,7 @@ jobs: with: node-version: 18 - - run: npm i -g vercel@latest + - run: npm i -g vercel@37 - id: deploy name: Deploy to Vercel diff --git a/040-SDK/150-search.mdx b/040-SDK/150-search.mdx index 3c8c79f5..c99f049d 100644 --- a/040-SDK/150-search.mdx +++ b/040-SDK/150-search.mdx @@ -7,6 +7,12 @@ slug: sdk/search published: true --- + + Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be + available as documented to users on the Pro and Enterprises plans. For more details see this [blog + post](/blog/changes-free-tier). + + Xata natively provides text-based search for your database with the following core features: - Fuzzy matching for typo tolerance in search queries diff --git a/040-SDK/151-vector-search.mdx b/040-SDK/151-vector-search.mdx index 82566cc3..01469b94 100644 --- a/040-SDK/151-vector-search.mdx +++ b/040-SDK/151-vector-search.mdx @@ -8,6 +8,12 @@ published: true status: beta --- + + Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be + available as documented to users on the Pro and Enterprises plans. For more details see this [blog + post](/blog/changes-free-tier). + + The Xata [vector type](/docs/concepts/data-model#vector) can be combined with the `vectorSearch` API to perform similarity search on your data based on embeddings. An embedding is a vector of floating point numbers that represents the original data (text, image, audio, etc.). Embeddings are typically produced by a machine learning model. You can store the embeddings in Xata in a column of type `vector` and use the `vectorSearch` API call to find the nearest neighbors of a given embedding. This is useful in a number of use cases related to machine learning, such as: semantic search, recommendations, clustering, classification, and others. diff --git a/040-SDK/152-aggregate.mdx b/040-SDK/152-aggregate.mdx index a7802efc..40648a85 100644 --- a/040-SDK/152-aggregate.mdx +++ b/040-SDK/152-aggregate.mdx @@ -8,6 +8,12 @@ published: true status: beta --- + + Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be + available as documented to users on the Pro and Enterprises plans. For more details see this [blog + post](/blog/changes-free-tier). + + The `/aggregate` API allows you to use the search/analytics engine to perform aggregations on your data. Similar to the [search API](/docs/sdk/search) aggregations run in the optional Search store, which means: it is eventually consistent with the main transactional store, and it cannot access the linked fields from a table. The Search store is enabled by default and can be disabled in the Database Settings from the Web UI. The aggregate API and features described in this page require the Search store to be enabled. If these limitations are not acceptable for your use case, you should use the Summarize API. The advantages of using the Aggregation API, over the Summarize API, are: diff --git a/040-SDK/160-ask.mdx b/040-SDK/160-ask.mdx index cd217d9b..0d15f395 100644 --- a/040-SDK/160-ask.mdx +++ b/040-SDK/160-ask.mdx @@ -7,6 +7,12 @@ slug: sdk/ask published: true --- + + Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be + available as documented to users on the Pro and Enterprises plans. For more details see this [blog + post](/blog/changes-free-tier). + + The `ask` endpoint helps you create interactive and engaging conversational interfaces, Q&A assistants, and chatbots. It provides users with swift and direct access to the information they need, eliminating the need to navigate through lengthy documentation or articles. The endpoint leverages up-to-date information from your Xata database, such as documentation, knowledge bases, or any source of data you've configured. The `ask` endpoint uses Xata's search capabilities to find relevant information from your database, and uses this with OpenAI's ChatGPT API to interpret your question and generate natural language responses. diff --git a/040-SDK/170-file-attachments.mdx b/040-SDK/170-file-attachments.mdx index a945a54c..0250b44e 100644 --- a/040-SDK/170-file-attachments.mdx +++ b/040-SDK/170-file-attachments.mdx @@ -7,6 +7,12 @@ slug: sdk/file-attachments published: true --- + + Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be + available as documented to users on the Pro and Enterprises plans. For more details see this [blog + post](/blog/changes-free-tier). + + Xata offers general purpose file attachment capabilities. In order to simplify the management of large binary objects and to improve the developer experience, Xata integrates files support directly into the database itself. The aim is to offer a unified, seamless experience by exposing file support under one API, security model, and SDK. Using this approach, the [queries](/docs/sdk/get), [filters](/docs/sdk/filtering), [summaries](/docs/sdk/summarize), [aggregations](/docs/sdk/aggregate) from the SDK can also be used on the files' metadata. The metadata (file name, media type, tags) is also indexed for [search](/docs/sdk/search) in the optional Search store so it can be included in search results. ![Add the xata_file column type to start working with files](images/file-attachments-add.jpg) diff --git a/040-SDK/171-image-transformations.mdx b/040-SDK/171-image-transformations.mdx index 0df4078a..31ee4b0f 100644 --- a/040-SDK/171-image-transformations.mdx +++ b/040-SDK/171-image-transformations.mdx @@ -7,6 +7,12 @@ slug: sdk/image-transformations published: true --- + + Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be + available as documented to users on the Pro and Enterprises plans. For more details see this [blog + post](/blog/changes-free-tier). + + Xata supports transformations for images stored in Xata's `xata_file` and `xata_file_array` [column types](/docs/sdk/file-attachments). Transformations are specified by modifying the `File`'s URL by adding `/transform/height=100,width=200/{fileId}`