diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/contactcenterai/2024-06-03 | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/contactcenterai/2024-06-03')
| -rw-r--r-- | data/en_us/contactcenterai/2024-06-03/api-docs.php | 3328 |
1 files changed, 3328 insertions, 0 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 new file mode 100644 index 0000000..faecc98 --- /dev/null +++ b/data/en_us/contactcenterai/2024-06-03/api-docs.php @@ -0,0 +1,3328 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'ContactCenterAI', + 'version' => '2024-06-03', + ], + 'directories' => [ + 'RunCompletion', + 'RunCompletionMessage', + 'AnalyzeConversation', + 'GetTaskResult', + 'CreateTask', + 'AnalyzeImage', + 'GeneralAnalyzeImage', + [ + 'id' => 203152, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateVocab', + 'UpdateVocab', + 'ListVocab', + 'DeleteVocab', + 'GetVocab', + ], + ], + [ + 'id' => 204673, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AnalyzeAudioSync', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'RunCompletion' => [ + 'summary' => 'CCAI服务面API', + 'path' => '/{workspaceId}/ccai/app/{appId}/completion', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + 'application/octet-stream', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm-ik******RVYCKzt'."\n", + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '097d65c9c7004f8dad2b454850ac232b', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'phoneNumber', + ], + 'Desc' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'EnumValues' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Desc' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ModelCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ccai-72b' => 'ccai-72b', + 'ccai-14b' => 'ccai-14b', + ], + 'example' => 'ccai-14b', + 'default' => 'tyxmTurbo', + 'enum' => [ + 'ccai-14b', + 'ccai-72b', + ], + ], + 'ServiceInspection' => [ + 'type' => 'object', + 'properties' => [ + 'InspectionContents' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'type' => 'string', + ], + 'Title' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + 'InspectionIntroduction' => [ + 'type' => 'string', + ], + 'SceneIntroduction' => [ + 'type' => 'string', + ], + ], + ], + 'Stream' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + 'default' => 'false', + ], + 'TemplateIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10375', + ], + 'required' => true, + ], + 'variables' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'variableCode' => [ + 'type' => 'string', + ], + 'variableValue' => [ + 'type' => 'string', + ], + ], + ], + ], + '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' => [ + 'type' => 'object', + 'properties' => [ + 'rag' => [ + 'type' => 'object', + 'properties' => [ + 'dialogSummary' => [ + 'type' => 'object', + 'properties' => [ + 'inputTokens' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'outputTokens' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'invokeCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'adaptive' => [ + 'type' => 'object', + 'properties' => [ + 'inputTokens' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'outputTokens' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'invokeCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + 'ragStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\\\n\\",\\n \\"inputTokens\\": \\"4672\\",\\n \\"outputTokens\\": \\"621\\",\\n \\"totalTokens\\": \\"5609\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"invokeCount\\": 0\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"invokeCount\\": 0\\n }\\n }\\n },\\n \\"ragStatus\\": \\"\\"\\n}","type":"json"}]', + ], + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'Role' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'enum' => [ + 'user', + 'assistant', + 'system', + 'function', + ], + ], + ], + 'required' => false, + ], + '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', + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"\\",\\n \\"outputTokens\\": \\"\\",\\n \\"totalTokens\\": \\"\\"\\n}","type":"json"}]', + ], + 'AnalyzeConversation' => [ + 'summary' => '根据类型调用大模型', + 'path' => '/{workspaceId}/ccai/app/{appId}/analyze_conversation', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/octet-stream', + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm-368******3ifum', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a070a49c681f4a95a0f0*********35c', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'categoryTags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagDesc' => [ + 'type' => 'string', + 'required' => false, + ], + 'tagName' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + ], + 'dialogue' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'sentences' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'role' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'enum' => [ + 'user', + 'agent', + 'system', + ], + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + 'sessionId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'session-01', + ], + ], + 'required' => false, + ], + 'examples' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'output' => [ + 'type' => 'string', + 'required' => true, + ], + 'sentences' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'chatId' => [ + 'type' => 'string', + 'required' => false, + ], + 'role' => [ + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'user', + 'agent', + 'system', + ], + ], + 'text' => [ + 'type' => 'string', + 'required' => true, + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + 'fields' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'phoneNumber'."\n", + ], + 'desc' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'enumValues' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'desc' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'enumValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + 'modelCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tyxmTurbo', + 'default' => 'tyxmTurbo', + 'enum' => [ + 'tyxmTurbo', + 'tyxmPlus', + ], + ], + 'resultTypes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'summary', + 'enum' => [ + 'summary', + 'title', + 'fields', + 'keywords', + 'service_inspection', + 'question_solution', + ], + ], + 'required' => true, + ], + 'sceneName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'serviceInspection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'inspectionContents' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + 'inspectionIntroduction' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'sceneIntroduction' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + ], + 'stream' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + 'userProfiles' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'type' => 'string', + 'required' => false, + ], + 'value' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + ], + 'timeConstraintList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'sourceCallerUid' => [ + 'type' => 'string', + ], + 'customPrompt' => [ + 'type' => 'string', + ], + 'responseFormatType' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource %s .', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"errorCode\\": \\"success\\",\\n \\"errorInfo\\": \\"success\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"\\",\\n \\"outputTokens\\": \\"\\",\\n \\"totalTokens\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetTaskResult' => [ + 'summary' => '语音文件调用大模型获取结果', + 'path' => '/ccai/app/getTaskResult', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n", + ], + ], + [ + 'name' => 'requiredFieldList', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'enum' => [ + 'asr_result', + 'debug', + 'rag_result', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource %s .', + ], + ], + 429 => [ + [ + 'errorCode' => 'Ccai.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\\\n\\",\\n \\"text\\": \\"对话中没有发现客服故意套取客户隐私信息的行为\\",\\n \\"taskErrorMessage\\": \\"\\",\\n \\"taskStatus\\": \\"FINISH\\",\\n \\"asrResult\\": [\\n {\\n \\"begin\\": 0,\\n \\"emotionValue\\": 0,\\n \\"end\\": 0,\\n \\"role\\": \\"\\",\\n \\"speechRate\\": 0,\\n \\"words\\": \\"\\",\\n \\"roleName\\": \\"\\"\\n }\\n ],\\n \\"extra\\": \\"\\",\\n \\"ragStatus\\": \\"\\",\\n \\"ragResult\\": \\"\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"invokeCount\\": 0\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"invokeCount\\": 0\\n }\\n }\\n },\\n \\"ragErrorMessage\\": \\"\\"\\n },\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]', + ], + 'CreateTask' => [ + 'summary' => '创建语音文件调用llm任务', + 'path' => '/{workspaceId}/ccai/app/{appId}/createTask', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'object', + 'properties' => [ + 'dialogue' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'sentences' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'role' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'enum' => [ + 'agent', + 'user', + 'system', + ], + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'sessionId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'session-01', + ], + ], + 'required' => false, + ], + 'examples' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'output' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'sentences' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'role' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + 'required' => true, + 'docRequired' => false, + ], + ], + 'required' => false, + ], + 'fields' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'phoneNumber'."\n", + ], + 'desc' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'enumValues' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'desc' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'enumValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + 'modelCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'tyxmTurbo', + 'enum' => [ + 'tyxmTurbo', + 'tyxmPlus', + ], + ], + 'resultTypes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'summary', + 'enum' => [ + 'summary', + 'title', + 'fields', + 'keywords', + 'service_inspection', + 'question_solution', + ], + ], + 'required' => false, + ], + 'serviceInspection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'inspectionContents' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + 'inspectionIntroduction' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'sceneIntroduction' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + ], + 'taskType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'text', + 'enum' => [ + 'audio', + 'text', + ], + ], + 'templateIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '34', + ], + 'required' => false, + ], + 'transcription' => [ + 'description' => '', + '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', + ], + 'serviceChannelKeywords' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'required' => false, + ], + 'voiceFileUrl' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'http://1111.com/sss.mp3', + ], + 'asrModelCode' => [ + 'type' => 'string', + 'enum' => [ + 'asr', + 'paraformer', + ], + ], + 'level' => [ + 'type' => 'string', + 'enum' => [ + 'low', + 'middle', + 'high', + ], + ], + 'vocabularyId' => [ + 'type' => 'string', + ], + 'roleIdentification' => [ + 'type' => 'boolean', + ], + 'languageHints' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'customPrompt' => [ + 'type' => 'string', + ], + 'variables' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'variableCode' => [ + 'type' => 'string', + 'required' => false, + ], + 'variableValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + ], + 'categoryTags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagName' => [ + 'type' => 'string', + ], + 'tagDesc' => [ + 'type' => 'string', + ], + ], + ], + ], + 'responseFormatType' => [ + 'type' => 'string', + ], + 'callBackUrl' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'taskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '9F1DB065-AE0D-5EE3-B1AF-48632CB0831C', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Ccai.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\"\\n },\\n \\"requestId\\": \\"9F1DB065-AE0D-5EE3-B1AF-48632CB0831C\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]', + ], + 'AnalyzeImage' => [ + 'summary' => '图片分析', + 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeImage', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + 'application/octet-stream', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'watermark_analysis' => 'watermark_analysis', + ], + 'example' => 'watermark', + 'enum' => [ + 'watermark', + ], + ], + 'required' => false, + ], + 'responseFormatType' => [ + 'type' => 'string', + ], + ], + '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' => '9*****-AE0D-5EE3-B1AF-48632CB0831C', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9*****-AE0D-5EE3-B1AF-48632CB0831C\\",\\n \\"success\\": true,\\n \\"text\\": \\"[{\\\\\\\\\\\\\\"num\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isHit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"remarks\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"无水印\\\\\\\\\\\\\\"}]\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]', + ], + 'GeneralAnalyzeImage' => [ + 'summary' => '通用图片分析', + 'path' => '/{workspaceId}/ccai/app/{appId}/generalanalyzeImage', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + 'application/octet-stream', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2D718325-92F9-5588-803B-C4A69A5F0AE1', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'text' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D718325-92F9-5588-803B-C4A69A5F0AE1\\",\\n \\"success\\": true,\\n \\"text\\": \\"这张图片中没有可识别的文本内容。因此，无法进行OCR（光学字符识别）。如果你有其他需求或问题，请告诉我\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"inputTokens\\": 1000,\\n \\"outputTokens\\": 2000,\\n \\"totalTokens\\": 3000\\n}","type":"json"}]', + ], + 'CreateVocab' => [ + 'summary' => '创建热词', + 'path' => '/vocab/createVocab', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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.', + ], + ], + ], + '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' => [], + ], + ], + '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' => '', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsvsv***dsvv', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'wordWeightList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'word' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'weight' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'workspaceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm-jhfr****w8v', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '968A8634-FA2C-5381-9B3E-*******F', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ListVocab' => [ + 'summary' => '热词列表', + 'path' => '/vocab/listVocab', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm-jhfr****8v', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + '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', + 'example' => '', + ], + 'audioModelCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nls', + ], + 'wordWeightList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'word' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'weight' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": [\\n {\\n \\"vocabularyId\\": \\"dv*****erverve\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 3\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteVocab' => [ + 'summary' => '删删除热词', + 'path' => '/vocab/deleteVocab', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ern*******rve', + ], + 'workspaceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm-0*****jlg8s', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '968A8634-FA2C-5381-9B3E-*******F', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'GetVocab' => [ + 'summary' => '获取热词', + 'path' => '/vocab/getVocab', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dhbf***rbrdb', + ], + 'workspaceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm-9864***1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '968A8634-FA2C-5381-9B3E-*******F', + ], + 'success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": {\\n \\"vocabularyId\\": \\"rrbe***jrvrdd\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'AnalyzeAudioSync' => [ + 'summary' => '语音文件分析任务极速版', + 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeAudioSync', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + 'application/octet-stream', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'llm-ik******RVYCKzt'."\n", + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a070a49c681f4a95a0f0*********35c', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'modelCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tyxmTurbo', + ], + 'fields' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'phoneNumber'."\n", + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'desc' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'enumValues' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'desc' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'enumValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'resultTypes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'summary', + ], + 'required' => false, + ], + 'serviceInspection' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'inspectionContents' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'title' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'inspectionIntroduction' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'sceneIntroduction' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'templateIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '34', + ], + 'required' => false, + ], + 'categoryTags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'tagName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'tagDesc' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'customPrompt' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'transcription' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'autoSplit' => [ + 'description' => '', + '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' => '', + ], + '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', + ], + ], + 'required' => false, + ], + 'variables' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'variableCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'variableValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'responseFormatType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'jsonObject', + ], + 'stream' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CCAI.InvalidParam.NotExist', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', + 'errorMessage' => 'The parameter value of the request API is illegal %s.', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qpm', + 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', + ], + [ + 'errorCode' => 'CCAI.Throttling.Qps', + 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', + ], + ], + 403 => [ + [ + 'errorCode' => 'CCAI.IllegalPermission.NoAuth', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'CCAI.ParamNotfound.MissParam', + 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', + ], + [ + 'errorCode' => 'CCAI.TenantPermission.NoAuth', + 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CCAI.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论，但具体内容难以明确理解，因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', + ], + ], +]; |