支持调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果,应用调用支持 HTTP 调用来完成客户的响应,目前提供普通 HTTP 和 HTTP SSE 两种协议,您可根据自己的需求自行选择。
接口说明
请确保在使用该接口前,已充分了解通义晓蜜 CCAI-对话分析 AIO 产品的收费方式和价格。
前提条件
已开通通义晓蜜 CCAI-对话分析 AIO 服务。
已创建应用:应用中心完成通义晓蜜 CCAI-对话分析 AIO 应用创建,并获取到 APP-ID 和 WORKSPACE-ID:获取 APP-ID 和 WORKSPACE-ID。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /{workspaceId}/ccai/app/{appId}/completion HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
是 |
子业务空间标识 |
llm-ik******RVYCKzt |
| appId |
string |
是 |
应用 ID |
097d65c9c7004f8dad2b454850ac232b |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
request body 结构信息 |
|
| Dialogue |
object |
是 |
对话结构信息 |
|
| Sentences |
array<object> |
否 |
对话内容列表 |
|
|
object |
否 |
每一轮对话内容的结构信息 |
||
| ChatId |
string |
否 |
每一轮对话内容的唯一性 ID |
ae2483e01a8446aa859925947fcf4d8e |
| Role |
string |
是 |
(通话角色) user-客户 agent-客服 system-系统消息 |
user |
| Text |
string |
是 |
对话内容信息 |
查询北京天气 |
| SessionId |
string |
否 |
对话唯一性 ID |
d25zc9c7004f8dad2b454d |
| Fields |
array<object> |
否 |
信息抽取时,需要抽取的字段列表 |
|
|
array<object> |
否 |
字段结构信息 |
||
| Code |
string |
否 |
字段编码 |
phoneNumber |
| Desc |
string |
否 |
字段描述 |
用户来电咨询的原因分类,主要有投诉、咨询、政策建议等。 |
| EnumValues |
array<object> |
否 |
枚举值列表 |
|
|
object |
否 |
枚举值结构信息 |
||
| Desc |
string |
否 |
枚举值描述 |
客户有新的需求/新的场景,客服跟进沟通需求细节 |
| EnumValue |
string |
是 |
枚举值 |
新业务拓展 |
| Name |
string |
是 |
字段名称 |
来电原因类型 |
| ModelCode |
string |
否 |
模型规格 枚举值:
|
tyxmTurbo |
| ServiceInspection |
object |
否 |
服务质检结构信息 |
|
| InspectionContents |
array<object> |
否 |
服务质检维度结构列表 |
|
|
object |
否 |
服务质检维度结构 |
||
| Content |
string |
否 |
服务质检维度描述 |
客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为,如:最快到货时间是12小时,无法给客户承诺更快的到货时间。 |
| Title |
string |
是 |
服务质检维度名称 |
客服是否过度承诺 |
| InspectionIntroduction |
string |
否 |
服务质检场景详细介绍及描述 |
请检测客服是否存在服务不当的行为,包括:过度承诺、故意套取客户隐私信息等 |
| SceneIntroduction |
string |
否 |
服务质检场景 |
保险销售场景 |
| Stream |
boolean |
否 |
true 则会开启 SSE 响应,默认 false 枚举值:
|
false |
| TemplateIds |
array |
是 |
CCAI 应用下的模版 ID 列表 |
|
|
integer |
否 |
CCAI 应用下的模版 ID |
10375 |
|
| variables |
array<object> |
否 |
变量列表 |
|
|
object |
否 |
变量列表 |
||
| variableCode |
string |
否 |
变量 code |
name |
| variableValue |
string |
否 |
变量值 |
张三 |
| responseFormatType |
string |
否 |
输出结果格式化类型,jsonObject-json 结构,text-原始字符串 |
jsonObject |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Response 结构信息 |
||
| FinishReason |
string |
如果是流式输出,正在生成时为 null,生成结束时如果由于停止 token 导致则为 stop。 |
stop |
| RequestId |
string |
系统生成的标志本次请求的唯一性 ID |
17204B98-xxxx-4F9A-8464-2446A84821CA |
| Text |
string |
应用返回的结果。 |
这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。 |
| inputTokens |
string |
输入 Token 数量 |
4672 |
| outputTokens |
string |
输出 Token 数量 |
621 |
| totalTokens |
string |
Tokens 总量 |
5609 |
| usage |
object |
||
| rag |
object |
||
| dialogSummary |
object |
||
| inputTokens |
integer |
||
| outputTokens |
integer |
||
| invokeCount |
integer |
||
| adaptive |
object |
||
| inputTokens |
integer |
||
| outputTokens |
integer |
||
| invokeCount |
integer |
||
| ragStatus |
string |
示例
正常返回示例
JSON格式
{
"FinishReason": "stop",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA\n",
"Text": "这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。\n",
"inputTokens": "4672",
"outputTokens": "621",
"totalTokens": "5609",
"usage": {
"rag": {
"dialogSummary": {
"inputTokens": 0,
"outputTokens": 0,
"invokeCount": 0
},
"adaptive": {
"inputTokens": 0,
"outputTokens": 0,
"invokeCount": 0
}
}
},
"ragStatus": ""
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | CCAI.InvalidParam.NotExist | The specified parameter %s is not valid. | 请求API的参数不存在 |
| 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限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(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). | 触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。 |
| 400 | CCAI.ParamInvalid.IllegalParamValue | The parameter value of the request API is illegal %s. | 请求API的参数不合法 |
| 500 | CCAI.InternalError | The request processing has failed due to some unknown error, exception or failure. | 系统内部错误,请稍后重试 |
| 403 | CCAI.IllegalPermission.NoAuth | User not authorized to operate on the specified resource. | 该用户未被授权可操作指定资源 |
| 403 | CCAI.ParamNotfound.MissParam | Parameter verification failed, The specified parameter %s 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. | 当前账号没有指定业务空间的权限,请进行业务空间权限授权。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。