Browse Source

fix: suggest service api missed user in query (#2918)

Joel 1 year ago
parent
commit
9a3d5729bb

+ 9 - 1
web/app/components/develop/template/template_chat.en.mdx

@@ -444,10 +444,18 @@ Chat applications support session persistence, allowing previous chat history to
         Message ID
       </Property>
     </Properties>
+
+    ### Query
+    <Properties>
+      <Property name='user' type='string' key='user'>
+        User identifier, used to define the identity of the end-user for retrieval and statistics.
+        Should be uniquely defined by the developer within the application.
+      </Property>
+    </Properties>
   </Col>
   <Col sticky>
 
-    <CodeGroup title="Request" tag="GET" label="/messages/{message_id}/suggested" targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json'`}>
+    <CodeGroup title="Request" tag="GET" label="/messages/{message_id}/suggested" targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested?user=abc-123& \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json'`}>
 
     ```bash {{ title: 'cURL' }}
     curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested' \

+ 8 - 1
web/app/components/develop/template/template_chat.zh.mdx

@@ -459,10 +459,17 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
         Message ID
       </Property>
     </Properties>
+
+    ### Query
+    <Properties>
+      <Property name='user' type='string' key='user'>
+        用户标识,由开发者定义规则,需保证用户标识在应用内唯一。
+      </Property>
+    </Properties>
   </Col>
   <Col sticky>
 
-    <CodeGroup title="Request" tag="GET" label="/messages/{message_id}/suggested" targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json'`}>
+    <CodeGroup title="Request" tag="GET" label="/messages/{message_id}/suggested" targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested?user=abc-123 \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json'`}>
 
     ```bash {{ title: 'cURL' }}
     curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested' \