'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'MultimodalDialog', 'version' => '2025-09-03', ], 'directories' => [ 'Vocabulary', ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'Vocabulary' => [ 'summary' => '提供热词词表的创建、删除、更新、查询功能。', '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' => '请求Body。', 'type' => 'object', 'properties' => [ 'action' => [ 'description' => '本次请求的操作。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'createVocabulary' => 'createVocabulary', 'queryVocabulary' => 'queryVocabulary', 'updateVocabulary' => 'updateVocabulary', 'deleteVocabulary' => 'deleteVocabulary', ], 'example' => 'createVocabulary', ], 'vocabularyName' => [ 'description' => '热词表名称。创建时必填。', 'type' => 'string', 'required' => false, 'example' => '热词表', ], 'vocabulary' => [ 'description' => '热词表，创建时必填。每个热词列表最多添加500个词。', 'type' => 'array', 'items' => [ 'description' => '热词。', 'type' => 'object', 'properties' => [ 'text' => [ 'description' => '热词文本。每个热词不超过15个汉字或7个英文单词。若热词同时含中文和英文，则汉字与英文字母总数不超过15个。', 'type' => 'string', 'required' => false, 'example' => '张三', ], 'lang' => [ 'description' => '热词语种。'."\n" .'- zh：中文'."\n" .'- en：英语', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'en' => 'en', 'zh' => 'zh', ], 'example' => 'zh', ], 'type' => [ 'description' => '热词种类。如果需要在对话系统中使用联系人等类型的热词，需要设置该值。否则，如果只需要在asr任务中使用，可以将该值置为null或空字符串。'."\n" .'- contact_name：联系人', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'contact_name' => 'contact_name', ], 'example' => 'contact_name', ], ], 'required' => false, ], 'required' => false, ], 'vocabularyId' => [ 'description' => '热词id。更新、删除时必填。', 'type' => 'string', 'required' => false, 'example' => 'a93b91141c0f422fa114af203f8b****'."\n", ], 'vocabularyIds' => [ 'description' => '热词id列表。查询时必填。', 'type' => 'array', 'items' => [ 'description' => '热词id。', 'type' => 'string', 'required' => false, 'example' => 'a93b91141c0f422fa114af203f8b****', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应参数', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'."\n", ], 'code' => [ 'description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'message' => [ 'description' => '响应信息。', 'type' => 'string', 'example' => 'Success', ], 'vocabularyId' => [ 'description' => '热词id。创建操作生成的热词唯一标识，在对话连接时可以传入此id。', 'type' => 'string', 'example' => 'a93b91141c0f422fa114af203f8b****'."\n", ], 'vocabularys' => [ 'description' => '热词列表。请求为查询操作时，根据热词id列表查询操作到的热词列表。', 'type' => 'array', 'items' => [ 'description' => '热词。', 'type' => 'object', 'properties' => [ 'vocabularyId' => [ 'description' => '热词id。', 'type' => 'string', 'example' => 'a93b91141c0f422fa114af203f8b****'."\n", ], 'vocabularyName' => [ 'description' => '热词表名称。查询不到对应热词时，该返回值为null。', 'type' => 'string', 'example' => '热词表', ], 'modifiedTime' => [ 'description' => '热词表最新修改时间。查询不到对应热词时，该返回值为null。', 'type' => 'integer', 'format' => 'int64', 'example' => '1749565022301', ], 'vocabulary' => [ 'description' => '热词。热词表最新修改时间。查询不到对应热词时，该返回值为null。', 'type' => 'object', 'properties' => [ 'text' => [ 'description' => '热词文本。', 'type' => 'string', 'example' => '张三', ], 'lang' => [ 'description' => '热词语种。', 'type' => 'string', 'example' => 'zh', ], 'type' => [ 'description' => '热词类型。', 'type' => 'string', 'example' => 'contact_name', ], ], ], ], ], ], ], ], ], ], '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' => '热词管理', 'responseParamsDescription' => '请求成功时，返回状态码为200。\\'."\n" .'如果返回状态码不是200，说明请求失败，可从message字段查看错误信息。以下为常见的错误响应信息：'."\n" .'+ Vocabulary not found error （指定热词id不存在，或不属于本阿里云账号）'."\n" .'+ Vocabulary size too large （热词表中热词数量超出限制）'."\n" .'+ Vocabulary format invalid （热词格式错误，如热词长度过大）'."\n" .'+ Internal vocabulary error （其他类型的热词错误）', ], ], 'endpoints' => [ [ 'regionId' => 'cn-beijing', 'endpoint' => 'multimodaldialog.cn-beijing.aliyuncs.com', ], ], ];