release studio 3.9.0

docs-2.0-en/20.appendix/release-notes/studio-release-note.md

@@ -1,39 +1,11 @@
 # NebulaGraph Studio release notes
 
-## v3.8.0
+## v3.9.0 (2024.1)
 
 - Features
-  - Supported the use of MySQL databases as backend storage.
+  - Supported importing data using [AI](../../nebula-studio/quick-start/st-ug-import-data.md).
+  - Supported the generation of nGQL statements using the [AI Assistant](../../nebula-studio/quick-start/st-ug-console.md).
 
 - Enhancements
-  - Supported customizing the read and write parameters of the WebSocket.
-  - Usability
-    - Supported filtering tasks in the import task list based on the map space name.
-  - Compatibility
-    - Since the database table structure has changed, you need to set `DB.AutoMigrate` to `true` in the configuration file, and the system will automatically upgrade and adapt the existing historical data.
-
-      If the tables were created manually after you consulted our after-sales staff, please modify these tables manually: `task_infos`, `task_effects`, `sketches`, `schema_snapshots`, `favorites`, `files`, and `datasources`.
-
-      For example:
-
-      ```mysql
-      ALTER TABLE `task_infos` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
-      UPDATE TABLE `task_infos` SET `b_id` = `id`;
-      CREATE UNIQUE INDEX `idx_task_infos_id` ON `task_infos`(`b_id`);
-
-      ALTER TABLE `task_effects` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
-      UPDATE TABLE `task_effects` SET `b_id` = `id`;
-      CREATE UNIQUE INDEX `idx_task_effects_id` ON `task_effects`(`b_id`);
-      ...
-      ```
-
-
-## v3.7.0
-
-- Enhancements
-
-  - Supported importing SFTP, Amazon S3 data files.
-  - The import page is supported to configure more import parameters, such as concurrency, retries, etc.
-  - Supported re-running tasks.
-  - Supported saving tasks as drafts.
-  - Supported running Studio in a docker container on the ARM architecture.
+  - Optimized the [console feature](../../nebula-studio/quick-start/st-ug-console.md), including automatic completion of a tag or edge type, quick selection of the historical statements, quick viewing of the schema, etc.
+  - Optimized the presentation style of the [execution plan](../../nebula-studio/quick-start/st-ug-console.md).

docs-2.0-en/nebula-studio/quick-start/st-ug-console.md

@@ -2,24 +2,48 @@
 
 Studio console interface is shown as follows.
 
-![console](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-015-en.png)
+## Entry
 
-The following table lists various functions on the console interface.
+In the top navigation bar, click **Console**.
+
+## Overview
+
+<img src="https://docs-cdn.nebula-graph.com.cn/figures/std_console_240131_en.png" width="1200" alt="A screenshot that shows the overview of the console">
+
+The following table lists the functions on the console page.
 
 | number  |  function | descriptions  |
 | :-- | :--|   :--   |
