writinwaters commited on
Commit
9dc377f
·
1 Parent(s): 18f8b2c

Fixed a Docusaurus display issue. (#3125)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

docs/references/http_api_reference.md CHANGED
@@ -1386,11 +1386,7 @@ curl --request POST \
1386
  - `"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.
1387
  - `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`.
1388
  - `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`.
1389
- - `"prompt"`: `string` The prompt content. Defaults to `You are an intelligent assistant. Please summarize the content of the dataset to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence "The answer you are looking for is not found in the knowledge base!" Answers need to consider chat history.
1390
- Here is the knowledge base:
1391
- {knowledge}
1392
- The above is the knowledge base.`
1393
-
1394
  ### Response
1395
 
1396
  Success:
@@ -1422,7 +1418,7 @@ Success:
1422
  "empty_response": "Sorry! No relevant content was found in the knowledge base!",
1423
  "keywords_similarity_weight": 0.3,
1424
  "opener": "Hi! I'm your assistant, what can I do for you?",
1425
- "prompt": "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence \"The answer you are looking for is not found in the knowledge base!\" Answers need to consider chat history.\n Here is the knowledge base:\n {knowledge}\n The above is the knowledge base.",
1426
  "rerank_model": "",
1427
  "similarity_threshold": 0.2,
1428
  "top_n": 6,
@@ -1524,10 +1520,7 @@ curl --request PUT \
1524
  - `"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.
1525
  - `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`.
1526
  - `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`.
1527
- - `"prompt"`: `string` The prompt content. Defaults to `You are an intelligent assistant. Please summarize the content of the dataset to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence "The answer you are looking for is not found in the knowledge base!" Answers need to consider chat history.
1528
- Here is the knowledge base:
1529
- {knowledge}
1530
- The above is the knowledge base.`
1531
 
1532
  ### Response
1533
 
@@ -1673,7 +1666,7 @@ Success:
1673
  "empty_response": "Sorry! No relevant content was found in the knowledge base!",
1674
  "keywords_similarity_weight": 0.3,
1675
  "opener": "Hi! I'm your assistant, what can I do for you?",
1676
- "prompt": "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence \"The answer you are looking for is not found in the knowledge base!\" Answers need to consider chat history.\n Here is the knowledge base:\n {knowledge}\n The above is the knowledge base.",
1677
  "rerank_model": "",
1678
  "similarity_threshold": 0.2,
1679
  "top_n": 6,
@@ -1793,6 +1786,7 @@ Updates a chat session.
1793
  - `"name`: `string`
1794
 
1795
  #### Request example
 
1796
  ```bash
1797
  curl --request PUT \
1798
  --url http://{address}/api/v1/chats/{chat_id}/sessions/{session_id} \
@@ -2063,7 +2057,7 @@ data: {
2063
  {
2064
  "chunk_id": "895d34de762e674b43e8613c6fb54c6d",
2065
  "content_ltks": "xxxx\r\n\r\n\"\"\"\r\nyou are an intellig assistant. pleas summar the content of the knowledg base to answer the question. pleas list thedata in the knowledg base and answer in detail. when all knowledg base content is irrelev to the question , your answer must includ the sentenc\"the answer you are lookfor isnot found in the knowledg base!\" answer needto consid chat history.\r\n here is the knowledg base:\r\n{ knowledg}\r\nthe abov is the knowledg base.\r\n\"\"\"\r\n1\r\n 2\r\n 3\r\n 4\r\n 5\r\n 6\r\nxxxx ",
2066
- "content_with_weight": "xxxx\r\n\r\n\"\"\"\r\nYou are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence \"The answer you are looking for is not found in the knowledge base!\" Answers need to consider chat history.\r\n Here is the knowledge base:\r\n {knowledge}\r\n The above is the knowledge base.\r\n\"\"\"\r\n1\r\n2\r\n3\r\n4\r\n5\r\n6\r\nxxxx\r\n\r\n\"\"\"\r\nxxxx",
2067
  "doc_id": "5c5999ec7be811ef9cab0242ac120005",
2068
  "docnm_kwd": "1.txt",
2069
  "kb_id": "c7ee74067a2c11efb21c0242ac120006",
@@ -2085,7 +2079,7 @@ data: {
2085
  }
2086
  ]
2087
  },
2088
- "prompt": "xxxx\r\n\r\n\"\"\"\r\nYou are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence \"The answer you are looking for is not found in the knowledge base!\" Answers need to consider chat history.\r\n Here is the knowledge base:\r\n {knowledge}\r\n The above is the knowledge base.\r\n\"\"\"\r\n1\r\n2\r\n3\r\n4\r\n5\r\n6\r\nxxxx\n\n### Query:\nwho are you,please answer me in English\n\n### Elapsed\n - Retrieval: 332.2 ms\n - LLM: 2972.1 ms",
2089
  "id": "d8e5ebb6-6b52-4fd1-bd02-35b52ba3acaa",
2090
  "session_id": "e14344d08d1a11efb6210242ac120004"
2091
  }
 
1386
  - `"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.
1387
  - `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`.
1388
  - `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`.
1389
+ - `"prompt"`: `string` The prompt content.
 
 
 
 
1390
  ### Response
1391
 
1392
  Success:
 
1418
  "empty_response": "Sorry! No relevant content was found in the knowledge base!",
1419
  "keywords_similarity_weight": 0.3,
1420
  "opener": "Hi! I'm your assistant, what can I do for you?",
1421
+ "prompt": "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence \"The answer you are looking for is not found in the knowledge base!\" Answers need to consider chat history.\n ",
1422
  "rerank_model": "",
1423
  "similarity_threshold": 0.2,
1424
  "top_n": 6,
 
1520
  - `"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.
1521
  - `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`.
1522
  - `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`.
1523
+ - `"prompt"`: `string` The prompt content.
 
 
 
1524
 
1525
  ### Response
1526
 
 
1666
  "empty_response": "Sorry! No relevant content was found in the knowledge base!",
1667
  "keywords_similarity_weight": 0.3,
1668
  "opener": "Hi! I'm your assistant, what can I do for you?",
1669
+ "prompt": "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence \"The answer you are looking for is not found in the knowledge base!\" Answers need to consider chat history.\n",
1670
  "rerank_model": "",
1671
  "similarity_threshold": 0.2,
1672
  "top_n": 6,
 
1786
  - `"name`: `string`
1787
 
1788
  #### Request example
1789
+
1790
  ```bash
1791
  curl --request PUT \
1792
  --url http://{address}/api/v1/chats/{chat_id}/sessions/{session_id} \
 
2057
  {
2058
  "chunk_id": "895d34de762e674b43e8613c6fb54c6d",
2059
  "content_ltks": "xxxx\r\n\r\n\"\"\"\r\nyou are an intellig assistant. pleas summar the content of the knowledg base to answer the question. pleas list thedata in the knowledg base and answer in detail. when all knowledg base content is irrelev to the question , your answer must includ the sentenc\"the answer you are lookfor isnot found in the knowledg base!\" answer needto consid chat history.\r\n here is the knowledg base:\r\n{ knowledg}\r\nthe abov is the knowledg base.\r\n\"\"\"\r\n1\r\n 2\r\n 3\r\n 4\r\n 5\r\n 6\r\nxxxx ",
2060
+ "content_with_weight": "xxxx\r\n\r\n\"\"\"\r\nYou are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence \"The answer you are looking for is not found in the knowledge base!\" Answers need to consider chat history.\r\n ",
2061
  "doc_id": "5c5999ec7be811ef9cab0242ac120005",
2062
  "docnm_kwd": "1.txt",
2063
  "kb_id": "c7ee74067a2c11efb21c0242ac120006",
 
2079
  }
2080
  ]
2081
  },
2082
+ "prompt": "xxxx\r\n\r\n\"\"\"\r\nYou are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence \"The answer you are looking for is not found in the knowledge base!\" Answers need to consider chat history.\r\n \r\n\"\"\"\r\n1\r\n2\r\n3\r\n4\r\n5\r\n6\r\nxxxx\n\n### Query:\nwho are you,please answer me in English\n\n### Elapsed\n - Retrieval: 332.2 ms\n - LLM: 2972.1 ms",
2083
  "id": "d8e5ebb6-6b52-4fd1-bd02-35b52ba3acaa",
2084
  "session_id": "e14344d08d1a11efb6210242ac120004"
2085
  }