Refa: enhancement: enhance the prompt of related_question API (#6463)

### What problem does this PR solve? Enhance the prompt of `related_question` API. ### Type of change - [x] Enhancement - [x] Documentation Update
2025-12-08 20:42:30 +08:00 · 2025-03-25 10:00:10 +08:00
parent b6f3242c6c
commit ee6a0bd9db
2 changed files with 208 additions and 116 deletions
--- a/docs/references/http_api_reference.md
+++ b/docs/references/http_api_reference.md
@ -535,17 +535,15 @@ Failure:

 ---

-| Code | Message | Description |
-|------|---------|-------------|
-| 400  | Bad Request | Invalid request parameters |
-| 401  | Unauthorized | Unauthorized access |
-| 403  | Forbidden | Access denied |
-| 404  | Not Found | Resource not found |
-| 500  | Internal Server Error | Server internal error |
-| 1001 | Invalid Chunk ID | Invalid Chunk ID |
-| 1002 | Chunk Update Failed | Chunk update failed |
-
-
+| Code | Message               | Description                |
+| ---- | --------------------- | -------------------------- |
+| 400  | Bad Request           | Invalid request parameters |
+| 401  | Unauthorized          | Unauthorized access        |
+| 403  | Forbidden             | Access denied              |
+| 404  | Not Found             | Resource not found         |
+| 500  | Internal Server Error | Server internal error      |
+| 1001 | Invalid Chunk ID      | Invalid Chunk ID           |
+| 1002 | Chunk Update Failed   | Chunk update failed        |

 ---

@ -1091,6 +1089,7 @@ curl --request POST \
  The key terms or phrases to tag with the chunk.
 - `"questions"`(*Body parameter*), `list[string]`
  If there is a given question, the embedded chunks will be based on them
+
 #### Response

 Success:
@ -1549,7 +1548,7 @@ curl --request POST \
    - All the variables in 'System' should be curly bracketed.
    - The default value is `[{"key": "knowledge", "optional": true}]`.
  - `"rerank_model"`: `string` If it is not specified, vector cosine similarity will be used; otherwise, reranking score will be used.
-  -  `top_k`: `int` Refers to the process of reordering or selecting the top-k items from a list or set based on a specific ranking criterion. Default to 1024.
+  - `top_k`: `int` Refers to the process of reordering or selecting the top-k items from a list or set based on a specific ranking criterion. Default to 1024.
  - `"empty_response"`: `string` If nothing is retrieved in the dataset for the user's question, this will be used as the response. To allow the LLM to improvise when nothing is found, leave this blank.
  - `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`.
  - `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`.
@ -2148,8 +2147,10 @@ Failure:
 Asks a specified chat assistant a question to start an AI-powered conversation.

 :::tip NOTE
+
 - In streaming mode, not all responses include a reference, as this depends on the system's judgement.
 - In streaming mode, the last message is an empty message:
+
  ```json
  data:
  {
@ -2157,6 +2158,7 @@ Asks a specified chat assistant a question to start an AI-powered conversation.
    "data": true
  }
  ```
+
 :::

 #### Request
@ -2183,6 +2185,7 @@ curl --request POST \
     {
     }'
 ```
+
 ```bash
 curl --request POST \
     --url http://{address}/api/v1/chats/{chat_id}/completions \
@ -2214,6 +2217,7 @@ curl --request POST \
 #### Response

 Success without `session_id`:
+
 ```json
 data:{
    "code": 0,
@ -2504,8 +2508,10 @@ Failure:
 Asks a specified agent a question to start an AI-powered conversation.

 :::tip NOTE
+
 - In streaming mode, not all responses include a reference, as this depends on the system's judgement.
 - In streaming mode, the last message is an empty message:
+
  ```json
  data:
  {
@ -2513,6 +2519,7 @@ Asks a specified agent a question to start an AI-powered conversation.
    "data": true
  }
  ```
+
 :::

 #### Request
@ -2529,9 +2536,12 @@ Asks a specified agent a question to start an AI-powered conversation.
  - `"user_id"`: `string`(optional)
  - `"sync_dsl"`: `boolean` (optional)
  - other parameters: `string`
+
 ##### Request example
+
 If the **Begin** component does not take parameters, the following code will create a session.
-```bash 
+
+```bash
 curl --request POST \
     --url http://{address}/api/v1/agents/{agent_id}/completions \
     --header 'Content-Type: application/json' \
@ -2540,7 +2550,9 @@ curl --request POST \
     {
     }'
 ```
+
 If the **Begin** component takes parameters, the following code will create a session.
+
 ```bash
 curl --request POST \
     --url http://{address}/api/v1/agents/{agent_id}/completions \
@ -2552,7 +2564,9 @@ curl --request POST \
          "file":"How is the weather tomorrow?"
     }'
 ```
+
 The following code will execute the completion process
+
 ```bash
 curl --request POST \
     --url http://{address}/api/v1/agents/{agent_id}/completions \
@ -2586,7 +2600,9 @@ curl --request POST \
  Parameters specified in the **Begin** component.

 #### Response
+
 success without `session_id` provided and with no parameters specified in the **Begin** component:
+
 ```json
 data:{
    "code": 0,
@ -2641,7 +2657,9 @@ data:{
 }
 data:
 ```
+
 Success with parameters specified in the **Begin** component:
+
 ```json
 data:{
    "code": 0,
@ -2979,6 +2997,79 @@ Failure:
    "message": "The agent doesn't own the session cbd31e52f73911ef93b232903b842af6"
 }
 ```
+
+---
+
+### Related Questions
+
+**POST** `/api/v1/conversation/related_questions`
+
+Generates five to ten alternative question strings from the user's original query to retrieve more relevant search results.
+
+:::tip NOTE
+The chat model dynamically determines the number of questions to generate based on the instruction, typically between five and ten.
+:::
+
+#### Request
+
+- Method: POST
+- URL: `/api/v1/conversation/related_questions`
+- Headers:
+  - `'content-Type: application/json'`
+  - `'Authorization: Bearer <YOUR_API_KEY>'`
+- Body:
+  - `"question"`: `string`
+
+##### Request example
+
+```bash
+curl --request DELETE \
+     --url http://{address}/api/v1/conversation/related_questions \
+     --header 'Content-Type: application/json' \
+     --header 'Authorization: Bearer <YOUR_API_KEY>' \
+     --data '
+     {
+          "question": "What are the key advantages of Neovim over Vim?"
+     }'
+```
+
+##### Request Parameters
+
+- `"question"`: (*Body Parameter*), `string`
+  The original user question.
+
+#### Response
+
+Success:
+
+```json
+{
+    "code": 0,
+    "data": [
+        "What makes Neovim superior to Vim in terms of features?",
+        "How do the benefits of Neovim compare to those of Vim?",
+        "What advantages does Neovim offer that are not present in Vim?",
+        "In what ways does Neovim outperform Vim in functionality?",
+        "What are the most significant improvements in Neovim compared to Vim?",
+        "What unique advantages does Neovim bring to the table over Vim?",
+        "How does the user experience in Neovim differ from Vim in terms of benefits?",
+        "What are the top reasons to switch from Vim to Neovim?",
+        "What features of Neovim are considered more advanced than those in Vim?"
+    ],
+    "message": "success"
+}
+```
+
+Failure:
+
+```json
+{
+    "code": 401,
+    "data": null,
+    "message": "<Unauthorized '401: Unauthorized'>"
+}
+```
+
 ---

 ## AGENT MANAGEMENT
@ -3094,4 +3185,4 @@ Failure:
 }
 ```

---
+---