diff options
Diffstat (limited to 'data/en_us/contactcenterai')
| -rw-r--r-- | data/en_us/contactcenterai/2024-06-03/api-docs.php | 4195 |
1 files changed, 1776 insertions, 2419 deletions
diff --git a/data/en_us/contactcenterai/2024-06-03/api-docs.php b/data/en_us/contactcenterai/2024-06-03/api-docs.php index faecc98..dcb3136 100644 --- a/data/en_us/contactcenterai/2024-06-03/api-docs.php +++ b/data/en_us/contactcenterai/2024-06-03/api-docs.php @@ -1,1061 +1,726 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'ContactCenterAI', - 'version' => '2024-06-03', - ], + 'info' => ['style' => 'ROA', 'product' => 'ContactCenterAI', 'version' => '2024-06-03'], 'directories' => [ 'RunCompletion', 'RunCompletionMessage', 'AnalyzeConversation', 'GetTaskResult', - 'CreateTask', 'AnalyzeImage', 'GeneralAnalyzeImage', [ - 'id' => 203152, - 'title' => null, + 'children' => ['CreateVocab', 'UpdateVocab', 'ListVocab', 'DeleteVocab', 'GetVocab'], 'type' => 'directory', - 'children' => [ - 'CreateVocab', - 'UpdateVocab', - 'ListVocab', - 'DeleteVocab', - 'GetVocab', - ], + 'title' => 'Hot word management', ], [ - 'id' => 204673, - 'title' => null, + 'children' => ['AnalyzeAudioSync'], + 'type' => 'directory', + 'title' => 'Not recommended or open via whitelist', + ], + [ + 'children' => ['CreateTask'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'AnalyzeAudioSync', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'RunCompletion' => [ - 'summary' => 'CCAI服务面API', - 'path' => '/{workspaceId}/ccai/app/{appId}/completion', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - 'sse', - ], + 'AnalyzeAudioSync' => [ + 'summary' => 'Analyzes conversations in audio files in real time. Applications send HTTPS requests to retrieve responses.', + 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeAudioSync', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n", 'title' => ''], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '097d65c9c7004f8dad2b454850ac232b', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'a070a49c681f4a95a0f0*********35c', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Dialogue' => [ - 'type' => 'object', - 'properties' => [ - 'Sentences' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ChatId' => [ - 'type' => 'string', - ], - 'Role' => [ - 'type' => 'string', - 'required' => true, - 'example' => 'user', - 'default' => 'user', - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'Text' => [ - 'type' => 'string', - 'required' => true, - ], - ], - ], - ], - 'SessionId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd25zc9c7004f8dad2b454d', - ], - ], - 'required' => true, - ], - 'Fields' => [ - 'description' => '', + 'modelCode' => ['description' => 'The model code.', 'type' => 'string', 'required' => false, 'example' => 'tyxmTurbo', 'title' => ''], + 'fields' => [ + 'description' => 'The structure of the fields.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The structure of the fields.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'phoneNumber', - ], - 'Desc' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'EnumValues' => [ + 'code' => ['description' => 'The field code.', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n", 'title' => ''], + 'name' => ['description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => '来电原因类型'."\n", 'title' => ''], + 'desc' => ['description' => 'The field description.', 'type' => 'string', 'required' => false, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n", 'title' => ''], + 'enumValues' => [ + 'description' => 'The list of enumeration values.', 'type' => 'array', 'items' => [ + 'description' => 'The list of enumeration values.', 'type' => 'object', 'properties' => [ - 'Desc' => [ - 'type' => 'string', - ], - 'EnumValue' => [ - 'type' => 'string', - 'required' => true, - ], + 'desc' => ['description' => 'The description of the enumeration value.', 'type' => 'string', 'required' => false, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n", 'title' => ''], + 'enumValue' => ['description' => 'The enumeration value.', 'type' => 'string', 'required' => false, 'example' => '新业务拓展'."\n", 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'required' => false, + 'title' => '', 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'ModelCode' => [ - 'description' => '', - 'type' => 'string', + 'resultTypes' => [ + 'description' => 'The task types.', + 'type' => 'array', + 'items' => ['description' => 'summary: conversation summary. title: title generation. fields: field information extraction. keywords: keyword extraction. service\\_inspection: service quality inspection. question\\_solution: problem and solution extraction. questions\\_and\\_answer: question and answer (QA) extraction. custom\\_prompt: custom instruction.', 'type' => 'string', 'required' => true, 'example' => 'summary', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'ccai-72b' => 'ccai-72b', - 'ccai-14b' => 'ccai-14b', - ], - 'example' => 'ccai-14b', - 'default' => 'tyxmTurbo', - 'enum' => [ - 'ccai-14b', - 'ccai-72b', - ], + 'title' => '', + 'example' => '', ], - 'ServiceInspection' => [ + 'serviceInspection' => [ + 'description' => 'The structure for service quality inspection.', 'type' => 'object', 'properties' => [ - 'InspectionContents' => [ + 'inspectionContents' => [ + 'description' => 'The list of inspection items.', 'type' => 'array', 'items' => [ + 'description' => 'The structure of an inspection item.', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'type' => 'string', - ], - 'Title' => [ - 'type' => 'string', - 'required' => true, - ], + 'content' => ['description' => 'The description of the inspection item.', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。', 'title' => ''], + 'title' => ['description' => 'The inspection name.', 'type' => 'string', 'required' => false, 'example' => '客服是否过度承诺'."\n", 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'InspectionIntroduction' => [ - 'type' => 'string', - ], - 'SceneIntroduction' => [ - 'type' => 'string', - ], + 'inspectionIntroduction' => ['description' => 'A detailed introduction and description of the service quality inspection scenario.', 'type' => 'string', 'required' => false, 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等', 'title' => ''], + 'sceneIntroduction' => ['description' => 'The service quality inspection scenario.', 'type' => 'string', 'required' => false, 'example' => '保险销售场景'."\n", 'title' => ''], ], - ], - 'Stream' => [ - 'description' => '', - 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'false', - 'default' => 'false', + 'title' => '', + 'example' => '', ], - 'TemplateIds' => [ - 'description' => '', + 'templateIds' => [ + 'description' => 'The template IDs.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10375', - ], - 'required' => true, + 'items' => ['description' => 'The template ID. If both a template ID and an instruction task type are specified, the template ID takes precedence.', 'type' => 'string', 'required' => false, 'example' => '34', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'variables' => [ + 'categoryTags' => [ + 'description' => 'The list of tag categorizations.', 'type' => 'array', 'items' => [ + 'description' => 'The list of tag categorizations.', 'type' => 'object', 'properties' => [ - 'variableCode' => [ - 'type' => 'string', - ], - 'variableValue' => [ - 'type' => 'string', - ], + 'tagName' => ['description' => 'The tag name.', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺', 'title' => ''], + 'tagDesc' => ['description' => 'The tag description.', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'responseFormatType' => [ - 'type' => 'string', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FinishReason' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n", - ], - 'Text' => [ - 'type' => 'string', - ], - 'inputTokens' => [ - 'type' => 'string', - ], - 'outputTokens' => [ - 'type' => 'string', - ], - 'totalTokens' => [ - 'type' => 'string', - ], - 'usage' => [ + 'customPrompt' => ['description' => 'The custom instruction.', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结', 'title' => ''], + 'transcription' => [ + 'description' => 'The runtime parameters for audio.', 'type' => 'object', 'properties' => [ - 'rag' => [ - 'type' => 'object', - 'properties' => [ - 'dialogSummary' => [ - 'type' => 'object', - 'properties' => [ - 'inputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'outputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'invokeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'adaptive' => [ - 'type' => 'object', - 'properties' => [ - 'inputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'outputTokens' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'invokeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], + 'autoSplit' => ['description' => 'This parameter is typically used for single-channel recordings. Valid values are 0 and 1. A value of 1 indicates that automatic channel splitting is enabled. A value of 0 indicates that automatic channel splitting is disabled. Default value: 1. Setting this parameter to 1 treats the uploaded audio as a single-channel recording. Automatic channel splitting requires additional processing time. For dual-channel recordings, set this parameter to 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'clientChannel' => ['description' => 'This parameter is used for dual-channel recordings. It specifies the channel number for the customer role. Valid values are 0 and 1. Default value: 1, which means channel 1 is the customer. Audio channels are typically numbered starting from 0, so two channels are 0 and 1. Confirm whether channel 0 is the agent or the customer. If using this parameter, also set the autoSplit parameter to 0. This parameter is ignored for single-channel files.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'serviceChannel' => ['description' => 'This parameter is used for dual-channel recordings. It specifies the channel number for the agent role. Valid values are 0 and 1. Default value: 0, which means channel 0 is the agent. Audio channels are typically numbered starting from 0, so two channels are 0 and 1. Confirm whether channel 0 is the agent or the customer. If using this parameter, also set the autoSplit parameter to 0. This parameter is ignored for single-channel files.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'fileName' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'sss.mp3', 'title' => ''], + 'voiceFileUrl' => ['description' => 'The URL of the file.', 'type' => 'string', 'required' => true, 'example' => 'http://1111.com/sss.mp3', 'title' => ''], + 'serviceChannelKeywords' => [ + 'description' => 'The list of keywords for the agent channel.', + 'type' => 'array', + 'items' => ['description' => 'This parameter is typically used for single-channel recordings. Set a list of keywords that the agent is likely to say. Make sure to choose highly distinctive keywords. The system analyzes the transcript sentence by sentence. When a sentence contains a specified keyword, the speaker of that sentence is identified as the agent, and the other speaker is identified as the customer.', 'type' => 'string', 'required' => false, 'example' => '你好', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'asrModelCode' => ['description' => 'The speech-to-text model. Valid values: nls (small model) and paraformer (large model).', 'type' => 'string', 'required' => false, 'example' => 'nls', 'title' => ''], + 'vocabularyId' => ['description' => 'The ID of the hotword vocabulary.', 'type' => 'string', 'required' => false, 'example' => 'esnvknv*****skdnvjksd', 'title' => ''], + 'level' => ['description' => 'The priority of the speech-to-text task.', 'type' => 'string', 'required' => false, 'example' => 'low', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - '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"}]', - ], - 'RunCompletionMessage' => [ - 'summary' => 'CCAI服务面API', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '097d65c9c7004f8dad2b454850ac232b', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'schema of request body', - 'type' => 'object', - 'properties' => [ - 'Messages' => [ - 'description' => '', + 'variables' => [ + 'description' => 'The list of variables.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of variables.', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'Role' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user', - 'enum' => [ - 'user', - 'assistant', - 'system', - 'function', - ], - ], + 'variableCode' => ['description' => 'The variable code.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'variableValue' => ['description' => 'The variable value.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - ], - 'ModelCode' => [ - 'description' => '', - 'type' => 'string', 'required' => false, - 'example' => 'ccai-14b', - 'default' => 'tyxmTurbo', - 'enum' => [ - 'ccai-14b', - 'ccai-72b', - ], - ], - 'Stream' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'responseFormatType' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], + 'responseFormatType' => ['description' => 'The format of the output. Valid values: jsonObject (JSON structure) and text (raw string).', 'type' => 'string', 'required' => false, 'example' => 'jsonObject', 'title' => ''], + 'stream' => ['description' => 'Specifies whether to return the result in a stream. Set to true for streaming output, or false for a complete response.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'FinishReason' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n", - ], - 'Text' => [ - 'type' => 'string', - ], - 'inputTokens' => [ - 'type' => 'string', - ], - 'outputTokens' => [ - 'type' => 'string', - ], - 'totalTokens' => [ - 'type' => 'string', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'finishReason' => ['description' => 'This parameter applies to streamed output. It is null during content generation. When generation finishes, the value is stop if a stop token ends the process.', 'type' => 'string', 'example' => 'stop', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'text' => ['description' => 'The result returned by the application.', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。', 'title' => ''], + 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'string', 'example' => '2000', 'title' => ''], + 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'string', 'example' => '3000', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]', + 'title' => 'Real-time Analysis of Audio Files', + 'description' => 'Before using this API, review the billing methods and pricing for the Tongyi Xiaomi CCAI-Conversation Analysis AIO product.'."\n" + ."\n" + .'## Prerequisites'."\n" + ."\n" + .'- 1\\. Activate the Tongyi Xiaomi CCAI-Conversation Analysis AIO service.'."\n" + ."\n" + .'- 2\\. Create an application. In the Application Center, create a Tongyi Xiaomi CCAI-Conversation Analysis AIO application and obtain the APP-ID and WORKSPACE-ID. For more information, see [Obtain an APP-ID and a 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" + .'## Notes'."\n" + ."\n" + .'- 1\\. Use offline tasks to analyze audio files longer than 3 minutes.'."\n" + ."\n" + .'- 2\\. Dual-channel audio files are supported. Specify the role for each channel.', + 'requestParamsDescription' => '## Examples'."\n" + ."\n" + .'```java'."\n" + ."\n" + .'import com.alibaba.fastjson.JSONObject;'."\n" + .'import com.aliyun.contactcenterai20240603.Client;'."\n" + .'import com.aliyun.contactcenterai20240603.models.AnalyzeAudioSyncRequest;'."\n" + .'import com.aliyun.contactcenterai20240603.models.AnalyzeAudioSyncResponse;'."\n" + ."\n" + .'import com.aliyun.teaopenapi.models.Config;'."\n" + ."\n" + .'import java.util.ArrayList;'."\n" + .'import java.util.List;'."\n" + ."\n" + .'public class CCAiTask {'."\n" + ."\n" + .' public static void main(String[] args) throws Exception {'."\n" + .' String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n" + .' String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n" + .' String workspaceId = "YOUR_WORKSPACEID";'."\n" + .' String appId = "YOUR_APPID";'."\n" + ."\n" + .' Config config = new Config();'."\n" + .' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n" + .' .setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n" + ."\n" + .' Client client = new Client(config);'."\n" + ."\n" + .' AnalyzeAudioSyncRequest request = new AnalyzeAudioSyncRequest();'."\n" + .' request.setStream(false);'."\n" + ."\n" + .' request.setModelCode("tyxmPlus");'."\n" + ."\n" + .' List<String> typeList = new ArrayList<>();'."\n" + .' typeList.add("summary");'."\n" + .' request.setResultTypes(typeList);'."\n" + ."\n" + .' AnalyzeAudioSyncRequest.AnalyzeAudioSyncRequestTranscription transcription = new AnalyzeAudioSyncRequest.AnalyzeAudioSyncRequestTranscription();'."\n" + .' transcription.setFileName("out**.wav");'."\n" + .' transcription.setVoiceFileUrl("https://age***.com/out**.wav");'."\n" + .' transcription.setServiceChannel(1);'."\n" + .' transcription.setClientChannel(0);'."\n" + ."\n" + .' request.setTranscription(transcription);'."\n" + ."\n" + .' AnalyzeAudioSyncResponse response = client.analyzeAudioSync(workspaceId, appId, request);'."\n" + .' System.out.println(JSONObject.toJSONString(response));'."\n" + .' }'."\n" + .' '."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeAudioSync'], + ], ], - '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"}]', ], 'AnalyzeConversation' => [ - 'summary' => '根据类型调用大模型', + 'summary' => 'Retrieves conversation analysis results including conversation summary, title generation, keywords, field information extraction, questions and solutions, service quality inspection, to-do items, satisfaction, emotion detection, QA extraction, user profiles, and tag categorization. The application invokes HTTP calls to complete customer responses.', 'path' => '/{workspaceId}/ccai/app/{appId}/analyze_conversation', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/octet-stream', - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/octet-stream', 'application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-368******3ifum', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-368******3ifum', 'title' => ''], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'a070a49c681f4a95a0f0*********35c', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'categoryTags' => [ + 'description' => 'The tag categorization list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'tagDesc' => [ - 'type' => 'string', - 'required' => false, - ], - 'tagName' => [ - 'type' => 'string', - 'required' => false, - ], + 'tagDesc' => ['description' => 'The tag description.', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为', 'title' => ''], + 'tagName' => ['description' => 'The tag name.', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'dialogue' => [ - 'description' => '', + 'description' => 'The list of dialogue content.', 'type' => 'object', 'properties' => [ 'sentences' => [ - 'description' => '', + 'description' => 'The dialogue content.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'role' => [ - 'description' => '', + 'description' => 'The conversation role. Valid values:'."\n" + ."\n" + .'- user: customer'."\n" + ."\n" + .'- agent: customer service representative'."\n" + ."\n" + .'- system: system message.', 'type' => 'string', 'required' => true, + 'enum' => ['user', 'agent', 'system'], 'example' => 'user', - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'text' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', + 'title' => '', ], + 'text' => ['description' => 'The dialogue text.', 'type' => 'string', 'required' => true, 'example' => '请问怎么申请新卡'."\n", 'title' => ''], ], 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], - 'sessionId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'session-01', - ], + 'sessionId' => ['description' => 'The customer service session ID.', 'type' => 'string', 'required' => false, 'example' => 'session-01', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'examples' => [ + 'description' => 'The list of instruction examples.', 'type' => 'array', 'items' => [ + 'description' => 'The instruction example.', 'type' => 'object', 'properties' => [ - 'output' => [ - 'type' => 'string', - 'required' => true, - ], + 'output' => ['description' => 'The output example.', 'type' => 'string', 'required' => true, 'example' => '问题描述：询问2.2更新时间，处理方案：已告知', 'title' => ''], 'sentences' => [ + 'description' => 'The list of dialogue content examples.', 'type' => 'array', 'items' => [ + 'description' => 'The dialogue content example.', 'type' => 'object', 'properties' => [ - 'chatId' => [ - 'type' => 'string', - 'required' => false, - ], + 'chatId' => ['description' => 'The ID of each conversation turn.', 'type' => 'string', 'required' => false, 'example' => 'chat-01', 'title' => ''], 'role' => [ + 'description' => 'The conversation role. Valid values:'."\n" + ."\n" + .'- user: customer'."\n" + ."\n" + .'- agent: customer service representative'."\n" + ."\n" + .'- system: system message.', 'type' => 'string', 'required' => true, - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'text' => [ - 'type' => 'string', - 'required' => true, + 'enum' => ['user', 'agent', 'system'], + 'example' => 'user', + 'title' => '', ], + 'text' => ['description' => 'The dialogue text.', 'type' => 'string', 'required' => true, 'example' => '什么时候更新', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'fields' => [ - 'description' => '', + 'description' => 'The list of fields to extract during information extraction.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The field structure information.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'phoneNumber'."\n", - ], - 'desc' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'code' => ['description' => 'The field code.', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n", 'title' => ''], + 'desc' => ['description' => 'The field description.', 'type' => 'string', 'required' => true, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n", 'title' => ''], 'enumValues' => [ - 'description' => '', + 'description' => 'The list of enumeration values.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'desc' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'enumValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'desc' => ['description' => 'The enumeration description.', 'type' => 'string', 'required' => true, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n", 'title' => ''], + 'enumValue' => ['description' => 'The enumeration value.', 'type' => 'string', 'required' => true, 'example' => '新业务拓展'."\n", 'title' => ''], ], 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', 'example' => '', ], + 'name' => ['description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'."\n", 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'modelCode' => [ - 'description' => '', + 'description' => 'The model code.', 'type' => 'string', - 'required' => false, 'example' => 'tyxmTurbo', 'default' => 'tyxmTurbo', - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], + 'enum' => ['tyxmTurbo', 'tyxmPlus'], + 'required' => false, + 'title' => '', ], 'resultTypes' => [ - 'description' => '', + 'description' => 'The instruction task types.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Valid values: summary (conversation summary), title (title generation), fields (field information extraction), keywords (keyword extraction), service_inspection (service quality inspection), question_solution (questions and solutions), actions (to-do items), satisfaction (satisfaction), emotion_detection (emotion detection), questions_and_answer (QA extraction), user_profile (user profile), category_tag (tag categorization), custom_prompt (custom instruction).', 'type' => 'string', 'required' => true, + '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'], 'example' => 'summary', - 'enum' => [ - 'summary', - 'title', - 'fields', - 'keywords', - 'service_inspection', - 'question_solution', - ], + 'title' => '', ], 'required' => true, - ], - 'sceneName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], + 'sceneName' => ['description' => 'The scenario name.', 'type' => 'string', 'required' => false, 'example' => '阿里云工单质检场景'."\n", 'title' => ''], 'serviceInspection' => [ - 'description' => '', + 'description' => 'The service quality inspection structure information.', 'type' => 'object', 'properties' => [ 'inspectionContents' => [ - 'description' => '', + 'description' => 'The list of service quality inspection dimension structures.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The service quality inspection dimension structure.', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'content' => ['description' => 'The description of the service quality inspection dimension.', 'type' => 'string', 'required' => true, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。', 'title' => ''], + 'title' => ['description' => 'The name of the service quality inspection dimension.', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺'."\n", 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => true, - ], - 'inspectionIntroduction' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'sceneIntroduction' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', 'example' => '', ], + 'inspectionIntroduction' => ['description' => 'The detailed introduction and description of the service quality inspection scenario.', 'type' => 'string', 'required' => true, 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等', 'title' => ''], + 'sceneIntroduction' => ['description' => 'The service quality inspection scenario.', 'type' => 'string', 'required' => true, 'example' => '保险销售场景'."\n", 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'stream' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'stream' => ['description' => 'Required. Specifies whether to use streaming output. Valid values: true (returns the answer in streaming mode) and false (returns the complete answer at once).', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], 'userProfiles' => [ + 'description' => 'The list of user profiles.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'name' => [ - 'type' => 'string', - 'required' => false, - ], - 'value' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'sex', 'title' => ''], + 'value' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '表示客户的性别，从列表[“男”, “女”]中选择一个值', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'timeConstraintList' => [ + 'description' => 'The time constraints that specify the time ranges the model should focus on or be limited to during analysis.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'sourceCallerUid' => [ - 'type' => 'string', - ], - 'customPrompt' => [ - 'type' => 'string', - ], - 'responseFormatType' => [ - 'type' => 'string', + 'items' => ['description' => 'The time information.', 'type' => 'string', 'required' => false, 'example' => '2026年1月', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'sourceCallerUid' => ['description' => 'Not required.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + 'customPrompt' => ['description' => 'The custom instruction. The instruction must contain ${dialogue}.', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结${dialogue}', 'title' => ''], + 'responseFormatType' => ['description' => 'The output result format type. Valid values: jsonObject (JSON structure) and text (raw string).', 'type' => 'string', 'required' => false, 'example' => 'jsonObject', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'errorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidUser.NotFound', - ], - 'errorInfo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'finishReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stop', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'text' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'inputTokens' => [ - 'type' => 'string', - ], - 'outputTokens' => [ - 'type' => 'string', - ], - 'totalTokens' => [ - 'type' => 'string', - ], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'errorInfo' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'finishReason' => ['description' => 'For streaming output, this value is null during generation and is set to stop when generation ends due to a stop token.', 'type' => 'string', 'example' => 'stop', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'The unique ID generated by the system to identify this request.', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'text' => ['description' => 'The result returned by the application.', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。', 'title' => ''], + 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'string', 'example' => '238', 'title' => ''], + 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'string', 'example' => '458', 'title' => ''], + 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'string', 'example' => '696', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], + ['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => 'Trigger current limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], ], 403 => [ - [ - 'errorCode' => 'CCAI.TenantPermission.NoAuth', - 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', - ], - [ - 'errorCode' => 'CCAI.ParamNotfound.MissParam', - 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', - ], - [ - 'errorCode' => 'CCAI.IllegalPermission.NoAuth', - 'errorMessage' => 'User not authorized to operate on the specified resource %s .', - ], + ['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter is missing.'], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource %s .', 'description' => 'The user is not authorized to operate the specified resource'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"errorCode\\": \\"success\\",\\n \\"errorInfo\\": \\"success\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"238\\",\\n \\"outputTokens\\": \\"458\\",\\n \\"totalTokens\\": \\"696\\"\\n}","type":"json"}]', + 'title' => 'Call tongyi xiaomi CCAI conversation analysis AIO application by task type', + 'description' => 'Before using this operation, make sure that you fully understand the billing methods and pricing of the Tongyi Xiaomi CCAI Conversation Analysis AIO product.'."\n" + ."\n" + .'Before you begin'."\n" + ."\n" + .'1. Activate the Tongyi Xiaomi CCAI Conversation Analysis AIO service.'."\n" + .'2. Create an application: Create a Tongyi Xiaomi CCAI Conversation Analysis AIO application in the Application Center and obtain the APP-ID and WORKSPACE-ID. For more information, see [Get APP-ID and WORKSPACE-ID](https://www.alibabacloud.com/help/en/model-studio/developer-reference/get-app-id-and-workspace).', + 'changeSet' => [ + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-05T01:49:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-20T02:54:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-05T02:01:27.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-13T10:57:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-24T02:47:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-19T08:06:31.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 2, 'regionId' => '*', 'api' => 'AnalyzeConversation'], ], ], - '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"}]', ], - 'GetTaskResult' => [ - 'summary' => '语音文件调用大模型获取结果', - 'path' => '/ccai/app/getTaskResult', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AnalyzeImage' => [ + 'summary' => 'Use the Tongyi Xiaomi CCAI Conversation Analysis AIO application to analyze image content, including watermark detection. Call this API using HTTP to obtain responses for your customers.', + 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeImage', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'multipart/form-data', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n", - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n", 'title' => ''], ], [ - 'name' => 'requiredFieldList', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'enum' => [ - 'asr_result', - 'debug', - 'rag_result', + 'description' => 'Request body.', + 'type' => 'object', + 'properties' => [ + 'stream' => ['description' => 'Required. Set to true to return results in streaming mode. Set to false to return the full result at once.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + 'imageUrls' => [ + 'description' => 'List of image URLs.', + 'type' => 'array', + 'items' => ['description' => 'A list of image URLs.', 'type' => 'string', 'required' => false, 'example' => 'https://img.123.com/1.jppg', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'resultTypes' => [ + 'description' => 'List of task types.', + 'type' => 'array', + 'items' => [ + 'description' => 'watermark: Analyze watermarks in images.', + 'enumValueTitles' => ['watermark_analysis' => 'watermark_analysis'], + 'type' => 'string', + 'enum' => ['watermark'], + 'required' => false, + 'example' => 'watermark', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'responseFormatType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -1063,587 +728,349 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'taskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n", - ], - 'text' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'taskErrorMessage' => [ - 'type' => 'string', - ], - 'taskStatus' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF', - ], - 'success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'True', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '9*****-AE0D-5EE3-B1AF-48632CB0831C'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'text' => ['description' => 'Response from the application.', 'type' => 'string', 'example' => '[{\\"num\\":\\"1\\",\\"isHit\\":\\"false\\",\\"remarks\\":\\"无水印\\"}]', 'title' => ''], + 'finishReason' => ['description' => 'If streaming is enabled, this field is null while the response is generating. When generation ends, this field is stop if the response ends because of a stop token.', 'type' => 'string', 'example' => 'stop', 'title' => ''], + 'inputTokens' => ['description' => 'Number of input tokens.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'outputTokens' => ['description' => 'Number of output tokens.', 'type' => 'string', 'example' => '2000', 'title' => ''], + 'totalTokens' => ['description' => 'Total number of tokens.', 'type' => 'string', 'example' => '3000', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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).', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"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' => 'Image Content Analysis', + 'description' => 'Before you use this API, review the pricing and billing model for the Tongyi Xiaomi CCAI Conversation Analysis AIO service.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'1. You can enable the Tongyi Xiaomi CCAI Conversation Analysis AIO service.'."\n" + ."\n" + .'2. You can create an application. In the Application Center, you can create a Tongyi Xiaomi CCAI Conversation Analysis AIO application and obtain your APP-ID and WORKSPACE-ID. For more information, see [Obtain APP-ID and WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.2eb8281f6Dxglg).', + 'changeSet' => [ + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], 'CreateTask' => [ - 'summary' => '创建语音文件调用llm任务', + 'summary' => 'You can perform conversation analysis by creating an offline asynchronous job. The application supports HTTP invocation to deliver the customer\'s response.'."\n", 'path' => '/{workspaceId}/ccai/app/{appId}/createTask', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n", 'title' => ''], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], + 'schema' => ['description' => 'Application ID', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Body', 'type' => 'object', 'properties' => [ 'dialogue' => [ - 'description' => '', + 'description' => 'List of Conversation Content ', 'type' => 'object', 'properties' => [ 'sentences' => [ - 'description' => '', + 'description' => 'Conversation Content ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Conversation Content ', 'type' => 'object', 'properties' => [ 'role' => [ - 'description' => '', + 'description' => 'The role in the conversation:'."\n" + ."\n" + .'- user: Customer'."\n" + .'- agent: Customer service representative'."\n" + .'- system: System message', 'type' => 'string', 'required' => true, 'example' => 'user', - 'enum' => [ - 'agent', - 'user', - 'system', - ], - ], - 'text' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', + 'enum' => ['agent', 'user', 'system'], + 'title' => '', ], + 'text' => ['description' => 'Conversation text', 'type' => 'string', 'required' => true, 'example' => '请问怎么申请新卡'."\n", 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], - 'sessionId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'session-01', - ], + 'sessionId' => ['description' => 'Session ID of the customer service session', 'type' => 'string', 'required' => false, 'example' => 'session-01', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'examples' => [ - 'description' => '', + 'description' => 'Instruction Sample ', 'type' => 'object', 'properties' => [ - 'output' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'output' => ['description' => 'Outputs Sample ', 'type' => 'string', 'required' => false, 'example' => '问题描述：询问2.2更新时间，处理方案：已告知', 'title' => ''], 'sentences' => [ - 'description' => '', + 'description' => 'Sample Content of Conversation ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Sample Content of Conversation ', 'type' => 'object', 'properties' => [ - 'role' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user', - ], - 'text' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'role' => ['description' => 'Conversation Role '."\n" + ."\n" + .'- user: Customer '."\n" + .'- agent: Customer Service Agent '."\n" + .'- system: System message ', 'type' => 'string', 'required' => true, 'example' => 'user', 'title' => ''], + 'text' => ['description' => 'Conversation Text ', 'type' => 'string', 'required' => true, 'example' => '什么时候更新', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => true, 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'fields' => [ - 'description' => '', + 'description' => 'Field structure information ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Field structure information ', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'phoneNumber'."\n", - ], - 'desc' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'code' => ['description' => 'Field encoding ', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n", 'title' => ''], + 'desc' => ['description' => 'Field description ', 'type' => 'string', 'required' => true, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。'."\n", 'title' => ''], 'enumValues' => [ - 'description' => '', + 'description' => 'List of enumeration values ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'List of enumeration values ', 'type' => 'object', 'properties' => [ - 'desc' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'enumValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'desc' => ['description' => 'Enumeration description ', 'type' => 'string', 'required' => true, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节'."\n", 'title' => ''], + 'enumValue' => ['description' => 'Enumeration value ', 'type' => 'string', 'required' => true, 'example' => '新业务拓展'."\n", 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => false, - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', 'example' => '', ], + 'name' => ['description' => 'Field Name ', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'."\n", 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'modelCode' => [ - 'description' => '', + 'description' => 'Model code ', 'type' => 'string', 'required' => true, 'example' => 'tyxmTurbo', - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], + 'enum' => ['tyxmTurbo', 'tyxmPlus'], + 'title' => '', ], 'resultTypes' => [ - 'description' => '', + 'description' => 'LLM processing types', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'summary – conversation summary, title – title generation, fields – field information extraction, keywords – keyword extraction, service_inspection – service quality inspection, question_solution – problem and solutions, questions_and_answer – QA pair extraction, custom_prompt – custom instruction', 'type' => 'string', 'required' => true, 'example' => 'summary', - 'enum' => [ - 'summary', - 'title', - 'fields', - 'keywords', - 'service_inspection', - 'question_solution', - ], + 'enum' => ['summary', 'title', 'fields', 'keywords', 'service_inspection', 'question_solution', 'custom_prompt', 'category_tag', 'questions_and_answer', 'service_finish', 'actions', 'satisfaction', 'emotion_detection'], + 'title' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'serviceInspection' => [ - 'description' => '', + 'description' => 'Service quality inspection structure information', 'type' => 'object', 'properties' => [ 'inspectionContents' => [ - 'description' => '', + 'description' => 'Service quality inspection dimension structure', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Service quality inspection dimension structure', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'content' => ['description' => 'Description of the service quality inspection dimension ', 'type' => 'string', 'required' => true, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。', 'title' => ''], + 'title' => ['description' => 'Name of the service quality inspection dimension ', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺'."\n", 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => true, - ], - 'inspectionIntroduction' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'sceneIntroduction' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', 'example' => '', ], + 'inspectionIntroduction' => ['description' => 'Detailed description and explanation of the service quality inspection scenario', 'type' => 'string', 'required' => true, 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等', 'title' => ''], + 'sceneIntroduction' => ['description' => 'Service quality inspection scenario', 'type' => 'string', 'required' => true, 'example' => '保险销售场景'."\n", 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'taskType' => [ - 'description' => '', + 'description' => 'Task Type: audio - audio file, text - text ', 'type' => 'string', 'required' => true, 'example' => 'text', - 'enum' => [ - 'audio', - 'text', - ], + 'enum' => ['audio', 'text'], + 'title' => '', ], 'templateIds' => [ - 'description' => '', + 'description' => 'List of template IDs', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '34', - ], + 'items' => ['description' => 'Template ID. When both a template ID and a Job Type are provided, the template ID takes precedence.', 'type' => 'string', 'required' => true, 'example' => '34', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], 'transcription' => [ - 'description' => '', + 'description' => 'Runtime parameters for Audio jobs', 'type' => 'object', 'properties' => [ - 'autoSplit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'clientChannel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'fileName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sss.mp3', - ], - 'serviceChannel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'autoSplit' => ['description' => 'Enables automatic speaker separation for single-channel audio. Set to 0 to enable Auto detection, or 1 to disable it. Default value: 1. Note: This applies only to audio files with a sample rate of 8 kHz.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'clientChannel' => ['description' => 'Applies to dual-channel recordings. Specifies the track number for the Customer role. Valid values: 0 or 1. Default value: 1, meaning track 1 is assigned to the Customer. Audio tracks are typically numbered starting from 0, so a two-track file uses tracks 0 and 1. You must confirm whether track 0 corresponds to the agent or the customer in your specific case. **If you use this parameter, you must also set the autoSplit parameter to 0.** This parameter is ignored for single-channel files.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'fileName' => ['description' => 'File name.', 'type' => 'string', 'required' => true, 'example' => 'sss.mp3', 'title' => ''], + 'serviceChannel' => ['description' => 'Applies to dual-channel recordings. Specifies the track number for the service agent role. Valid values: 0 or 1. Default value: 0, meaning track 0 is assigned to the agent. Audio tracks are typically numbered starting from 0, so a two-track file uses tracks 0 and 1. You must confirm whether track 0 corresponds to the agent or the customer in your specific case. **If you use this parameter, you must also set the autoSplit parameter to 0.** This parameter is ignored for single-channel files.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'serviceChannelKeywords' => [ - 'description' => '', + 'description' => 'Mostly applicable to single-track recordings. Specify a list of keywords that the customer service representative might say (ensure the selected keywords are highly distinctive). The system analyzes the transcription line by line from top to bottom. When a sentence hits any of the specified keywords, that sentence is classified as spoken by the customer service representative, and the other role is identified as the customer. ', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'items' => ['description' => 'Mostly applicable to single-track recordings. Specify a list of keywords that the customer service representative might say (ensure the selected keywords are highly distinctive). The system analyzes the transcription line by line from top to bottom. When a sentence hits any of the specified keywords, that sentence is classified as spoken by the customer service representative, and the other role is identified as the customer. ', 'type' => 'string', 'required' => false, 'example' => '你好', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], - 'voiceFileUrl' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http://1111.com/sss.mp3', - ], + 'voiceFileUrl' => ['description' => 'File URL ', 'type' => 'string', 'required' => true, 'example' => 'http://1111.com/sss.mp3', 'title' => ''], 'asrModelCode' => [ + 'description' => 'Speech-to-text model. Valid values: asr (small model) or paraformer (LLM).', 'type' => 'string', - 'enum' => [ - 'asr', - 'paraformer', - ], + 'enum' => ['asr', 'paraformer'], + 'required' => false, + 'example' => 'asr', + 'title' => '', ], 'level' => [ + 'description' => 'Priority for speech transcription', 'type' => 'string', - 'enum' => [ - 'low', - 'middle', - 'high', - ], - ], - 'vocabularyId' => [ - 'type' => 'string', - ], - 'roleIdentification' => [ - 'type' => 'boolean', - ], - 'languageHints' => [ - 'type' => 'string', + 'enum' => ['low', 'middle', 'high'], + 'required' => false, + 'example' => 'low', + 'title' => '', ], + 'vocabularyId' => ['description' => 'ID of the speech hotword vocabulary', 'type' => 'string', 'required' => false, 'example' => 'esnvknv*****skdnvjksd', 'title' => ''], + 'roleIdentification' => ['description' => 'Automatically detect speaker roles. Set to true to enable auto detection; set to false to disable it. Default: false ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'languageHints' => ['description' => 'Language for detection. The default value is Mandarin Chinese. For other supported languages and dialects, contact customer support. ', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'customPrompt' => [ - 'type' => 'string', - ], + 'customPrompt' => ['description' => 'Custom instruction ', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结', 'title' => ''], 'variables' => [ + 'description' => 'List of variables', 'type' => 'array', 'items' => [ + 'description' => 'List of variables', 'type' => 'object', 'properties' => [ - 'variableCode' => [ - 'type' => 'string', - 'required' => false, - ], - 'variableValue' => [ - 'type' => 'string', - 'required' => false, - ], + 'variableCode' => ['description' => 'Variable code', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'variableValue' => ['description' => 'Variable value', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'categoryTags' => [ + 'description' => 'Tag categorization list ', 'type' => 'array', 'items' => [ + 'description' => 'Tag categorization list ', 'type' => 'object', 'properties' => [ - 'tagName' => [ - 'type' => 'string', - ], - 'tagDesc' => [ - 'type' => 'string', - ], + 'tagName' => ['description' => 'Tag Name ', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺', 'title' => ''], + 'tagDesc' => ['description' => 'Tag Description', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'responseFormatType' => [ - 'type' => 'string', - ], - 'callBackUrl' => [ - 'type' => 'string', - ], + 'responseFormatType' => ['description' => 'Output result format type: jsonObject for JSON structure, text for raw string ', 'type' => 'string', 'required' => false, 'example' => 'jsonObject', 'title' => ''], + 'callBackUrl' => ['description' => 'Callback parameter after the job is completed', 'type' => 'string', 'required' => false, 'example' => '123.456.com/callback', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -1655,179 +1082,172 @@ 'type' => 'object', 'properties' => [ 'data' => [ - 'description' => '', + 'description' => 'Data', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071', - ], + 'taskId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '9F1DB065-AE0D-5EE3-B1AF-48632CB0831C', - ], - 'success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'True', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '9F1DB065-AE0D-5EE3-B1AF-48632CB0831C'], + 'success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'string', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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).', - ], + ['errorCode' => 'Ccai.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => 'Invalid error code, subsequent offline'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\"\\n },\\n \\"requestId\\": \\"9F1DB065-AE0D-5EE3-B1AF-48632CB0831C\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]', - ], - 'AnalyzeImage' => [ - 'summary' => '图片分析', - 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeImage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', + 'title' => 'Perform Tongyi Xiaomi CCAI - Conversation Analysis by uploading offline task data', + 'description' => 'Ensure that you fully understand the billing method and pricing of the Tongyi Xiaomi CCAI - Conversation Analysis AIO product before using this API.'."\n" + ."\n" + .'## Prerequisites'."\n" + ."\n" + .'- 1. You have activated the Tongyi Xiaomi CCAI - Conversation Analysis AIO service.'."\n" + .'- 2. You have created an application: Complete the creation of a Tongyi Xiaomi CCAI - Conversation Analysis AIO application in the Application Center and obtained the APP-ID and WORKSPACE-ID: [Obtain APP-ID and 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" + .'## Notes'."\n" + ."\n" + .'- 1. Task data is retained on the server for 90 days.'."\n" + .'- 2. The conversation content is limited to 20,000 characters. Content exceeding this limit will be automatically truncated.'."\n" + .'- 3. Audio files are recommended to use an 8 kHz sample rate. Using other sample rates may affect the final result.'."\n", + 'requestParamsDescription' => '## Parameter Guide for Speech Recognition'."\n" + ."\n" + .'When uploading an audio file, you must use either **serviceChannel** or **clientChannel** to assign audio tracks to different roles. The backend service detects roles based on these audio tracks. Alternatively, you can use **serviceChannelKeywords** to specify keywords in customer service conversations, and the backend service will detect roles based on those keywords.'."\n" + ."\n" + .'## Callback Parameter Guide'."\n" + ."\n" + .'Assume the webhook address provided by the caller is: `http://aliyun.com/callback`. The complete callback URL will be: '."\n" + .'`http://aliyun.com/callback?taskId=xxx×tamp=xxx&taskType=xxx&signature=xxx&success=xxx`, where:'."\n" + ."\n" + .'- **taskId**: the job ID '."\n" + .'- **timestamp**: the UNIX timestamp (in milliseconds) when the request was made '."\n" + .'- **taskType**: the task type '."\n" + .'- **success**: indicates whether the job succeeded '."\n" + .'- **signature**: the signature that the caller can use to verify that the request originated from Alibaba Cloud '."\n" + ."\n" + .'**Signature calculation**: Perform MD5 hashing followed by Base64 encoding on the string `taskId=xxx×tamp=xxx&aliUid=xxx` (note the exact order). After receiving the callback, the caller can extract **taskId** and **timestamp** from the callback URL, and **aliUid** is the Alibaba Cloud account ID. The caller should compute the signature using the same method and compare it with the **signature** in the URL to verify authenticity. See the Java code sample below for details.'."\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" + .' // Compute MD5 + Base64 of "taskId=xxx×tamp=xxx&aliUid=xxx" and place the result in the signature field'."\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" + .' // The string encoding must be 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" + .'```', + 'changeSet' => [ + ['createdAt' => '2025-07-25T09:33:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-20T07:54:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-27T09:09:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-06T09:49:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-01T02:08:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-25T02:52:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-20T10:52:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-16T08:47:12.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTask'], + ], ], + ], + 'CreateVocab' => [ + 'summary' => 'Uploads a set of hotwords to the server and returns a vocabulary ID.', + 'path' => '/vocab/createVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'stream' => [ - 'description' => '', - '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' => '', + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-9****me1', 'title' => ''], + 'name' => ['description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '词表1', 'title' => ''], + 'description' => ['description' => 'The version description.', 'type' => 'string', 'required' => false, 'example' => '销售词表', 'title' => ''], + 'audioModelCode' => ['description' => 'The speech-to-text model.', 'type' => 'string', 'required' => false, 'example' => 'nls', 'title' => ''], + 'wordWeightList' => [ + 'description' => 'The hotword group.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'watermark_analysis' => 'watermark_analysis', - ], - 'example' => 'watermark', - 'enum' => [ - 'watermark', + 'type' => 'object', + 'properties' => [ + 'weight' => ['description' => 'The weight value.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], + 'word' => ['description' => 'The word.', 'type' => 'string', 'required' => true, 'example' => '大树', 'title' => ''], ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'responseFormatType' => [ - 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -1835,190 +1255,159 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '9*****-AE0D-5EE3-B1AF-48632CB0831C', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'text' => [ - 'description' => '', - 'type' => 'string', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => ['description' => 'The vocabulary ID.', 'type' => 'string', 'example' => 'f3d82*******7', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'finishReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stop', - ], - 'inputTokens' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - 'outputTokens' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2000', - ], - 'totalTokens' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3000', - ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"True\\",\\n \\"data\\": {\\n \\"vocabularyId\\": \\"f3d82*******7\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create Hotword', + 'description' => 'Before using this API, make sure you understand the billing methods and pricing of Tongyi Xiaomi CCAI-Dialogue Analysis AIO.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'- You have activated the Tongyi Xiaomi CCAI-Dialogue Analysis AIO service.'."\n" + ."\n" + .'- You have created an application for Tongyi Xiaomi CCAI-Dialogue Analysis AIO in the Application Center and obtained an APP-ID and a WORKSPACE-ID. For more information, see [Obtain an APP-ID and a 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' => '## Request parameter limits'."\n" + ."\n" + .'- You can create a maximum of 10 vocabularies.'."\n" + ."\n" + .'- Each vocabulary can contain up to 500 words. Each word can be up to 10 characters long.'."\n" + ."\n" + .'- Custom hotwords must use UTF-8 encoding and cannot contain punctuation or special characters.'."\n" + ."\n" + .'- The weight of a custom word must be an integer from -6 to 5.'."\n" + ."\n" + .'- A value greater than 0 increases the probability that the word is detected. A value less than 0 decreases the probability.'."\n" + ."\n" + .'- A value of -6 indicates that the system should avoid detecting the word.'."\n" + ."\n" + .'- A value of 2 is a common setting.'."\n" + ."\n" + .'- If the results are not satisfactory, you can increase the weight. However, a very high weight might cause adverse effects, such as inaccurate detection of other words.'."\n" + ."\n" + .'## Request example'."\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("Sales Vocabulary");'."\n" + .' request.setDescription("For sales in Northeast China Region 1");'."\n" + .' request.setWorkspaceId(workspaceId);'."\n" + ."\n" + .' List<CreateVocabRequest.CreateVocabRequestWordWeightList> wordWeightList = new ArrayList<>();'."\n" + .' CreateVocabRequest.CreateVocabRequestWordWeightList word1 = new CreateVocabRequest.CreateVocabRequestWordWeightList();'."\n" + .' word1.setWord("Children");'."\n" + .' word1.setWeight(3);'."\n" + .' wordWeightList.add(word1);'."\n" + ."\n" + .' CreateVocabRequest.CreateVocabRequestWordWeightList word2 = new CreateVocabRequest.CreateVocabRequestWordWeightList();'."\n" + .' word2.setWord("Metal");'."\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" + .'```', + 'changeSet' => [ + ['createdAt' => '2025-03-26T09:32:54.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'GeneralAnalyzeImage' => [ - 'summary' => '通用图片分析', - 'path' => '/{workspaceId}/ccai/app/{appId}/generalanalyzeImage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'DeleteVocab' => [ + 'summary' => 'Delete a vocabulary by its ID.', + 'path' => '/vocab/deleteVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'stream' => [ - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34', - ], - 'required' => false, - ], + 'vocabularyId' => ['description' => 'Vocabulary ID', 'type' => 'string', 'required' => true, 'example' => 'ern*******rve', 'title' => ''], + 'workspaceId' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-0*****jlg8s', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2029,348 +1418,139 @@ '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' => '', - ], - 'finishReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stop', - ], - 'inputTokens' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'outputTokens' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000', - ], - 'totalTokens' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'data' => ['description' => 'Response data', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Delete hotword', + 'description' => 'Before you use this API, review the billing method and pricing for the Tongyi Xiaomi CCAI Conversation Analytics AIO product.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'- You have activated the Tongyi Xiaomi CCAI Conversation Analytics AIO service.'."\n" + ."\n" + .'- You have created an application: Create a Tongyi Xiaomi CCAI Conversation Analytics AIO application in the Application Center and obtain your APP-ID and WORKSPACE-ID. For more information, see [Obtain APP-ID and 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' => '## Sample request code'."\n" + ."\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" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'CreateVocab' => [ - 'summary' => '创建热词', - 'path' => '/vocab/createVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GeneralAnalyzeImage' => [ + 'summary' => 'Performs general image analysis.', + 'path' => '/{workspaceId}/ccai/app/{appId}/generalanalyzeImage', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-9****me1', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - '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' => '', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'True', - ], - 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'vocabularyId' => [ - 'description' => '', - '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.', - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n", 'title' => ''], ], - ], - '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"}]', - ], - 'UpdateVocab' => [ - 'summary' => '修改热词', - 'path' => '/vocab/updateVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c', 'title' => ''], ], - ], - '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' => '', + 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'vocabularyId' => [ - 'description' => '', - 'type' => 'string', + 'stream' => ['description' => 'Required. Set to true for streaming output or false for full output.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + 'imageUrls' => [ + 'description' => 'List of image URLs.', + 'type' => 'array', + 'items' => ['description' => 'A list of image URLs.', 'type' => 'string', 'required' => false, 'example' => 'https://img.123.com/1.jppg', 'title' => ''], 'required' => true, - 'example' => 'dsvsv***dsvv', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'wordWeightList' => [ - 'description' => '', + 'customPrompt' => ['description' => 'Custom instruction.', 'type' => 'string', 'required' => false, 'example' => 'Analyze the content in the image', 'title' => ''], + 'templateIds' => [ + 'description' => 'Template ID. If both template ID and customPrompt are provided, the template ID takes precedence.', '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, - ], + 'items' => ['description' => 'Template ID. If both template ID and instruction task type are provided, the template ID takes precedence.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34', 'title' => ''], 'required' => false, - ], - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-jhfr****w8v', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2378,289 +1558,251 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2D718325-92F9-5588-803B-C4A69A5F0AE1'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'text' => ['description' => 'Response from the application.', 'type' => 'string', 'example' => '这张图片中没有可识别的文本内容。因此，无法进行OCR（光学字符识别）。如果你有其他需求或问题，请告诉我', 'title' => ''], + 'finishReason' => ['description' => 'For streaming output, this field is null while generating. When generation ends due to a stop token, the value is stop.', 'type' => 'string', 'example' => 'stop', 'title' => ''], + 'inputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'outputTokens' => ['description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''], + 'totalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.'], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"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' => 'General Image Analysis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', ], - 'ListVocab' => [ - 'summary' => '热词列表', - 'path' => '/vocab/listVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetTaskResult' => [ + 'summary' => 'Retrieves the conversation analysis results of an offline task by task ID. The application supports HTTPS calls to complete the response.', + 'path' => '/ccai/app/getTaskResult', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['multipart/form-data'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'taskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n", 'title' => ''], + ], + [ + 'name' => 'requiredFieldList', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-jhfr****8v', - ], + 'description' => 'The list of optional fields.', + 'type' => 'array', + 'items' => [ + 'description' => 'The optional field value.', + 'type' => 'string', + 'enum' => ['asr_result', 'debug', 'rag_result'], + 'required' => false, + 'example' => 'asr_result', + 'title' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'dv*****erverve', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n", 'title' => ''], + 'text' => ['description' => 'The result returned by the application.', 'type' => 'string', 'example' => '对话中没有发现客服故意套取客户隐私信息的行为', 'title' => ''], + 'taskErrorMessage' => ['description' => 'The error message of the task.', 'type' => 'string', 'example' => '异常', 'title' => ''], + 'taskStatus' => ['description' => 'The task status. Valid values:'."\n" + .'- QUEUE: queued'."\n" + .'- FINISH: completed'."\n" + .'- ERROR: failed.', 'type' => 'string', 'example' => 'FINISH', 'title' => ''], + 'asrResult' => [ + 'description' => 'The list of Automatic Speech Recognition (ASR) results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ASR result.', + 'type' => 'object', + 'properties' => [ + 'begin' => ['description' => 'The start time offset of the sentence, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], + 'emotionValue' => ['description' => 'The emotion energy value, which is calculated as the volume in decibels divided by 10. Valid values: 1 to 10. A higher value indicates a stronger emotion.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'end' => ['description' => 'The end time offset of the sentence, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '8480', 'title' => ''], + 'role' => ['description' => 'The audio track ID to which the sentence belongs.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'speechRate' => ['description' => 'The average speech rate of the sentence.'."\n" + ."\n" + .'If the recognition language is Chinese, the unit is characters per minute.'."\n" + ."\n" + .'If the recognition language is English, the unit is words per minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '342', 'title' => ''], + 'words' => ['description' => 'The recognized text of the sentence.', 'type' => 'string', 'example' => 'Hello', 'title' => ''], + 'roleName' => ['description' => 'The role name.', 'type' => 'string', 'example' => '客户', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'audioModelCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'nls', - ], - 'wordWeightList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', + 'title' => '', + 'example' => '', + ], + 'extra' => ['description' => 'The optional supplementary content.', 'type' => 'string', 'example' => '{"roleConfig":{"role1Name":"客户","role2Name":"客服"}}', 'title' => ''], + 'ragStatus' => ['description' => 'The RAG execution status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'ragResult' => ['description' => 'The RAG recall result.', 'type' => 'string', 'example' => '召回内容', 'title' => ''], + 'usage' => [ + 'description' => 'The usage information.', + 'type' => 'object', + 'properties' => [ + 'rag' => [ + 'description' => 'The RAG usage details.', 'type' => 'object', 'properties' => [ - 'word' => [ - 'description' => '', - 'type' => 'string', + 'dialogSummary' => [ + 'description' => 'The conversation summary.', + 'type' => 'object', + 'properties' => [ + 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '520', 'title' => ''], + 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '664', 'title' => ''], + 'invokeCount' => ['description' => 'The number of invocations.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'weight' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'adaptive' => [ + 'description' => 'The RAG intelligent invocation.', + 'type' => 'object', + 'properties' => [ + 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '482', 'title' => ''], + 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '789', 'title' => ''], + 'invokeCount' => ['description' => 'The number of invocations.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'ragErrorMessage' => ['description' => 'The error message of the RAG execution.', 'type' => 'string', 'example' => '非法参数:[无有效知识库]', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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 .', 'description' => 'The user is not authorized to operate the specified resource'], + ], + 429 => [ + ['errorCode' => 'Ccai.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => 'Invalid error code, subsequent offline'], ], 500 => [ - [ - 'errorCode' => 'CCAI.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": [\\n {\\n \\"vocabularyId\\": \\"dv*****erverve\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 3\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - ], - 'DeleteVocab' => [ - 'summary' => '删删除热词', - 'path' => '/vocab/deleteVocab', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\\\n\\",\\n \\"text\\": \\"对话中没有发现客服故意套取客户隐私信息的行为\\",\\n \\"taskErrorMessage\\": \\"异常\\",\\n \\"taskStatus\\": \\"FINISH\\",\\n \\"asrResult\\": [\\n {\\n \\"begin\\": 80,\\n \\"emotionValue\\": 5,\\n \\"end\\": 8480,\\n \\"role\\": \\"0\\",\\n \\"speechRate\\": 342,\\n \\"words\\": \\"Hello\\",\\n \\"roleName\\": \\"客户\\"\\n }\\n ],\\n \\"extra\\": \\"{\\\\\\"roleConfig\\\\\\":{\\\\\\"role1Name\\\\\\":\\\\\\"客户\\\\\\",\\\\\\"role2Name\\\\\\":\\\\\\"客服\\\\\\"}}\\",\\n \\"ragStatus\\": \\"SUCCESS\\",\\n \\"ragResult\\": \\"召回内容\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 520,\\n \\"outputTokens\\": 664,\\n \\"invokeCount\\": 1\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 482,\\n \\"outputTokens\\": 789,\\n \\"invokeCount\\": 1\\n }\\n }\\n },\\n \\"ragErrorMessage\\": \\"非法参数:[无有效知识库]\\"\\n },\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]', + 'title' => 'Retrieve offline task analysis results by task ID', + 'description' => 'Before using this operation, make sure that you fully understand the billing methods and pricing of CCAI-Dialogue Analysis AIO.'."\n" + ."\n" + .'Before you begin'."\n" + .'1. CCAI-Dialogue Analysis AIO is activated.'."\n" + .'2. An application is created: Create a CCAI-Dialogue Analysis AIO application in the application center and obtain the APP-ID and WORKSPACE-ID. For more information, see [Obtain APP-ID and WORKSPACE-ID](https://www.alibabacloud.com/help/en/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id).', + 'changeSet' => [ + ['createdAt' => '2025-06-11T09:04:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-16T08:47:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-12-05T02:01:27.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskResult'], + ], ], + ], + 'GetVocab' => [ + 'summary' => 'Retrieves vocabulary information by its ID.', + 'path' => '/vocab/getVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'vocabularyId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ern*******rve', - ], - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-0*****jlg8s', - ], + 'vocabularyId' => ['description' => 'The vocabulary ID.', 'type' => 'string', 'required' => true, 'example' => 'dhbf***rbrdb', 'title' => ''], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-9864***1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2668,124 +1810,145 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => ['description' => 'The vocabulary ID.', 'type' => 'string', 'example' => 'rrbe***jrvrdd', 'title' => ''], + 'name' => ['description' => 'The name of the vocabulary.', 'type' => 'string', 'example' => '热词1', 'title' => ''], + 'description' => ['description' => 'Description', 'type' => 'string', 'example' => '销售热词', 'title' => ''], + 'audioModelCode' => ['description' => 'The speech-to-text model.', 'type' => 'string', 'example' => 'nls', 'title' => ''], + 'wordWeightList' => [ + 'description' => 'The list of words and their weights.', + 'type' => 'array', + 'items' => [ + 'description' => 'Hot word group', + 'type' => 'object', + 'properties' => [ + 'word' => ['description' => 'The word.', 'type' => 'string', 'example' => '儿童', 'title' => ''], + 'weight' => ['description' => 'The weight of the word.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": {\\n \\"vocabularyId\\": \\"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' => 'Retrieve hotwords', + 'description' => 'Before you use this API, review the billing methods and pricing for the Tongyi Xiaomi CCAI-Conversation Analysis AIO product.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'- The Tongyi Xiaomi CCAI-Conversation Analysis AIO service is activated.'."\n" + ."\n" + .'- You have created an application for Tongyi Xiaomi CCAI-Conversation Analysis AIO in Application Center and obtained an APP-ID and a WORKSPACE-ID. For more information, see [Obtain an APP-ID and a 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' => '## Examples'."\n" + ."\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" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', ], - 'GetVocab' => [ - 'summary' => '获取热词', - 'path' => '/vocab/getVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListVocab' => [ + 'summary' => 'List hot words in a specified workspace.', + 'path' => '/vocab/listVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'vocabularyId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dhbf***rbrdb', - ], - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-9864***1', - ], + 'workspaceId' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-jhfr****8v', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2793,436 +1956,594 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'string', 'example' => 'true', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'vocabularyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rrbe***jrvrdd', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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', + 'description' => 'Response data', + 'type' => 'array', + 'items' => [ + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => ['description' => 'Hot word ID', 'type' => 'string', 'example' => 'dv*****erverve', 'title' => ''], + 'name' => ['description' => 'Name', 'type' => 'string', 'example' => '热词1', 'title' => ''], + 'description' => ['description' => 'Description', 'type' => 'string', 'example' => '销售热词', 'title' => ''], + 'audioModelCode' => ['description' => 'Speech-to-text model', 'type' => 'string', 'example' => 'nls', 'title' => ''], + 'wordWeightList' => [ + 'description' => 'Hot word group', + 'type' => 'array', + 'items' => [ + 'description' => 'Hot word group', + 'type' => 'object', + 'properties' => [ + 'word' => ['description' => 'Word', 'type' => 'string', 'example' => '儿童', 'title' => ''], + 'weight' => ['description' => 'Weight', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": [\\n {\\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' => 'Retrieve hot word list ', + 'description' => 'Before you use this operation, review the pricing and billing details for Tongyi Xiaomi CCAI – Conversation Analytics AIO.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'- You have activated Tongyi Xiaomi CCAI – Conversation Analytics AIO.'."\n" + ."\n" + .'- You have created an application. In the Application Center, create a Tongyi Xiaomi CCAI – Conversation Analytics AIO application and obtain the APP-ID and WORKSPACE-ID: [Obtain APP-ID and 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' => '## Sample request code'."\n" + ."\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" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'AnalyzeAudioSync' => [ - 'summary' => '语音文件分析任务极速版', - 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeAudioSync', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'RunCompletion' => [ + 'summary' => 'Calls a Tongyi Xiaomi CCAI conversation analysis AIO application to retrieve conversation summaries, key information extraction results, quality inspection results, and conversation analysis results. The application supports HTTP calls to complete customer responses. Both standard HTTP and HTTP SSE protocols are available. Choose the protocol that best suits your needs.', + 'path' => '/{workspaceId}/ccai/app/{appId}/completion', + 'methods' => ['post'], + 'schemes' => ['http', 'https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-ik******RVYCKzt'."\n", - ], + 'schema' => ['description' => 'The ID of the sub-business workspace.', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n", 'title' => ''], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a070a49c681f4a95a0f0*********35c', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => '097d65c9c7004f8dad2b454850ac232b', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body structure.', 'type' => 'object', 'properties' => [ - 'modelCode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tyxmTurbo', + 'Dialogue' => [ + 'description' => 'The dialogue structure.', + 'type' => 'object', + 'properties' => [ + 'Sentences' => [ + 'description' => 'The list of dialogue content.', + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of each dialogue turn.', + 'type' => 'object', + 'properties' => [ + 'ChatId' => ['description' => 'The unique ID of each dialogue turn.', 'type' => 'string', 'required' => false, 'example' => 'ae2483e01a8446aa859925947fcf4d8e', 'title' => ''], + 'Role' => [ + 'description' => 'The conversation role. Valid values:'."\n" + .'- user: customer'."\n" + .'- agent: customer service representative'."\n" + .'- system: system message.', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'default' => 'user', + 'enum' => ['user', 'agent', 'system'], + 'title' => '', + ], + 'Text' => ['description' => 'The dialogue content.', 'type' => 'string', 'required' => true, 'example' => '查询北京天气', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'SessionId' => ['description' => 'The unique ID of the dialogue session.', 'type' => 'string', 'required' => false, 'example' => 'd25zc9c7004f8dad2b454d', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'fields' => [ - 'description' => '', + 'Fields' => [ + 'description' => 'The list of fields to extract during information extraction.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The field structure.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'phoneNumber'."\n", - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'desc' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'enumValues' => [ - 'description' => '', + 'Code' => ['description' => 'The field code.', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber', 'title' => ''], + 'Desc' => ['description' => 'The field description.', 'type' => 'string', 'required' => false, 'example' => '用户来电咨询的原因分类，主要有投诉、咨询、政策建议等。', 'title' => ''], + 'EnumValues' => [ + 'description' => 'The list of enumeration values.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The enumeration value structure.', 'type' => 'object', 'properties' => [ - 'desc' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'enumValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'Desc' => ['description' => 'The description of the enumeration value.', 'type' => 'string', 'required' => false, 'example' => '客户有新的需求/新的场景，客服跟进沟通需求细节', 'title' => ''], + 'EnumValue' => ['description' => 'The enumeration value.', 'type' => 'string', 'required' => true, 'example' => '新业务拓展', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], + 'Name' => ['description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => '来电原因类型', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'resultTypes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'summary', - ], + 'ModelCode' => [ + 'description' => 'The model specification.', + 'enumValueTitles' => ['tyxmPlus' => 'tyxmPlus', 'tyxmTurbo' => 'tyxmTurbo'], + 'type' => 'string', + 'example' => 'tyxmTurbo', + 'default' => 'tyxmTurbo', + 'enum' => ['tyxmTurbo', 'tyxmPlus'], 'required' => false, + 'title' => '', ], - 'serviceInspection' => [ - 'description' => '', + 'ServiceInspection' => [ + 'description' => 'The service quality inspection structure.', 'type' => 'object', 'properties' => [ - 'inspectionContents' => [ - 'description' => '', + 'InspectionContents' => [ + 'description' => 'The list of service quality inspection dimension structures.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The service quality inspection dimension structure.', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'Content' => ['description' => 'The description of the service quality inspection dimension.', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中，基于已有的服务标准是否存在过度承诺的行为，如：最快到货时间是12小时，无法给客户承诺更快的到货时间。', 'title' => ''], + 'Title' => ['description' => 'The name of the service quality inspection dimension.', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - ], - 'inspectionIntroduction' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'sceneIntroduction' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], + 'InspectionIntroduction' => ['description' => 'The detailed introduction and description of the service quality inspection scenario.', 'type' => 'string', 'required' => false, 'example' => '请检测客服是否存在服务不当的行为，包括：过度承诺、故意套取客户隐私信息等', 'title' => ''], + 'SceneIntroduction' => ['description' => 'The service quality inspection scenario.', 'type' => 'string', 'required' => false, 'example' => '保险销售场景', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'templateIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '34', - ], + 'Stream' => [ + 'description' => 'Specifies whether to enable SSE response. Default value: false.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', 'required' => false, + 'default' => 'false', + 'example' => 'false', + 'title' => '', ], - 'categoryTags' => [ - 'description' => '', + 'TemplateIds' => [ + 'description' => 'The list of template IDs under the CCAI application.', + 'type' => 'array', + 'items' => ['description' => 'The template ID under the CCAI application.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10375', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'variables' => [ + 'description' => 'The list of variables.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of variables.', 'type' => 'object', 'properties' => [ - 'tagName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'tagDesc' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'variableCode' => ['description' => 'The variable code.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'variableValue' => ['description' => 'The variable value.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - ], - 'customPrompt' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], - 'transcription' => [ - 'description' => '', + 'responseFormatType' => ['description' => 'The output result format type. Valid values:'."\n" + .'- jsonObject: JSON structure.'."\n" + .'- text: raw string.', 'type' => 'string', 'required' => false, 'example' => 'jsonObject', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response structure.', + 'type' => 'object', + 'properties' => [ + 'FinishReason' => ['description' => 'If streaming output is used, this value is null during generation. When generation is complete, the value is stop if the generation ended due to a stop token.', 'type' => 'string', 'example' => 'stop', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID generated by the system to identify this request.', 'type' => 'string', 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n", 'title' => ''], + 'Text' => ['description' => 'The result returned by the application.', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。'."\n", 'title' => ''], + 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'string', 'example' => '4672', 'title' => ''], + 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'string', 'example' => '621', 'title' => ''], + 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'string', 'example' => '5609', 'title' => ''], + 'usage' => [ + 'description' => 'The usage information.', 'type' => 'object', 'properties' => [ - 'autoSplit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'clientChannel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'serviceChannel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'fileName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sss.mp3', - ], - 'voiceFileUrl' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http://1111.com/sss.mp3', - ], - 'serviceChannelKeywords' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', + 'rag' => [ + 'description' => 'The RAG usage details.', + 'type' => 'object', + 'properties' => [ + 'dialogSummary' => [ + 'description' => 'The dialogue summary.', + 'type' => 'object', + 'properties' => [ + 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '4672', 'title' => ''], + 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '621', 'title' => ''], + 'invokeCount' => ['description' => 'The number of invocations.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adaptive' => [ + 'description' => 'The RAG intelligent invocation.', + 'type' => 'object', + 'properties' => [ + 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '4672', 'title' => ''], + 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '621', 'title' => ''], + 'invokeCount' => ['description' => 'The number of invocations.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], - 'required' => false, - ], - 'asrModelCode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'nls', - ], - 'vocabularyId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'esnvknv*****skdnvjksd', - ], - 'level' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'low', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'variables' => [ - 'description' => '', + 'ragStatus' => ['description' => 'The RAG execution status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', 'description' => 'The parameter value of the request API is illegal.'], + ], + 403 => [ + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\\\n\\",\\n \\"inputTokens\\": \\"4672\\",\\n \\"outputTokens\\": \\"621\\",\\n \\"totalTokens\\": \\"5609\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 4672,\\n \\"outputTokens\\": 621,\\n \\"invokeCount\\": 3\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 4672,\\n \\"outputTokens\\": 621,\\n \\"invokeCount\\": 3\\n }\\n }\\n },\\n \\"ragStatus\\": \\"SUCCESS\\"\\n}","type":"json"}]', + 'title' => 'Call a tongyi xiaomi CCAI conversation analysis AIO application by template ID', + 'description' => 'Before using this operation, make sure that you fully understand the billing methods and pricing of the Tongyi Xiaomi CCAI conversation analysis AIO product.'."\n" + ."\n" + .'Before you begin'."\n" + .'1. The Tongyi Xiaomi CCAI conversation analysis AIO service is activated.'."\n" + .'2. An application is created: Create a Tongyi Xiaomi CCAI conversation analysis AIO application in the application center and obtain the APP-ID and WORKSPACE-ID. For more information, see [Obtain APP-ID and WORKSPACE-ID](https://help.aliyun.com/document_detail/2782167.html?spm=a2c4g.2782164.0.0.2b2b6dcdZZ5oUE).', + 'changeSet' => [ + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-01T02:08:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-06T03:50:11.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-07-02T08:31:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-01T08:41:21.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-06-14T09:00:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletion'], + ], + ], + ], + 'RunCompletionMessage' => [ + 'summary' => 'You can call the Tongyi Xiaomi CCAI-Conversation Analysis AIO application using the Message protocol format to obtain conversation summaries, extract key information, and generate quality inspection and conversation analysis results. The application supports HTTP calls to provide responses. You can use either the standard HTTP or HTTP Server-Sent Events (SSE) protocol.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n", 'title' => ''], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => '097d65c9c7004f8dad2b454850ac232b', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'Messages' => [ + 'description' => 'The list of messages for the model request.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The structure of a message.', 'type' => 'object', 'properties' => [ - 'variableCode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'variableValue' => [ - 'description' => '', + 'Content' => ['description' => 'The content of the prompt.', 'type' => 'string', 'required' => true, 'example' => '如Role=system ,Content=You are a helpful assistant.'."\n" + .'Role=user , Content=请阅读以下对话内容，按照要求执行指令任务。', 'title' => ''], + 'Role' => [ + 'description' => 'The role in the conversation. Valid values: \\`user\\` (customer), \\`agent\\` (customer service representative), \\`system\\` (system message), and \\`function\\` (function call).', 'type' => 'string', - 'required' => false, - 'example' => '', + 'required' => true, + 'enum' => ['user', 'assistant', 'system', 'function'], + 'example' => 'user', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], - 'responseFormatType' => [ - 'description' => '', + 'ModelCode' => [ + 'description' => 'The model type.', 'type' => 'string', + 'example' => 'tyxmTurbo', + 'default' => 'tyxmTurbo', + 'enum' => ['tyxmTurbo', 'tyxmPlus'], 'required' => false, - 'example' => 'jsonObject', + 'title' => '', ], - 'stream' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', + 'Stream' => ['description' => 'Specifies whether to enable SSE responses. The default value is \\`false\\`.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], + 'responseFormatType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The structure of the response.', + 'type' => 'object', + 'properties' => [ + 'FinishReason' => ['description' => 'For streaming output, the value is \\`null\\` during generation. If generation stops because of a stop token, the value is \\`stop\\`.', 'type' => 'string', 'example' => 'stop', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n", 'title' => ''], + 'Text' => ['description' => 'The result returned by the application.', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。', 'title' => ''], + 'inputTokens' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'outputTokens' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'totalTokens' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', 'description' => 'The parameter value of the request API is illegal.'], + ], + 403 => [ + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"\\",\\n \\"outputTokens\\": \\"\\",\\n \\"totalTokens\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Invoke the Tongyi Xiaomi CCAI-Dialogue Analysis AIO application using a native prompt '."\n", + 'description' => 'Before you use this API, make sure you understand the billing methods and pricing of the Tongyi Xiaomi CCAI-Conversation Analysis AIO product.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'1. Activate the Tongyi Xiaomi CCAI-Conversation Analysis AIO service.'."\n" + ."\n" + .'2. Create a Tongyi Xiaomi CCAI-Conversation Analysis AIO application in the Application Center to obtain an APP-ID and a WORKSPACE-ID. For more information, see [the referenced document](https://help.aliyun.com/document_detail/2782167.html?spm=a2c4g.2782164.0.0.2b2b6dcdZZ5oUE).', + 'changeSet' => [ + ['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-06T03:50:11.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-07-01T08:41:21.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletionMessage'], + ], + ], + ], + 'UpdateVocab' => [ + 'summary' => 'Updates a vocabulary\'s information based on its ID, including its name, description, words, and weights.', + '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' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => ['description' => 'The vocabulary ID.', 'type' => 'string', 'required' => true, 'example' => 'dsvsv***dsvv', 'title' => ''], + 'name' => ['description' => 'The name of the vocabulary.', 'type' => 'string', 'required' => false, 'example' => '热词1', 'title' => ''], + 'description' => ['description' => 'Description', 'type' => 'string', 'required' => false, 'example' => '销售热词', 'title' => ''], + 'wordWeightList' => [ + 'description' => 'The words and their weights in the vocabulary.', + 'type' => 'array', + 'items' => [ + 'description' => 'A word and its weight.', + 'type' => 'object', + 'properties' => [ + 'word' => ['description' => 'The word.', 'type' => 'string', 'required' => true, 'example' => '虹桥', 'title' => ''], + 'weight' => ['description' => 'The weight.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-jhfr****w8v', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3233,96 +2554,132 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '968A8634-FA2C-5381-9B3E-*******F', - ], - 'finishReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stop', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'text' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'inputTokens' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - 'outputTokens' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2000', - ], - 'totalTokens' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3000', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'data' => ['description' => 'The data returned.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CCAI.InvalidParam.NotExist', - 'errorMessage' => 'The specified parameter %s is not valid.', - ], - [ - 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', - 'errorMessage' => 'The parameter value of the request API is illegal %s.', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qpm', - 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', - ], - [ - 'errorCode' => 'CCAI.Throttling.Qps', - 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', - ], + ['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => 'The request parameter does not exist.'], + ['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => 'The parameter value of the request API is illegal.'], + ['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '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).', 'description' => 'Trigger current limit, pay API please buy higher QPS, 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.', - ], + ['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The user is not authorized to operate the specified resource'], + ['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => 'Parameter validation failed. The specified parameter 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.', 'description' => '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.', - ], + ['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Modify Hotword', + 'description' => 'Before using this operation, you must understand the billing methods and pricing of the Tongyi Xiaomi Contact Center AI (CCAI)-Conversation Analysis AIO product.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'- Activate the Tongyi Xiaomi CCAI-Conversation Analysis AIO service.'."\n" + ."\n" + .'- Create an application in the Application Center for Tongyi Xiaomi CCAI-Conversation Analysis AIO. Obtain an APP-ID and a WORKSPACE-ID. For more information, see [the referenced document](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' => '## Request example'."\n" + ."\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("Sales Vocabulary");'."\n" + .' request.setDescription("Sales vocabulary for South China 1");'."\n" + .' request.setWorkspaceId(workspaceId);'."\n" + ."\n" + .' List<UpdateVocabRequest.UpdateVocabRequestWordWeightList> wordWeightList = new ArrayList<>();'."\n" + .' UpdateVocabRequest.UpdateVocabRequestWordWeightList word1 = new UpdateVocabRequest.UpdateVocabRequestWordWeightList();'."\n" + .' word1.setWord("Europe");'."\n" + .' word1.setWeight(4);'."\n" + .' wordWeightList.add(word1);'."\n" + ."\n" + .' UpdateVocabRequest.UpdateVocabRequestWordWeightList word2 = new UpdateVocabRequest.UpdateVocabRequestWordWeightList();'."\n" + .' word2.setWord("Earache");'."\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" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'contactcenterai.cn-shanghai.aliyuncs.com', 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', 'vpc' => 'contactcenterai-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'CCAI.IllegalPermission.NoAuth', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'The user is not authorized to operate the specified resource'], + ['code' => 'CCAI.IllegalPermission.NoAuth', 'message' => 'User not authorized to operate on the specified resource %s .', 'http_code' => 403, 'description' => 'The user is not authorized to operate the specified resource'], + ['code' => 'CCAI.InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => ''], + ['code' => 'CCAI.InvalidParam.NotExist', 'message' => 'The specified parameter %s is not valid.', 'http_code' => 400, 'description' => 'The request parameter does not exist.'], + ['code' => 'CCAI.ParamInvalid.IllegalParamValue', 'message' => 'The parameter value of the request API is illegal %s.', 'http_code' => 400, 'description' => 'The parameter value of the request API is illegal.'], + ['code' => 'CCAI.ParamNotfound.MissParam', 'message' => 'Parameter verification failed, The specified parameter %s is missing.', 'http_code' => 403, 'description' => 'Parameter validation failed. The specified parameter is missing.'], + ['code' => 'CCAI.TenantPermission.NoAuth', 'message' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'http_code' => 403, 'description' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.'], + ['code' => 'CCAI.Throttling.Qpm', 'message' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'http_code' => 400, 'description' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).'], + ['code' => 'Ccai.Throttling.Qps', 'message' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'http_code' => 429, 'description' => 'Invalid error code, subsequent offline'], + ['code' => 'CCAI.Throttling.Qps', 'message' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'http_code' => 400, 'description' => 'Trigger current limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).'], + ], + 'changeSet' => [ [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RunCompletion'], + ], + 'createdAt' => '2024-06-14T09:00:55.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskResult'], + ['threshold' => '30', 'countWindow' => 2, 'regionId' => '*', 'api' => 'AnalyzeConversation'], + ['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletion'], + ['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletionMessage'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeAudioSync'], ], ], ]; |