-|  1  |  toolbar  |  Click the **Console** tab to enter the console page.  |
-|  2  |  select a space  | Select a space in the Current Graph Space list. <br/> **descriptions**: Studio does not support running the `USE <space_name>` statements directly in the input box.  |
-|  3  | favorites | Click the ![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) button to expand the favorites, click one of the statements, and the input box will automatically enter the statement. |
-|  4  |  history list   |  Click ![history](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-history.png) button representing the statement record. In the statement running record list, click one of the statements, and the statement will be automatically entered in the input box. The list provides the record of the last 15 statements.  |
-|  5  |  clean input box  | Click ![clean](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-clear.png) button to clear the content entered in the input box.  |
-|  6  |  run   |  After inputting the nGQL statement in the input box, click ![run](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) button to indicate the operation to start running the statement.  |
-|  7  |  custom parameters display   | Click the ![Query](https://docs-cdn.nebula-graph.com.cn/figures/down.png) button to expand the custom parameters for parameterized query. For details, see [Manage parameters](../../nebula-console.md).|
-|  8  |  input box   |  After inputting the nGQL statements, click the ![run](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) button to run the statement. You can input multiple statements and run them at the same time by using the separator `;`, and also use the symbol `//` to add comments. |
-|  9  |  statement running status   |  After running the nGQL statement, the statement running status is displayed. If the statement runs successfully, the statement is displayed in green. If the statement fails, the statement is displayed in red.   |
-|  10  | add to favorites | Click the ![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) button to save the statement as a favorite, the button for the favorite statement is colored in yellow exhibit.|
-|  11  |  export CSV file or PNG file |  After running the nGQL statement to return the result, when the result is in **Table** window, click the ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) button to export as a CSV file. Switch to the **Graph** window and click the ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) button to save the results as a CSV file or PNG image export. |
-|  12  |  expand/hide execution results  | Click the ![up](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-up.png) button to hide the result or click ![down](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-down.png) button to expand the result. |
-|  13  |  close execution results | Click the ![close](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-close.png) button to close the result returned by this nGQL statement. |
-|  14  |  **Table** window | Display the result from running nGQL statement. If the statement returns results, the window displays the results in a table. |
-|  15  |  **Graph** window | Display the result from running nGQL statement. If the statement returns the complete vertex-edge result, the window displays the result as a graph . Click the ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png) button on the right to view the overview panel. |
+|  1  |  View the schema | Display the schemas of the graph spaces. |
+|  2  |  Select a space  | Select a space in the graph space drop down list. The console does not support using the `USE <space_name>` statement to switch graph spaces. |
+|  3  | Favorites | Click the ![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) button to expand the favorites. Select a statement, and it automatically populates in the input box. |
+|  4  |  History list   |  Click the ![history](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-history.png) button to view the execution history. In the execution history list, click one of the statements, and the statement is automatically populated in the input box. The list provides the record of the last 15 statements.</br>Type `/` in the input box to quickly select a historical query statement.  |
+|  5  |  Clean input box  | Click the ![clean](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-clear.png) button to clear the content populated in the input box.  |
+|  6  |  Run   |  After entering the nGQL statement in the input box, click the ![run](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) button to start running the statement.  |
+|  7  |  Input box   |  The area where the nGQL statement is entered. The statement displays different colors depending on the schemas or character strings. </br>Support code completion, you can quickly enter a tag or edge type based on the schema.</br>You can input multiple statements and run them at the same time by using the separator `;`. Use the symbol `//` to add comments.</br>Support right-clicking on a selected statement and then performing operations such as cut, copy, or run. |
+|  8  |  Custom parameters display   | Click the ![Query](https://docs-cdn.nebula-graph.com.cn/figures/down.png) button to expand the custom parameters for the parameterized query. For details, see [Manage parameters](../../nebula-console.md).|
+|  9  |  Statement running status   |  After running the nGQL statement, the statement running status is displayed. If the statement runs successfully, the statement is displayed in green. If the statement fails, the statement is displayed in red.   |
+|  10  | Add to favorites | Click the ![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) button to save the statement as a favorite. The button for the favorite statement is colored in yellow.|
+|  11  |  Export CSV file or PNG file |  After running the nGQL statement to return the result, when the result is in the **Table** window, click the ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) button to export as a CSV file. </br>Switch to the **Graph** window and click the ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) button to export the results as a CSV file or a PNG image. |
+|  12  |  Expand/hide execution results  | Click the ![up](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-up.png) button to hide the result or click ![down](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-down.png) to expand the result. |
+|  13  |  Close execution results | Click the ![close](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-close.png) button to close the result returned by this nGQL statement. |
+|  14  |  **Table** window | Display the results from running the nGQL statement in a table. |
+|  15 | **Plan** window | Display the execution plan. If an `EXPLAIN` or `PROFILE` statement is executed, the window presents the execution plan in visual form. See the description of the execution plan below. |
+|  16  |  **Graph** window | Display the results from running the nGQL statement in a graph if the results contain complete vertex and edge information. Click the ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png) button on the right to view the overview panel. |
+|  17  | AI Assistant | You can chat with an AI assistant to convert natural language instructions into nGQL query statements and then copy the nGQL statements into the input box with one click. This feature needs to be set up and enabled in the [system settings](../system-settings.md) before use.</br>Note: </br>The schema information of the current graph space is sent to the large language model when you chat with the assistant. Please pay attention to information security.</br>The toggle **text2match** is used to switch between normal Q&A and query Q&A. The query Q&A can convert the input natural languages to nGQL query statements.|
+
+## Execution plan descriptions
+
+The Studio can display the execution plan of the statement. The execution plan descriptions are as follows.
+
+<img src="https://docs-cdn.nebula-graph.com.cn/figures/eo_expl_excutionPlan_231226_en.png" width="1000" alt="A screenshot that shows the execute plan of studio">
+
+|No.|Description|
+|:---|:---|
+|1   |An `EXPLAIN` or `PROFILE` statement.|
+|2   |The operators used by the execution plan, which are sorted according to the execution duration. The top three operators are labeled as red, orange, and yellow, respectively. Clicking on an operator directly selects the corresponding operator in the operator execution flow and displays the operator information.</br>Note: The `PROFILE` statement actually executes the statement, and the actual execution durations can be obtained and sorted. The `EXPLAIN` statement does not actually execute the statement, and the execution durations of all operators are considered the same and are labeled as red.|
+|3   |The operator execution flow. For each operator, the following information is displayed: in-parameters, out-parameters, and total execution duration.</br>The `Select`, `Loop`, `PassThrough`, and `Start` operators have independent color schemes.</br>The arrows show the direction of data flow and the number of rows. The thicker the arrows, the more rows of data.</br> You can click on the operator to check the details of the operator on the right side.|
+|4   |The details of the operator, divided into `Profiling data` and `Operator info`.</br>`Profiling data` shows the performance data of the operator, including the rows of data received, the execution time, the total time, etc.</br>`Operator info` shows the detailed operation information of the operator.|
+|5   |Zoom out, zoom in, or reverse the execution flow.|
+|6   |The duration of the statement.|
+|7   |Full screen or cancel full screen.|

