'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'ContactCenterAI', 'version' => '2024-06-03', ], 'directories' => [ 'RunCompletion', 'RunCompletionMessage', 'AnalyzeConversation', 'GetTaskResult', 'CreateTask', 'AnalyzeImage', 'GeneralAnalyzeImage', [ 'id' => 203152, 'title' => '热词管理', 'type' => 'directory', 'children' => [ 'CreateVocab', 'UpdateVocab', 'ListVocab', 'DeleteVocab', 'GetVocab', ], ], [ 'id' => 204673, 'title' => '不推荐或白名单开放', 'type' => 'directory', 'children' => [ 'AnalyzeAudioSync', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ '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' => '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' => 'request body结构信息', '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' => '信息抽取时，需要抽取的字段列表', 'type' => 'array', 'items' => [ 'description' => '字段结构信息', 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber', ], 'Desc' => [ 'description' => '字段描述', 'type' => 'string', 'required' => false, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。', ], 'EnumValues' => [ 'description' => '枚举值列表', 'type' => 'array', 'items' => [ 'description' => '枚举值结构信息', 'type' => 'object', 'properties' => [ '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, ], 'ModelCode' => [ 'description' => '模型规格', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'tyxmPlus' => 'tyxmPlus', 'tyxmTurbo' => 'tyxmTurbo', ], 'example' => 'tyxmTurbo', 'default' => 'tyxmTurbo', 'enum' => [ 'tyxmTurbo', 'tyxmPlus', ], ], 'ServiceInspection' => [ 'description' => '服务质检结构信息', 'type' => 'object', 'properties' => [ 'InspectionContents' => [ 'description' => '服务质检维度结构列表', 'type' => 'array', 'items' => [ 'description' => '服务质检维度结构', 'type' => 'object', 'properties' => [ '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' => '保险销售场景', ], ], 'required' => false, ], 'Stream' => [ 'description' => 'true则会开启 SSE 响应，默认false', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', 'default' => 'false', ], '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' => '变量列表', 'type' => 'object', 'properties' => [ 'variableCode' => [ 'description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name', ], 'variableValue' => [ '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' => [ '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', ], ], ], ], ], ], ], '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列表', 'type' => 'array', 'items' => [ 'description' => 'Message结构信息', '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', ], ], ], '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, ], ], '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', ], 'outputTokens' => [ 'type' => 'string', ], 'totalTokens' => [ '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 \\"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)。', ], 'AnalyzeConversation' => [ 'summary' => '获取对话摘要、标题生成、关键词、字段信息抽取、问题及解决方案、服务质检、代办事项、满意度、情绪检测、QA抽取、用户画像、标签分类等对话分析结果，应用调用支持 HTTP 调用来完成客户的响应。', 'path' => '/{workspaceId}/ccai/app/{appId}/analyze_conversation', 'methods' => [ 'post', ], 'schemes' => [ 'https', 'sse', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/octet-stream', 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', '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', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体。', 'type' => 'object', 'properties' => [ 'categoryTags' => [ 'description' => '标签分类列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'tagDesc' => [ 'description' => '标签描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为', ], 'tagName' => [ 'description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺', ], ], 'required' => false, ], 'required' => false, ], 'dialogue' => [ 'description' => '对话内容列表', 'type' => 'object', 'properties' => [ 'sentences' => [ 'description' => '对话内容', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'role' => [ 'description' => '通话角色：'."\n" ."\n" .'- user-客户'."\n" ."\n" .'- agent-客服'."\n" ."\n" .'- system-系统消息', 'type' => 'string', 'required' => true, 'example' => 'user', 'enum' => [ 'user', 'agent', 'system', ], ], 'text' => [ 'description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '请问怎么申请新卡'."\n", ], ], 'required' => true, ], 'required' => true, ], 'sessionId' => [ 'description' => '客服会话sessionId', 'type' => 'string', 'required' => false, 'example' => 'session-01', ], ], 'required' => false, ], 'examples' => [ 'description' => '指令示例列表', 'type' => 'array', 'items' => [ 'description' => '指令示例', 'type' => 'object', 'properties' => [ 'output' => [ 'description' => '输出示例', 'type' => 'string', 'required' => true, 'example' => '问题描述：询问2.2更新时间，处理方案：已告知', ], 'sentences' => [ 'description' => '对话内容示例列表', 'type' => 'array', 'items' => [ 'description' => '对话内容示例', 'type' => 'object', 'properties' => [ 'chatId' => [ 'description' => '每一轮对话id', 'type' => 'string', 'required' => false, 'example' => 'chat-01', ], 'role' => [ 'description' => '通话角色：'."\n" ."\n" .'- user-客户'."\n" ."\n" .'- agent-客服'."\n" ."\n" .'- system-系统消息', 'type' => 'string', 'required' => true, 'example' => 'user', 'enum' => [ 'user', 'agent', 'system', ], ], 'text' => [ 'description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '什么时候更新', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], 'required' => false, ], 'fields' => [ 'description' => '信息抽取时，需要抽取的字段列表', 'type' => 'array', 'items' => [ 'description' => '字段结构信息', 'type' => 'object', 'properties' => [ '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", ], ], 'required' => true, ], 'required' => false, ], 'name' => [ 'description' => '字段名称', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'."\n", ], ], 'required' => true, ], 'required' => false, ], 'modelCode' => [ 'description' => '模型code', 'type' => 'string', 'required' => false, 'example' => 'tyxmTurbo', 'default' => 'tyxmTurbo', '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-标签分类', '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', ], ], 'required' => true, ], 'sceneName' => [ 'description' => '场景名称', 'type' => 'string', 'required' => false, 'example' => '阿里云工单质检场景'."\n", ], 'serviceInspection' => [ 'description' => '服务质检结构信息', 'type' => 'object', 'properties' => [ 'inspectionContents' => [ 'description' => '服务质检维度结构列表', 'type' => 'array', 'items' => [ 'description' => '服务质检维度结构', 'type' => 'object', 'properties' => [ '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", ], ], 'required' => 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' => '表示客户的性别，从列表[“男”, “女”]中选择一个值', ], ], 'required' => false, ], 'required' => false, ], 'timeConstraintList' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, ], 'required' => false, ], 'sourceCallerUid' => [ 'type' => 'string', 'required' => false, ], 'customPrompt' => [ 'type' => 'string', 'required' => false, ], 'responseFormatType' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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', ], ], ], ], ], '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.', ], ], 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 .', ], ], 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 \\"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"}]', 'title' => '通过任务类型调用通义晓蜜CCAI-对话分析AIO应用', '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/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.41df281fWNMfrx)。', ], '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' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, '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' => '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', ], ], ], ], ], '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 %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).', ], ], 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 \\"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获取离线任务分析结果', '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/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.310f281ffuUD8V)。', ], 'CreateTask' => [ 'summary' => '通过创建离线异步任务，进行对话分析。应用调用支持 HTTP 调用来完成客户的响应。', 'path' => '/{workspaceId}/ccai/app/{appId}/createTask', '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' => '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', 'type' => 'object', 'properties' => [ 'dialogue' => [ 'description' => '对话内容列表', 'type' => 'object', 'properties' => [ 'sentences' => [ 'description' => '对话内容', 'type' => 'array', 'items' => [ 'description' => '对话内容', 'type' => 'object', 'properties' => [ 'role' => [ 'description' => '通话角色'."\n" ."\n" .'- user：客户'."\n" .'- agent：客服'."\n" .'- system：系统消息', 'type' => 'string', 'required' => true, 'example' => 'user', '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', ], ], 'required' => false, ], 'examples' => [ 'description' => '指令示例', 'type' => 'object', 'properties' => [ 'output' => [ 'description' => '输出示例', 'type' => 'string', 'required' => false, 'example' => '问题描述：询问2.2更新时间，处理方案：已告知', ], 'sentences' => [ 'description' => '对话内容示例', 'type' => 'array', 'items' => [ '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' => '什么时候更新', ], ], 'required' => true, ], 'required' => true, 'docRequired' => false, ], ], 'required' => false, ], 'fields' => [ 'description' => '字段结构信息', 'type' => 'array', 'items' => [ 'description' => '字段结构信息', 'type' => 'object', 'properties' => [ 'code' => [ 'description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n", ], 'desc' => [ 'description' => '字段描述', 'type' => 'string', 'required' => true, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n", ], 'enumValues' => [ 'description' => '枚举值列表', 'type' => 'array', 'items' => [ 'description' => '枚举值列表', 'type' => 'object', 'properties' => [ '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", ], ], 'required' => true, ], 'required' => false, ], 'modelCode' => [ 'description' => '模型code', 'type' => 'string', 'required' => true, 'example' => 'tyxmTurbo', 'enum' => [ 'tyxmTurbo', 'tyxmPlus', ], ], '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', 'enum' => [ 'summary', 'title', 'fields', 'keywords', 'service_inspection', 'question_solution', 'custom_prompt', 'category_tag', 'questions_and_answer', 'service_finish', 'actions', 'satisfaction', 'emotion_detection', ], ], 'required' => false, ], 'serviceInspection' => [ 'description' => '服务质检结构信息', 'type' => 'object', 'properties' => [ 'inspectionContents' => [ 'description' => '服务质检维度结构', 'type' => 'array', 'items' => [ 'description' => '服务质检维度结构', 'type' => 'object', 'properties' => [ '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", ], ], 'required' => false, ], 'taskType' => [ 'description' => '任务类型 audio -语音文件 ，text - 文本', 'type' => 'string', 'required' => true, 'example' => 'text', 'enum' => [ 'audio', 'text', ], ], 'templateIds' => [ 'description' => '模版id列表', 'type' => 'array', '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', ], 'serviceChannelKeywords' => [ 'description' => '多数情况下适用于单轨录音，设置一组客服可能说的关键词列表（请确保选择那些区别性比较高的关键词），通过对转写文本从上到下逐句分析，当一句话命中某一个关键词时，则判定该句的角色为客服，则另一个角色就是客户。', 'type' => 'array', 'items' => [ 'description' => '多数情况下适用于单轨录音，设置一组客服可能说的关键词列表（请确保选择那些区别性比较高的关键词），通过对转写文本从上到下逐句分析，当一句话命中某一个关键词时，则判定该句的角色为客服，则另一个角色就是客户。', 'type' => 'string', 'required' => false, 'example' => '你好', ], 'required' => false, ], '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', ], ], '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', ], ], 'required' => false, ], 'customPrompt' => [ 'description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结', ], 'variables' => [ 'description' => '变量列表', 'type' => 'array', 'items' => [ 'description' => '变量列表', 'type' => 'object', 'properties' => [ 'variableCode' => [ 'description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name', ], 'variableValue' => [ 'description' => '变量值', 'type' => 'string', 'required' => false, 'example' => '张三', ], ], 'required' => false, ], 'required' => false, ], 'categoryTags' => [ 'description' => '标签分类列表', 'type' => 'array', 'items' => [ 'description' => '标签分类列表', 'type' => 'object', 'properties' => [ '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', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'data' => [ 'description' => '数据', 'type' => 'object', 'properties' => [ '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', ], ], ], ], ], '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.', ], ], 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).', ], ], 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 \\"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" ."\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" .'- 1.目前任务数据在服务端保存时间为90天。'."\n" .'- 2.对话内容字数限制为2万字，超过部分会自动截断。'."\n" .'- 3.音频文件建议使用8k采样率，使用其他采样率会影响最终效果。', 'requestParamsDescription' => '## 语音识别参数说明'."\n" ."\n" .'上传语音文件时，需要通过 serviceChannel 或 clientChannel 设置不同角色的音轨，后台服务通过音轨来识别角色。或是通过 serviceChannelKeywords 设置客服通话中的关键字，后台服务通过客服通话中的关键字来识别角色。'."\n" ."\n" .'## 回调参数说明'."\n" .'假设调用方传入的回调地址是：http://aliyun.com/callback，那么回调时的完整 URL 为http://aliyun.com/callback?taskId=xxx×tamp=xxx&taskType=xxx&signature=xxx&&success=xxx，其中：'."\n" ."\n" .'- taskId：为任务 ID'."\n" .'- timestamp：为调用时的时间戳，单位：毫秒 '."\n" .'- taskType：为任务类型 '."\n" .'- success：为是否成功'."\n" .'- signature：为签名，调用方可用来判断请求是否来自阿里云；计算说明：将taskId=xxx×tamp=xxx&aliUid=xxx进行 md5+base64 加密，注意顺序；调用方接到回调后，taskId 和 timestamp 可以从回调 URL 中获取，aliUid 即为阿里云主账号 ID。通过计算来比对自己计算出的 signature，与 URL 中的 signature 是否一致，详见下方 Java 代码示例。'."\n" ."\n" .'```java'."\n" .'import java.net.URLEncoder;'."\n" .'import java.security.MessageDigest;'."\n" .'import java.security.NoSuchAlgorithmException;'."\n" .'import java.nio.charset.StandardCharsets;'."\n" .'import org.apache.commons.codec.binary.Base64;'."\n" ."\n" .'public class Sample {'."\n" ."\n" .' public static void signature() {'."\n" .' long timestamp = System.currentTimeMillis();'."\n" .' String taskId = "xxx";'."\n" .' String aliUid = "xxx";'."\n" .' // 将 taskId=xxx×tamp=xxx&aliUid=xxx 进行 md5 + base64 加密，放在 signature 字段'."\n" .' String signature;'."\n" .' try {'."\n" .' signature = URLEncoder.encode(md5Base64("taskId=" + taskId + "×tamp=" + timestamp + "&aliUid=" + aliUid), "utf-8");'."\n" .' System.out.println(signature);'."\n" .' } catch (Exception e) {'."\n" .' e.printStackTrace();'."\n" .' }'."\n" .' }'."\n" ."\n" .' public static String md5Base64(String str) throws NoSuchAlgorithmException {'."\n" .' //string 编码必须为 utf-8'."\n" .' byte[] utfBytes = str.getBytes(StandardCharsets.UTF_8);'."\n" .' MessageDigest mdTemp = MessageDigest.getInstance("MD5");'."\n" .' mdTemp.update(utfBytes);'."\n" .' byte[] md5Bytes = mdTemp.digest();'."\n" .' return Base64.encodeBase64String(md5Bytes);'."\n" .' }'."\n" .'}'."\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', ], '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', ], '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' => [ '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' => '大树', ], ], 'required' => true, ], 'required' => true, ], ], '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' => '968A8634-FA2C-5381-9B3E-*******F', ], 'success' => [ 'description' => '调用是否成功', 'type' => 'string', 'example' => 'True', ], 'data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'vocabularyId' => [ 'description' => '热词id', 'type' => 'string', 'example' => 'f3d82*******7', ], ], ], ], ], ], ], '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', ], '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" ."\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" ."\n" .'- 默认最多创建10个词表。'."\n" ."\n" .'- 每个词表最多添加500个词，每个词语最长10个字。'."\n" ."\n" .'- 业务专属热词必须为UTF-8编码，不能包含标点、特殊字符。'."\n" ."\n" .'- 业务专属词对应的权重取值范围为[-6,5]之间的整数。'."\n" ."\n" .'- 取值大于0增大该词语被识别的概率，小于0减小该词语被识别的概率。'."\n" ."\n" .'- 取值为-6：表示尽量不要识别出该词语。'."\n" ."\n" .'- 取值为2：常用值。'."\n" ."\n" .'- 如果效果不明显可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确。'."\n" ."\n" .'## 接口请求示例'."\n" .'```java'."\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.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" ."\n" .' private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\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" .' CreateVocabRequest request = new CreateVocabRequest();'."\n" .' request.setName("销售词表");'."\n" .' request.setDescription("东北一区销售业务专用");'."\n" .' request.setWorkspaceId(workspaceId);'."\n" ."\n" .' List wordWeightList = new ArrayList<>();'."\n" .' CreateVocabRequest.CreateVocabRequestWordWeightList word1 = new CreateVocabRequest.CreateVocabRequestWordWeightList();'."\n" .' word1.setWord("儿童");'."\n" .' word1.setWeight(3);'."\n" .' wordWeightList.add(word1);'."\n" ."\n" .' CreateVocabRequest.CreateVocabRequestWordWeightList word2 = new CreateVocabRequest.CreateVocabRequestWordWeightList();'."\n" .' word2.setWord("金属");'."\n" .' word2.setWeight(3);'."\n" .' wordWeightList.add(word2);'."\n" ."\n" .' request.setWordWeightList(wordWeightList);'."\n" ."\n" .' CreateVocabResponse response = client.createVocab(request);'."\n" .' System.out.println(JSONObject.toJSONString(response));'."\n" .' }'."\n" .'}'."\n" ."\n" .'```', ], '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, ], ], ], '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' => '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).', ], ], 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 \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', 'title' => '修改热词', '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" .' UpdateVocabRequest request = new UpdateVocabRequest();'."\n" .' request.setVocabularyId("f3d82e0d********d23bd7");'."\n" .' request.setName("销售热词");'."\n" .' request.setDescription("南方一区销售热词");'."\n" .' request.setWorkspaceId(workspaceId);'."\n" ."\n" .' List 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" .' System.out.println(JSONObject.toJSONString(response));'."\n" .' }'."\n" .'}'."\n" ."\n" .'```', ], 'ListVocab' => [ 'summary' => '列举指定业务空间下的热词列表信息。', 'path' => '/vocab/listVocab', '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' => [ 'workspaceId' => [ 'description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-jhfr****8v', ], ], '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' => '968A8634-FA2C-5381-9B3E-*******F', ], 'success' => [ 'description' => '请求是否成功', 'type' => 'string', 'example' => 'true', ], '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', ], 'wordWeightList' => [ 'description' => '热词组', 'type' => 'array', 'items' => [ 'description' => '热词组', 'type' => 'object', 'properties' => [ 'word' => [ 'description' => '单词', 'type' => 'string', 'example' => '儿童', ], 'weight' => [ 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], ], ], ], ], ], ], ], ], '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', ], '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" ."\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', ], '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' => 'ern*******rve', ], 'workspaceId' => [ 'description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-0*****jlg8s', ], ], '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' => '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).', ], ], 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 \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', 'title' => '删除热词', '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" .' DeleteVocabRequest request = new DeleteVocabRequest();'."\n" .' request.setVocabularyId("81a3*********2d7c8");'."\n" .' request.setWorkspaceId(workspaceId);'."\n" ."\n" .' DeleteVocabResponse response = client.deleteVocab(request);'."\n" .' System.out.println(JSONObject.toJSONString(response));'."\n" .' }'."\n" .'}'."\n" ."\n" .'```', ], 'GetVocab' => [ 'summary' => '根据词表的ID获取对应的词表信息。', 'path' => '/vocab/getVocab', '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' => 'dhbf***rbrdb', ], 'workspaceId' => [ 'description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-9864***1', ], ], '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' => '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' => [ 'description' => '热词组', 'type' => 'object', 'properties' => [ 'word' => [ 'description' => '单词', 'type' => 'string', 'example' => '儿童', ], 'weight' => [ 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], ], ], ], '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', ], '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" ."\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.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" .'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" .' GetVocabRequest request = new GetVocabRequest();'."\n" .' request.setVocabularyId("1a3188**********7d2e");'."\n" .' request.setWorkspaceId(workspaceId);'."\n" ."\n" .' GetVocabResponse response = client.getVocab(request);'."\n" .' System.out.println(JSONObject.toJSONString(response));'."\n" .' }'."\n" .'}'."\n" ."\n" .'```', ], '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' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '业务空间Id', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n", ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '应用id', 'type' => 'string', 'required' => true, 'example' => 'a070a49c681f4a95a0f0*********35c', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'properties' => [ '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'."\n", ], 'name' => [ 'description' => '字段名称', 'type' => 'string', 'required' => false, 'example' => '来电原因类型'."\n", ], 'desc' => [ 'description' => '字段描述', 'type' => 'string', 'required' => false, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n", ], 'enumValues' => [ 'description' => '枚举值列表', 'type' => 'array', 'items' => [ 'description' => '枚举值列表', 'type' => 'object', 'properties' => [ 'desc' => [ 'description' => '枚举描述', 'type' => 'string', 'required' => false, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n", ], 'enumValue' => [ 'description' => '枚举值', 'type' => 'string', 'required' => false, 'example' => '新业务拓展'."\n", ], ], 'required' => false, ], 'required' => false, ], ], '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', ], 'required' => false, ], 'serviceInspection' => [ 'description' => '服务质检结构信息', 'type' => 'object', 'properties' => [ 'inspectionContents' => [ 'description' => '质检项列表', 'type' => 'array', 'items' => [ 'description' => '质检项结构', 'type' => 'object', 'properties' => [ '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' => '保险销售场景'."\n", ], ], 'required' => false, ], 'templateIds' => [ 'description' => '模版id', 'type' => 'array', 'items' => [ 'description' => '模版id，模版id和指令任务类型同时存在时，优先使用模版id', 'type' => 'string', 'required' => false, 'example' => '34', ], 'required' => false, ], 'categoryTags' => [ 'description' => '标签分类列表', 'type' => 'array', 'items' => [ 'description' => '标签分类列表', 'type' => 'object', 'properties' => [ 'tagName' => [ 'description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺', ], 'tagDesc' => [ 'description' => '标签描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为', ], ], 'required' => false, ], 'required' => false, ], 'customPrompt' => [ 'description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结', ], 'transcription' => [ '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' => '你好', ], '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' => '变量列表', 'type' => 'array', 'items' => [ 'description' => '变量列表', 'type' => 'object', 'properties' => [ 'variableCode' => [ 'description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name', ], 'variableValue' => [ 'description' => '变量值', 'type' => 'string', 'required' => false, 'example' => '张三', ], ], 'required' => false, ], '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, ], ], ], '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' => '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.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', ], '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" ."\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 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" .'```', ], ], 'endpoints' => [ [ 'regionId' => 'cn-shanghai', 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', ], ], ];