通义晓蜜CCAI-对话分析AIO
对话分析AIO，即对话分析all-in-one API，是基于深度调优的对话大模型， 为营销服类产品提供智能化升级所需的生成式摘要总结、质检、分析等能力的官方应用。
-
**面向对象：**开发者、自研企业、传统呼叫中心采购者及友商等。
-
**核心能力：**为客户提供多种规格专属模型（支持切换），并提供多指令精准执行、自带最佳实践的API及贴合业务场景的被集成方式。
-
**服务形式：**通过API服务输出给客户，方便客户进行集成和使用官方预置模板或自定义模板，客户自定义前端样式。
-
**核心价值：**免去企业SFT、探索prompt 、应用最佳实践开发的成本，使企业专注在业务逻辑的实现。
通义晓蜜的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
API目录
| API | 标题 | API概述 |
|---|---|---|
| RunCompletion | 通过模版ID调用通义晓蜜CCAI-对话分析AIO应用 | 支持调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果，应用调用支持 HTTP 调用来完成客户的响应，目前提供普通 HTTP 和 HTTP SSE 两种协议，您可根据自己的需求自行选择。 |
| RunCompletionMessage | 使用原生Prompt调用通义晓蜜CCAI-对话分析AIO应用 | 支持以Message协议格式调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果，应用调用支持 HTTP 调用来完成客户的响应，目前提供普通 HTTP 和 HTTP SSE 两种协议，您可根据自己的需求自行选择。 |
| AnalyzeConversation | 通过任务类型调用通义晓蜜CCAI-对话分析AIO应用 | 获取对话摘要、标题生成、关键词、字段信息抽取、问题及解决方案、服务质检、代办事项、满意度、情绪检测、QA抽取、用户画像、标签分类等对话分析结果，应用调用支持 HTTP 调用来完成客户的响应， |
RunCompletion - 通过模版ID调用通义晓蜜CCAI-对话分析AIO应用
支持调用通义晓蜜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代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /{workspaceId}/ccai/app/{appId}/completion
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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> | 否 | 信息抽取时，需要抽取的字段列表 | |
| object | 否 | 字段结构信息 | ||
| Code | string | 否 | 字段编码 | phoneNumber |
| Desc | string | 否 | 字段描述 | 用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。 |
| EnumValues | array<object> | 否 | 枚举值列表 | |
| object | 否 | 枚举值结构信息 | ||
| Desc | string | 否 | 枚举值描述 | 客户有新的需求/新的场景，客服跟进沟通需求细节 |
| EnumValue | string | 是 | 枚举值 | 新业务拓展 |
| Name | string | 是 | 字段名称 | 来电原因类型 |
| ModelCode | string | 否 | 模型规格 枚举值： * tyxmPlus：tyxmPlus。 * tyxmTurbo：tyxmTurbo。 | 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 列表 | |
| long | 否 | CCAI 应用下的模版 ID | 10375 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | Response 结构信息 | ||
| FinishReason | string | 如果是流式输出，正在生成时为 null，生成结束时如果由于停止 token 导致则为 stop。 | stop |
| RequestId | string | 系统生成的标志本次请求的唯一性 ID | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Text | string | 应用返回的结果。 | 这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。 |
示例
正常返回示例
JSON格式
{
"FinishReason": "stop",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA\n",
"Text": "这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\n"
}
错误码
| 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的参数不合法 |
| 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. | 当前账号没有指定业务空间的权限，请进行业务空间权限授权。 |
| 500 | CCAI.InternalError | The request processing has failed due to some unknown error, exception or failure. | 系统内部错误，请稍后重试 |
HTTP status code错误码错误信息描述
RunCompletionMessage - 使用原生Prompt调用通义晓蜜CCAI-对话分析AIO应用
支持以Message协议格式调用通义晓蜜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代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /{workspaceId}/ccai/app/{appId}/completion_message
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 子业务空间标识 | llm-ik******RVYCKzt |
| appId | string | 是 | 应用 ID | 097d65c9c7004f8dad2b454850ac232b |
| body | object | 否 | schema of request body | |
| Messages | array<object> | 是 | 模型请求 Message 列表 | |
| object | 否 | Message 结构信息 | ||
| Content | string | 是 | prompt 内容 | 如Role=system ,Content=You are a helpful assistant. Role=user , Content=请阅读以下对话内容，按照要求执行指令任务。 |
| Role | string | 是 | (通话角色) user-客户 agent-客服 system-系统消息 function-函数 | user |
| ModelCode | string | 否 | 模型规格 | tyxmTurbo |
| Stream | boolean | 否 | true 则会开启 SSE 响应，默认 false | false |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | Response 结构信息 | ||
| FinishReason | string | 如果是流式输出，正在生成时为 null，生成结束时如果由于停止 token 导致则为 stop。 | stop |
| RequestId | string | 系统生成的标志本次请求的唯一性 ID | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Text | string | 应用返回的结果。 | 这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。 |
示例
正常返回示例
JSON格式
{
"FinishReason": "stop",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA\n",
"Text": "这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。"
}
错误码
| 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的参数不合法 |
| 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. | 当前账号没有指定业务空间的权限，请进行业务空间权限授权。 |
| 500 | CCAI.InternalError | The request processing has failed due to some unknown error, exception or failure. | 系统内部错误，请稍后重试 |
HTTP status code错误码错误信息描述
AnalyzeConversation - 通过任务类型调用通义晓蜜CCAI-对话分析AIO应用
获取对话摘要、标题生成、关键词、字段信息抽取、问题及解决方案、服务质检、代办事项、满意度、情绪检测、QA抽取、用户画像、标签分类等对话分析结果，应用调用支持 HTTP 调用来完成客户的响应，
接口说明
请确保在使用该接口前，已充分了解通义晓蜜 CCAI-对话分析 AIO 产品的收费方式和价格。
前提条件
- 已开通 通义晓蜜 CCAI-对话分析 AIO 服务。
- 已创建应用：应用中心完成通义晓蜜 CCAI-对话分析 AIO 应用创建，并获取到 APP-ID 和 WORKSPACE-ID：获取APP-ID 和 WORKSPACE-ID。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /{workspaceId}/ccai/app/{appId}/analyze_conversation HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 工作空间 ID | llm-368******3ifum |
| appId | string | 是 | 应用 id。 | a070a49c681f4a95a0f0*********35c |
| body | object | 否 | 请求体。 | |
| categoryTags | array<object> | 否 | 标签分类列表 | |
| object | 否 | |||
| tagDesc | string | 否 | 标签描述 | 客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为 |
| tagName | string | 否 | 标签名称 | 客服过度承诺 |
| dialogue | object | 是 | 对话内容列表 | |
| sentences | array<object> | 是 | 对话内容 | |
| object | 是 | |||
| role | string | 是 | (通话角色) user-客户 agent-客服 system-系统消息 | user |
| text | string | 是 | 对话文本 | 请问怎么申请新卡 |
| sessionId | string | 否 | 客服会话 sessionId | session-01 |
| examples | array<object> | 否 | 指令示例列表 | |
| object | 是 | 指令示例 | ||
| output | string | 是 | 输出示例 | 问题描述：询问2.2更新时间 处理方案：已告知 |
| sentences | array<object> | 是 | 对话内容示例列表 | |
| object | 是 | 对话内容示例 | ||
| chatId | string | 否 | 每一轮对话 id | chat-01 |
| role | string | 是 | (通话角色) user-客户 agent-客服 system-系统消息 | user |
| text | string | 是 | 对话文本 | 什么时候更新 |
| fields | array<object> | 否 | 信息抽取时，需要抽取的字段列表 | |
| object | 是 | 字段结构信息 | ||
| code | string | 否 | 字段编码 | phoneNumber |
| desc | string | 是 | 字段描述 | 用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。 |
| enumValues | array<object> | 否 | 枚举值列表 | |
| object | 是 | |||
| desc | string | 是 | 枚举描述 | 客户有新的需求/新的场景，客服跟进沟通需求细节 |
| enumValue | string | 是 | 枚举值 | 新业务拓展 |
| name | string | 是 | 字段名称 | 来电原因类型 |
| modelCode | string | 否 | 模型 code | tyxmTurbo |
| resultTypes | array | 是 | 指令任务类型 | |
| string | 是 | summary-对话摘要，title-标题生成、fields-字段信息抽取、keywords -关键字抽取，service_inspection-服务质检、question_solution-问题和解决方案、actions-代办事项、satisfaction-满意度、emotion_detection-情绪检测、questions_and_answer-QA 抽取、user_profile-用户画像、category_tag-标签分类 | summary | |
| sceneName | string | 否 | 场景名称 | 阿里云工单质检场景 |
| serviceInspection | object | 否 | 服务质检结构信息 | |
| inspectionContents | array<object> | 是 | 服务质检维度结构列表 | |
| object | 是 | 服务质检维度结构 | ||
| content | string | 是 | 服务质检维度描述 | 客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。 |
| title | string | 是 | 服务质检维度名称 | 客服是否过度承诺 |
| inspectionIntroduction | string | 是 | 服务质检场景详细介绍及描述 | 请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等 |
| sceneIntroduction | string | 是 | 服务质检场景 | 保险销售场景 |
| stream | boolean | 是 | 必填。是否流式: true，流式返回答案；false，全量返回答案。 | false |
| userProfiles | array<object> | 否 | 用户画像列表 | |
| object | 否 | |||
| name | string | 否 | 名称 | sex |
| value | string | 否 | 描述 | 表示客户的性别，从列表["男", "女"]中选择一个值 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | Schema of Response | ||
| errorCode | string | 错误码 | success |
| errorInfo | string | 错误信息 | success |
| finishReason | string | 如果是流式输出，正在生成时为 null，生成结束时如果由于停止 token 导致则为 stop。 | stop |
| requestId | string | 系统生成的标志本次请求的唯一性 ID | 968A8634-FA2C-5381-9B3E-C552DED7E8BF |
| success | boolean | 请求是否成功 | True |
| text | string | 应用返回的结果。 | 这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。 |
示例
正常返回示例
JSON格式
{
"errorCode": "success",
"errorInfo": "success",
"finishReason": "stop",
"requestId": "968A8634-FA2C-5381-9B3E-C552DED7E8BF",
"success": true,
"text": "这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。"
}
错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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.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.InvalidParam.NotExist | The specified parameter %s is not valid. | 请求API的参数不存在 |
| 400 | CCAI.ParamInvalid.IllegalParamValue | The parameter value of the request API is illegal %s. | 请求API的参数不合法 |
| 403 | CCAI.IllegalPermission.NoAuth | User not authorized to operate on the specified resource. | 该用户未被授权可操作指定资源 |
| 403 | CCAI.TenantPermission.NoAuth | The current account does not have the permission to specify the business space. Please authorize the business space permission. | 当前账号没有指定业务空间的权限，请进行业务空间权限授权。 |
| 403 | CCAI.ParamNotfound.MissParam | Parameter verification failed, The specified parameter %s is missing. | 参数校验失败，指定参数缺失。 |
| 500 | CCAI.InternalError | The request processing has failed due to some unknown error, exception or failure. | 系统内部错误，请稍后重试 |
HTTP status code错误码错误信息描述