diff options
Diffstat (limited to 'data/contactcenterai/2024-06-03/api-docs.php')
| -rw-r--r-- | data/contactcenterai/2024-06-03/api-docs.php | 1412 |
1 files changed, 385 insertions, 1027 deletions
diff --git a/data/contactcenterai/2024-06-03/api-docs.php b/data/contactcenterai/2024-06-03/api-docs.php index 264e52a..aab099b 100644 --- a/data/contactcenterai/2024-06-03/api-docs.php +++ b/data/contactcenterai/2024-06-03/api-docs.php @@ -1,53 +1,32 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'ContactCenterAI', - 'version' => '2024-06-03', - ], + 'info' => ['style' => 'ROA', 'product' => 'ContactCenterAI', 'version' => '2024-06-03'], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'RunCompletion' => [ - 'path' => '/{workspaceId}/ccai/app/{appId}/completion', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - 'sse', - ], + 'AnalyzeAudioSync' => [ + 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeAudioSync', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'body', @@ -57,251 +36,108 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'Dialogue' => [ - 'type' => 'object', - 'required' => true, - 'properties' => [ - 'Sentences' => [ - 'type' => 'array', - 'required' => false, - 'items' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'ChatId' => [ - 'type' => 'string', - 'required' => false, - ], - 'Role' => [ - 'type' => 'string', - 'required' => true, - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'Text' => [ - 'type' => 'string', - 'required' => true, - ], - ], - ], - ], - 'SessionId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'Fields' => [ + 'modelCode' => ['type' => 'string', 'required' => false], + 'fields' => [ 'type' => 'array', 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'Code' => [ - 'type' => 'string', - 'required' => false, - ], - 'Desc' => [ - 'type' => 'string', - 'required' => false, - ], - 'EnumValues' => [ + 'code' => ['type' => 'string', 'required' => false], + 'name' => ['type' => 'string', 'required' => false], + 'desc' => ['type' => 'string', 'required' => false], + 'enumValues' => [ 'type' => 'array', 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'Desc' => [ - 'type' => 'string', - 'required' => false, - ], - 'EnumValue' => [ - 'type' => 'string', - 'required' => true, - ], + 'desc' => ['type' => 'string', 'required' => false], + 'enumValue' => ['type' => 'string', 'required' => false], ], ], ], - 'Name' => [ - 'type' => 'string', - 'required' => true, - ], ], ], ], - 'ModelCode' => [ - 'type' => 'string', + 'resultTypes' => [ + 'type' => 'array', 'required' => false, - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], + 'items' => ['type' => 'string', 'required' => true], ], - 'ServiceInspection' => [ + 'serviceInspection' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'InspectionContents' => [ + 'inspectionContents' => [ 'type' => 'array', 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'Content' => [ - 'type' => 'string', - 'required' => false, - ], - 'Title' => [ - 'type' => 'string', - 'required' => true, - ], + 'content' => ['type' => 'string', 'required' => false], + 'title' => ['type' => 'string', 'required' => false], ], ], ], - 'InspectionIntroduction' => [ - 'type' => 'string', - 'required' => false, - ], - 'SceneIntroduction' => [ - 'type' => 'string', - 'required' => false, - ], + 'inspectionIntroduction' => ['type' => 'string', 'required' => false], + 'sceneIntroduction' => ['type' => 'string', 'required' => false], ], ], - 'Stream' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'TemplateIds' => [ + 'templateIds' => [ 'type' => 'array', - 'required' => true, - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'required' => false, + 'items' => ['type' => 'string', 'required' => false], ], - 'variables' => [ + 'categoryTags' => [ 'type' => 'array', 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'variableCode' => [ - 'type' => 'string', - 'required' => false, - ], - 'variableValue' => [ - 'type' => 'string', - 'required' => false, - ], + 'tagName' => ['type' => 'string', 'required' => false], + 'tagDesc' => ['type' => 'string', 'required' => false], ], ], ], - 'responseFormatType' => [ - 'type' => 'string', + 'customPrompt' => ['type' => 'string', 'required' => false], + 'transcription' => [ + 'type' => 'object', 'required' => false, + 'properties' => [ + 'autoSplit' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + 'clientChannel' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + 'serviceChannel' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + 'fileName' => ['type' => 'string', 'required' => true], + 'voiceFileUrl' => ['type' => 'string', 'required' => true], + 'serviceChannelKeywords' => [ + 'type' => 'array', + 'required' => false, + 'items' => ['type' => 'string', 'required' => false], + ], + 'asrModelCode' => ['type' => 'string', 'required' => false], + 'vocabularyId' => ['type' => 'string', 'required' => false], + 'level' => ['type' => 'string', 'required' => false], + ], ], - ], - ], - ], - ], - ], - 'RunCompletionMessage' => [ - 'path' => '/{workspaceId}/ccai/app/{appId}/completion_message', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - 'sse', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'deprecated' => false, - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'Messages' => [ + 'variables' => [ 'type' => 'array', - 'required' => true, + 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'Content' => [ - 'type' => 'string', - 'required' => true, - ], - 'Role' => [ - 'type' => 'string', - 'required' => true, - 'enum' => [ - 'user', - 'assistant', - 'system', - 'function', - ], - ], + 'variableCode' => ['type' => 'string', 'required' => false], + 'variableValue' => ['type' => 'string', 'required' => false], ], ], ], - 'ModelCode' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], - ], - 'Stream' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'responseFormatType' => [ - 'type' => 'string', - 'required' => false, - ], + 'responseFormatType' => ['type' => 'string', 'required' => false], + 'stream' => ['type' => 'boolean', 'required' => true], ], ], ], @@ -309,42 +145,26 @@ ], 'AnalyzeConversation' => [ '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'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'body', @@ -361,14 +181,8 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'tagDesc' => [ - 'type' => 'string', - 'required' => false, - ], - 'tagName' => [ - 'type' => 'string', - 'required' => false, - ], + 'tagDesc' => ['type' => 'string', 'required' => false], + 'tagName' => ['type' => 'string', 'required' => false], ], ], ], @@ -386,23 +200,13 @@ 'role' => [ 'type' => 'string', 'required' => true, - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'text' => [ - 'type' => 'string', - 'required' => true, + 'enum' => ['user', 'agent', 'system'], ], + 'text' => ['type' => 'string', 'required' => true], ], ], ], - 'sessionId' => [ - 'type' => 'string', - 'required' => false, - ], + 'sessionId' => ['type' => 'string', 'required' => false], ], ], 'examples' => [ @@ -412,10 +216,7 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'output' => [ - 'type' => 'string', - 'required' => true, - ], + 'output' => ['type' => 'string', 'required' => true], 'sentences' => [ 'type' => 'array', 'required' => true, @@ -423,23 +224,13 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'chatId' => [ - 'type' => 'string', - 'required' => false, - ], + 'chatId' => ['type' => 'string', 'required' => false], 'role' => [ 'type' => 'string', 'required' => true, - 'enum' => [ - 'user', - 'agent', - 'system', - ], - ], - 'text' => [ - 'type' => 'string', - 'required' => true, + 'enum' => ['user', 'agent', 'system'], ], + 'text' => ['type' => 'string', 'required' => true], ], ], ], @@ -453,14 +244,8 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'code' => [ - 'type' => 'string', - 'required' => false, - ], - 'desc' => [ - 'type' => 'string', - 'required' => true, - ], + 'code' => ['type' => 'string', 'required' => false], + 'desc' => ['type' => 'string', 'required' => true], 'enumValues' => [ 'type' => 'array', 'required' => false, @@ -468,31 +253,19 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'desc' => [ - 'type' => 'string', - 'required' => true, - ], - 'enumValue' => [ - 'type' => 'string', - 'required' => true, - ], + 'desc' => ['type' => 'string', 'required' => true], + 'enumValue' => ['type' => 'string', 'required' => true], ], ], ], - 'name' => [ - 'type' => 'string', - 'required' => true, - ], + 'name' => ['type' => 'string', 'required' => true], ], ], ], 'modelCode' => [ 'type' => 'string', 'required' => false, - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], + 'enum' => ['tyxmTurbo', 'tyxmPlus'], ], 'resultTypes' => [ 'type' => 'array', @@ -500,31 +273,10 @@ 'items' => [ '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', - ], + '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'], ], ], - 'sceneName' => [ - 'type' => 'string', - 'required' => false, - ], + 'sceneName' => ['type' => 'string', 'required' => false], 'serviceInspection' => [ 'type' => 'object', 'required' => false, @@ -536,31 +288,16 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'content' => [ - 'type' => 'string', - 'required' => true, - ], - 'title' => [ - 'type' => 'string', - 'required' => true, - ], + 'content' => ['type' => 'string', 'required' => true], + 'title' => ['type' => 'string', 'required' => true], ], ], ], - 'inspectionIntroduction' => [ - 'type' => 'string', - 'required' => true, - ], - 'sceneIntroduction' => [ - 'type' => 'string', - 'required' => true, - ], + 'inspectionIntroduction' => ['type' => 'string', 'required' => true], + 'sceneIntroduction' => ['type' => 'string', 'required' => true], ], ], - 'stream' => [ - 'type' => 'boolean', - 'required' => true, - ], + 'stream' => ['type' => 'boolean', 'required' => true], 'userProfiles' => [ 'type' => 'array', 'required' => false, @@ -568,86 +305,71 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'name' => [ - 'type' => 'string', - 'required' => false, - ], - 'value' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => ['type' => 'string', 'required' => false], + 'value' => ['type' => 'string', 'required' => false], ], ], ], 'timeConstraintList' => [ 'type' => 'array', 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'sourceCallerUid' => [ - 'type' => 'string', - 'required' => false, - ], - 'customPrompt' => [ - 'type' => 'string', - 'required' => false, - ], - 'responseFormatType' => [ - 'type' => 'string', - 'required' => false, + 'items' => ['type' => 'string', 'required' => false], ], + 'sourceCallerUid' => ['type' => 'string', 'required' => false], + 'customPrompt' => ['type' => 'string', 'required' => false], + 'responseFormatType' => ['type' => 'string', 'required' => false], ], ], ], ], ], - 'GetTaskResult' => [ - 'path' => '/ccai/app/getTaskResult', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AnalyzeImage' => [ + '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'], 'deprecated' => false, 'parameters' => [ [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'requiredFieldList', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => false], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'array', + 'type' => 'object', 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'asr_result', - 'debug', - 'rag_result', + 'properties' => [ + 'stream' => ['type' => 'boolean', 'required' => true], + 'imageUrls' => [ + 'type' => 'array', + 'required' => false, + 'items' => ['type' => 'string', 'required' => false], ], + 'resultTypes' => [ + 'type' => 'array', + 'required' => false, + 'items' => [ + 'type' => 'string', + 'required' => false, + 'enum' => ['watermark'], + ], + ], + 'responseFormatType' => ['type' => 'string', 'required' => false], ], ], ], @@ -655,40 +377,26 @@ ], 'CreateTask' => [ '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'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'body', @@ -712,33 +420,20 @@ 'role' => [ 'type' => 'string', 'required' => true, - 'enum' => [ - 'agent', - 'user', - 'system', - ], - ], - 'text' => [ - 'type' => 'string', - 'required' => true, + 'enum' => ['agent', 'user', 'system'], ], + 'text' => ['type' => 'string', 'required' => true], ], ], ], - 'sessionId' => [ - 'type' => 'string', - 'required' => false, - ], + 'sessionId' => ['type' => 'string', 'required' => false], ], ], 'examples' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'output' => [ - 'type' => 'string', - 'required' => false, - ], + 'output' => ['type' => 'string', 'required' => false], 'sentences' => [ 'type' => 'array', 'required' => true, @@ -746,14 +441,8 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'role' => [ - 'type' => 'string', - 'required' => true, - ], - 'text' => [ - 'type' => 'string', - 'required' => true, - ], + 'role' => ['type' => 'string', 'required' => true], + 'text' => ['type' => 'string', 'required' => true], ], ], ], @@ -766,14 +455,8 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'code' => [ - 'type' => 'string', - 'required' => false, - ], - 'desc' => [ - 'type' => 'string', - 'required' => true, - ], + 'code' => ['type' => 'string', 'required' => false], + 'desc' => ['type' => 'string', 'required' => true], 'enumValues' => [ 'type' => 'array', 'required' => false, @@ -781,31 +464,19 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'desc' => [ - 'type' => 'string', - 'required' => true, - ], - 'enumValue' => [ - 'type' => 'string', - 'required' => true, - ], + 'desc' => ['type' => 'string', 'required' => true], + 'enumValue' => ['type' => 'string', 'required' => true], ], ], ], - 'name' => [ - 'type' => 'string', - 'required' => true, - ], + 'name' => ['type' => 'string', 'required' => true], ], ], ], 'modelCode' => [ 'type' => 'string', 'required' => true, - 'enum' => [ - 'tyxmTurbo', - 'tyxmPlus', - ], + 'enum' => ['tyxmTurbo', 'tyxmPlus'], ], 'resultTypes' => [ 'type' => 'array', @@ -813,21 +484,7 @@ 'items' => [ 'type' => 'string', 'required' => true, - 'enum' => [ - 'summary', - 'title', - 'fields', - 'keywords', - 'service_inspection', - 'question_solution', - 'custom_prompt', - 'category_tag', - 'questions_and_answer', - 'service_finish', - 'actions', - 'satisfaction', - 'emotion_detection', - ], + 'enum' => ['summary', 'title', 'fields', 'keywords', 'service_inspection', 'question_solution', 'custom_prompt', 'category_tag', 'questions_and_answer', 'service_finish', 'actions', 'satisfaction', 'emotion_detection'], ], ], 'serviceInspection' => [ @@ -841,113 +498,55 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'content' => [ - 'type' => 'string', - 'required' => true, - ], - 'title' => [ - 'type' => 'string', - 'required' => true, - ], + 'content' => ['type' => 'string', 'required' => true], + 'title' => ['type' => 'string', 'required' => true], ], ], ], - 'inspectionIntroduction' => [ - 'type' => 'string', - 'required' => true, - ], - 'sceneIntroduction' => [ - 'type' => 'string', - 'required' => true, - ], + 'inspectionIntroduction' => ['type' => 'string', 'required' => true], + 'sceneIntroduction' => ['type' => 'string', 'required' => true], ], ], 'taskType' => [ 'type' => 'string', 'required' => true, - 'enum' => [ - 'audio', - 'text', - ], + 'enum' => ['audio', 'text'], ], 'templateIds' => [ 'type' => 'array', 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => true, - ], + 'items' => ['type' => 'string', 'required' => true], ], 'transcription' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'autoSplit' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'clientChannel' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'fileName' => [ - 'type' => 'string', - 'required' => true, - ], - 'serviceChannel' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'autoSplit' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + 'clientChannel' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + 'fileName' => ['type' => 'string', 'required' => true], + 'serviceChannel' => ['type' => 'integer', 'format' => 'int32', 'required' => false], 'serviceChannelKeywords' => [ 'type' => 'array', 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'voiceFileUrl' => [ - 'type' => 'string', - 'required' => true, + 'items' => ['type' => 'string', 'required' => false], ], + 'voiceFileUrl' => ['type' => 'string', 'required' => true], 'asrModelCode' => [ 'type' => 'string', 'required' => false, - 'enum' => [ - 'asr', - 'paraformer', - ], + 'enum' => ['asr', 'paraformer'], ], 'level' => [ 'type' => 'string', 'required' => false, - 'enum' => [ - 'low', - 'middle', - 'high', - ], - ], - 'vocabularyId' => [ - 'type' => 'string', - 'required' => false, - ], - 'roleIdentification' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'languageHints' => [ - 'type' => 'string', - 'required' => false, + 'enum' => ['low', 'middle', 'high'], ], + 'vocabularyId' => ['type' => 'string', 'required' => false], + 'roleIdentification' => ['type' => 'boolean', 'required' => false], + 'languageHints' => ['type' => 'string', 'required' => false], ], ], - 'customPrompt' => [ - 'type' => 'string', - 'required' => false, - ], + 'customPrompt' => ['type' => 'string', 'required' => false], 'variables' => [ 'type' => 'array', 'required' => false, @@ -955,14 +554,8 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'variableCode' => [ - 'type' => 'string', - 'required' => false, - ], - 'variableValue' => [ - 'type' => 'string', - 'required' => false, - ], + 'variableCode' => ['type' => 'string', 'required' => false], + 'variableValue' => ['type' => 'string', 'required' => false], ], ], ], @@ -973,70 +566,32 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'tagName' => [ - 'type' => 'string', - 'required' => false, - ], - 'tagDesc' => [ - 'type' => 'string', - 'required' => false, - ], + 'tagName' => ['type' => 'string', 'required' => false], + 'tagDesc' => ['type' => 'string', 'required' => false], ], ], ], - 'responseFormatType' => [ - 'type' => 'string', - 'required' => false, - ], - 'callBackUrl' => [ - 'type' => 'string', - 'required' => false, - ], + 'responseFormatType' => ['type' => 'string', 'required' => false], + 'callBackUrl' => ['type' => 'string', 'required' => false], ], ], ], ], ], - 'AnalyzeImage' => [ - 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeImage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'CreateVocab' => [ + 'path' => '/vocab/createVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', @@ -1044,78 +599,41 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'stream' => [ - 'type' => 'boolean', - 'required' => true, - ], - 'imageUrls' => [ - 'type' => 'array', - 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'resultTypes' => [ + 'workspaceId' => ['type' => 'string', 'required' => true], + 'name' => ['type' => 'string', 'required' => true], + 'description' => ['type' => 'string', 'required' => false], + 'audioModelCode' => ['type' => 'string', 'required' => false], + 'wordWeightList' => [ 'type' => 'array', - 'required' => false, + 'required' => true, 'items' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'watermark', + 'type' => 'object', + 'required' => true, + 'properties' => [ + 'weight' => ['type' => 'integer', 'format' => 'int32', 'required' => true], + 'word' => ['type' => 'string', 'required' => true], ], ], ], - 'responseFormatType' => [ - 'type' => 'string', - 'required' => false, - ], ], ], ], ], ], - 'GeneralAnalyzeImage' => [ - 'path' => '/{workspaceId}/ccai/app/{appId}/generalanalyzeImage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'DeleteVocab' => [ + 'path' => '/vocab/deleteVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', @@ -1123,126 +641,36 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'stream' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'imageUrls' => [ - 'type' => 'array', - 'required' => true, - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'customPrompt' => [ - 'type' => 'string', - 'required' => false, - ], - 'templateIds' => [ - 'type' => 'array', - 'required' => false, - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], - ], + 'vocabularyId' => ['type' => 'string', 'required' => true], + 'workspaceId' => ['type' => 'string', 'required' => true], ], ], ], ], ], - 'CreateVocab' => [ - 'path' => '/vocab/createVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GeneralAnalyzeImage' => [ + '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'], 'deprecated' => false, 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'workspaceId' => [ - 'type' => 'string', - 'required' => true, - ], - 'name' => [ - 'type' => 'string', - 'required' => true, - ], - 'description' => [ - 'type' => 'string', - 'required' => false, - ], - 'audioModelCode' => [ - 'type' => 'string', - 'required' => false, - ], - 'wordWeightList' => [ - 'type' => 'array', - 'required' => true, - 'items' => [ - 'type' => 'object', - 'required' => true, - 'properties' => [ - 'weight' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - ], - 'word' => [ - 'type' => 'string', - 'required' => true, - ], - ], - ], - ], - ], - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => false], ], - ], - ], - 'UpdateVocab' => [ - 'path' => '/vocab/updateVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => false], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'parameters' => [ [ 'name' => 'body', 'in' => 'body', @@ -1251,103 +679,68 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'vocabularyId' => [ - 'type' => 'string', + 'stream' => ['type' => 'boolean', 'required' => false], + 'imageUrls' => [ + 'type' => 'array', 'required' => true, + 'items' => ['type' => 'string', 'required' => false], ], - 'name' => [ - 'type' => 'string', - 'required' => false, - ], - 'description' => [ - 'type' => 'string', - 'required' => false, - ], - 'wordWeightList' => [ + 'customPrompt' => ['type' => 'string', 'required' => false], + 'templateIds' => [ 'type' => 'array', 'required' => false, - 'items' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'word' => [ - 'type' => 'string', - 'required' => true, - ], - 'weight' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - ], - ], - ], - ], - 'workspaceId' => [ - 'type' => 'string', - 'required' => true, + 'items' => ['type' => 'integer', 'format' => 'int64', 'required' => true], ], ], ], ], ], ], - 'ListVocab' => [ - 'path' => '/vocab/listVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetTaskResult' => [ + 'path' => '/ccai/app/getTaskResult', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['multipart/form-data'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'taskId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false], + ], + [ + 'name' => 'requiredFieldList', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'type' => 'object', + 'type' => 'array', 'required' => false, - 'properties' => [ - 'workspaceId' => [ - 'type' => 'string', - 'required' => true, - ], + 'items' => [ + 'type' => 'string', + 'required' => false, + 'enum' => ['asr_result', 'debug', 'rag_result'], ], ], ], ], ], - 'DeleteVocab' => [ - 'path' => '/vocab/deleteVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetVocab' => [ + 'path' => '/vocab/getVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ @@ -1358,38 +751,24 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'vocabularyId' => [ - 'type' => 'string', - 'required' => true, - ], - 'workspaceId' => [ - 'type' => 'string', - 'required' => true, - ], + 'vocabularyId' => ['type' => 'string', 'required' => true], + 'workspaceId' => ['type' => 'string', 'required' => true], ], ], ], ], ], - 'GetVocab' => [ - 'path' => '/vocab/getVocab', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListVocab' => [ + 'path' => '/vocab/listVocab', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ @@ -1400,57 +779,34 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'vocabularyId' => [ - 'type' => 'string', - 'required' => true, - ], - 'workspaceId' => [ - 'type' => 'string', - 'required' => true, - ], + 'workspaceId' => ['type' => 'string', 'required' => true], ], ], ], ], ], - 'AnalyzeAudioSync' => [ - 'path' => '/{workspaceId}/ccai/app/{appId}/analyzeAudioSync', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'RunCompletion' => [ + 'path' => '/{workspaceId}/ccai/app/{appId}/completion', + 'methods' => ['post'], + 'schemes' => ['http', 'https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'body', @@ -1460,195 +816,200 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'modelCode' => [ - 'type' => 'string', - 'required' => false, + 'Dialogue' => [ + 'type' => 'object', + 'required' => true, + 'properties' => [ + 'Sentences' => [ + 'type' => 'array', + 'required' => false, + 'items' => [ + 'type' => 'object', + 'required' => false, + 'properties' => [ + 'ChatId' => ['type' => 'string', 'required' => false], + 'Role' => [ + 'type' => 'string', + 'required' => true, + 'enum' => ['user', 'agent', 'system'], + ], + 'Text' => ['type' => 'string', 'required' => true], + ], + ], + ], + 'SessionId' => ['type' => 'string', 'required' => false], + ], ], - 'fields' => [ + 'Fields' => [ 'type' => 'array', 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'code' => [ - 'type' => 'string', - 'required' => false, - ], - 'name' => [ - 'type' => 'string', - 'required' => false, - ], - 'desc' => [ - 'type' => 'string', - 'required' => false, - ], - 'enumValues' => [ + 'Code' => ['type' => 'string', 'required' => false], + 'Desc' => ['type' => 'string', 'required' => false], + 'EnumValues' => [ 'type' => 'array', 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'desc' => [ - 'type' => 'string', - 'required' => false, - ], - 'enumValue' => [ - 'type' => 'string', - 'required' => false, - ], + 'Desc' => ['type' => 'string', 'required' => false], + 'EnumValue' => ['type' => 'string', 'required' => true], ], ], ], + 'Name' => ['type' => 'string', 'required' => true], ], ], ], - 'resultTypes' => [ - 'type' => 'array', + 'ModelCode' => [ + 'type' => 'string', 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => true, - ], + 'enum' => ['tyxmTurbo', 'tyxmPlus'], ], - 'serviceInspection' => [ + 'ServiceInspection' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'inspectionContents' => [ + 'InspectionContents' => [ 'type' => 'array', 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'content' => [ - 'type' => 'string', - 'required' => false, - ], - 'title' => [ - 'type' => 'string', - 'required' => false, - ], + 'Content' => ['type' => 'string', 'required' => false], + 'Title' => ['type' => 'string', 'required' => true], ], ], ], - 'inspectionIntroduction' => [ - 'type' => 'string', - 'required' => false, - ], - 'sceneIntroduction' => [ - 'type' => 'string', - 'required' => false, - ], + 'InspectionIntroduction' => ['type' => 'string', 'required' => false], + 'SceneIntroduction' => ['type' => 'string', 'required' => false], ], ], - 'templateIds' => [ + 'Stream' => ['type' => 'boolean', 'required' => false], + 'TemplateIds' => [ + 'type' => 'array', + 'required' => true, + 'items' => ['type' => 'integer', 'format' => 'int64', 'required' => false], + ], + 'variables' => [ 'type' => 'array', 'required' => false, 'items' => [ - 'type' => 'string', + 'type' => 'object', 'required' => false, + 'properties' => [ + 'variableCode' => ['type' => 'string', 'required' => false], + 'variableValue' => ['type' => 'string', 'required' => false], + ], ], ], - 'categoryTags' => [ + 'responseFormatType' => ['type' => 'string', 'required' => false], + ], + ], + ], + ], + ], + 'RunCompletionMessage' => [ + 'path' => '/{workspaceId}/ccai/app/{appId}/completion_message', + 'methods' => ['post'], + 'schemes' => ['http', 'https', 'sse'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => true], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => true], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'properties' => [ + 'Messages' => [ 'type' => 'array', - 'required' => false, + 'required' => true, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'tagName' => [ - 'type' => 'string', - 'required' => false, - ], - 'tagDesc' => [ + 'Content' => ['type' => 'string', 'required' => true], + 'Role' => [ 'type' => 'string', - 'required' => false, + 'required' => true, + 'enum' => ['user', 'assistant', 'system', 'function'], ], ], ], ], - 'customPrompt' => [ + 'ModelCode' => [ 'type' => 'string', 'required' => false, + 'enum' => ['tyxmTurbo', 'tyxmPlus'], ], - 'transcription' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'autoSplit' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'clientChannel' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'serviceChannel' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'fileName' => [ - 'type' => 'string', - 'required' => true, - ], - 'voiceFileUrl' => [ - 'type' => 'string', - 'required' => true, - ], - 'serviceChannelKeywords' => [ - 'type' => 'array', - 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'asrModelCode' => [ - 'type' => 'string', - 'required' => false, - ], - 'vocabularyId' => [ - 'type' => 'string', - 'required' => false, - ], - 'level' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'variables' => [ + 'Stream' => ['type' => 'boolean', 'required' => false], + 'responseFormatType' => ['type' => 'string', 'required' => false], + ], + ], + ], + ], + ], + 'UpdateVocab' => [ + 'path' => '/vocab/updateVocab', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'properties' => [ + 'vocabularyId' => ['type' => 'string', 'required' => true], + 'name' => ['type' => 'string', 'required' => false], + 'description' => ['type' => 'string', 'required' => false], + 'wordWeightList' => [ 'type' => 'array', 'required' => false, 'items' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'variableCode' => [ - 'type' => 'string', - 'required' => false, - ], - 'variableValue' => [ - 'type' => 'string', - 'required' => false, - ], + 'word' => ['type' => 'string', 'required' => true], + 'weight' => ['type' => 'integer', 'format' => 'int32', 'required' => true], ], ], ], - 'responseFormatType' => [ - 'type' => 'string', - 'required' => false, - ], - 'stream' => [ - 'type' => 'boolean', - 'required' => true, - ], + 'workspaceId' => ['type' => 'string', 'required' => true], ], ], ], @@ -1656,9 +1017,6 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', - ], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'contactcenterai.cn-shanghai.aliyuncs.com', 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', 'vpc' => 'contactcenterai-vpc.cn-shanghai.aliyuncs.com'], ], ]; |