Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

cloud: update use-chat2query-api.md release chat2query v2 #15319

Merged
merged 20 commits into from
Nov 22, 2023
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
4 changes: 4 additions & 0 deletions tidb-cloud/data-service-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ 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 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.

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
4 changes: 4 additions & 0 deletions tidb-cloud/data-service-manage-data-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ 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
15 changes: 14 additions & 1 deletion tidb-cloud/explore-data-with-chat2query.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,20 @@ In Chat2Query, you can save your SQL queries in different SQL files and manage S
- To rename a SQL file, move your cursor on the filename, click **...** next to the filename, and then select **Rename**.
- To delete a SQL file, move your cursor on the filename, click **...** next to the filename, and then select **Delete**. Note that when there is only one SQL file on the **SQL Files** tab, you cannot delete it.

## Access Chat2Query via API

In addition to accessing Chat2Query via UI, you can also access Chat2Query via API. To do so, you need to create a Chat2Query Data App first.

In Chat2Query, you can access or create a Chat2Query Data App as follows:

1. Click **...** in the upper-right corner, and then click **Access Chat2Query via API**.
2. In the displayed dialog, do one of the following:

- To create a new Chat2Query Data App, click **New Chat2Query Data App**.
- To access an existing Chat2Query Data App, click the name of target Data App.

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

## Generate an endpoint from a SQL file

For TiDB clusters, TiDB Cloud provides a [Data Service (beta)](/tidb-cloud/data-service-overview.md) feature that enables you to access TiDB Cloud data via an HTTPS request using a custom API endpoint. In Chat2Query, you can generate an endpoint of Data Service (beta) from a SQL file by taking the following steps:
Expand All @@ -127,7 +141,6 @@ In Chat2Query, you can change the following settings:

- The maximum number of rows in query results
- Whether to show system database schemas on the **Schemas** tab
- Whether to enable [Chat2Query API](/tidb-cloud/use-chat2query-api.md)

To change the settings, take the following steps:

Expand Down
Loading
Loading