Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions TOC-tidb-cloud-starter.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,15 +135,11 @@
- [Troubleshoot Access Denied Errors during Data Import from Amazon S3](/tidb-cloud/troubleshoot-import-access-denied-error.md)
- [Connect AWS DMS to TiDB Cloud](/tidb-cloud/tidb-cloud-connect-aws-dms.md)
- Explore Data
- [Chat2Query in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png)
- [SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md) ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png)
- [SQL Proxy Account](/tidb-cloud/sql-proxy-account.md)
- Data Service ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png)
- [Overview](/tidb-cloud/data-service-overview.md)
- [Get Started](/tidb-cloud/data-service-get-started.md)
- Chat2Query API
- [Get Started](/tidb-cloud/use-chat2query-api.md)
- [Start Multi-round Chat2Query](/tidb-cloud/use-chat2query-sessions.md)
- [Use Knowledge Bases](/tidb-cloud/use-chat2query-knowledge.md)
- [Manage Data App](/tidb-cloud/data-service-manage-data-app.md)
- [Manage Endpoint](/tidb-cloud/data-service-manage-endpoint.md)
- [API Key](/tidb-cloud/data-service-api-key.md)
Expand Down
6 changes: 1 addition & 5 deletions TOC-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,15 +171,11 @@
- [Precheck Errors, Migration Errors, and Alerts for Data Migration](/tidb-cloud/tidb-cloud-dm-precheck-and-troubleshooting.md)
- [Connect AWS DMS to TiDB Cloud](/tidb-cloud/tidb-cloud-connect-aws-dms.md)
- Explore Data
- [Chat2Query in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png)
- [SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md) ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png)
- [SQL Proxy Account](/tidb-cloud/sql-proxy-account.md)
- Data Service ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png)
- [Overview](/tidb-cloud/data-service-overview.md)
- [Get Started](/tidb-cloud/data-service-get-started.md)
- Chat2Query API
- [Get Started](/tidb-cloud/use-chat2query-api.md)
- [Start Multi-round Chat2Query](/tidb-cloud/use-chat2query-sessions.md)
- [Use Knowledge Bases](/tidb-cloud/use-chat2query-knowledge.md)
- [Manage Data App](/tidb-cloud/data-service-manage-data-app.md)
- [Manage Endpoint](/tidb-cloud/data-service-manage-endpoint.md)
- [API Key](/tidb-cloud/data-service-api-key.md)
Expand Down
4 changes: 2 additions & 2 deletions develop/serverless-driver-drizzle-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ To complete this tutorial, you need the following:

1. Create a table in your {{{ .starter }}} instance.

You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-chat2query) to execute SQL statements. Here is an example:
You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-sql-editor) to execute SQL statements. Here is an example:
Comment thread
coderabbitai[bot] marked this conversation as resolved.

```sql
CREATE TABLE `test`.`users` (
Expand Down Expand Up @@ -208,7 +208,7 @@ To complete this tutorial, you need the following:

1. Create a table in your {{{ .starter }}} instance.

You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-chat2query.md) to execute SQL statements. Here is an example:
You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-sql-editor) to execute SQL statements. Here is an example:

```sql
CREATE TABLE `test`.`users` (
Expand Down
4 changes: 2 additions & 2 deletions develop/serverless-driver-kysely-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ To complete this tutorial, you need the following:

1. Create a table in your {{{ .starter }}} instance and insert some data.

You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-chat2query) to execute SQL statements. Here is an example:
You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-sql-editor) to execute SQL statements. Here is an example:
Comment thread
coderabbitai[bot] marked this conversation as resolved.