docs-2.0-en/nebula-studio/quick-start/st-ug-import-data.md

@@ -14,11 +14,17 @@ To batch import data, do a check of these:
 
 ## Entry
 
-In the top navigation bar, click ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png).
+In the top navigation bar, click **Import**.
+
+## Steps
 
 Importing data is divided into 2 parts, creating a new data source and creating an import task, which will be described in detail next.
 
-## Create a new data source
+!!! note
+
+    You can also import tasks via the AI Import feature, which is a beta feature that needs to be enabled and configured in the [system settings](../system-settings.md) before use.
+
+### Create a new data source
 
 Click **New Data Source** in the upper right corner of the page to set the data source and its related settings. Currently, 3 types of data sources are supported.
 
@@ -33,7 +39,7 @@ Click **New Data Source** in the upper right corner of the page to set the data
     - When uploading a local CSV file, you can select more than one CSV file at one time.
     - After adding a data source, you can click **Data Source Management** at the top of the page and switch tabs to view the details of different types of data sources, and you can also edit or delete data sources.
 
-## Create an import task
+### Create an import task
 
 1. Click **New Import** at the top left corner of the page to complete the following settings:
 
@@ -62,6 +68,25 @@ Click **New Data Source** in the upper right corner of the page to set the data
 
 After the import task is created, you can view the progress of the import task in the **Import Data** tab, which supports operations such as filtering tasks based on graph space, editing the task, viewing logs, downloading logs, reimporting, downloading configuration files, and deleting tasks.
 
+### Import data using AI Import
+
+!!! note
+
+    After the import task is completed, check whether the data is imported successfully. If not, it is recommended that you check the task logs on the import page to see whether issues such as timeouts, privacy policy violations, service interruption, or encoding errors occurred.
+
+1. Click **AI Import** in the upper left corner of the page to complete the following settings:
+
+  - **File**: Select the files for import via AI import. Only local single file or local directory is currently supported. You can select only one local file or directory each time. The file needs to be a plain text file.
+  - **Import Graph Space**: The graph space where the data is to be imported. The schema of the graph space needs to be created in advance.
+  - **Export NGQL File Path**: The path to the exported nGQL file, which usually does not need to be modified.
+  - **Attach Prompt**: You can attach additional prompts to guide the data import process. The precision of the prompts directly influences the accuracy of the import results.
+
+  You can view the `LLM` parameters related to AI import in the configuration file.
+
+2. After completing the settings, click **Next** to confirm the file for import and the AI URL to be used, and then click **Start**.
+
+After the import task is created, you can view the progress of the import task on the **Import Data** tab, which supports operations such as viewing logs, downloading logs, reimporting, and deleting tasks.
+
 ## Next
 
 After completing the data import, users can access the [Console](st-ug-console.md) page.

