Unverified Commit a38412de authored by crazywoola's avatar crazywoola Committed by GitHub

update doc (#965)

parent 9c9f0ddb
.spin-animation path { .spin-animation path {
animation: custom 1s linear infinite; animation: custom 2s linear infinite;
} }
@keyframes custom { @keyframes custom {
...@@ -29,13 +29,13 @@ ...@@ -29,13 +29,13 @@
} }
.spin-animation path:nth-child(2) { .spin-animation path:nth-child(2) {
animation-delay: 0.25s; animation-delay: 0.5s;
} }
.spin-animation path:nth-child(3) { .spin-animation path:nth-child(3) {
animation-delay: 0.5s; animation-delay: 1s;
} }
.spin-animation path:nth-child(4) { .spin-animation path:nth-child(4) {
animation-delay: 1s; animation-delay: 2s;
} }
...@@ -38,7 +38,7 @@ For versatile conversational apps using a Q&A format, call the chat-messages API ...@@ -38,7 +38,7 @@ For versatile conversational apps using a Q&A format, call the chat-messages API
- streaming returns. Implementation of streaming return based on SSE (**[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)**). - streaming returns. Implementation of streaming return based on SSE (**[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)**).
</Property> </Property>
<Property name='conversation_id' type='string' key='conversation_id'> <Property name='conversation_id' type='string' key='conversation_id'>
(Optional) Conversation ID: <strong>‼️ leave empty for first-time conversation ‼️</strong>; pass conversation_id from context to continue dialogue. (Required) Conversation ID: <strong>‼️ leave it empty for first-time (eg. conversation_id: "") conversation ‼️</strong>; pass conversation_id from context to continue dialogue.
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
The user identifier, defined by the developer, must ensure uniqueness within the app. The user identifier, defined by the developer, must ensure uniqueness within the app.
...@@ -47,7 +47,7 @@ For versatile conversational apps using a Q&A format, call the chat-messages API ...@@ -47,7 +47,7 @@ For versatile conversational apps using a Q&A format, call the chat-messages API
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="POST" label="/chat-messages" targetCode={`curl --location --request POST '${props.appDetail.api_base_url}/chat-messages' \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n "inputs": ${JSON.stringify(props.inputs)},\n "query": "eh",\n "response_mode": "streaming",\n "conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276",\n "user": "abc-123"\n}'\n`}> <CodeGroup title="Request" tag="POST" label="/chat-messages" targetCode={`curl --location --request POST '${props.appDetail.api_base_url}/chat-messages' \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n "inputs": ${JSON.stringify(props.inputs)},\n "query": "eh",\n "response_mode": "streaming",\n "conversation_id": "",\n "user": "abc-123"\n}'\n`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl --location --request POST 'https://cloud.langgenius.dev/api/chat-messages' \ curl --location --request POST 'https://cloud.langgenius.dev/api/chat-messages' \
......
...@@ -38,7 +38,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' ...@@ -38,7 +38,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- streaming 流式返回。基于 SSE(**[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)**)实现流式返回。 - streaming 流式返回。基于 SSE(**[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)**)实现流式返回。
</Property> </Property>
<Property name='conversation_id' type='string' key='conversation_id'> <Property name='conversation_id' type='string' key='conversation_id'>
选填)<strong>‼️ 会话标识符,首次对话为空 ‼️</strong>,如果要继续对话请传入上下文返回的 conversation_id 必填)<strong>‼️ 会话标识符,首次对话为 conversation_id: "" ‼️</strong>,如果要继续对话请传入上下文返回的 conversation_id
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
用户标识,由开发者定义规则,需保证用户标识在应用内唯一。 用户标识,由开发者定义规则,需保证用户标识在应用内唯一。
...@@ -47,7 +47,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' ...@@ -47,7 +47,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="POST" label="/chat-messages" targetCode={`curl --location --request POST '${props.appDetail.api_base_url}/chat-messages' \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n "inputs": ${JSON.stringify(props.inputs)},\n "query": "eh",\n "response_mode": "streaming",\n "conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276",\n "user": "abc-123"\n}'\n`}> <CodeGroup title="Request" tag="POST" label="/chat-messages" targetCode={`curl --location --request POST '${props.appDetail.api_base_url}/chat-messages' \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n "inputs": ${JSON.stringify(props.inputs)},\n "query": "eh",\n "response_mode": "streaming",\n "conversation_id": "",\n "user": "abc-123"\n}'\n`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl --location --request POST 'https://cloud.langgenius.dev/api/chat-messages' \ curl --location --request POST 'https://cloud.langgenius.dev/api/chat-messages' \
...@@ -57,7 +57,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' ...@@ -57,7 +57,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
"inputs": {}, "inputs": {},
"query": "eh", "query": "eh",
"response_mode": "streaming", "response_mode": "streaming",
"conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276", "conversation_id": "",
"user": "abc-123" "user": "abc-123"
}' }'
``` ```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment