diff options
Diffstat (limited to 'data/zh_cn/contactcenterai/2024-06-03')
| -rw-r--r-- | data/zh_cn/contactcenterai/2024-06-03/api-docs.php | 3756 |
1 files changed, 1093 insertions, 2663 deletions
diff --git a/data/zh_cn/contactcenterai/2024-06-03/api-docs.php b/data/zh_cn/contactcenterai/2024-06-03/api-docs.php index dde22d6..aecebfb 100644 --- a/data/zh_cn/contactcenterai/2024-06-03/api-docs.php +++ b/data/zh_cn/contactcenterai/2024-06-03/api-docs.php @@ -1,10 +1,6 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'ContactCenterAI', - 'version' => '2024-06-03', - ], + 'info' => ['style' => 'ROA', 'product' => 'ContactCenterAI', 'version' => '2024-06-03'], 'directories' => [ 'RunCompletion', 'RunCompletionMessage', @@ -14,558 +10,173 @@ 'AnalyzeImage', 'GeneralAnalyzeImage', [ - 'id' => 203152, - 'title' => '热词管理', + 'children' => ['CreateVocab', 'UpdateVocab', 'ListVocab', 'DeleteVocab', 'GetVocab'], 'type' => 'directory', - 'children' => [ - 'CreateVocab', - 'UpdateVocab', - 'ListVocab', - 'DeleteVocab', - 'GetVocab', - ], + 'title' => '热词管理', + 'id' => 335503, ], [ - 'id' => 204673, - 'title' => '不推荐或白名单开放', + 'children' => ['AnalyzeAudioSync'], 'type' => 'directory', - 'children' => [ - 'AnalyzeAudioSync', - ], + 'title' => '不推荐或白名单开放', + 'id' => 335509, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'RunCompletion' => [ - 'summary' => '支持调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果，应用调用支持 HTTP 调用来完成客户的响应，目前提供普通 HTTP 和 HTTP SSE 两种协议，您可根据自己的需求自行选择。', - 'path' => '/{workspaceId}/ccai/app/{appId}/completion', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - 'sse', - ], + 'AnalyzeAudioSync' => [ + 'summary' => '对进行语音文件进行实时对话分析。应用调用支持 HTTPS 调用来完成客户的响应。', + 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeAudioSync', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '子业务空间标识', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], + 'schema' => ['description' => '业务空间Id', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n"], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => '应用ID', - 'type' => 'string', - 'required' => true, - 'example' => '097d65c9c7004f8dad2b454850ac232b', - ], + 'schema' => ['description' => '应用id', 'type' => 'string', 'required' => true, 'example' => 'a070a49c681f4a95a0f0*********35c'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'request body结构信息', + 'description' => '请求体', 'type' => 'object', 'properties' => [ - 'Dialogue' => [ - 'description' => '对话结构信息', - 'type' => 'object', - 'properties' => [ - 'Sentences' => [ - 'description' => '对话内容列表', - 'type' => 'array', - 'items' => [ - 'description' => '每一轮对话内容的结构信息', - 'type' => 'object', - 'properties' => [ - 'ChatId' => [ - 'description' => '每一轮对话内容的唯一性ID', - 'type' => 'string', - 'required' => false, - 'example' => 'ae2483e01a8446aa859925947fcf4d8e', - ], - 'Role' => [ - 'description' => '（通话角色） user-客户 agent-客服 system-系统消息', - 'type' => 'string', - 'required' => true, - 'example' => 'user', - 'default' => 'user', - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'Text' => [ - 'description' => '对话内容信息', - 'type' => 'string', - 'required' => true, - 'example' => '查询北京天气', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'SessionId' => [ - 'description' => '对话唯一性ID', - 'type' => 'string', - 'required' => false, - 'example' => 'd25zc9c7004f8dad2b454d', - ], - ], - 'required' => true, - ], - 'Fields' => [ - 'description' => '信息抽取时，需要抽取的字段列表', + 'modelCode' => ['description' => '模型code', 'type' => 'string', 'required' => false, 'example' => 'tyxmTurbo'], + 'fields' => [ + 'description' => '字段结构信息', 'type' => 'array', 'items' => [ 'description' => '字段结构信息', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '字段编码', - 'type' => 'string', - 'required' => false, - 'example' => 'phoneNumber', - ], - 'Desc' => [ - 'description' => '字段描述', - 'type' => 'string', - 'required' => false, - 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。', - ], - 'EnumValues' => [ + 'code' => ['description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n"], + 'name' => ['description' => '字段名称', 'type' => 'string', 'required' => false, 'example' => '来电原因类型'."\n"], + 'desc' => ['description' => '字段描述', 'type' => 'string', 'required' => false, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n"], + 'enumValues' => [ 'description' => '枚举值列表', 'type' => 'array', 'items' => [ - 'description' => '枚举值结构信息', + 'description' => '枚举值列表', 'type' => 'object', 'properties' => [ - 'Desc' => [ - 'description' => '枚举值描述', - 'type' => 'string', - 'required' => false, - 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节', - ], - 'EnumValue' => [ - 'description' => '枚举值', - 'type' => 'string', - 'required' => true, - 'example' => '新业务拓展', - ], + 'desc' => ['description' => '枚举描述', 'type' => 'string', 'required' => false, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n"], + 'enumValue' => ['description' => '枚举值', 'type' => 'string', 'required' => false, 'example' => '新业务拓展'."\n"], ], 'required' => false, ], 'required' => false, ], - 'Name' => [ - 'description' => '字段名称', - 'type' => 'string', - 'required' => true, - 'example' => '来电原因类型', - ], ], 'required' => false, ], 'required' => false, ], - 'ModelCode' => [ - 'description' => '模型规格', - 'type' => 'string', + 'resultTypes' => [ + 'description' => '任务类型', + 'type' => 'array', + 'items' => ['description' => 'summary-对话摘要，title-标题生成、fields-字段信息抽取、keywords -关键字抽取，service_inspection-服务质检、question_solution-问题和解决方案、questions_and_answer-QA抽取、custom_prompt-自定义指令', 'type' => 'string', 'required' => true, 'example' => 'summary'], 'required' => false, - 'enumValueTitles' => [ - 'tyxmPlus' => 'tyxmPlus', - 'tyxmTurbo' => 'tyxmTurbo', - ], - 'example' => 'tyxmTurbo', - 'default' => 'tyxmTurbo', - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], ], - 'ServiceInspection' => [ + 'serviceInspection' => [ 'description' => '服务质检结构信息', 'type' => 'object', 'properties' => [ - 'InspectionContents' => [ - 'description' => '服务质检维度结构列表', + 'inspectionContents' => [ + 'description' => '质检项列表', 'type' => 'array', 'items' => [ - 'description' => '服务质检维度结构', + 'description' => '质检项结构', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => '服务质检维度描述', - 'type' => 'string', - 'required' => false, - 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。', - ], - 'Title' => [ - 'description' => '服务质检维度名称', - 'type' => 'string', - 'required' => true, - 'example' => '客服是否过度承诺', - ], + 'content' => ['description' => '质检项描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。'], + 'title' => ['description' => '质检名称', 'type' => 'string', 'required' => false, 'example' => '客服是否过度承诺'."\n"], ], 'required' => false, ], 'required' => false, ], - 'InspectionIntroduction' => [ - 'description' => '服务质检场景详细介绍及描述', - 'type' => 'string', - 'required' => false, - 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等', - ], - 'SceneIntroduction' => [ - 'description' => '服务质检场景', - 'type' => 'string', - 'required' => false, - 'example' => '保险销售场景', - ], + 'inspectionIntroduction' => ['description' => '服务质检场景详细介绍及描述', 'type' => 'string', 'required' => false, 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等'], + 'sceneIntroduction' => ['description' => '服务质检场景', 'type' => 'string', 'required' => false, 'example' => '保险销售场景'."\n"], ], 'required' => false, ], - 'Stream' => [ - 'description' => 'true则会开启 SSE 响应，默认false', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'false', - 'default' => 'false', - ], - 'TemplateIds' => [ - 'description' => 'CCAI应用下的模版ID 列表', + 'templateIds' => [ + 'description' => '模版id', 'type' => 'array', - 'items' => [ - 'description' => 'CCAI应用下的模版ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10375', - ], - 'required' => true, + 'items' => ['description' => '模版id，模版id和指令任务类型同时存在时，优先使用模版id', 'type' => 'string', 'required' => false, 'example' => '34'], + 'required' => false, ], - 'variables' => [ - 'description' => '变量列表', + 'categoryTags' => [ + 'description' => '标签分类列表', 'type' => 'array', 'items' => [ - 'description' => '变量列表', + 'description' => '标签分类列表', 'type' => 'object', 'properties' => [ - 'variableCode' => [ - 'description' => '变量code', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'variableValue' => [ - 'description' => '变量值', - 'type' => 'string', - 'required' => false, - 'example' => '张三', - ], + 'tagName' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺'], + 'tagDesc' => ['description' => '标签描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为'], ], 'required' => false, ], 'required' => false, ], - 'responseFormatType' => [ - 'description' => '输出结果格式化类型，jsonObject-json结构，text-原始字符串', - 'type' => 'string', - 'required' => false, - 'example' => 'jsonObject', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Response结构信息', - 'type' => 'object', - 'properties' => [ - 'FinishReason' => [ - 'description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', - 'type' => 'string', - 'example' => 'stop', - ], - 'RequestId' => [ - 'description' => '系统生成的标志本次请求的唯一性ID', - 'type' => 'string', - 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n", - ], - 'Text' => [ - 'description' => '应用返回的结果。', - 'type' => 'string', - 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。'."\n", - ], - 'inputTokens' => [ - 'description' => '输入Token数量', - 'type' => 'string', - 'example' => '4672', - ], - 'outputTokens' => [ - 'description' => '输出Token数量', - 'type' => 'string', - 'example' => '621', - ], - 'totalTokens' => [ - 'description' => 'Tokens总量', - 'type' => 'string', - 'example' => '5609', - ], - 'usage' => [ + 'customPrompt' => ['description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结'], + 'transcription' => [ + 'description' => '语音类型执行参数', 'type' => 'object', 'properties' => [ - 'rag' => [ - 'type' => 'object', - 'properties' => [ - 'dialogSummary' => [ - 'type' => 'object', - 'properties' => [ - 'inputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'outputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'invokeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'adaptive' => [ - 'type' => 'object', - 'properties' => [ - 'inputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'outputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'invokeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], + 'autoSplit' => ['description' => '多数情况下适用于单轨录音，取值：0、1，是否自动分轨，1 为自动分轨，0 为不分轨；默认：1；若指定为 1，则表示上传的音频为单轨；自动分轨会额外占用处理时间。若录音为双轨录音，该参数必须传 0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'clientChannel' => ['description' => '适用于双轨录音，指定客户角色的轨道编号，取值：0、1，默认 1，即第 1 轨为客户；通常音轨都是从 0 开始编号，2 个轨就是 0，1；具体 0 是客服还是客户，需要您自行确认。**若使用此参数，请务必传入 autoSplit 参数，值为 0。**单轨文件忽略此参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'serviceChannel' => ['description' => '适用于双轨录音，指定客服角色的轨道编号，取值：0、1，默认 0，即第 0 轨为客服；通常音轨都是从 0 开始编号，2 个轨就是 0，1；具体 0 是客服还是客户，需要您自行确认。**若使用此参数，请务必传入 autoSplit 参数，值为 0。**若单轨文件忽略此参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'fileName' => ['description' => '文件名。', 'type' => 'string', 'required' => true, 'example' => 'sss.mp3'], + 'voiceFileUrl' => ['description' => '文件地址', 'type' => 'string', 'required' => true, 'example' => 'http://1111.com/sss.mp3'], + 'serviceChannelKeywords' => [ + 'description' => '客服通话关键字列表', + 'type' => 'array', + 'items' => ['description' => '多数情况下适用于单轨录音，设置一组客服可能说的关键词列表（请确保选择那些区别性比较高的关键词），通过对转写文本从上到下逐句分析，当一句话命中某一个关键词时，则判定该句的角色为客服，则另一个角色就是客户。', 'type' => 'string', 'required' => false, 'example' => '你好'], + 'required' => false, ], + 'asrModelCode' => ['description' => '语音转写模型，取值 nls （小模型），paraformer（大模型）', 'type' => 'string', 'required' => false, 'example' => 'nls'], + 'vocabularyId' => ['description' => '语音热词id', 'type' => 'string', 'required' => false, 'example' => 'esnvknv*****skdnvjksd'], + 'level' => ['description' => '语音转写优先级', 'type' => 'string', 'required' => false, 'example' => 'low'], ], + 'required' => false, ], - 'ragStatus' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - ], - 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], - ], - 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\\\n\\",\\n \\"inputTokens\\": \\"4672\\",\\n \\"outputTokens\\": \\"621\\",\\n \\"totalTokens\\": \\"5609\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"invokeCount\\": 0\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"invokeCount\\": 0\\n }\\n }\\n },\\n \\"ragStatus\\": \\"\\"\\n}","type":"json"}]', - 'title' => '通过模版ID调用通义晓蜜CCAI-对话分析AIO应用', - 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" - ."\n" - .'前提条件'."\n" - .'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" - .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/document_detail/2782167.html?spm=a2c4g.2782164.0.0.2b2b6dcdZZ5oUE)。', - ], - 'RunCompletionMessage' => [ - 'summary' => '支持以Message协议格式调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果，应用调用支持 HTTP 调用来完成客户的响应，目前提供普通 HTTP 和 HTTP SSE 两种协议，您可根据自己的需求自行选择。', - 'path' => '/{workspaceId}/ccai/app/{appId}/completion_message', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - 'sse', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '子业务空间标识', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => '应用ID', - 'type' => 'string', - 'required' => true, - 'example' => '097d65c9c7004f8dad2b454850ac232b', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'schema of request body', - 'type' => 'object', - 'properties' => [ - 'Messages' => [ - 'description' => '模型请求Message列表', + 'variables' => [ + 'description' => '变量列表', 'type' => 'array', 'items' => [ - 'description' => 'Message结构信息', + 'description' => '变量列表', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => 'prompt内容', - 'type' => 'string', - 'required' => true, - 'example' => '如Role=system ,Content=You are a helpful assistant.'."\n" - .'Role=user , Content=请阅读以下对话内容，按照要求执行指令任务。', - ], - 'Role' => [ - 'description' => '（通话角色） user-客户 agent-客服 system-系统消息 function-函数', - 'type' => 'string', - 'required' => true, - 'example' => 'user', - 'enum' => [ - 'user', - 'assistant', - 'system', - 'function', - ], - ], + 'variableCode' => ['description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'variableValue' => ['description' => '变量值', 'type' => 'string', 'required' => false, 'example' => '张三'], ], 'required' => false, ], - 'required' => true, - ], - 'ModelCode' => [ - 'description' => '模型规格', - 'type' => 'string', - 'required' => false, - 'example' => 'tyxmTurbo', - 'default' => 'tyxmTurbo', - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], - ], - 'Stream' => [ - 'description' => 'true则会开启 SSE 响应，默认false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'responseFormatType' => [ - 'type' => 'string', 'required' => false, ], + 'responseFormatType' => ['description' => '输出结果格式化类型，jsonObject-json结构，text-原始字符串', 'type' => 'string', 'required' => false, 'example' => 'jsonObject'], + 'stream' => ['description' => '是否流式返回结果，流式返回-true，全量返回-false', 'type' => 'boolean', 'required' => true, 'example' => 'false'], ], 'required' => false, ], @@ -574,137 +185,129 @@ 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Response结构信息', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'FinishReason' => [ - 'description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', - 'type' => 'string', - 'example' => 'stop', - ], - 'RequestId' => [ - 'description' => '系统生成的标志本次请求的唯一性ID', - 'type' => 'string', - 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n", - ], - 'Text' => [ - 'description' => '应用返回的结果。', - 'type' => 'string', - 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。', - ], - 'inputTokens' => [ - 'type' => 'string', - ], - 'outputTokens' => [ - 'type' => 'string', - ], - 'totalTokens' => [ - 'type' => 'string', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'finishReason' => ['description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'], + 'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'], + 'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。'], + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'string', 'example' => '1000'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'string', 'example' => '2000'], + 'totalTokens' => ['description' => 'Tokens总量', 'type' => 'string', 'example' => '3000'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"\\",\\n \\"outputTokens\\": \\"\\",\\n \\"totalTokens\\": \\"\\"\\n}","type":"json"}]', - 'title' => '使用原生Prompt调用通义晓蜜CCAI-对话分析AIO应用', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]', + 'title' => '语音文件实时分析', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" ."\n" - .'前提条件'."\n" - .'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" - .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/document_detail/2782167.html?spm=a2c4g.2782164.0.0.2b2b6dcdZZ5oUE)。', + .'## 前提条件'."\n" + ."\n" + .'- 1.已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" + .'- 2.已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.3491281fOQZK5f)。'."\n" + ."\n" + .'## 注意事项'."\n" + ."\n" + .'- 1.超过3分钟的音频请使用离线任务分析。'."\n" + .'- 2.目前支持双轨录音文件，并且需要指定声轨对应的角色。', + 'requestParamsDescription' => '## 接口请求示例'."\n" + .'```java'."\n" + ."\n" + .'import com.alibaba.fastjson.JSONObject;'."\n" + .'import com.aliyun.contactcenterai20240603.Client;'."\n" + .'import com.aliyun.contactcenterai20240603.models.AnalyzeAudioSyncRequest;'."\n" + .'import com.aliyun.contactcenterai20240603.models.AnalyzeAudioSyncResponse;'."\n" + ."\n" + .'import com.aliyun.teaopenapi.models.Config;'."\n" + ."\n" + .'import java.util.ArrayList;'."\n" + .'import java.util.List;'."\n" + ."\n" + .'public class CCAiTask {'."\n" + ."\n" + .' public static void main(String[] args) throws Exception {'."\n" + .' String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n" + .' String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n" + .' String workspaceId = "YOUR_WORKSPACEID";'."\n" + .' String appId = "YOUR_APPID";'."\n" + ."\n" + .' Config config = new Config();'."\n" + .' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n" + .' .setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n" + ."\n" + .' Client client = new Client(config);'."\n" + ."\n" + .' AnalyzeAudioSyncRequest request = new AnalyzeAudioSyncRequest();'."\n" + .' request.setStream(false);'."\n" + ."\n" + .' request.setModelCode("tyxmPlus");'."\n" + ."\n" + .' List<String> typeList = new ArrayList<>();'."\n" + .' typeList.add("summary");'."\n" + .' request.setResultTypes(typeList);'."\n" + ."\n" + .' AnalyzeAudioSyncRequest.AnalyzeAudioSyncRequestTranscription transcription = new AnalyzeAudioSyncRequest.AnalyzeAudioSyncRequestTranscription();'."\n" + .' transcription.setFileName("out**.wav");'."\n" + .' transcription.setVoiceFileUrl("https://age***.com/out**.wav");'."\n" + .' transcription.setServiceChannel(1);'."\n" + .' transcription.setClientChannel(0);'."\n" + ."\n" + .' request.setTranscription(transcription);'."\n" + ."\n" + .' AnalyzeAudioSyncResponse response = client.analyzeAudioSync(workspaceId, appId, request);'."\n" + .' System.out.println(JSONObject.toJSONString(response));'."\n" + .' }'."\n" + .' '."\n" + .'}'."\n" + ."\n" + .'```', + 'changeSet' => [], ], 'AnalyzeConversation' => [ 'summary' => '获取对话摘要、标题生成、关键词、字段信息抽取、问题及解决方案、服务质检、代办事项、满意度、情绪检测、QA抽取、用户画像、标签分类等对话分析结果，应用调用支持 HTTP 调用来完成客户的响应。', 'path' => '/{workspaceId}/ccai/app/{appId}/analyze_conversation', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/octet-stream', - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/octet-stream', 'application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-368******3ifum', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-368******3ifum'], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => '应用id。', - 'type' => 'string', - 'required' => true, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], + 'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => true, 'example' => 'a070a49c681f4a95a0f0*********35c'], ], [ 'name' => 'body', @@ -720,20 +323,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'tagDesc' => [ - 'description' => '标签描述', - 'type' => 'string', - 'required' => false, - 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为', - ], - 'tagName' => [ - 'description' => '标签名称', - 'type' => 'string', - 'required' => false, - 'example' => '客服过度承诺', - ], + 'tagDesc' => ['description' => '标签描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为'], + 'tagName' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺'], ], 'required' => false, + 'description' => '', ], 'required' => false, ], @@ -758,29 +352,16 @@ 'type' => 'string', 'required' => true, 'example' => 'user', - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'text' => [ - 'description' => '对话文本', - 'type' => 'string', - 'required' => true, - 'example' => '请问怎么申请新卡'."\n", + 'enum' => ['user', 'agent', 'system'], ], + 'text' => ['description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '请问怎么申请新卡'."\n"], ], 'required' => true, + 'description' => '', ], 'required' => true, ], - 'sessionId' => [ - 'description' => '客服会话sessionId', - 'type' => 'string', - 'required' => false, - 'example' => 'session-01', - ], + 'sessionId' => ['description' => '客服会话sessionId', 'type' => 'string', 'required' => false, 'example' => 'session-01'], ], 'required' => false, ], @@ -791,12 +372,7 @@ 'description' => '指令示例', 'type' => 'object', 'properties' => [ - 'output' => [ - 'description' => '输出示例', - 'type' => 'string', - 'required' => true, - 'example' => '问题描述：询问2.2更新时间，处理方案：已告知', - ], + 'output' => ['description' => '输出示例', 'type' => 'string', 'required' => true, 'example' => '问题描述：询问2.2更新时间，处理方案：已告知'], 'sentences' => [ 'description' => '对话内容示例列表', 'type' => 'array', @@ -804,12 +380,7 @@ 'description' => '对话内容示例', 'type' => 'object', 'properties' => [ - 'chatId' => [ - 'description' => '每一轮对话id', - 'type' => 'string', - 'required' => false, - 'example' => 'chat-01', - ], + 'chatId' => ['description' => '每一轮对话id', 'type' => 'string', 'required' => false, 'example' => 'chat-01'], 'role' => [ 'description' => '通话角色：'."\n" ."\n" @@ -821,18 +392,9 @@ 'type' => 'string', 'required' => true, 'example' => 'user', - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'text' => [ - 'description' => '对话文本', - 'type' => 'string', - 'required' => true, - 'example' => '什么时候更新', + 'enum' => ['user', 'agent', 'system'], ], + 'text' => ['description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '什么时候更新'], ], 'required' => true, ], @@ -850,47 +412,23 @@ 'description' => '字段结构信息', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '字段编码', - 'type' => 'string', - 'required' => false, - 'example' => 'phoneNumber'."\n", - ], - 'desc' => [ - 'description' => '字段描述', - 'type' => 'string', - 'required' => true, - 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n", - ], + 'code' => ['description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n"], + 'desc' => ['description' => '字段描述', 'type' => 'string', 'required' => true, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n"], 'enumValues' => [ 'description' => '枚举值列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'desc' => [ - 'description' => '枚举描述', - 'type' => 'string', - 'required' => true, - 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n", - ], - 'enumValue' => [ - 'description' => '枚举值', - 'type' => 'string', - 'required' => true, - 'example' => '新业务拓展'."\n", - ], + 'desc' => ['description' => '枚举描述', 'type' => 'string', 'required' => true, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n"], + 'enumValue' => ['description' => '枚举值', 'type' => 'string', 'required' => true, 'example' => '新业务拓展'."\n"], ], 'required' => true, + 'description' => '', ], 'required' => false, ], - 'name' => [ - 'description' => '字段名称', - 'type' => 'string', - 'required' => true, - 'example' => '来电原因类型'."\n", - ], + 'name' => ['description' => '字段名称', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'."\n"], ], 'required' => true, ], @@ -902,47 +440,21 @@ 'required' => false, 'example' => 'tyxmTurbo', 'default' => 'tyxmTurbo', - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], + 'enum' => ['tyxmTurbo', 'tyxmPlus'], ], 'resultTypes' => [ 'description' => '指令任务类型', 'type' => 'array', 'items' => [ - 'description' => 'summary-对话摘要，title-标题生成、fields-字段信息抽取、keywords -关键字抽取，service_inspection-服务质检、question_solution-问题和解决方案、actions-代办事项、satisfaction-满意度、emotion_detection-情绪检测、questions_and_answer-QA抽取、user_profile-用户画像、category_tag-标签分类', + 'description' => 'summary-对话摘要，title-标题生成、fields-字段信息抽取、keywords -关键字抽取，service_inspection-服务质检、question_solution-问题和解决方案、actions-代办事项、satisfaction-满意度、emotion_detection-情绪检测、questions_and_answer-QA抽取、user_profile-用户画像、category_tag-标签分类、custom_prompt-自定义指令', 'type' => 'string', 'required' => true, 'example' => 'summary', - 'enum' => [ - 'summary', - 'title', - 'fields', - 'keywords', - 'service_inspection', - 'question_solution', - 'questions_and_answer', - 'user_profile', - 'category_tag', - 'emotion_detection', - 'satisfaction', - 'actions', - 'service_finish', - 'label_classification', - 'analysis_image', - 'custom_prompt', - 'dianxiao_summary', - ], + 'enum' => ['summary', 'title', 'fields', 'keywords', 'service_inspection', 'question_solution', 'questions_and_answer', 'user_profile', 'category_tag', 'emotion_detection', 'satisfaction', 'actions', 'service_finish', 'label_classification', 'analysis_image', 'custom_prompt', 'dianxiao_summary'], ], 'required' => true, ], - 'sceneName' => [ - 'description' => '场景名称', - 'type' => 'string', - 'required' => false, - 'example' => '阿里云工单质检场景'."\n", - ], + 'sceneName' => ['description' => '场景名称', 'type' => 'string', 'required' => false, 'example' => '阿里云工单质检场景'."\n"], 'serviceInspection' => [ 'description' => '服务质检结构信息', 'type' => 'object', @@ -954,87 +466,42 @@ 'description' => '服务质检维度结构', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '服务质检维度描述', - 'type' => 'string', - 'required' => true, - 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。', - ], - 'title' => [ - 'description' => '服务质检维度名称', - 'type' => 'string', - 'required' => true, - 'example' => '客服是否过度承诺'."\n", - ], + 'content' => ['description' => '服务质检维度描述', 'type' => 'string', 'required' => true, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。'], + 'title' => ['description' => '服务质检维度名称', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺'."\n"], ], 'required' => true, ], 'required' => true, ], - 'inspectionIntroduction' => [ - 'description' => '服务质检场景详细介绍及描述', - 'type' => 'string', - 'required' => true, - 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等', - ], - 'sceneIntroduction' => [ - 'description' => '服务质检场景', - 'type' => 'string', - 'required' => true, - 'example' => '保险销售场景'."\n", - ], + 'inspectionIntroduction' => ['description' => '服务质检场景详细介绍及描述', 'type' => 'string', 'required' => true, 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等'], + 'sceneIntroduction' => ['description' => '服务质检场景', 'type' => 'string', 'required' => true, 'example' => '保险销售场景'."\n"], ], 'required' => false, ], - 'stream' => [ - 'description' => '必填。是否流式：true，流式返回答案；false，全量返回答案。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'stream' => ['description' => '必填。是否流式：true，流式返回答案；false，全量返回答案。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], 'userProfiles' => [ 'description' => '用户画像列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '名称', - 'type' => 'string', - 'required' => false, - 'example' => 'sex', - ], - 'value' => [ - 'description' => '描述', - 'type' => 'string', - 'required' => false, - 'example' => '表示客户的性别，从列表[“男”, “女”]中选择一个值', - ], + 'name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'sex'], + 'value' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => '表示客户的性别，从列表[“男”, “女”]中选择一个值'], ], 'required' => false, + 'description' => '', ], 'required' => false, ], 'timeConstraintList' => [ + 'description' => '时间约束，用于告诉大模型在做分析时，需要关注或限定在哪些时间范围内', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, - ], - 'sourceCallerUid' => [ - 'type' => 'string', - 'required' => false, - ], - 'customPrompt' => [ - 'type' => 'string', - 'required' => false, - ], - 'responseFormatType' => [ - 'type' => 'string', + 'items' => ['description' => '时间信息', 'type' => 'string', 'required' => false, 'example' => '2026年1月'], 'required' => false, ], + 'sourceCallerUid' => ['description' => '不用填', 'type' => 'string', 'required' => false, 'example' => 'null'], + 'customPrompt' => ['description' => '自定义指令，指令中必须包含${dialogue}', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结${dialogue}'], + 'responseFormatType' => ['description' => '输出结果格式化类型，jsonObject-json结构，text-原始字符串', 'type' => 'string', 'required' => false, 'example' => 'jsonObject'], ], 'required' => false, ], @@ -1047,94 +514,37 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'errorCode' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => 'success', - ], - 'errorInfo' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'success', - ], - 'finishReason' => [ - 'description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', - 'type' => 'string', - 'example' => 'stop', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '系统生成的标志本次请求的唯一性ID', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'True', - ], - 'text' => [ - 'description' => '应用返回的结果。', - 'type' => 'string', - 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。', - ], - 'inputTokens' => [ - 'type' => 'string', - ], - 'outputTokens' => [ - 'type' => 'string', - ], - 'totalTokens' => [ - 'type' => 'string', - ], + 'errorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'], + 'errorInfo' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'], + 'finishReason' => ['description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'], + 'requestId' => ['title' => 'Id of the request', 'description' => '系统生成的标志本次请求的唯一性ID', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF'], + 'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'], + 'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。'], + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'string', 'example' => '238'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'string', 'example' => '458'], + 'totalTokens' => ['description' => 'Tokens总量', 'type' => 'string', 'example' => '696'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], ], 403 => [ - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource %s .', - ], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource %s .', 'description' => '该用户未被授权可操作指定资源'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"errorCode\\": \\"success\\",\\n \\"errorInfo\\": \\"success\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"\\",\\n \\"outputTokens\\": \\"\\",\\n \\"totalTokens\\": \\"\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"errorCode\\": \\"success\\",\\n \\"errorInfo\\": \\"success\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"238\\",\\n \\"outputTokens\\": \\"458\\",\\n \\"totalTokens\\": \\"696\\"\\n}","type":"json"}]', 'title' => '通过任务类型调用通义晓蜜CCAI-对话分析AIO应用', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" ."\n" @@ -1142,59 +552,77 @@ ."\n" .'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：获取[APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.41df281fWNMfrx)。', - ], - 'GetTaskResult' => [ - 'summary' => '通过任务ID获取离线任务对话分析结果。应用调用支持 HTTPS调用来完成客户的响应。', - 'path' => '/ccai/app/getTaskResult', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-03-05T01:49:58.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-20T02:54:56.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-05T02:01:27.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-11-13T10:57:56.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-09-24T02:47:12.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-19T08:06:31.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 2, 'regionId' => '*', 'api' => 'AnalyzeConversation'], + ], ], + ], + 'AnalyzeImage' => [ + 'summary' => '通过通义晓蜜CCAI-对话分析AIO应用进行图片内容分析。具体包括以下场景：水印检测。应用调用支持 HTTP 调用来完成客户的响应。', + 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeImage', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'multipart/form-data', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'description' => '任务ID', - 'type' => 'string', - 'required' => false, - 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n", - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n"], ], [ - 'name' => 'requiredFieldList', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'asr_result', - 'debug', - 'rag_result', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'stream' => ['description' => '必填。是否流式：true，流式返回答案；false，全量返回答案。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'imageUrls' => [ + 'description' => '图片地址列表', + 'type' => 'array', + 'items' => ['description' => '图片地址列表', 'type' => 'string', 'required' => false, 'example' => 'https://img.123.com/1.jppg'], + 'required' => false, + ], + 'resultTypes' => [ + 'description' => '任务类型列表', + 'type' => 'array', + 'items' => [ + 'description' => 'watermark-图片水印分析', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['watermark' => 'watermark'], + 'example' => 'watermark', + 'enum' => ['watermark'], + ], + 'required' => false, ], + 'responseFormatType' => ['type' => 'string', 'required' => false, 'description' => ''], ], 'required' => false, ], @@ -1207,238 +635,71 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'taskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n", - ], - 'text' => [ - 'description' => '应用返回的结果。', - 'type' => 'string', - 'example' => '对话中没有发现客服故意套取客户隐私信息的行为', - ], - 'taskErrorMessage' => [ - 'type' => 'string', - ], - 'taskStatus' => [ - 'description' => '任务状态。QUEUE-排队中，FINISH-已完成，ERROR-任务出错', - 'type' => 'string', - 'example' => 'FINISH', - ], - 'asrResult' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'begin' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'emotionValue' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'end' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'role' => [ - 'type' => 'string', - ], - 'speechRate' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'words' => [ - 'type' => 'string', - ], - 'roleName' => [ - 'type' => 'string', - ], - ], - ], - ], - 'extra' => [ - 'type' => 'string', - ], - 'ragStatus' => [ - 'type' => 'string', - ], - 'ragResult' => [ - 'type' => 'string', - ], - 'usage' => [ - 'type' => 'object', - 'properties' => [ - 'rag' => [ - 'type' => 'object', - 'properties' => [ - 'dialogSummary' => [ - 'type' => 'object', - 'properties' => [ - 'inputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'outputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'invokeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'adaptive' => [ - 'type' => 'object', - 'properties' => [ - 'inputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'outputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'invokeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - ], - ], - ], - 'ragErrorMessage' => [ - 'type' => 'string', - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'string', - 'example' => 'True', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '9*****-AE0D-5EE3-B1AF-48632CB0831C'], + 'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'], + 'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '[{\\"num\\":\\"1\\",\\"isHit\\":\\"false\\",\\"remarks\\":\\"无水印\\"}]'], + 'finishReason' => ['description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'], + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'string', 'example' => '1000'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'string', 'example' => '2000'], + 'totalTokens' => ['description' => 'Tokens总量', 'type' => 'string', 'example' => '3000'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource %s .', - ], - ], - 429 => [ - [ - 'errorCode' => 'Ccai.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\\\n\\",\\n \\"text\\": \\"对话中没有发现客服故意套取客户隐私信息的行为\\",\\n \\"taskErrorMessage\\": \\"\\",\\n \\"taskStatus\\": \\"FINISH\\",\\n \\"asrResult\\": [\\n {\\n \\"begin\\": 0,\\n \\"emotionValue\\": 0,\\n \\"end\\": 0,\\n \\"role\\": \\"\\",\\n \\"speechRate\\": 0,\\n \\"words\\": \\"\\",\\n \\"roleName\\": \\"\\"\\n }\\n ],\\n \\"extra\\": \\"\\",\\n \\"ragStatus\\": \\"\\",\\n \\"ragResult\\": \\"\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"invokeCount\\": 0\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"invokeCount\\": 0\\n }\\n }\\n },\\n \\"ragErrorMessage\\": \\"\\"\\n },\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]', - 'title' => '通过任务ID获取离线任务分析结果', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9*****-AE0D-5EE3-B1AF-48632CB0831C\\",\\n \\"success\\": true,\\n \\"text\\": \\"[{\\\\\\\\\\\\\\"num\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isHit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"remarks\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"无水印\\\\\\\\\\\\\\"}]\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]', + 'title' => '图片内容分析', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" ."\n" .'前提条件'."\n" + ."\n" .'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" - .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.310f281ffuUD8V)。', + .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.2eb8281f6Dxglg)。', + 'changeSet' => [ + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'], + ], ], 'CreateTask' => [ 'summary' => '通过创建离线异步任务，进行对话分析。应用调用支持 HTTP 调用来完成客户的响应。', 'path' => '/{workspaceId}/ccai/app/{appId}/createTask', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '业务空间ID', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], + 'schema' => ['description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n"], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => '应用ID', - 'type' => 'string', - 'required' => false, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], + 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c'], ], [ 'name' => 'body', @@ -1468,29 +729,15 @@ 'type' => 'string', 'required' => true, 'example' => 'user', - 'enum' => [ - 'agent', - 'user', - 'system', - ], - ], - 'text' => [ - 'description' => '对话文本', - 'type' => 'string', - 'required' => true, - 'example' => '请问怎么申请新卡'."\n", + 'enum' => ['agent', 'user', 'system'], ], + 'text' => ['description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '请问怎么申请新卡'."\n"], ], 'required' => false, ], 'required' => true, ], - 'sessionId' => [ - 'description' => '客服会话sessionId', - 'type' => 'string', - 'required' => false, - 'example' => 'session-01', - ], + 'sessionId' => ['description' => '客服会话sessionId', 'type' => 'string', 'required' => false, 'example' => 'session-01'], ], 'required' => false, ], @@ -1498,12 +745,7 @@ 'description' => '指令示例', 'type' => 'object', 'properties' => [ - 'output' => [ - 'description' => '输出示例', - 'type' => 'string', - 'required' => false, - 'example' => '问题描述：询问2.2更新时间，处理方案：已告知', - ], + 'output' => ['description' => '输出示例', 'type' => 'string', 'required' => false, 'example' => '问题描述：询问2.2更新时间，处理方案：已告知'], 'sentences' => [ 'description' => '对话内容示例', 'type' => 'array', @@ -1511,22 +753,12 @@ 'description' => '对话内容示例', 'type' => 'object', 'properties' => [ - 'role' => [ - 'description' => '通话角色'."\n" - ."\n" - .'- user：客户'."\n" - .'- agent：客服'."\n" - .'- system：系统消息', - 'type' => 'string', - 'required' => true, - 'example' => 'user', - ], - 'text' => [ - 'description' => '对话文本', - 'type' => 'string', - 'required' => true, - 'example' => '什么时候更新', - ], + 'role' => ['description' => '通话角色'."\n" + ."\n" + .'- user：客户'."\n" + .'- agent：客服'."\n" + .'- system：系统消息', 'type' => 'string', 'required' => true, 'example' => 'user'], + 'text' => ['description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '什么时候更新'], ], 'required' => true, ], @@ -1543,18 +775,8 @@ 'description' => '字段结构信息', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '字段编码', - 'type' => 'string', - 'required' => false, - 'example' => 'phoneNumber'."\n", - ], - 'desc' => [ - 'description' => '字段描述', - 'type' => 'string', - 'required' => true, - 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n", - ], + 'code' => ['description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n"], + 'desc' => ['description' => '字段描述', 'type' => 'string', 'required' => true, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n"], 'enumValues' => [ 'description' => '枚举值列表', 'type' => 'array', @@ -1562,29 +784,14 @@ 'description' => '枚举值列表', 'type' => 'object', 'properties' => [ - 'desc' => [ - 'description' => '枚举描述', - 'type' => 'string', - 'required' => true, - 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n", - ], - 'enumValue' => [ - 'description' => '枚举值', - 'type' => 'string', - 'required' => true, - 'example' => '新业务拓展'."\n", - ], + 'desc' => ['description' => '枚举描述', 'type' => 'string', 'required' => true, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n"], + 'enumValue' => ['description' => '枚举值', 'type' => 'string', 'required' => true, 'example' => '新业务拓展'."\n"], ], 'required' => true, ], 'required' => false, ], - 'name' => [ - 'description' => '字段名称', - 'type' => 'string', - 'required' => true, - 'example' => '来电原因类型'."\n", - ], + 'name' => ['description' => '字段名称', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'."\n"], ], 'required' => true, ], @@ -1595,10 +802,7 @@ 'type' => 'string', 'required' => true, 'example' => 'tyxmTurbo', - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], + 'enum' => ['tyxmTurbo', 'tyxmPlus'], ], 'resultTypes' => [ 'description' => '大模型处理类型', @@ -1608,21 +812,7 @@ 'type' => 'string', 'required' => true, 'example' => 'summary', - 'enum' => [ - 'summary', - 'title', - 'fields', - 'keywords', - 'service_inspection', - 'question_solution', - 'custom_prompt', - 'category_tag', - 'questions_and_answer', - 'service_finish', - 'actions', - 'satisfaction', - 'emotion_detection', - ], + 'enum' => ['summary', 'title', 'fields', 'keywords', 'service_inspection', 'question_solution', 'custom_prompt', 'category_tag', 'questions_and_answer', 'service_finish', 'actions', 'satisfaction', 'emotion_detection'], ], 'required' => false, ], @@ -1637,35 +827,15 @@ 'description' => '服务质检维度结构', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '服务质检维度描述', - 'type' => 'string', - 'required' => true, - 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。', - ], - 'title' => [ - 'description' => '服务质检维度名称', - 'type' => 'string', - 'required' => true, - 'example' => '客服是否过度承诺'."\n", - ], + 'content' => ['description' => '服务质检维度描述', 'type' => 'string', 'required' => true, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。'], + 'title' => ['description' => '服务质检维度名称', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺'."\n"], ], 'required' => true, ], 'required' => true, ], - 'inspectionIntroduction' => [ - 'description' => '服务质检场景详细介绍及描述', - 'type' => 'string', - 'required' => true, - 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等', - ], - 'sceneIntroduction' => [ - 'description' => '服务质检场景', - 'type' => 'string', - 'required' => true, - 'example' => '保险销售场景'."\n", - ], + 'inspectionIntroduction' => ['description' => '服务质检场景详细介绍及描述', 'type' => 'string', 'required' => true, 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等'], + 'sceneIntroduction' => ['description' => '服务质检场景', 'type' => 'string', 'required' => true, 'example' => '保险销售场景'."\n"], ], 'required' => false, ], @@ -1674,118 +844,50 @@ 'type' => 'string', 'required' => true, 'example' => 'text', - 'enum' => [ - 'audio', - 'text', - ], + 'enum' => ['audio', 'text'], ], 'templateIds' => [ 'description' => '模版id列表', 'type' => 'array', - 'items' => [ - 'description' => '模版id，模版id和指令任务类型同时存在时，优先使用模版id', - 'type' => 'string', - 'required' => true, - 'example' => '34', - ], + 'items' => ['description' => '模版id，模版id和指令任务类型同时存在时，优先使用模版id', 'type' => 'string', 'required' => true, 'example' => '34'], 'required' => false, ], 'transcription' => [ 'description' => '语音类型执行参数', 'type' => 'object', 'properties' => [ - 'autoSplit' => [ - 'description' => '单轨音频自动区分通话人，取值：0 为自动识别，取值：1 为不自动识别；默认：1；备注：只适用于8k采样率音频文件', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'clientChannel' => [ - 'description' => '适用于双轨录音，指定客户角色的轨道编号，取值：0、1，默认 1，即第 1 轨为客户；通常音轨都是从 0 开始编号，2 个轨就是 0，1；具体 0 是客服还是客户，需要您自行确认。**若使用此参数，请务必传入 autoSplit 参数，值为 0。**单轨文件忽略此参数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'fileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'required' => true, - 'example' => 'sss.mp3', - ], - 'serviceChannel' => [ - 'description' => '适用于双轨录音，指定客服角色的轨道编号，取值：0、1，默认 0，即第 0 轨为客服；通常音轨都是从 0 开始编号，2 个轨就是 0，1；具体 0 是客服还是客户，需要您自行确认。**若使用此参数，请务必传入 autoSplit 参数，值为 0。**若单轨文件忽略此参数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'autoSplit' => ['description' => '单轨音频自动区分通话人，取值：0 为自动识别，取值：1 为不自动识别；默认：1；备注：只适用于8k采样率音频文件', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'clientChannel' => ['description' => '适用于双轨录音，指定客户角色的轨道编号，取值：0、1，默认 1，即第 1 轨为客户；通常音轨都是从 0 开始编号，2 个轨就是 0，1；具体 0 是客服还是客户，需要您自行确认。**若使用此参数，请务必传入 autoSplit 参数，值为 0。**单轨文件忽略此参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'fileName' => ['description' => '文件名。', 'type' => 'string', 'required' => true, 'example' => 'sss.mp3'], + 'serviceChannel' => ['description' => '适用于双轨录音，指定客服角色的轨道编号，取值：0、1，默认 0，即第 0 轨为客服；通常音轨都是从 0 开始编号，2 个轨就是 0，1；具体 0 是客服还是客户，需要您自行确认。**若使用此参数，请务必传入 autoSplit 参数，值为 0。**若单轨文件忽略此参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], 'serviceChannelKeywords' => [ 'description' => '多数情况下适用于单轨录音，设置一组客服可能说的关键词列表（请确保选择那些区别性比较高的关键词），通过对转写文本从上到下逐句分析，当一句话命中某一个关键词时，则判定该句的角色为客服，则另一个角色就是客户。', 'type' => 'array', - 'items' => [ - 'description' => '多数情况下适用于单轨录音，设置一组客服可能说的关键词列表（请确保选择那些区别性比较高的关键词），通过对转写文本从上到下逐句分析，当一句话命中某一个关键词时，则判定该句的角色为客服，则另一个角色就是客户。', - 'type' => 'string', - 'required' => false, - 'example' => '你好', - ], + 'items' => ['description' => '多数情况下适用于单轨录音，设置一组客服可能说的关键词列表（请确保选择那些区别性比较高的关键词），通过对转写文本从上到下逐句分析，当一句话命中某一个关键词时，则判定该句的角色为客服，则另一个角色就是客户。', 'type' => 'string', 'required' => false, 'example' => '你好'], 'required' => false, ], - 'voiceFileUrl' => [ - 'description' => '文件地址', - 'type' => 'string', - 'required' => true, - 'example' => 'http://1111.com/sss.mp3', - ], + 'voiceFileUrl' => ['description' => '文件地址', 'type' => 'string', 'required' => true, 'example' => 'http://1111.com/sss.mp3'], 'asrModelCode' => [ 'description' => '语音转写模型，取值 asr （小模型），paraformer（大模型）', 'type' => 'string', 'required' => false, 'example' => 'asr', - 'enum' => [ - 'asr', - 'paraformer', - ], + 'enum' => ['asr', 'paraformer'], ], 'level' => [ 'description' => '语音转写优先级', 'type' => 'string', 'required' => false, 'example' => 'low', - 'enum' => [ - 'low', - 'middle', - 'high', - ], - ], - 'vocabularyId' => [ - 'description' => '语音热词id', - 'type' => 'string', - 'required' => false, - 'example' => 'esnvknv*****skdnvjksd', - ], - 'roleIdentification' => [ - 'description' => '自动识别通话角色，true 为自动识别，false为不自动识别。默认：false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'languageHints' => [ - 'description' => '识别语言，默认值为中文普通话，其他支持的语种和方言请联系客服', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'enum' => ['low', 'middle', 'high'], ], + 'vocabularyId' => ['description' => '语音热词id', 'type' => 'string', 'required' => false, 'example' => 'esnvknv*****skdnvjksd'], + 'roleIdentification' => ['description' => '自动识别通话角色，true 为自动识别，false为不自动识别。默认：false', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'languageHints' => ['description' => '识别语言，默认值为中文普通话，其他支持的语种和方言请联系客服', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], 'required' => false, ], - 'customPrompt' => [ - 'description' => '自定义指令', - 'type' => 'string', - 'required' => false, - 'example' => '对通话内容进行总结', - ], + 'customPrompt' => ['description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结'], 'variables' => [ 'description' => '变量列表', 'type' => 'array', @@ -1793,18 +895,8 @@ 'description' => '变量列表', 'type' => 'object', 'properties' => [ - 'variableCode' => [ - 'description' => '变量code', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'variableValue' => [ - 'description' => '变量值', - 'type' => 'string', - 'required' => false, - 'example' => '张三', - ], + 'variableCode' => ['description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'variableValue' => ['description' => '变量值', 'type' => 'string', 'required' => false, 'example' => '张三'], ], 'required' => false, ], @@ -1817,35 +909,15 @@ 'description' => '标签分类列表', 'type' => 'object', 'properties' => [ - 'tagName' => [ - 'description' => '标签名称', - 'type' => 'string', - 'required' => false, - 'example' => '客服过度承诺', - ], - 'tagDesc' => [ - 'description' => '标签描述', - 'type' => 'string', - 'required' => false, - 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为', - ], + 'tagName' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺'], + 'tagDesc' => ['description' => '标签描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为'], ], 'required' => false, ], 'required' => false, ], - 'responseFormatType' => [ - 'description' => '输出结果格式化类型，jsonObject-json结构，text-原始字符串', - 'type' => 'string', - 'required' => false, - 'example' => 'jsonObject', - ], - 'callBackUrl' => [ - 'description' => '任务完成后回调参数', - 'type' => 'string', - 'required' => false, - 'example' => '123.456.com/callback', - ], + 'responseFormatType' => ['description' => '输出结果格式化类型，jsonObject-json结构，text-原始字符串', 'type' => 'string', 'required' => false, 'example' => 'jsonObject'], + 'callBackUrl' => ['description' => '任务完成后回调参数', 'type' => 'string', 'required' => false, 'example' => '123.456.com/callback'], ], 'required' => false, ], @@ -1862,77 +934,35 @@ 'description' => '数据', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071', - ], + 'taskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '9F1DB065-AE0D-5EE3-B1AF-48632CB0831C', - ], - 'success' => [ - 'description' => '是否成功', - 'type' => 'string', - 'example' => 'True', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '9F1DB065-AE0D-5EE3-B1AF-48632CB0831C'], + 'success' => ['description' => '是否成功', 'type' => 'string', 'example' => 'True'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], ], 429 => [ - [ - 'errorCode' => 'Ccai.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'Ccai.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '无效错误码，后续下线'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\"\\n },\\n \\"requestId\\": \\"9F1DB065-AE0D-5EE3-B1AF-48632CB0831C\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]', 'title' => '通过上传离线任务数据进行通义晓蜜CCAI-对话分析', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" @@ -1994,429 +1024,33 @@ .'}'."\n" ."\n" .'```', - ], - 'AnalyzeImage' => [ - 'summary' => '通过通义晓蜜CCAI-对话分析AIO应用进行图片内容分析。具体包括以下场景：水印检测。应用调用支持 HTTP 调用来完成客户的响应。', - 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeImage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => '应用id。', - 'type' => 'string', - 'required' => false, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'stream' => [ - 'description' => '必填。是否流式：true，流式返回答案；false，全量返回答案。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'imageUrls' => [ - 'description' => '图片地址列表', - 'type' => 'array', - 'items' => [ - 'description' => '图片地址列表', - 'type' => 'string', - 'required' => false, - 'example' => 'https://img.123.com/1.jppg', - ], - 'required' => false, - ], - 'resultTypes' => [ - 'description' => '任务类型列表', - 'type' => 'array', - 'items' => [ - 'description' => 'watermark-图片水印分析', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'watermark' => 'watermark', - ], - 'example' => 'watermark', - 'enum' => [ - 'watermark', - ], - ], - 'required' => false, - ], - 'responseFormatType' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '9*****-AE0D-5EE3-B1AF-48632CB0831C', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'True', - ], - 'text' => [ - 'description' => '应用返回的结果。', - 'type' => 'string', - 'example' => '[{\\"num\\":\\"1\\",\\"isHit\\":\\"false\\",\\"remarks\\":\\"无水印\\"}]', - ], - 'finishReason' => [ - 'description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', - 'type' => 'string', - 'example' => 'stop', - ], - 'inputTokens' => [ - 'description' => '输入Token数量', - 'type' => 'string', - 'example' => '1000', - ], - 'outputTokens' => [ - 'description' => '输出Token数量', - 'type' => 'string', - 'example' => '2000', - ], - 'totalTokens' => [ - 'description' => 'Tokens总量', - 'type' => 'string', - 'example' => '3000', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], - ], - 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], - ], - 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'changeSet' => [ + ['createdAt' => '2025-07-25T09:33:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-06-20T07:54:42.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-05-27T09:09:34.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-05-06T09:49:02.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-04-01T02:08:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-25T02:52:45.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-20T10:52:12.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-01-16T08:47:12.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9*****-AE0D-5EE3-B1AF-48632CB0831C\\",\\n \\"success\\": true,\\n \\"text\\": \\"[{\\\\\\\\\\\\\\"num\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isHit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"remarks\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"无水印\\\\\\\\\\\\\\"}]\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]', - 'title' => '图片内容分析', - 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" - ."\n" - .'前提条件'."\n" - ."\n" - .'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" - .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.2eb8281f6Dxglg)。', - ], - 'GeneralAnalyzeImage' => [ - 'summary' => '通用图片分析。', - 'path' => '/{workspaceId}/ccai/app/{appId}/generalanalyzeImage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => '应用id。', - 'type' => 'string', - 'required' => false, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'stream' => [ - 'description' => '必填。是否流式：true，流式返回答案；false，全量返回答案。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - 'imageUrls' => [ - 'description' => '图片地址列表', - 'type' => 'array', - 'items' => [ - 'description' => '图片地址列表', - 'type' => 'string', - 'required' => false, - 'example' => 'https://img.123.com/1.jppg', - ], - 'required' => true, - ], - 'customPrompt' => [ - 'description' => '自定义指令', - 'type' => 'string', - 'required' => false, - 'example' => 'Analyze the content in the image', - ], - 'templateIds' => [ - 'description' => '模版id，模版id和customPrompt同时存在时，优先使用模版id', - 'type' => 'array', - 'items' => [ - 'description' => '模版id，模版id和指令任务类型同时存在时，优先使用模版id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D718325-92F9-5588-803B-C4A69A5F0AE1', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'True', - ], - 'text' => [ - 'description' => '应用返回的结果。', - 'type' => 'string', - 'example' => '这张图片中没有可识别的文本内容。因此，无法进行OCR（光学字符识别）。如果你有其他需求或问题，请告诉我', - ], - 'finishReason' => [ - 'description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', - 'type' => 'string', - 'example' => 'stop', - ], - 'inputTokens' => [ - 'description' => '输入Token数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'outputTokens' => [ - 'description' => '输出Token数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000', - ], - 'totalTokens' => [ - 'description' => 'Tokens总量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], - ], - 403 => [ - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - ], - 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D718325-92F9-5588-803B-C4A69A5F0AE1\\",\\n \\"success\\": true,\\n \\"text\\": \\"这张图片中没有可识别的文本内容。因此，无法进行OCR（光学字符识别）。如果你有其他需求或问题，请告诉我\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"inputTokens\\": 1000,\\n \\"outputTokens\\": 2000,\\n \\"totalTokens\\": 3000\\n}","type":"json"}]', - 'title' => '通用图片分析', ], 'CreateVocab' => [ 'summary' => '将一组语音热词上传到服务端，并获取返回热词ID。', 'path' => '/vocab/createVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', @@ -2426,51 +1060,21 @@ 'description' => '请求Body', 'type' => 'object', 'properties' => [ - 'workspaceId' => [ - 'description' => '业务空间ID', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-9****me1', - ], - 'name' => [ - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '词表1', - ], - 'description' => [ - 'description' => '版本描述', - 'type' => 'string', - 'required' => false, - 'example' => '销售词表', - ], - 'audioModelCode' => [ - 'description' => '语音转写模型', - 'type' => 'string', - 'required' => false, - 'example' => 'nls', - ], + 'workspaceId' => ['description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-9****me1'], + 'name' => ['description' => '名称', 'type' => 'string', 'required' => true, 'example' => '词表1'], + 'description' => ['description' => '版本描述', 'type' => 'string', 'required' => false, 'example' => '销售词表'], + 'audioModelCode' => ['description' => '语音转写模型', 'type' => 'string', 'required' => false, 'example' => 'nls'], 'wordWeightList' => [ 'description' => '热词组', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'weight' => [ - 'description' => '权重值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'word' => [ - 'description' => '单词', - 'type' => 'string', - 'required' => true, - 'example' => '大树', - ], + 'weight' => ['description' => '权重值', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], + 'word' => ['description' => '单词', 'type' => 'string', 'required' => true, 'example' => '大树'], ], 'required' => true, + 'description' => '', ], 'required' => true, ], @@ -2486,26 +1090,13 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '调用是否成功', - 'type' => 'string', - 'example' => 'True', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => '调用是否成功', 'type' => 'string', 'example' => 'True'], 'data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'vocabularyId' => [ - 'description' => '热词id', - 'type' => 'string', - 'example' => 'f3d82*******7', - ], + 'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'example' => 'f3d82*******7'], ], ], ], @@ -2514,47 +1105,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"True\\",\\n \\"data\\": {\\n \\"vocabularyId\\": \\"f3d82*******7\\"\\n }\\n}","type":"json"}]', 'title' => '创建热词', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" @@ -2634,34 +1199,25 @@ .'}'."\n" ."\n" .'```', - ], - 'UpdateVocab' => [ - 'summary' => '根据词表的ID可以更新对应的词表信息，包括词表名称、词表描述信息、词表的词和权重。', - 'path' => '/vocab/updateVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-26T09:32:54.000Z', 'description' => '请求参数发生变更'], ], + ], + 'DeleteVocab' => [ + 'summary' => '根据词表的ID删除对应的词表。', + 'path' => '/vocab/deleteVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', @@ -2671,55 +1227,8 @@ 'description' => '请求Body', 'type' => 'object', 'properties' => [ - 'vocabularyId' => [ - 'description' => '热词id', - 'type' => 'string', - 'required' => true, - 'example' => 'dsvsv***dsvv', - ], - 'name' => [ - 'description' => '名称', - 'type' => 'string', - 'required' => false, - 'example' => '热词1', - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'required' => false, - 'example' => '销售热词', - ], - 'wordWeightList' => [ - 'description' => '热词组', - 'type' => 'array', - 'items' => [ - 'description' => '热词组', - 'type' => 'object', - 'properties' => [ - 'word' => [ - 'description' => '单词', - 'type' => 'string', - 'required' => true, - 'example' => '虹桥', - ], - 'weight' => [ - 'description' => '权重', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'workspaceId' => [ - 'description' => '业务空间ID', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-jhfr****w8v', - ], + 'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'required' => true, 'example' => 'ern*******rve'], + 'workspaceId' => ['description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-0*****jlg8s'], ], 'required' => false, ], @@ -2732,71 +1241,32 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'string', - 'example' => 'true', - ], - 'data' => [ - 'description' => '返回数据', - 'type' => 'string', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'], + 'data' => ['description' => '返回数据', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', - 'title' => '修改热词', + 'title' => '删除热词', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" ."\n" .'前提条件'."\n" @@ -2831,73 +1301,65 @@ .' public static void main(String[] args) throws Exception {'."\n" .' Client client = new Client(config);'."\n" ."\n" - .' UpdateVocabRequest request = new UpdateVocabRequest();'."\n" - .' request.setVocabularyId("f3d82e0d********d23bd7");'."\n" - .' request.setName("销售热词");'."\n" - .' request.setDescription("南方一区销售热词");'."\n" + .' DeleteVocabRequest request = new DeleteVocabRequest();'."\n" + .' request.setVocabularyId("81a3*********2d7c8");'."\n" .' request.setWorkspaceId(workspaceId);'."\n" ."\n" - .' List<UpdateVocabRequest.UpdateVocabRequestWordWeightList> wordWeightList = new ArrayList<>();'."\n" - .' UpdateVocabRequest.UpdateVocabRequestWordWeightList word1 = new UpdateVocabRequest.UpdateVocabRequestWordWeightList();'."\n" - .' word1.setWord("欧洲");'."\n" - .' word1.setWeight(4);'."\n" - .' wordWeightList.add(word1);'."\n" - ."\n" - .' UpdateVocabRequest.UpdateVocabRequestWordWeightList word2 = new UpdateVocabRequest.UpdateVocabRequestWordWeightList();'."\n" - .' word2.setWord("耳痛");'."\n" - .' word2.setWeight(2);'."\n" - .' wordWeightList.add(word2);'."\n" - ."\n" - .' request.setWordWeightList(wordWeightList);'."\n" - ."\n" - .' UpdateVocabResponse response = client.updateVocab(request);'."\n" + .' DeleteVocabResponse response = client.deleteVocab(request);'."\n" .' System.out.println(JSONObject.toJSONString(response));'."\n" .' }'."\n" .'}'."\n" ."\n" .'```', + 'changeSet' => [], ], - 'ListVocab' => [ - 'summary' => '列举指定业务空间下的热词列表信息。', - 'path' => '/vocab/listVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GeneralAnalyzeImage' => [ + 'summary' => '通用图片分析。', + 'path' => '/{workspaceId}/ccai/app/{appId}/generalanalyzeImage', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n"], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求Body', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'workspaceId' => [ - 'description' => '业务空间ID', - 'type' => 'string', + 'stream' => ['description' => '必填。是否流式：true，流式返回答案；false，全量返回答案。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + 'imageUrls' => [ + 'description' => '图片地址列表', + 'type' => 'array', + 'items' => ['description' => '图片地址列表', 'type' => 'string', 'required' => false, 'example' => 'https://img.123.com/1.jppg'], 'required' => true, - 'example' => 'llm-jhfr****8v', + ], + 'customPrompt' => ['description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => 'Analyze the content in the image'], + 'templateIds' => [ + 'description' => '模版id，模版id和customPrompt同时存在时，优先使用模版id', + 'type' => 'array', + 'items' => ['description' => '模版id，模版id和指令任务类型同时存在时，优先使用模版id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34'], + 'required' => false, ], ], 'required' => false, @@ -2911,189 +1373,208 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'string', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D718325-92F9-5588-803B-C4A69A5F0AE1'], + 'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'], + 'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这张图片中没有可识别的文本内容。因此，无法进行OCR（光学字符识别）。如果你有其他需求或问题，请告诉我'], + 'finishReason' => ['description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'], + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'], + 'totalTokens' => ['description' => 'Tokens总量', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ], + 403 => [ + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ], + 500 => [ + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D718325-92F9-5588-803B-C4A69A5F0AE1\\",\\n \\"success\\": true,\\n \\"text\\": \\"这张图片中没有可识别的文本内容。因此，无法进行OCR（光学字符识别）。如果你有其他需求或问题，请告诉我\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"inputTokens\\": 1000,\\n \\"outputTokens\\": 2000,\\n \\"totalTokens\\": 3000\\n}","type":"json"}]', + 'title' => '通用图片分析', + 'changeSet' => [], + ], + 'GetTaskResult' => [ + 'summary' => '通过任务ID获取离线任务对话分析结果。应用调用支持 HTTPS调用来完成客户的响应。', + 'path' => '/ccai/app/getTaskResult', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['multipart/form-data'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'query', + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n"], + ], + [ + 'name' => 'requiredFieldList', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '可选字段列表', + 'type' => 'array', + 'items' => [ + 'description' => '可选字段值', + 'type' => 'string', + 'required' => false, + 'example' => 'asr_result', + 'enum' => ['asr_result', 'debug', 'rag_result'], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ 'data' => [ - 'description' => '返回数据', - 'type' => 'array', - 'items' => [ - 'description' => '返回数据', - 'type' => 'object', - 'properties' => [ - 'vocabularyId' => [ - 'description' => '热词id', - 'type' => 'string', - 'example' => 'dv*****erverve', - ], - 'name' => [ - 'description' => '名称', - 'type' => 'string', - 'example' => '热词1', - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => '销售热词', - ], - 'audioModelCode' => [ - 'description' => '语音转写模型', - 'type' => 'string', - 'example' => 'nls', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n"], + 'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '对话中没有发现客服故意套取客户隐私信息的行为'], + 'taskErrorMessage' => ['description' => '任务失败信息', 'type' => 'string', 'example' => '异常'], + 'taskStatus' => ['description' => '任务状态。QUEUE-排队中，FINISH-已完成，ERROR-任务出错', 'type' => 'string', 'example' => 'FINISH'], + 'asrResult' => [ + 'description' => 'ASR识别结果列表', + 'type' => 'array', + 'items' => [ + 'description' => 'ASR识别结果', + 'type' => 'object', + 'properties' => [ + 'begin' => ['description' => '该句的起始时间偏移，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '80'], + 'emotionValue' => ['description' => '情绪能量值，取值为音量分贝值/10。取值范围：[1,10]。值越高情绪越强烈。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'end' => ['description' => '该句的结束时间偏移，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '8480'], + 'role' => ['description' => '该句所属音轨ID。', 'type' => 'string', 'example' => '0'], + 'speechRate' => ['description' => '本句的平均语速。'."\n" + ."\n" + .'若识别语言为中文，则单位为：字数/分钟。'."\n" + ."\n" + .'若识别语言为英文，则单位为：单词数/分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '342'], + 'words' => ['description' => '该句的识别文本结果。', 'type' => 'string', 'example' => 'Hello'], + 'roleName' => ['description' => '角色名称', 'type' => 'string', 'example' => '客户'], + ], ], - 'wordWeightList' => [ - 'description' => '热词组', - 'type' => 'array', - 'items' => [ - 'description' => '热词组', + ], + 'extra' => ['description' => '可选的补充内容', 'type' => 'string', 'example' => '{"roleConfig":{"role1Name":"客户","role2Name":"客服"}}'], + 'ragStatus' => ['description' => 'rag执行状态', 'type' => 'string', 'example' => 'SUCCESS'], + 'ragResult' => ['description' => 'rag召回结果', 'type' => 'string', 'example' => '召回内容'], + 'usage' => [ + 'description' => '使用量', + 'type' => 'object', + 'properties' => [ + 'rag' => [ + 'description' => 'rag使用详情', 'type' => 'object', 'properties' => [ - 'word' => [ - 'description' => '单词', - 'type' => 'string', - 'example' => '儿童', + 'dialogSummary' => [ + 'description' => '会话摘要', + 'type' => 'object', + 'properties' => [ + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '520'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '664'], + 'invokeCount' => ['description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], - 'weight' => [ - 'description' => '权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'adaptive' => [ + 'description' => 'rag智能调用', + 'type' => 'object', + 'properties' => [ + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '482'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '789'], + 'invokeCount' => ['description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], ], ], ], ], + 'ragErrorMessage' => ['description' => 'rag执行错误异常message', 'type' => 'string', 'example' => '非法参数:[无有效知识库]'], ], ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF'], + 'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'True'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource %s .', 'description' => '该用户未被授权可操作指定资源'], + ], + 429 => [ + ['errorCode' => 'Ccai.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '无效错误码，后续下线'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": [\\n {\\n \\"vocabularyId\\": \\"dv*****erverve\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 3\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取热词列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\\\n\\",\\n \\"text\\": \\"对话中没有发现客服故意套取客户隐私信息的行为\\",\\n \\"taskErrorMessage\\": \\"异常\\",\\n \\"taskStatus\\": \\"FINISH\\",\\n \\"asrResult\\": [\\n {\\n \\"begin\\": 80,\\n \\"emotionValue\\": 5,\\n \\"end\\": 8480,\\n \\"role\\": \\"0\\",\\n \\"speechRate\\": 342,\\n \\"words\\": \\"Hello\\",\\n \\"roleName\\": \\"客户\\"\\n }\\n ],\\n \\"extra\\": \\"{\\\\\\"roleConfig\\\\\\":{\\\\\\"role1Name\\\\\\":\\\\\\"客户\\\\\\",\\\\\\"role2Name\\\\\\":\\\\\\"客服\\\\\\"}}\\",\\n \\"ragStatus\\": \\"SUCCESS\\",\\n \\"ragResult\\": \\"召回内容\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 520,\\n \\"outputTokens\\": 664,\\n \\"invokeCount\\": 1\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 482,\\n \\"outputTokens\\": 789,\\n \\"invokeCount\\": 1\\n }\\n }\\n },\\n \\"ragErrorMessage\\": \\"非法参数:[无有效知识库]\\"\\n },\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]', + 'title' => '通过任务ID获取离线任务分析结果', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" ."\n" .'前提条件'."\n" - ."\n" - .'- 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" - .'- 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.39e3281fMO5qOX)。', - 'requestParamsDescription' => '## 请求代码示例'."\n" - .'```java'."\n" - ."\n" - .'import com.alibaba.fastjson.JSONObject;'."\n" - .'import com.aliyun.contactcenterai20240603.Client;'."\n" - .'import com.aliyun.contactcenterai20240603.models.*;'."\n" - .'import com.aliyun.teaopenapi.models.Config;'."\n" - ."\n" - .'import java.util.ArrayList;'."\n" - .'import java.util.List;'."\n" - ."\n" - .'public class Vocab {'."\n" - ."\n" - .' private static String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n" - .' private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n" - ."\n\n" - .' private static String workspaceId = "YOUR_WORKSPACE_ID";'."\n" - ."\n" - .' private static Config config = new Config();'."\n" - ."\n" - .' static {'."\n" - .' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n" - .' .setReadTimeout(30000).setConnectTimeout(300000).setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n" - .' }'."\n" - ."\n" - .' public static void main(String[] args) throws Exception {'."\n" - .' Client client = new Client(config);'."\n" - ."\n" - .' ListVocabRequest request = new ListVocabRequest();'."\n" - ."\n" - .' request.setWorkspaceId(workspaceId);'."\n" - ."\n" - .' ListVocabResponse response = client.listVocab(request);'."\n" - .' System.out.println(JSONObject.toJSONString(response));'."\n" - .' }'."\n" - .'}'."\n" - ."\n" - .'```', - ], - 'DeleteVocab' => [ - 'summary' => '根据词表的ID删除对应的词表。', - 'path' => '/vocab/deleteVocab', - 'methods' => [ - 'post', + .'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" + .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.310f281ffuUD8V)。', + 'changeSet' => [ + ['createdAt' => '2025-06-11T09:04:52.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-01-16T08:47:12.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-12-05T02:01:27.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskResult'], + ], ], + ], + 'GetVocab' => [ + 'summary' => '根据词表的ID获取对应的词表信息。', + 'path' => '/vocab/getVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', @@ -3103,18 +1584,8 @@ 'description' => '请求Body', 'type' => 'object', 'properties' => [ - 'vocabularyId' => [ - 'description' => '热词id', - 'type' => 'string', - 'required' => true, - 'example' => 'ern*******rve', - ], - 'workspaceId' => [ - 'description' => '业务空间ID', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-0*****jlg8s', - ], + 'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'required' => true, 'example' => 'dhbf***rbrdb'], + 'workspaceId' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-9864***1'], ], 'required' => false, ], @@ -3127,21 +1598,29 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'string', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'], 'data' => [ 'description' => '返回数据', - 'type' => 'string', - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'example' => 'rrbe***jrvrdd'], + 'name' => ['description' => '名称', 'type' => 'string', 'example' => '热词1'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => '销售热词'], + 'audioModelCode' => ['description' => '语音转写模型', 'type' => 'string', 'example' => 'nls'], + 'wordWeightList' => [ + 'description' => '热词组', + 'type' => 'array', + 'items' => [ + 'description' => '热词组', + 'type' => 'object', + 'properties' => [ + 'word' => ['description' => '单词', 'type' => 'string', 'example' => '儿童'], + 'weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + ], + ], + ], ], ], ], @@ -3149,49 +1628,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', - 'title' => '删除热词', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": {\\n \\"vocabularyId\\": \\"rrbe***jrvrdd\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取热词', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" ."\n" .'前提条件'."\n" @@ -3203,7 +1656,10 @@ ."\n" .'import com.alibaba.fastjson.JSONObject;'."\n" .'import com.aliyun.contactcenterai20240603.Client;'."\n" - .'import com.aliyun.contactcenterai20240603.models.*;'."\n" + .'import com.aliyun.contactcenterai20240603.models.CreateVocabRequest;'."\n" + .'import com.aliyun.contactcenterai20240603.models.CreateVocabResponse;'."\n" + .'import com.aliyun.contactcenterai20240603.models.GetVocabRequest;'."\n" + .'import com.aliyun.contactcenterai20240603.models.GetVocabResponse;'."\n" .'import com.aliyun.teaopenapi.models.Config;'."\n" ."\n" .'import java.util.ArrayList;'."\n" @@ -3226,44 +1682,33 @@ .' public static void main(String[] args) throws Exception {'."\n" .' Client client = new Client(config);'."\n" ."\n" - .' DeleteVocabRequest request = new DeleteVocabRequest();'."\n" - .' request.setVocabularyId("81a3*********2d7c8");'."\n" + .' GetVocabRequest request = new GetVocabRequest();'."\n" + .' request.setVocabularyId("1a3188**********7d2e");'."\n" .' request.setWorkspaceId(workspaceId);'."\n" ."\n" - .' DeleteVocabResponse response = client.deleteVocab(request);'."\n" + .' GetVocabResponse response = client.getVocab(request);'."\n" .' System.out.println(JSONObject.toJSONString(response));'."\n" .' }'."\n" .'}'."\n" ."\n" .'```', + 'changeSet' => [], ], - 'GetVocab' => [ - 'summary' => '根据词表的ID获取对应的词表信息。', - 'path' => '/vocab/getVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListVocab' => [ + 'summary' => '列举指定业务空间下的热词列表信息。', + 'path' => '/vocab/listVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', @@ -3273,18 +1718,7 @@ 'description' => '请求Body', 'type' => 'object', 'properties' => [ - 'vocabularyId' => [ - 'description' => '热词id', - 'type' => 'string', - 'required' => true, - 'example' => 'dhbf***rbrdb', - ], - 'workspaceId' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-9864***1', - ], + 'workspaceId' => ['description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-jhfr****8v'], ], 'required' => false, ], @@ -3297,58 +1731,28 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'string', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'], 'data' => [ 'description' => '返回数据', - 'type' => 'object', - 'properties' => [ - 'vocabularyId' => [ - 'description' => '热词id', - 'type' => 'string', - 'example' => 'rrbe***jrvrdd', - ], - 'name' => [ - 'description' => '名称', - 'type' => 'string', - 'example' => '热词1', - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => '销售热词', - ], - 'audioModelCode' => [ - 'description' => '语音转写模型', - 'type' => 'string', - 'example' => 'nls', - ], - 'wordWeightList' => [ - 'description' => '热词组', - 'type' => 'array', - 'items' => [ + 'type' => 'array', + 'items' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'example' => 'dv*****erverve'], + 'name' => ['description' => '名称', 'type' => 'string', 'example' => '热词1'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => '销售热词'], + 'audioModelCode' => ['description' => '语音转写模型', 'type' => 'string', 'example' => 'nls'], + 'wordWeightList' => [ 'description' => '热词组', - 'type' => 'object', - 'properties' => [ - 'word' => [ - 'description' => '单词', - 'type' => 'string', - 'example' => '儿童', - ], - 'weight' => [ - 'description' => '权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'type' => 'array', + 'items' => [ + 'description' => '热词组', + 'type' => 'object', + 'properties' => [ + 'word' => ['description' => '单词', 'type' => 'string', 'example' => '儿童'], + 'weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], ], ], @@ -3361,49 +1765,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": {\\n \\"vocabularyId\\": \\"rrbe***jrvrdd\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取热词', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": [\\n {\\n \\"vocabularyId\\": \\"dv*****erverve\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 3\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取热词列表', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" ."\n" .'前提条件'."\n" @@ -3415,10 +1793,7 @@ ."\n" .'import com.alibaba.fastjson.JSONObject;'."\n" .'import com.aliyun.contactcenterai20240603.Client;'."\n" - .'import com.aliyun.contactcenterai20240603.models.CreateVocabRequest;'."\n" - .'import com.aliyun.contactcenterai20240603.models.CreateVocabResponse;'."\n" - .'import com.aliyun.contactcenterai20240603.models.GetVocabRequest;'."\n" - .'import com.aliyun.contactcenterai20240603.models.GetVocabResponse;'."\n" + .'import com.aliyun.contactcenterai20240603.models.*;'."\n" .'import com.aliyun.teaopenapi.models.Config;'."\n" ."\n" .'import java.util.ArrayList;'."\n" @@ -3441,335 +1816,422 @@ .' public static void main(String[] args) throws Exception {'."\n" .' Client client = new Client(config);'."\n" ."\n" - .' GetVocabRequest request = new GetVocabRequest();'."\n" - .' request.setVocabularyId("1a3188**********7d2e");'."\n" + .' ListVocabRequest request = new ListVocabRequest();'."\n" + ."\n" .' request.setWorkspaceId(workspaceId);'."\n" ."\n" - .' GetVocabResponse response = client.getVocab(request);'."\n" + .' ListVocabResponse response = client.listVocab(request);'."\n" .' System.out.println(JSONObject.toJSONString(response));'."\n" .' }'."\n" .'}'."\n" ."\n" .'```', + 'changeSet' => [], ], - 'AnalyzeAudioSync' => [ - 'summary' => '对进行语音文件进行实时对话分析。应用调用支持 HTTPS 调用来完成客户的响应。', - 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeAudioSync', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'RunCompletion' => [ + 'summary' => '支持调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果，应用调用支持 HTTP 调用来完成客户的响应，目前提供普通 HTTP 和 HTTP SSE 两种协议，您可根据自己的需求自行选择。', + 'path' => '/{workspaceId}/ccai/app/{appId}/completion', + 'methods' => ['post'], + 'schemes' => ['http', 'https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '业务空间Id', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], + 'schema' => ['description' => '子业务空间标识', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n"], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => '应用id', - 'type' => 'string', - 'required' => true, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], + 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => '097d65c9c7004f8dad2b454850ac232b'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体', + 'description' => 'request body结构信息', 'type' => 'object', 'properties' => [ - 'modelCode' => [ - 'description' => '模型code', - 'type' => 'string', - 'required' => false, - 'example' => 'tyxmTurbo', + 'Dialogue' => [ + 'description' => '对话结构信息', + 'type' => 'object', + 'properties' => [ + 'Sentences' => [ + 'description' => '对话内容列表', + 'type' => 'array', + 'items' => [ + 'description' => '每一轮对话内容的结构信息', + 'type' => 'object', + 'properties' => [ + 'ChatId' => ['description' => '每一轮对话内容的唯一性ID', 'type' => 'string', 'required' => false, 'example' => 'ae2483e01a8446aa859925947fcf4d8e'], + 'Role' => [ + 'description' => '（通话角色） user-客户 agent-客服 system-系统消息', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'default' => 'user', + 'enum' => ['user', 'agent', 'system'], + ], + 'Text' => ['description' => '对话内容信息', 'type' => 'string', 'required' => true, 'example' => '查询北京天气'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SessionId' => ['description' => '对话唯一性ID', 'type' => 'string', 'required' => false, 'example' => 'd25zc9c7004f8dad2b454d'], + ], + 'required' => true, ], - 'fields' => [ - 'description' => '字段结构信息', + 'Fields' => [ + 'description' => '信息抽取时，需要抽取的字段列表', 'type' => 'array', 'items' => [ 'description' => '字段结构信息', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '字段编码', - 'type' => 'string', - 'required' => false, - 'example' => 'phoneNumber'."\n", - ], - 'name' => [ - 'description' => '字段名称', - 'type' => 'string', - 'required' => false, - 'example' => '来电原因类型'."\n", - ], - 'desc' => [ - 'description' => '字段描述', - 'type' => 'string', - 'required' => false, - 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n", - ], - 'enumValues' => [ + 'Code' => ['description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'], + 'Desc' => ['description' => '字段描述', 'type' => 'string', 'required' => false, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'], + 'EnumValues' => [ 'description' => '枚举值列表', 'type' => 'array', 'items' => [ - 'description' => '枚举值列表', + 'description' => '枚举值结构信息', 'type' => 'object', 'properties' => [ - 'desc' => [ - 'description' => '枚举描述', - 'type' => 'string', - 'required' => false, - 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n", - ], - 'enumValue' => [ - 'description' => '枚举值', - 'type' => 'string', - 'required' => false, - 'example' => '新业务拓展'."\n", - ], + 'Desc' => ['description' => '枚举值描述', 'type' => 'string', 'required' => false, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'], + 'EnumValue' => ['description' => '枚举值', 'type' => 'string', 'required' => true, 'example' => '新业务拓展'], ], 'required' => false, ], 'required' => false, ], + 'Name' => ['description' => '字段名称', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'], ], 'required' => false, ], 'required' => false, ], - 'resultTypes' => [ - 'description' => '任务类型', - 'type' => 'array', - 'items' => [ - 'description' => 'summary-对话摘要，title-标题生成、fields-字段信息抽取、keywords -关键字抽取，service_inspection-服务质检、question_solution-问题和解决方案、questions_and_answer-QA抽取、custom_prompt-自定义指令', - 'type' => 'string', - 'required' => true, - 'example' => 'summary', - ], + 'ModelCode' => [ + 'description' => '模型规格', + 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['tyxmPlus' => 'tyxmPlus', 'tyxmTurbo' => 'tyxmTurbo'], + 'example' => 'tyxmTurbo', + 'default' => 'tyxmTurbo', + 'enum' => ['tyxmTurbo', 'tyxmPlus'], ], - 'serviceInspection' => [ + 'ServiceInspection' => [ 'description' => '服务质检结构信息', 'type' => 'object', 'properties' => [ - 'inspectionContents' => [ - 'description' => '质检项列表', + 'InspectionContents' => [ + 'description' => '服务质检维度结构列表', 'type' => 'array', 'items' => [ - 'description' => '质检项结构', + 'description' => '服务质检维度结构', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '质检项描述', - 'type' => 'string', - 'required' => false, - 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。', - ], - 'title' => [ - 'description' => '质检名称', - 'type' => 'string', - 'required' => false, - 'example' => '客服是否过度承诺'."\n", - ], + 'Content' => ['description' => '服务质检维度描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。'], + 'Title' => ['description' => '服务质检维度名称', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺'], ], 'required' => false, ], 'required' => false, ], - 'inspectionIntroduction' => [ - 'description' => '服务质检场景详细介绍及描述', - 'type' => 'string', - 'required' => false, - 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等', - ], - 'sceneIntroduction' => [ - 'description' => '服务质检场景', - 'type' => 'string', - 'required' => false, - 'example' => '保险销售场景'."\n", - ], + 'InspectionIntroduction' => ['description' => '服务质检场景详细介绍及描述', 'type' => 'string', 'required' => false, 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等'], + 'SceneIntroduction' => ['description' => '服务质检场景', 'type' => 'string', 'required' => false, 'example' => '保险销售场景'], ], 'required' => false, ], - 'templateIds' => [ - 'description' => '模版id', - 'type' => 'array', - 'items' => [ - 'description' => '模版id，模版id和指令任务类型同时存在时，优先使用模版id', - 'type' => 'string', - 'required' => false, - 'example' => '34', - ], + 'Stream' => [ + 'description' => 'true则会开启 SSE 响应，默认false', + 'type' => 'boolean', 'required' => false, + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'false', + 'default' => 'false', ], - 'categoryTags' => [ - 'description' => '标签分类列表', + 'TemplateIds' => [ + 'description' => 'CCAI应用下的模版ID 列表', + 'type' => 'array', + 'items' => ['description' => 'CCAI应用下的模版ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10375'], + 'required' => true, + ], + 'variables' => [ + 'description' => '变量列表', 'type' => 'array', 'items' => [ - 'description' => '标签分类列表', + 'description' => '变量列表', 'type' => 'object', 'properties' => [ - 'tagName' => [ - 'description' => '标签名称', - 'type' => 'string', - 'required' => false, - 'example' => '客服过度承诺', - ], - 'tagDesc' => [ - 'description' => '标签描述', - 'type' => 'string', - 'required' => false, - 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为', - ], + 'variableCode' => ['description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'variableValue' => ['description' => '变量值', 'type' => 'string', 'required' => false, 'example' => '张三'], ], 'required' => false, ], 'required' => false, ], - 'customPrompt' => [ - 'description' => '自定义指令', - 'type' => 'string', - 'required' => false, - 'example' => '对通话内容进行总结', - ], - 'transcription' => [ - 'description' => '语音类型执行参数', + 'responseFormatType' => ['description' => '输出结果格式化类型，jsonObject-json结构，text-原始字符串', 'type' => 'string', 'required' => false, 'example' => 'jsonObject'], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response结构信息', + 'type' => 'object', + 'properties' => [ + 'FinishReason' => ['description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'], + 'RequestId' => ['description' => '系统生成的标志本次请求的唯一性ID', 'type' => 'string', 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n"], + 'Text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。'."\n"], + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'string', 'example' => '4672'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'string', 'example' => '621'], + 'totalTokens' => ['description' => 'Tokens总量', 'type' => 'string', 'example' => '5609'], + 'usage' => [ + 'description' => '使用量', 'type' => 'object', 'properties' => [ - 'autoSplit' => [ - 'description' => '多数情况下适用于单轨录音，取值：0、1，是否自动分轨，1 为自动分轨，0 为不分轨；默认：1；若指定为 1，则表示上传的音频为单轨；自动分轨会额外占用处理时间。若录音为双轨录音，该参数必须传 0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'clientChannel' => [ - 'description' => '适用于双轨录音，指定客户角色的轨道编号，取值：0、1，默认 1，即第 1 轨为客户；通常音轨都是从 0 开始编号，2 个轨就是 0，1；具体 0 是客服还是客户，需要您自行确认。**若使用此参数，请务必传入 autoSplit 参数，值为 0。**单轨文件忽略此参数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'serviceChannel' => [ - 'description' => '适用于双轨录音，指定客服角色的轨道编号，取值：0、1，默认 0，即第 0 轨为客服；通常音轨都是从 0 开始编号，2 个轨就是 0，1；具体 0 是客服还是客户，需要您自行确认。**若使用此参数，请务必传入 autoSplit 参数，值为 0。**若单轨文件忽略此参数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'fileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'required' => true, - 'example' => 'sss.mp3', - ], - 'voiceFileUrl' => [ - 'description' => '文件地址', - 'type' => 'string', - 'required' => true, - 'example' => 'http://1111.com/sss.mp3', - ], - 'serviceChannelKeywords' => [ - 'description' => '客服通话关键字列表', - 'type' => 'array', - 'items' => [ - 'description' => '多数情况下适用于单轨录音，设置一组客服可能说的关键词列表（请确保选择那些区别性比较高的关键词），通过对转写文本从上到下逐句分析，当一句话命中某一个关键词时，则判定该句的角色为客服，则另一个角色就是客户。', - 'type' => 'string', - 'required' => false, - 'example' => '你好', + 'rag' => [ + 'description' => 'rag使用详情', + 'type' => 'object', + 'properties' => [ + 'dialogSummary' => [ + 'description' => '会话摘要', + 'type' => 'object', + 'properties' => [ + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '4672'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '621'], + 'invokeCount' => ['description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], + ], + 'adaptive' => [ + 'description' => 'rag智能调用', + 'type' => 'object', + 'properties' => [ + 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '4672'], + 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '621'], + 'invokeCount' => ['description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], + ], ], - 'required' => false, - ], - 'asrModelCode' => [ - 'description' => '语音转写模型，取值 nls （小模型），paraformer（大模型）', - 'type' => 'string', - 'required' => false, - 'example' => 'nls', - ], - 'vocabularyId' => [ - 'description' => '语音热词id', - 'type' => 'string', - 'required' => false, - 'example' => 'esnvknv*****skdnvjksd', - ], - 'level' => [ - 'description' => '语音转写优先级', - 'type' => 'string', - 'required' => false, - 'example' => 'low', ], ], - 'required' => false, ], - 'variables' => [ - 'description' => '变量列表', + 'ragStatus' => ['description' => 'rag执行状态', 'type' => 'string', 'example' => 'SUCCESS'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ], + 403 => [ + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], + ], + 500 => [ + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\\\n\\",\\n \\"inputTokens\\": \\"4672\\",\\n \\"outputTokens\\": \\"621\\",\\n \\"totalTokens\\": \\"5609\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 4672,\\n \\"outputTokens\\": 621,\\n \\"invokeCount\\": 3\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 4672,\\n \\"outputTokens\\": 621,\\n \\"invokeCount\\": 3\\n }\\n }\\n },\\n \\"ragStatus\\": \\"SUCCESS\\"\\n}","type":"json"}]', + 'title' => '通过模版ID调用通义晓蜜CCAI-对话分析AIO应用', + 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" + ."\n" + .'前提条件'."\n" + .'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" + .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/document_detail/2782167.html?spm=a2c4g.2782164.0.0.2b2b6dcdZZ5oUE)。', + 'changeSet' => [ + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-04-01T02:08:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-09-06T03:50:11.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2024-07-02T08:31:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-07-01T08:41:21.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2024-06-14T09:00:50.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletion'], + ], + ], + ], + 'RunCompletionMessage' => [ + 'summary' => '支持以Message协议格式调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果，应用调用支持 HTTP 调用来完成客户的响应，目前提供普通 HTTP 和 HTTP SSE 两种协议，您可根据自己的需求自行选择。', + 'path' => '/{workspaceId}/ccai/app/{appId}/completion_message', + 'methods' => ['post'], + 'schemes' => ['http', 'https', 'sse'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => '子业务空间标识', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n"], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => '097d65c9c7004f8dad2b454850ac232b'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'schema of request body', + 'type' => 'object', + 'properties' => [ + 'Messages' => [ + 'description' => '模型请求Message列表', 'type' => 'array', 'items' => [ - 'description' => '变量列表', + 'description' => 'Message结构信息', 'type' => 'object', 'properties' => [ - 'variableCode' => [ - 'description' => '变量code', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'variableValue' => [ - 'description' => '变量值', + 'Content' => ['description' => 'prompt内容', 'type' => 'string', 'required' => true, 'example' => '如Role=system ,Content=You are a helpful assistant.'."\n" + .'Role=user , Content=请阅读以下对话内容，按照要求执行指令任务。'], + 'Role' => [ + 'description' => '（通话角色） user-客户 agent-客服 system-系统消息 function-函数', 'type' => 'string', - 'required' => false, - 'example' => '张三', + 'required' => true, + 'example' => 'user', + 'enum' => ['user', 'assistant', 'system', 'function'], ], ], 'required' => false, ], - 'required' => false, + 'required' => true, ], - 'responseFormatType' => [ - 'description' => '输出结果格式化类型，jsonObject-json结构，text-原始字符串', + 'ModelCode' => [ + 'description' => '模型规格', 'type' => 'string', 'required' => false, - 'example' => 'jsonObject', + 'example' => 'tyxmTurbo', + 'default' => 'tyxmTurbo', + 'enum' => ['tyxmTurbo', 'tyxmPlus'], ], - 'stream' => [ - 'description' => '是否流式返回结果，流式返回-true，全量返回-false', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', + 'Stream' => ['description' => 'true则会开启 SSE 响应，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + 'responseFormatType' => ['type' => 'string', 'required' => false, 'description' => ''], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response结构信息', + 'type' => 'object', + 'properties' => [ + 'FinishReason' => ['description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'], + 'RequestId' => ['description' => '系统生成的标志本次请求的唯一性ID', 'type' => 'string', 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n"], + 'Text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。'], + 'inputTokens' => ['type' => 'string', 'description' => ''], + 'outputTokens' => ['type' => 'string', 'description' => ''], + 'totalTokens' => ['type' => 'string', 'description' => ''], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ], + 403 => [ + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], + ], + 500 => [ + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"\\",\\n \\"outputTokens\\": \\"\\",\\n \\"totalTokens\\": \\"\\"\\n}","type":"json"}]', + 'title' => '使用原生Prompt调用通义晓蜜CCAI-对话分析AIO应用', + 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" + ."\n" + .'前提条件'."\n" + .'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" + .'2. 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/document_detail/2782167.html?spm=a2c4g.2782164.0.0.2b2b6dcdZZ5oUE)。', + 'changeSet' => [ + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-09-06T03:50:11.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2024-07-01T08:41:21.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ], + ], + 'UpdateVocab' => [ + 'summary' => '根据词表的ID可以更新对应的词表信息，包括词表名称、词表描述信息、词表的词和权重。', + 'path' => '/vocab/updateVocab', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'required' => true, 'example' => 'dsvsv***dsvv'], + 'name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => '热词1'], + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => '销售热词'], + 'wordWeightList' => [ + 'description' => '热词组', + 'type' => 'array', + 'items' => [ + 'description' => '热词组', + 'type' => 'object', + 'properties' => [ + 'word' => ['description' => '单词', 'type' => 'string', 'required' => true, 'example' => '虹桥'], + 'weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], + ], + 'required' => false, + ], + 'required' => false, ], + 'workspaceId' => ['description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-jhfr****w8v'], ], 'required' => false, ], @@ -3782,159 +2244,127 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'finishReason' => [ - 'description' => '如果是流式输出，正在生成时为null，生成结束时如果由于停止token导致则为stop。', - 'type' => 'string', - 'example' => 'stop', - ], - 'success' => [ - 'description' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'True', - ], - 'text' => [ - 'description' => '应用返回的结果。', - 'type' => 'string', - 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。', - ], - 'inputTokens' => [ - 'description' => '输入Token数量', - 'type' => 'string', - 'example' => '1000', - ], - 'outputTokens' => [ - 'description' => '输出Token数量', - 'type' => 'string', - 'example' => '2000', - ], - 'totalTokens' => [ - 'description' => 'Tokens总量', - 'type' => 'string', - 'example' => '3000', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'], + 'data' => ['description' => '返回数据', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => '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).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => '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).', 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], ], 403 => [ - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败，指定参数缺失。'], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误，请稍后重试'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]', - 'title' => '语音文件实时分析', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '修改热词', 'description' => '请确保在使用该接口前，已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n" ."\n" - .'## 前提条件'."\n" - ."\n" - .'- 1.已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" - .'- 2.已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.3491281fOQZK5f)。'."\n" - ."\n" - .'## 注意事项'."\n" + .'前提条件'."\n" ."\n" - .'- 1.超过3分钟的音频请使用离线任务分析。'."\n" - .'- 2.目前支持双轨录音文件，并且需要指定声轨对应的角色。', - 'requestParamsDescription' => '## 接口请求示例'."\n" + .'- 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n" + .'- 已创建应用：应用中心完成通义晓蜜CCAI-对话分析AIO应用创建，并获取到APP-ID和WORKSPACE-ID：[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.39e3281fMO5qOX)。', + 'requestParamsDescription' => '## 请求代码示例'."\n" .'```java'."\n" ."\n" .'import com.alibaba.fastjson.JSONObject;'."\n" .'import com.aliyun.contactcenterai20240603.Client;'."\n" - .'import com.aliyun.contactcenterai20240603.models.AnalyzeAudioSyncRequest;'."\n" - .'import com.aliyun.contactcenterai20240603.models.AnalyzeAudioSyncResponse;'."\n" - ."\n" + .'import com.aliyun.contactcenterai20240603.models.*;'."\n" .'import com.aliyun.teaopenapi.models.Config;'."\n" ."\n" .'import java.util.ArrayList;'."\n" .'import java.util.List;'."\n" ."\n" - .'public class CCAiTask {'."\n" + .'public class Vocab {'."\n" ."\n" - .' public static void main(String[] args) throws Exception {'."\n" - .' String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n" - .' String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n" - .' String workspaceId = "YOUR_WORKSPACEID";'."\n" - .' String appId = "YOUR_APPID";'."\n" + .' private static String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n" + .' private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n" + ."\n\n" + .' private static String workspaceId = "YOUR_WORKSPACE_ID";'."\n" ."\n" - .' Config config = new Config();'."\n" + .' private static Config config = new Config();'."\n" + ."\n" + .' static {'."\n" .' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n" - .' .setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n" + .' .setReadTimeout(30000).setConnectTimeout(300000).setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n" + .' }'."\n" ."\n" + .' public static void main(String[] args) throws Exception {'."\n" .' Client client = new Client(config);'."\n" ."\n" - .' AnalyzeAudioSyncRequest request = new AnalyzeAudioSyncRequest();'."\n" - .' request.setStream(false);'."\n" - ."\n" - .' request.setModelCode("tyxmPlus");'."\n" + .' UpdateVocabRequest request = new UpdateVocabRequest();'."\n" + .' request.setVocabularyId("f3d82e0d********d23bd7");'."\n" + .' request.setName("销售热词");'."\n" + .' request.setDescription("南方一区销售热词");'."\n" + .' request.setWorkspaceId(workspaceId);'."\n" ."\n" - .' List<String> typeList = new ArrayList<>();'."\n" - .' typeList.add("summary");'."\n" - .' request.setResultTypes(typeList);'."\n" + .' List<UpdateVocabRequest.UpdateVocabRequestWordWeightList> wordWeightList = new ArrayList<>();'."\n" + .' UpdateVocabRequest.UpdateVocabRequestWordWeightList word1 = new UpdateVocabRequest.UpdateVocabRequestWordWeightList();'."\n" + .' word1.setWord("欧洲");'."\n" + .' word1.setWeight(4);'."\n" + .' wordWeightList.add(word1);'."\n" ."\n" - .' AnalyzeAudioSyncRequest.AnalyzeAudioSyncRequestTranscription transcription = new AnalyzeAudioSyncRequest.AnalyzeAudioSyncRequestTranscription();'."\n" - .' transcription.setFileName("out**.wav");'."\n" - .' transcription.setVoiceFileUrl("https://age***.com/out**.wav");'."\n" - .' transcription.setServiceChannel(1);'."\n" - .' transcription.setClientChannel(0);'."\n" + .' UpdateVocabRequest.UpdateVocabRequestWordWeightList word2 = new UpdateVocabRequest.UpdateVocabRequestWordWeightList();'."\n" + .' word2.setWord("耳痛");'."\n" + .' word2.setWeight(2);'."\n" + .' wordWeightList.add(word2);'."\n" ."\n" - .' request.setTranscription(transcription);'."\n" + .' request.setWordWeightList(wordWeightList);'."\n" ."\n" - .' AnalyzeAudioSyncResponse response = client.analyzeAudioSync(workspaceId, appId, request);'."\n" + .' UpdateVocabResponse response = client.updateVocab(request);'."\n" .' System.out.println(JSONObject.toJSONString(response));'."\n" .' }'."\n" - .' '."\n" .'}'."\n" ."\n" .'```', + 'changeSet' => [], ], ], 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'contactcenterai.cn-shanghai.aliyuncs.com', 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', 'vpc' => 'contactcenterai-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'CCAI.IllegalPermission.NoAuth', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => '该用户未被授权可操作指定资源'], + ['code' => 'CCAI.IllegalPermission.NoAuth', 'message' => 'User not authorized to operate on the specified resource %s .', 'http_code' => 403, 'description' => '该用户未被授权可操作指定资源'], + ['code' => 'CCAI.InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => '系统内部错误，请稍后重试'], + ['code' => 'CCAI.InvalidParam.NotExist', 'message' => 'The specified parameter %s is not valid.', 'http_code' => 400, 'description' => '请求API的参数不存在'], + ['code' => 'CCAI.ParamInvalid.IllegalParamValue', 'message' => 'The parameter value of the request API is illegal %s.', 'http_code' => 400, 'description' => '请求API的参数不合法'], + ['code' => 'CCAI.ParamNotfound.MissParam', 'message' => 'Parameter verification failed, The specified parameter %s is missing.', 'http_code' => 403, 'description' => '参数校验失败，指定参数缺失。'], + ['code' => 'CCAI.TenantPermission.NoAuth', 'message' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'http_code' => 403, 'description' => '当前账号没有指定业务空间的权限，请进行业务空间权限授权。'], + ['code' => 'CCAI.Throttling.Qpm', 'message' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'http_code' => 400, 'description' => '触发QPM限流，付费API请购买更高QPM，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ['code' => 'Ccai.Throttling.Qps', 'message' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'http_code' => 429, 'description' => '无效错误码，后续下线'], + ['code' => 'CCAI.Throttling.Qps', 'message' => '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).', 'http_code' => 400, 'description' => '触发限流，付费API请购买更高QPS，免费API如有特殊需求，请通过钉钉群（62730018475）联系我们。'."\n"], + ], + 'changeSet' => [ [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'RunCompletion'], + ], + 'createdAt' => '2024-06-14T09:00:55.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskResult'], + ['threshold' => '30', 'countWindow' => 2, 'regionId' => '*', 'api' => 'AnalyzeConversation'], + ['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletion'], + ['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletionMessage'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeAudioSync'], ], ], ]; |