文档

RunCompletionMessage - 使用原生Prompt调用通义晓蜜CCAI-对话分析AIO应用

更新时间:

支持以Message协议格式调用通义晓蜜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_message

请求参数

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

子业务空间标识

llm-ik******RVYCKzt
appIdstring

应用 ID

097d65c9c7004f8dad2b454850ac232b
bodyobject

schema of request body

Messagesarray<object>

模型请求 Message 列表

object

Message 结构信息

Contentstring

prompt 内容

如Role=system ,Content=You are a helpful assistant. Role=user , Content=请阅读以下对话内容,按照要求执行指令任务。
Rolestring

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

user
ModelCodestring

模型规格

tyxmTurbo
Streamboolean

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

false

返回参数

名称类型描述示例值
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": "这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。"
}

错误码

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.系统内部错误,请稍后重试

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