```sql
CREATE TABLE `test`.`person` (
Expand Down Expand Up @@ -202,7 +202,7 @@ mysql://[username]:[password]@[host]/[database]

1. Create a table in your {{{ .starter }}} instance and insert some data.

You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-chat2query) to execute SQL statements. Here is an example:
You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-sql-editor) to execute SQL statements. Here is an example:

```sql
CREATE TABLE `test`.`person` (
Expand Down
8 changes: 1 addition & 7 deletions tidb-cloud/ai-feature-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,10 @@ summary: Learn about AI features for TiDB Cloud.

# AI Features

The AI features in TiDB Cloud enable you to fully leverage advanced technologies for data exploration, search, and integration. From natural language-driven SQL query generation to high-performance vector search, TiDB combines database capabilities with modern AI features to power innovative applications. With support for popular AI frameworks, embedding models, and seamless integration with ORM libraries, TiDB offers a versatile platform for use cases such as semantic search and AI-powered analytics.
The AI features in TiDB Cloud enable you to fully leverage advanced technologies for data exploration, search, and integration. TiDB combines database capabilities with modern AI features to power innovative applications. With support for popular AI frameworks, embedding models, and seamless integration with ORM libraries, TiDB offers a versatile platform for use cases such as semantic search and AI-powered analytics.

This document highlights these AI features and how they enhance the TiDB experience.

## Chat2Query (PREVIEW)

Chat2Query is an AI-powered feature integrated into SQL Editor that assists users in generating, debugging, or rewriting SQL queries using natural language instructions. For more information, see [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md).

In addition, TiDB Cloud provides a Chat2Query API for {{{ .starter }}} instances. After it is enabled, TiDB Cloud will automatically create a system Data App called Chat2Query and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md).

## Vector search (PREVIEW)

Vector search is a search method that prioritizes the meaning of your data to deliver relevant results.
Expand Down
6 changes: 3 additions & 3 deletions tidb-cloud/connect-to-tidb-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ After your TiDB Cloud Dedicated cluster is created on TiDB Cloud, you can connec

If you want lower latency and more security, set up VPC peering and connect via a private endpoint using a VM instance on the corresponding cloud provider in your cloud account. For more information, see [Connect to TiDB Cloud Dedicated via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md).

- [Built-in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md)
- [Built-in SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md)

> **Note:**
>
> To use SQL Editor on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md).

