文档

RunCompletion - 通过模版ID调用通义晓蜜CCAI-对话分析AIO应用

更新时间:

支持调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果,应用调用支持 HTTP 调用来完成客户的响应,目前提供普通 HTTP 和 HTTP SSE 两种协议,您可根据自己的需求自行选择。

接口说明

请确保在使用该接口前,已充分了解通义晓蜜 CCAI-对话分析 AIO 产品的收费方式和价格。

前提条件

  1. 已开通 通义晓蜜 CCAI-对话分析 AIO 服务。
  2. 已创建应用:应用中心完成通义晓蜜 CCAI-对话分析 AIO 应用创建,并获取到 APP-ID 和 WORKSPACE-ID:获取 APP-ID 和 WORKSPACE-ID

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /{workspaceId}/ccai/app/{appId}/completion

请求参数

名称类型必填描述示例值
workspaceIdstring

子业务空间标识

llm-ik******RVYCKzt
appIdstring

应用 ID

097d65c9c7004f8dad2b454850ac232b
bodyobject

request body 结构信息

Dialogueobject

对话结构信息

Sentencesarray<object>

对话内容列表

object

每一轮对话内容的结构信息

ChatIdstring

每一轮对话内容的唯一性 ID

ae2483e01a8446aa859925947fcf4d8e
Rolestring

(通话角色) user-客户 agent-客服 system-系统消息

user
Textstring

对话内容信息

查询北京天气
SessionIdstring

对话唯一性 ID

d25zc9c7004f8dad2b454d
Fieldsarray<object>

信息抽取时,需要抽取的字段列表

object

字段结构信息

Codestring

字段编码

phoneNumber
Descstring

字段描述

用户来电咨询的原因分类,主要有投诉、咨询、政策建议等。
EnumValuesarray<object>

枚举值列表

object

枚举值结构信息

Descstring

枚举值描述

客户有新的需求/新的场景,客服跟进沟通需求细节
EnumValuestring

枚举值

新业务拓展
Namestring

字段名称

来电原因类型
ModelCodestring

模型规格

枚举值:
  • tyxmPlustyxmPlus
  • tyxmTurbotyxmTurbo
tyxmTurbo
ServiceInspectionobject

服务质检结构信息

InspectionContentsarray<object>

服务质检维度结构列表

object

服务质检维度结构

Contentstring

服务质检维度描述

客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为,如:最快到货时间是12小时,无法给客户承诺更快的到货时间。
Titlestring

服务质检维度名称

客服是否过度承诺
InspectionIntroductionstring

服务质检场景详细介绍及描述

请检测客服是否存在服务不当的行为,包括:过度承诺、故意套取客户隐私信息等
SceneIntroductionstring

服务质检场景

保险销售场景
Streamboolean

true 则会开启 SSE 响应,默认 false

false
TemplateIdsarray

CCAI 应用下的模版 ID 列表

long

CCAI 应用下的模版 ID

10375

返回参数

名称类型描述示例值
object

Response 结构信息

FinishReasonstring

如果是流式输出,正在生成时为 null,生成结束时如果由于停止 token 导致则为 stop。

stop
RequestIdstring

系统生成的标志本次请求的唯一性 ID

17204B98-xxxx-4F9A-8464-2446A84821CA
Textstring

应用返回的结果。

这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。

示例

正常返回示例

JSON格式

{
  "FinishReason": "stop",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA\n",
  "Text": "这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。\n"
}

错误码

HTTP status code错误码错误信息描述
400CCAI.InvalidParam.NotExistThe specified parameter %s is not valid.请求API的参数不存在
400CCAI.Throttling.QpmTrigger 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)联系我们。
400CCAI.Throttling.QpsTrigger 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)联系我们。
400CCAI.ParamInvalid.IllegalParamValueThe parameter value of the request API is illegal %s.请求API的参数不合法
403CCAI.IllegalPermission.NoAuthUser not authorized to operate on the specified resource.该用户未被授权可操作指定资源
403CCAI.ParamNotfound.MissParamParameter verification failed, The specified parameter %s is missing.参数校验失败,指定参数缺失。
403CCAI.TenantPermission.NoAuthThe current account does not have the permission to specify the business space. Please authorize the business space permission.当前账号没有指定业务空间的权限,请进行业务空间权限授权。
500CCAI.InternalErrorThe request processing has failed due to some unknown error, exception or failure.系统内部错误,请稍后重试

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-14OpenAPI 错误码发生变更查看变更详情