Chat
API Authorization
NOTE
- To obtain the AUTH_TOKEN, please refer to the Authorization section and find the AUTH_TOKEN section.
- Please make sure that all API requests include the AUTH_TOKEN in the request header, as shown below:
SDK Authorization
NOTE
- Before integrating the SDK, please make sure that you have obtained the APP_ID and APP_KEY.
- To obtain the APP_ID and APP_KEY, please refer to the Authorization section and find the Obtain APP_ID & APP_KEY section.
Chat（Server-Sent Events）
API Request
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| query | String | Y | Dialogue content. |
API Response
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| identify | Integer | Y | Unique identifier for the dialogue, which remains the same within the same session. |
| generatedText | String | Y | Generated text for the dialogue. |
Search
API Request
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| query | String | Y | Dialogue content. |
| type | String | Y | Dialogue type, including CHAT/PAGE/AGENT |
API Response
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| id | Integer | Y | Unique identifier |
| name | String | Y | Dialogue content. |
| type | String | Y | Dialogue type, including CHAT/PAGE/AGENT |
| data | Object | Y | Supplementary information for the dialogue type. |