diff options
Diffstat (limited to 'data/en_us/multimodaldialog')
| -rw-r--r-- | data/en_us/multimodaldialog/2025-09-03/api-docs.php | 205 |
1 files changed, 203 insertions, 2 deletions
diff --git a/data/en_us/multimodaldialog/2025-09-03/api-docs.php b/data/en_us/multimodaldialog/2025-09-03/api-docs.php index 19d0733..309da68 100644 --- a/data/en_us/multimodaldialog/2025-09-03/api-docs.php +++ b/data/en_us/multimodaldialog/2025-09-03/api-docs.php @@ -1,4 +1,205 @@ <?php return [ - 'code' => 500, - 'message' => 'server error', + 'version' => '1.0', + 'info' => ['style' => 'ROA', 'product' => 'MultimodalDialog', 'version' => '2025-09-03'], + 'directories' => ['Vocabulary'], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'Vocabulary' => [ + 'summary' => 'Provides features for creating, deleting, updating, and querying hot word lists.', + 'path' => '/openapi/vocabulary/v1', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREnlsPWZ9VY'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂不支持', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'description' => 'The operation for this request.', + 'enumValueTitles' => ['createVocabulary' => 'createVocabulary', 'queryVocabulary' => 'queryVocabulary', 'updateVocabulary' => 'updateVocabulary', 'deleteVocabulary' => 'deleteVocabulary'], + 'type' => 'string', + 'required' => false, + 'example' => 'createVocabulary', + 'title' => '', + ], + 'vocabularyName' => ['description' => 'The name of the hot word list. Required for creation.', 'type' => 'string', 'required' => false, 'example' => '热词表', 'title' => ''], + 'vocabulary' => [ + 'description' => 'The hot word list. Required for creation. You can add up to 500 words to each hot word list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hot word.', + 'type' => 'object', + 'properties' => [ + 'text' => ['description' => 'The hot word text. Each hot word can contain up to 15 Chinese characters or 7 English words. If a hot word contains both Chinese and English, the total number of Chinese characters and English letters cannot exceed 15.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], + 'lang' => [ + 'description' => 'The language of the hot word. Valid values:'."\n" + .'- zh: Chinese'."\n" + .'- en: English.', + 'enumValueTitles' => ['en' => 'en', 'zh' => 'zh'], + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'title' => '', + ], + 'type' => [ + 'description' => 'The type of the hot word. If you need to use hot words of types such as contacts in a conversation system, set this parameter. Otherwise, if you only need to use the hot word in ASR tasks, set this parameter to null or an empty string. Valid values:'."\n" + .'- contact_name: contact.', + 'enumValueTitles' => ['contact_name' => 'contact_name'], + 'type' => 'string', + 'required' => false, + 'example' => 'contact_name', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'vocabularyId' => ['description' => 'The hot word ID. Required for update and delete operations.', 'type' => 'string', 'required' => false, 'example' => 'a93b91141c0f422fa114af203f8b****'."\n", 'title' => ''], + 'vocabularyIds' => [ + 'description' => 'The list of hot word IDs. Required for query operations.', + 'type' => 'array', + 'items' => ['description' => 'The hot word ID.', 'type' => 'string', 'required' => false, 'example' => 'a93b91141c0f422fa114af203f8b****', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'."\n", 'title' => ''], + 'code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'vocabularyId' => ['description' => 'The hot word ID. This is the unique identifier generated by the create operation. You can pass this ID when establishing a conversation connection.', 'type' => 'string', 'example' => 'a93b91141c0f422fa114af203f8b****'."\n", 'title' => ''], + 'vocabularys' => [ + 'description' => 'The list of hot words. When the request is a query operation, this list contains the hot words retrieved based on the specified hot word ID list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hot word.', + 'type' => 'object', + 'properties' => [ + 'vocabularyId' => ['description' => 'The hot word ID.', 'type' => 'string', 'example' => 'a93b91141c0f422fa114af203f8b****'."\n", 'title' => ''], + 'vocabularyName' => ['description' => 'The name of the hot word list. This value is null if the corresponding hot word is not found.', 'type' => 'string', 'example' => '热词表', 'title' => ''], + 'modifiedTime' => ['description' => 'The last modification time of the hot word list. This value is null if the corresponding hot word is not found.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749565022301', 'title' => ''], + 'vocabulary' => [ + 'description' => 'The hot word. This value is null if the corresponding hot word is not found.', + 'type' => 'object', + 'properties' => [ + 'text' => ['description' => 'The hot word text.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'lang' => ['description' => 'The language of the hot word.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'type' => ['description' => 'The type of the hot word.', 'type' => 'string', 'example' => 'contact_name', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\\\n\\",\\n \\"code\\": 200,\\n \\"message\\": \\"Success\\",\\n \\"vocabularyId\\": \\"a93b91141c0f422fa114af203f8b****\\\\n\\",\\n \\"vocabularys\\": [\\n {\\n \\"vocabularyId\\": \\"a93b91141c0f422fa114af203f8b****\\\\n\\",\\n \\"vocabularyName\\": \\"热词表\\",\\n \\"modifiedTime\\": 1749565022301,\\n \\"vocabulary\\": {\\n \\"text\\": \\"张三\\",\\n \\"lang\\": \\"zh\\",\\n \\"type\\": \\"contact_name\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Hot word management', + 'responseParamsDescription' => 'A status code of 200 is returned if the request succeeds.\\'."\n" + .'If the returned status code is not 200, the request has failed. Check the message field for the error message. The following are common error response messages:'."\n" + .'+ Vocabulary not found error (The specified hot word ID does not exist or does not belong to this Alibaba Cloud account.)'."\n" + .'+ Vocabulary size too large (The number of hot words in the hot word list exceeds the limit.)'."\n" + .'+ Vocabulary format invalid (The hot word format is invalid, such as the hot word length being too long.)'."\n" + .'+ Internal vocabulary error (Other types of hot word errors.)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'multimodaldialog:Vocabulary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MultimodalDialog', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'multimodaldialog.cn-beijing.aliyuncs.com', 'endpoint' => 'multimodaldialog.cn-beijing.aliyuncs.com', 'vpc' => 'multimodaldialog-vpc.cn-beijing.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ram' => [ + 'productCode' => 'MultimodalDialog', + 'productName' => 'Intelligent Speech Interaction', + 'ramCodes' => ['multimodaldialog'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'Vocabulary', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'multimodaldialog:Vocabulary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MultimodalDialog', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [], + ], ]; |