feat: add doc (#728)

This commit is contained in:
crazywoola
2023-08-03 10:40:36 +08:00
committed by GitHub
parent 17c3a63e50
commit c4c47ae8c6
2 changed files with 4 additions and 4 deletions

View File

@@ -3,7 +3,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
# Chat App API
For versatile conversational apps using a Q&A format, call the chat-messages API to initiate dialogue. Maintain ongoing conversations by passing the returned conversation_id. Response parameters and templates depend on LangGenius Prompt Eng. settings.
For versatile conversational apps using a Q&A format, call the chat-messages API to initiate dialogue. Maintain ongoing conversations by passing the returned conversation_id. Response parameters and templates depend on LangGenius Prompt Eng. settings. **[Before you start, READ This !! What is a Bearer Token](https://swagger.io/docs/specification/authentication/bearer-authentication/)**
<Heading
url='/chat-messages'
@@ -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)**.
</Property>
<Property name='conversation_id' type='string' key='conversation_id'>
(Optional) Conversation ID: leave empty for first-time conversation; pass conversation_id from context to continue dialogue.
(Optional) Conversation ID: <strong>‼️ leave empty for first-time conversation ‼️</strong>; pass conversation_id from context to continue dialogue.
</Property>
<Property name='user' type='string' key='user'>
The user identifier, defined by the developer, must ensure uniqueness within the app.