docs-2.0-en/nebula-studio/system-settings.md

@@ -0,0 +1,21 @@
+# Global settings
+
+This topic introduces the global settings of NebulaGraph Studio, including language switching and beta functions.
+
+- Language: Switch between Chinese and English.
+
+- Beta functions: Switch on/off beta features, which include [view schema](manage-schema/st-ug-view-schema.md), [text to query](quick-start/st-ug-console.md) and [AI import](quick-start/st-ug-import-data.md).
+
+  The text to query and AI import features need to be configured with AI-related configurations. See below for detailed configurations.
+
+## Text to query and AI import
+
+The text to query and AI import are artificial intelligence features developed based on the large language model (LLM) and require the following parameters to be configured.
+
+|Parameter|Description|
+|:---------|:--|
+|**API type**  | The API type for AI. Valid values are `OpenAI` and `Aliyun`.     |
+|**URL**       | The API URL. Fill in the correct URL format according to the corresponding API type. For example, `https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/chat/completions?api-version={api-version}`。  |
+|**Key**       | The key used to validate the API. The key is required when using an online large language model, and is optional depending on the actual settings when using an offline large language model.  |
+|**Model**     | The version of the large language model. The model is required when using an online large language model, and is optional depending on the actual settings when using an offline large language model.   |
+|**Max text length**| The maximum length for receiving or generating a single piece of text. Unit: byte.     |

docs-2.0-zh/20.appendix/release-notes/studio-release-note.md

@@ -1,39 +1,11 @@
 # NebulaGraph Studio 更新说明
 
-
-## v3.8.0
+## v3.9.0（2024.1）
 
 - 功能
-  - 支持使用 MySQL 数据库作为后端存储。
+  - 支持[使用 AI 导入数据](../../nebula-studio/quick-start/st-ug-import-data.md)。
+  - 支持[使用 AI 查询语句助手](../../nebula-studio/quick-start/st-ug-console.md)生成 nGQL 语句。
 
 - 增强
-  - 支持自定义 WebSocket 的读写参数。
-  - 易用性
-    - 支持在导入任务列表根据图空间名称筛选任务。
-  - 兼容性
-    - 由于数据库表结构变更，需要在配置文件内将`DB.AutoMigrate`设置为`true`，系统会自动对已有历史数据进行升级适配。
-
-      如果是自己手动创建的库表，请手动修改这些表：`task_infos`、`task_effects`、`sketches`、`schema_snapshots`、`favorites`、`files`、`datasources`。
-
-      示例如下：
-
-      ```mysql
-      ALTER TABLE `task_infos` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
-      UPDATE TABLE `task_infos` SET `b_id` = `id`;
-      CREATE UNIQUE INDEX `idx_task_infos_id` ON `task_infos`(`b_id`);
-
-      ALTER TABLE `task_effects` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
-      UPDATE TABLE `task_effects` SET `b_id` = `id`;
-      CREATE UNIQUE INDEX `idx_task_effects_id` ON `task_effects`(`b_id`);
-      ...
-      ```
-
-## v3.7.0
-
-- 增强
-
-  - 支持导入 SFTP、Amazon S3 的数据文件。
-  - 导入页面支持配置更多导入参数，如并发数、重试次数等。
-  - 支持重跑任务。
-  - 支持任务保存为草稿。
-  - 支持在 ARM 架构的 Docker 容器内运行 Studio。
+  - 优化[控制台功能](../../nebula-studio/quick-start/st-ug-console.md)，包括自动补全 Tag/Edge type、快速选择历史语句、快速查看 Schema 等。
+  - 优化[执行计划](../../nebula-studio/quick-start/st-ug-console.md)展示样式。