You can call the Tongyi Xiaomi CCAI-Conversation Analysis AIO application using the Message protocol format to obtain conversation summaries, extract key information, and generate quality inspection and conversation analysis results. The application supports HTTP calls to provide responses. You can use either the standard HTTP or HTTP Server-Sent Events (SSE) protocol.
Operation description
Before you use this API, make sure you understand the billing methods and pricing of the Tongyi Xiaomi CCAI-Conversation Analysis AIO product.
Prerequisites
- Activate the Tongyi Xiaomi CCAI-Conversation Analysis AIO service.
- Create an application: create a Tongyi Xiaomi CCAI-Conversation Analysis AIO application in the Application Center and obtain the APP-ID and WORKSPACE-ID: Obtain the APP-ID and WORKSPACE-ID.
Debug
You can run this API directly in OpenAPI Explorer without having to calculate signatures. After a successful run, OpenAPI Explorer can automatically generate SDK code examples.
Debug
Authorization information
No authorization information is exposed for the current API.
Request syntax
Request parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| workspaceId | string | Yes | The workspace ID. | llm-ik******RVYCKzt |
| appId | string | Yes | The application ID. | 097d65c9c7004f8dad2b454850ac232b |
| body | object | No | schema of request body | |
| Messages | array<object> | Yes | The list of messages for the model request. | |
| object | No | The structure of a message. | ||
| Content | string | Yes | The content of the prompt. | e.g. Role=system, Content=You are a helpful assistant. Role=user, Content=Read the following conversation and perform the instructed task. |
| Role | string | Yes | (Conversation role) Valid values: user (customer), assistant (customer service representative), system (system message), function (function). | user |
| ModelCode | string | No | The model specification. | tyxmTurbo |
| Stream | boolean | No | If true, SSE responses are enabled. Default value: false. | false |
Response parameters
| Name | Type | Description | Example |
|---|---|---|---|
| object | The structure of the response. | ||
| FinishReason | string | For streaming output, the value is null while the model is generating. If generation ends due to a stop token, the value is stop. | stop |
| RequestId | string | The unique ID generated by the system to identify this request. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Text | string | The result returned by the application. | The conversation appears to be a discussion between a customer service representative and a customer about a service or product, but the specific content is difficult to understand because the conversation is scattered and abstract. |
Examples
Success response
JSON format
Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | CCAI.InvalidParam.NotExist | The specified parameter %s is not valid. | The request parameter does not exist. |
| 400 | CCAI.Throttling.Qpm | Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475). | QPM throttling is triggered. For paid APIs, purchase a higher QPM. If you have special requirements for a free API, contact us through the DingTalk group (62730018475). |
| 400 | CCAI.Throttling.Qps | Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475). | Throttling is triggered. For paid APIs, purchase a higher QPS. If you have special requirements for a free API, contact us through the DingTalk group (62730018475). |
| 400 | CCAI.ParamInvalid.IllegalParamValue | The parameter value of the request API is illegal %s. | The request parameter is invalid. |
| 403 | CCAI.IllegalPermission.NoAuth | User not authorized to operate on the specified resource. | The user is not authorized to operate on the specified resource. |
| 403 | CCAI.ParamNotfound.MissParam | Parameter verification failed, The specified parameter %s is missing. | Parameter validation failed. The specified parameter is missing. |
| 403 | CCAI.TenantPermission.NoAuth | The current account does not have the permission to specify the business space. Please authorize the business space permission. | The current account does not have permission to access the specified workspace. Grant the workspace permissions. |
| 500 | CCAI.InternalError | The request processing has failed due to some unknown error, exception or failure. | Internal system error. Try again later. |