If your cluster is hosted on AWS and the TiDB version of the cluster is v6.5.0 or later, you can use the AI-assisted SQL Editor in the [TiDB Cloud console](https://tidbcloud.com/) to maximize your data value.
If your cluster is hosted on AWS and the TiDB version of the cluster is v6.5.0 or later, you can use the SQL Editor in the [TiDB Cloud console](https://tidbcloud.com/) to maximize your data value.

In SQL Editor, you can either write SQL queries manually or simply press <kbd>⌘</kbd> + <kbd>I</kbd> on macOS (or <kbd>Control</kbd> + <kbd>I</kbd> on Windows or Linux) to instruct [Chat2Query (PREVIEW)](/tidb-cloud/tidb-cloud-glossary.md#chat2query) to generate SQL queries automatically. This enables you to run SQL queries against databases without a local SQL client. You can intuitively view the query results in tables or charts and easily check the query logs.
In SQL Editor, you can write and run SQL queries. This enables you to run SQL queries against databases without a local SQL client. You can intuitively view the query results in tables or charts and easily check the query logs.

## What's next

Expand Down
2 changes: 0 additions & 2 deletions tidb-cloud/data-service-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ Request quotas are subject to rate limits as follows:
{"type":"","data":{"columns":[],"rows":[],"result":{"latency":"","row_affect":0,"code":49900007,"row_count":0,"end_ms":0,"limit":0,"message":"API key rate limit exceeded. The limit can be increased up to 1000 requests per minute per API key in TiDB Cloud console. For an increase in quota beyond 1000 rpm, please contact us: https://tidb.support.pingcap.com/","start_ms":0}}}
```

- TiDB Cloud Data Service allows up to 100 requests per day for each Chat2Query Data App.

## API key expiration

By default, API keys never expire. However, for security considerations, you can specify an expiration time for your API key when you [create](#create-an-api-key) or [edit](#edit-an-api-key) the key.
Expand Down
1 change: 0 additions & 1 deletion tidb-cloud/data-service-app-config-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,6 @@ In the SQL file, you can write statements such as table join queries, complex qu
```sql
/* Getting Started:
Enter "USE {database};" before entering your SQL statements.
Type "--your question" + Enter to try out AI-generated SQL queries in the TiDB Cloud console.
Declare a parameter like "Where id = ${arg}".
*/
USE sample_data;
Expand Down
6 changes: 0 additions & 6 deletions tidb-cloud/data-service-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,6 @@ An endpoint in [Data Service (PREVIEW)](https://tidbcloud.com/project/data-servi

For more information, see [Manage an Endpoint](/tidb-cloud/data-service-manage-endpoint.md).

## Chat2Query API

In TiDB Cloud, Chat2Query API is a RESTful interface that enables you to generate and execute SQL statements using AI by providing instructions. Then, the API returns the query results for you.

For more information, see [Get Started with Chat2Query API](/tidb-cloud/use-chat2query-api.md).

## AI integrations

Integrating third-party tools with your Data App enhances your applications with advanced natural language processing and artificial intelligence (AI) capabilities provided by third-party tools. This integration enables your applications to perform more complex tasks and deliver intelligent solutions.
Expand Down
17 changes: 1 addition & 16 deletions tidb-cloud/data-service-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ summary: Learn how to use TiDB Cloud Data Service to access your data with HTTPS

Data Service (PREVIEW) enables you to access TiDB Cloud data via an HTTPS request using a custom API endpoint and allows you to seamlessly integrate with any application or service that is compatible with HTTPS.

> **Tip:**
>
> TiDB Cloud provides a Chat2Query API for {{{ .starter }}} instances. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions.
>
> For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md).

This document introduces how to quickly get started with TiDB Cloud Data Service (PREVIEW) by creating a Data App, developing, testing, deploying, and calling an endpoint. A Data App is a collection of endpoints that you can use to access data for a specific application.

## Before you begin
Expand Down Expand Up @@ -61,10 +55,6 @@ To get started with Data Service, you can also create your own Data App, and the

3. In the **Create Data App** dialog, enter a name, a description, and select {{{ .starter }}} instances that you want the Data App to access.

> **Note:**
>
> By default, the Data App type is **Standard Data App**. If you want to create a **Chat2Query Data App**, refer to [Get Started with Chat2Query API](/tidb-cloud/use-chat2query-api.md) instead of this document.

4. (Optional) To automatically deploy endpoints of the Data App to your preferred GitHub repository and branch, enable **Connect to GitHub**, and then do the following:

1. Click **Install on GitHub**, and then follow the on-screen instructions to install **TiDB Cloud Data Service** as an application on your target repository.
Expand Down Expand Up @@ -116,11 +106,7 @@ You can customize SQL statements for the endpoint in the <Tooltip id="sql-editor

Before querying or modifying data, you need to first specify the database in the SQL statements. For example, `USE database_name;`.

In the SQL editor, you can write statements such as table join queries, complex queries, and aggregate functions. You can also simply type `--` followed by your instructions to let AI generate SQL statements automatically.

> **Note:**
>
> To try the AI capacity of TiDB Cloud, you need to allow PingCAP and Amazon Bedrock to use your code snippets for research and service improvement. For more information, see [Enable or disable AI to generate SQL queries](/tidb-cloud/explore-data-with-chat2query.md#enable-or-disable-ai-to-generate-sql-queries).
In the SQL editor, you can write statements such as table join queries, complex queries, and aggregate functions.

To define a parameter, you can insert it as a variable placeholder like `${ID}` in the SQL statement. For example, `SELECT * FROM table_name WHERE id = ${ID}`. Then, you can click the **Params** tab on the right pane to change the parameter definition and test values.

Expand Down Expand Up @@ -303,6 +289,5 @@ For more information about the response, see [Response of an endpoint](/tidb-clo
## Learn more

- [Data Service Overview](/tidb-cloud/data-service-overview.md)
- [Get Started with Chat2Query API](/tidb-cloud/use-chat2query-api.md)
- [Manage a Data App](/tidb-cloud/data-service-manage-data-app.md)
- [Manage an Endpoint](/tidb-cloud/data-service-manage-endpoint.md)
4 changes: 0 additions & 4 deletions tidb-cloud/data-service-manage-data-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ To create a Data App for your project, perform the following steps:

2. Enter a name, a description, and select clusters that you want the Data App to access.

> **Note:**
>
> By default, the Data App type is **Standard Data App**. If you want to create a **Chat2Query Data App**, refer to [Get Started with Chat2Query API](/tidb-cloud/use-chat2query-api.md) instead of this document.

3. (Optional) To automatically deploy endpoints of the Data App to your preferred GitHub repository and branch, enable **Connect to GitHub**, and then do the following:

1. Click **Install on GitHub**, and then follow the on-screen instructions to install **TiDB Cloud Data Service** as an application on your target repository.
Expand Down
8 changes: 2 additions & 6 deletions tidb-cloud/data-service-manage-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ This document describes how to manage your endpoints in a Data App in the TiDB C

In Data Service, you can automatically generate endpoints, manually create endpoints, or add predefined system endpoints.

> **Tip:**
>
> You can also create an endpoint from a SQL file in SQL Editor. For more information, see [Generate an endpoint from a SQL file](/tidb-cloud/explore-data-with-chat2query.md#generate-an-endpoint-from-a-sql-file).

### Generate an endpoint automatically

In TiDB Cloud Data Service, you can generate one or multiple endpoints automatically in one go as follows:
Expand Down Expand Up @@ -199,7 +195,7 @@ On the right pane of the endpoint details page, you can click the **Properties**

### Write SQL statements

On the SQL editor of the endpoint details page, you can write and run the SQL statements for an endpoint. You can also simply type `--` followed by your instructions to let AI generate SQL statements automatically.
On the SQL editor of the endpoint details page, you can write and run the SQL statements for an endpoint.

1. Select a {{{ .starter }}} instance.

Expand All @@ -216,7 +212,7 @@ On the SQL editor of the endpoint details page, you can write and run the SQL st

3. Write SQL statements.

In the SQL editor, you can write statements such as table join queries, complex queries, and aggregate functions. You can also simply type `--` followed by your instructions to let AI generate SQL statements automatically.
In the SQL editor, you can write statements such as table join queries, complex queries, and aggregate functions.

To define a parameter, you can insert it as a variable placeholder like `${ID}` in the SQL statement. For example, `SELECT * FROM table_name WHERE id = ${ID}`. Then, you can click the **Params** tab on the right pane to change the parameter definition and test values. For more information, see [Parameters](#configure-parameters).

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/data-service-oas-with-nextjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This document uses a {{{ .starter }}} instance as an example.

To begin with, create a table `test.repository` in your {{{ .starter }}} instance or {{{ .dedicated }}} cluster and insert some sample data into it. The following example inserts some open source projects developed by PingCAP as data for demonstration purposes.

To execute the SQL statements, you can use [SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) in the [TiDB Cloud console](https://tidbcloud.com).
To execute the SQL statements, you can use [SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md) in the [TiDB Cloud console](https://tidbcloud.com).

```sql
-- Select the database
Expand Down
7 changes: 0 additions & 7 deletions tidb-cloud/data-service-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,6 @@ An endpoint in Data Service is a web API that you can customize to execute SQL s

To manage endpoints more efficiently, you can use Data Apps. A Data App in Data Service is a collection of endpoints that you can use to access data for a specific application. By creating a Data App, you can group your endpoints and configure authorization settings using API keys to restrict access to endpoints. In this way, you can ensure that only authorized users can access and manipulate your data, making your application more secure.

> **Tip:**
>
> TiDB Cloud provides a Chat2Query API for TiDB clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions.
>
> For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md).

## Scenarios

Data Service allows you to seamlessly integrate TiDB Cloud with any application or service that is compatible with HTTPS. The following are some typical usage scenarios:
Expand All @@ -35,6 +29,5 @@ Data Service allows you to seamlessly integrate TiDB Cloud with any application
## What's next

- [Get Started with Data Service](/tidb-cloud/data-service-get-started.md)
- [Get Started with Chat2Query API](/tidb-cloud/use-chat2query-api.md)
- [Manage a Data App](/tidb-cloud/data-service-manage-data-app.md)
- [Manage an Endpoint](/tidb-cloud/data-service-manage-endpoint.md)
3 changes: 1 addition & 2 deletions tidb-cloud/data-service-postman-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ To import your Data App to Postman, take the following steps:

> **Note:**
>
> - If a Data App lacks a well-defined endpoint (the target {{{ .starter }}} instance, path, request method, and SQL statements are configured), **Run in Postman** remains disabled for the Data App.
> - For a Chat2Query Data App, **Run in Postman** is not available.
> If a Data App lacks a well-defined endpoint (the target {{{ .starter }}} instance, path, request method, and SQL statements are configured), **Run in Postman** remains disabled for the Data App.

4. Follow the steps provided in the dialog for the Data App import:

Expand Down
Loading
Loading