diff options
Diffstat (limited to 'data/zh_cn/chatbot/2022-04-08/api-docs.php')
| -rw-r--r-- | data/zh_cn/chatbot/2022-04-08/api-docs.php | 15087 |
1 files changed, 5098 insertions, 9989 deletions
diff --git a/data/zh_cn/chatbot/2022-04-08/api-docs.php b/data/zh_cn/chatbot/2022-04-08/api-docs.php index d2b8c9c..e1b15a2 100644 --- a/data/zh_cn/chatbot/2022-04-08/api-docs.php +++ b/data/zh_cn/chatbot/2022-04-08/api-docs.php @@ -1,855 +1,199 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Chatbot', - 'version' => '2022-04-08', - ], + 'info' => ['style' => 'RPC', 'product' => 'Chatbot', 'version' => '2022-04-08'], 'directories' => [ [ - 'id' => 189601, - 'title' => '文档管理', + 'children' => ['CreateDoc', 'DeleteDoc', 'UpdateDoc', 'RetryDoc', 'SearchDoc', 'DescribeDoc'], 'type' => 'directory', - 'children' => [ - 'CreateDoc', - 'DeleteDoc', - 'UpdateDoc', - 'RetryDoc', - 'SearchDoc', - 'DescribeDoc', - ], + 'title' => '文档管理', + 'id' => 453611, ], [ - 'id' => 189608, - 'title' => '类目管理', + 'children' => ['CreateCategory', 'DescribeCategory', 'ListCategory'], 'type' => 'directory', - 'children' => [ - 'CreateCategory', - 'DeleteCategory', - 'UpdateCategory', - 'DescribeCategory', - 'ListCategory', - ], + 'title' => '类目管理', + 'id' => 453612, ], [ - 'id' => 167775, - 'title' => '会话管理', + 'children' => ['TongyiChatDebugInfo', 'ApplyForStreamAccessToken', 'Feedback', 'Chat', 'Associate', 'BeginSession', 'Nlu'], 'type' => 'directory', - 'children' => [ - 'TongyiChatDebugInfo', - 'ApplyForStreamAccessToken', - 'Feedback', - 'Chat', - 'Associate', - 'BeginSession', - 'Nlu', - ], + 'title' => '会话管理', + 'id' => 453613, ], [ - 'id' => 168180, - 'title' => '全局服务', + 'children' => ['GetAsyncResult'], 'type' => 'directory', - 'children' => [ - 'GetAsyncResult', - ], + 'title' => '全局服务', + 'id' => 453614, ], [ - 'id' => 168037, - 'title' => '机器人管理', - 'type' => 'directory', 'children' => [ [ - 'id' => 168069, - 'title' => '机器人管理', + 'children' => ['LinkInstanceCategory', 'DescribeInstance', 'ListInstance'], 'type' => 'directory', - 'children' => [ - 'CreateInstance', - 'DeleteInstance', - 'UpdateInstance', - 'LinkInstanceCategory', - 'DescribeInstance', - 'ListInstance', - ], + 'title' => '机器人管理', + 'id' => 453616, ], [ - 'id' => 168038, - 'title' => '机器人发布', + 'children' => ['CreateInstancePublishTask', 'CancelInstancePublishTask', 'ContinueInstancePublishTask', 'GetInstancePublishTaskState'], 'type' => 'directory', - 'children' => [ - 'CreateInstancePublishTask', - 'CancelInstancePublishTask', - 'ContinueInstancePublishTask', - 'GetInstancePublishTaskState', - ], + 'title' => '机器人发布', + 'id' => 453617, ], ], + 'type' => 'directory', + 'title' => '机器人管理', + 'id' => 453615, ], [ - 'id' => 167654, - 'title' => 'FAQ管理', - 'type' => 'directory', 'children' => [ [ - 'id' => 168042, - 'title' => 'FAQ答案', + 'children' => ['CreateSolution', 'DeleteSolution', 'UpdateSolution', 'ListSolution'], 'type' => 'directory', - 'children' => [ - 'CreateSolution', - 'DeleteSolution', - 'UpdateSolution', - 'ListSolution', - ], + 'title' => 'FAQ答案', + 'id' => 453619, ], [ - 'id' => 168043, - 'title' => 'FAQ关联问', + 'children' => ['CreateConnQuestion', 'DeleteConnQuestion', 'UpdateConnQuestion', 'ListConnQuestion'], 'type' => 'directory', - 'children' => [ - 'CreateConnQuestion', - 'DeleteConnQuestion', - 'UpdateConnQuestion', - 'ListConnQuestion', - ], + 'title' => 'FAQ关联问', + 'id' => 453620, ], [ - 'id' => 168045, - 'title' => 'FAQ相似问', + 'children' => ['CreateSimQuestion', 'DeleteSimQuestion', 'UpdateSimQuestion', 'ListSimQuestion'], 'type' => 'directory', - 'children' => [ - 'CreateSimQuestion', - 'DeleteSimQuestion', - 'UpdateSimQuestion', - 'ListSimQuestion', - ], + 'title' => 'FAQ相似问', + 'id' => 453621, ], [ - 'id' => 168046, - 'title' => 'FAQ', + 'children' => ['CreateFaq', 'DeleteFaq', 'UpdateFaq', 'DescribeFaq', 'SearchFaq'], 'type' => 'directory', - 'children' => [ - 'CreateFaq', - 'DeleteFaq', - 'UpdateFaq', - 'DescribeFaq', - 'SearchFaq', - ], + 'title' => 'FAQ', + 'id' => 453622, ], ], + 'type' => 'directory', + 'title' => 'FAQ管理', + 'id' => 453618, ], [ - 'id' => 168050, - 'title' => '对话工厂', - 'type' => 'directory', 'children' => [ [ - 'id' => 168103, - 'title' => '实体管理', - 'type' => 'directory', 'children' => [ [ - 'id' => 168104, - 'title' => '实体', + 'children' => ['CreateDSEntity', 'DeleteDSEntity', 'UpdateDSEntity', 'DescribeDSEntity', 'ListDSEntity'], 'type' => 'directory', - 'children' => [ - 'CreateDSEntity', - 'DeleteDSEntity', - 'UpdateDSEntity', - 'DescribeDSEntity', - 'ListDSEntity', - ], + 'title' => '实体', + 'id' => 453625, ], [ - 'id' => 168105, - 'title' => '实体成员', + 'children' => ['CreateDSEntityValue', 'DeleteDSEntityValue', 'UpdateDSEntityValue', 'ListDSEntityValue'], 'type' => 'directory', - 'children' => [ - 'CreateDSEntityValue', - 'DeleteDSEntityValue', - 'UpdateDSEntityValue', - 'ListDSEntityValue', - ], + 'title' => '实体成员', + 'id' => 453626, ], ], + 'type' => 'directory', + 'title' => '实体管理', + 'id' => 453624, ], [ - 'id' => 168106, - 'title' => '意图管理', - 'type' => 'directory', 'children' => [ [ - 'id' => 168107, - 'title' => '意图', + 'children' => ['CreateIntent', 'DeleteIntent', 'UpdateIntent', 'DescribeIntent', 'ListIntent'], 'type' => 'directory', - 'children' => [ - 'CreateIntent', - 'DeleteIntent', - 'UpdateIntent', - 'DescribeIntent', - 'ListIntent', - ], + 'title' => '意图', + 'id' => 453628, ], [ - 'id' => 168108, - 'title' => '意图话术', + 'children' => ['CreateUserSay', 'DeleteUserSay', 'UpdateUserSay', 'ListUserSay'], 'type' => 'directory', - 'children' => [ - 'CreateUserSay', - 'DeleteUserSay', - 'UpdateUserSay', - 'ListUserSay', - ], + 'title' => '意图话术', + 'id' => 453629, ], [ - 'id' => 168109, - 'title' => '高级语义配置（LGF）', + 'children' => ['CreateLgf', 'DeleteLgf', 'UpdateLgf', 'ListLgf'], 'type' => 'directory', - 'children' => [ - 'CreateLgf', - 'DeleteLgf', - 'UpdateLgf', - 'ListLgf', - ], + 'title' => '高级语义配置（LGF）', + 'id' => 453630, ], ], + 'type' => 'directory', + 'title' => '意图管理', + 'id' => 453627, ], ], + 'type' => 'directory', + 'title' => '对话工厂', + 'id' => 453623, ], [ - 'id' => 168068, - 'title' => '视角管理', + 'children' => ['CreatePerspective', 'DeletePerspective', 'UpdatePerspective', 'DescribePerspective', 'QueryPerspectives'], 'type' => 'directory', - 'children' => [ - 'CreatePerspective', - 'DeletePerspective', - 'UpdatePerspective', - 'DescribePerspective', - 'QueryPerspectives', - ], + 'title' => '视角管理', + 'id' => 453631, ], [ - 'id' => 168054, - 'title' => '发布管理', + 'children' => ['CreatePublishTask', 'CancelPublishTask', 'GetPublishTaskState'], 'type' => 'directory', - 'children' => [ - 'CreatePublishTask', - 'CancelPublishTask', - 'GetPublishTaskState', - ], + 'title' => '发布管理', + 'id' => 453632, ], [ - 'id' => 168056, - 'title' => '业务空间', + 'children' => ['GetAgentInfo', 'ListAgent'], 'type' => 'directory', - 'children' => [ - 'GetAgentInfo', - 'ListAgent', - ], + 'title' => '业务空间', + 'id' => 453633, ], [ - 'id' => 169501, - 'title' => '渠道聊天窗', + 'children' => ['GenerateUserAccessToken'], 'type' => 'directory', - 'children' => [ - 'GenerateUserAccessToken', - ], + 'title' => '渠道聊天窗', + 'id' => 453634, ], [ - 'id' => 192374, - 'title' => '数据看板', + 'children' => ['ListTongyiConversationLogs', 'ListTongyiChatHistorys', 'GetBotSessionData'], 'type' => 'directory', - 'children' => [ - 'ListTongyiConversationLogs', - 'ListTongyiChatHistorys', - 'GetBotSessionData', - ], + 'title' => '数据看板', + 'id' => 453635, ], [ - 'id' => 187838, - 'title' => '其他', + 'children' => ['InitIMConnect', 'ListSaasInfo', 'ListSaasPermissionGroupInfos', 'CancelChat', 'CreateInstance', 'DeleteCategory', 'DeleteInstance', 'UpdateCategory', 'UpdateInstance'], 'type' => 'directory', - 'children' => [ - 'InitIMConnect', - 'ListSaasInfo', - 'ListSaasPermissionGroupInfos', - 'CancelChat', - ], + 'title' => '其他', + 'id' => 453636, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateDoc' => [ - 'summary' => '文档新建。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key,不传时访问默认业务空间,key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - [ - 'name' => 'CategoryId', - 'in' => 'query', - 'schema' => [ - 'title' => '文档类目ID', - 'description' => '文档类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30000049006', - ], - ], - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'title' => '文档标题', - 'description' => '文档标题', - 'type' => 'string', - 'required' => true, - 'example' => '测试标题', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], - [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'title' => '文档内容', - 'description' => '文档内容,与URL二选一', - 'type' => 'string', - 'required' => false, - 'example' => '测试内容', - ], - ], - [ - 'name' => 'Config', - 'in' => 'query', - 'schema' => [ - 'title' => '文档解析/切分配置'."\n" - .'配置项：切分器'."\n" - .'KEY：Splitter'."\n" - .'值选项：ParagraphSplitter-识别层级'."\n" - .'值选项：TreeSplitter-规则层级'."\n" - ."\n" - .'配置项：文档切块大小'."\n" - .'KEY：ChunkSize'."\n" - .'VALUE：默认500；范围[200,800]'."\n" - ."\n" - .'配置项：规则层级'."\n" - .'KEY：TreePatterns'."\n" - .'VALUE：默认[]'."\n" - ."\n" - .'配置项：文档标题来源'."\n" - .'KEY：TitleSource'."\n" - .'值选项：ocrTitle - OCR识别标题【默认】'."\n" - .'值选项：docName - 文档名即标题', - 'description' => '文档解析/切分配置'."\n" - .'配置项：切分器'."\n" - .'KEY：Splitter'."\n" - .'值选项：ParagraphSplitter-识别层级'."\n" - .'值选项：TreeSplitter-规则层级'."\n" - ."\n" - .'配置项：文档切块大小'."\n" - .'KEY：ChunkSize'."\n" - .'VALUE：默认500；范围[200,800]'."\n" - ."\n" - .'配置项：规则层级'."\n" - .'KEY：TreePatterns'."\n" - .'VALUE：默认[]'."\n" - ."\n" - .'配置项：文档标题来源'."\n" - .'KEY：TitleSource'."\n" - .'值选项：ocrTitle - OCR识别标题【默认】'."\n" - .'值选项：docName - 文档名即标题', - 'type' => 'string', - 'required' => false, - 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":""}', - ], - ], - [ - 'name' => 'Meta', - 'in' => 'query', - 'schema' => [ - 'title' => '文档随路数据', - 'description' => '文档随路数据', - 'type' => 'string', - 'required' => false, - 'example' => '{"code":"xxx"}', - ], - ], - [ - 'name' => 'StartDate', - 'in' => 'query', - 'schema' => [ - 'title' => '生效开始时间', - 'description' => '生效开始时间UTC', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-25T16:28:36Z'."\n", - ], - ], - [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'title' => '生效结束时间', - 'description' => '生效结束时间UTC', - 'type' => 'string', - 'required' => false, - 'example' => '2032-05-25T16:28:36Z'."\n", - ], - ], - [ - 'name' => 'Url', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '文档链接URL路径 ', - 'description' => '文档链接URL路径，与Content二选一，支持txt、pdf、markdown、doc、docx格式（单个文件：最多100页，txt小于200K，pdf小于100M，markdown小于200K，doc小于100M，docx小于100M）', - 'type' => 'string', - 'required' => false, - 'example' => 'https://example.com/example.pdf', - ], - ], - [ - 'name' => 'TagIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '标签ID列表', - 'type' => 'array', - 'items' => [ - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1201', - ], - 'required' => false, - ], - ], - [ - 'name' => 'DocMetadata', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BusinessViewId' => [ - 'type' => 'string', - 'required' => false, - ], - 'BusinessViewName' => [ - 'type' => 'string', - 'required' => false, - ], - 'MetaCellInfoDTOList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FieldCode' => [ - 'type' => 'string', - 'required' => false, - ], - 'FieldName' => [ - 'type' => 'string', - 'required' => false, - ], - 'Value' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - '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', - 'type' => 'string', - 'example' => '07B270A4-61D8-57F6-A609-A3C216CFB872', - ], - 'KnowledgeId' => [ - 'description' => '知识ID'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001905617', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '文档新建', - ], - 'DeleteDoc' => [ - 'summary' => '删除文档。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ApplyForStreamAccessToken' => [ + 'summary' => '获取流式调用的连接信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'APP' => [], ], [ - 'name' => 'KnowledgeId', - 'in' => 'query', - 'schema' => [ - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910', - ], - 'KnowledgeId' => [ - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30002406051', - ], - ], - ], + 'PrivateKey' => [], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '删除文档', - ], - 'UpdateDoc' => [ - 'summary' => '更新文档。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - [ - 'name' => 'KnowledgeId', - 'in' => 'query', - 'schema' => [ - 'title' => '文档ID', - 'description' => '文档ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], - ], - [ - 'name' => 'CategoryId', - 'in' => 'query', - 'schema' => [ - 'title' => '文档类目ID', - 'description' => '文档类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '231001028593', - ], - ], - [ - 'name' => 'DocName', - 'in' => 'query', - 'schema' => [ - 'title' => '文档名称', - 'description' => '文档名称', - 'type' => 'string', - 'required' => false, - 'example' => '文档问答模块功能说明文档', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'title' => '文档标题', - 'description' => '文档标题', - 'type' => 'string', - 'required' => false, - 'example' => '文档问答功能说明', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], - [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'title' => '文档内容', - 'description' => '文档内容', - 'type' => 'string', - 'required' => false, - 'example' => '文档内容', - 'maxLength' => 40000, - ], - ], - [ - 'name' => 'Config', - 'in' => 'query', - 'schema' => [ - 'title' => '文档解析/切分配置'."\n" - .'配置项：切分器'."\n" - .'KEY：Splitter'."\n" - .'值选项：ParagraphSplitter-识别层级【默认】'."\n" - .'值选项：TreeSplitter-规则层级'."\n" - ."\n" - .'配置项：文档切块大小'."\n" - .'KEY：ChunkSize'."\n" - .'VALUE：默认500；范围[200,800]'."\n" - ."\n" - .'配置项：规则层级'."\n" - .'KEY：TreePatterns'."\n" - .'VALUE：默认[]'."\n" - ."\n" - .'配置项：文档标题来源'."\n" - .'KEY：TitleSource'."\n" - .'值选项：ocrTitle - OCR识别标题【默认】'."\n" - .'值选项：docName - 文档名即标题', - 'description' => '文档解析/切分配置'."\n" - .'配置项：切分器'."\n" - .'KEY：Splitter'."\n" - .'值选项：paragraphSplitter-识别层级【默认】'."\n" - .'值选项：treeSplitter-规则层级'."\n" - ."\n" - .'配置项：文档切块大小'."\n" - .'KEY：ChunkSize'."\n" - .'VALUE：默认500；范围[200,800]'."\n" - ."\n" - .'配置项：规则层级'."\n" - .'KEY：TreePatterns'."\n" - .'VALUE：默认[]'."\n" - ."\n" - .'配置项：文档标题来源'."\n" - .'KEY：TitleSource'."\n" - .'值选项：ocrTitle - OCR识别标题【默认】'."\n" - .'值选项：docName - 文档名即标题', - 'type' => 'string', - 'required' => false, - 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":""}', - ], - ], - [ - 'name' => 'Meta', - 'in' => 'query', - 'schema' => [ - 'title' => '文档随路数据', - 'description' => '文档随路数据', - 'type' => 'string', - 'required' => false, - 'example' => '{"code":"xxx"}', - 'maxLength' => 1000, - ], - ], - [ - 'name' => 'StartDate', - 'in' => 'query', - 'schema' => [ - 'description' => '开始生效时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-25T16:28:36Z', - ], - ], - [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '结束生效时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-03-11T23:59:59Z', - ], - ], - [ - 'name' => 'TagIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '标签ID列表，为空时解除绑定', - 'type' => 'array', - 'items' => [ - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1201', - ], - 'required' => false, - ], - ], - [ - 'name' => 'DocMetadata', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BusinessViewId' => [ - 'type' => 'string', - 'required' => false, - ], - 'BusinessViewName' => [ - 'type' => 'string', - 'required' => false, - ], - 'MetaCellInfoDTOList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FieldCode' => [ - 'type' => 'string', - 'required' => false, - ], - 'FieldName' => [ - 'type' => 'string', - 'required' => false, - ], - 'Value' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -859,351 +203,75 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0F9F136A-1BF6-5CC1-9D57-9717761F03B8', - ], - 'KnowledgeId' => [ - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30002406051', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '736994BD-AA35-4742-88C9-E64BE4BAA14B'], + 'AccessToken' => ['description' => '服务的请求Token。', 'type' => 'string', 'example' => '63ba97b4f18a4a04f715c81e8e643938'], + 'ChannelId' => ['description' => '通道ID', 'type' => 'string', 'example' => 'cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d'], + 'StreamSecret' => ['description' => '业务空间的密钥，流式请求加签使用', 'type' => 'string', 'example' => 'cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '更新文档', - ], - 'RetryDoc' => [ - 'summary' => '文档重试。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'e2a20f74cd9042558002c0f7dc873739_p_outbound_public', - ], - ], - [ - 'name' => 'KnowledgeId', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '6419BA93-D111-5225-8998-13E63E6D3940', - ], - 'KnowledgeId' => [ - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001905617', - ], - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"736994BD-AA35-4742-88C9-E64BE4BAA14B\\",\\n \\"AccessToken\\": \\"63ba97b4f18a4a04f715c81e8e643938\\",\\n \\"ChannelId\\": \\"cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d\\",\\n \\"StreamSecret\\": \\"cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d\\"\\n}","type":"json"}]', + 'title' => '获取流式调用的连接信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyForStreamAccessToken'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '文档重试', + 'ramActions' => [], ], - 'SearchDoc' => [ - 'summary' => '搜索文档。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'Associate' => [ + 'summary' => '根据用户query联想知识库中的FAQ。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ - 'name' => 'Keyword', + 'name' => 'Utterance', 'in' => 'query', - 'schema' => [ - 'description' => '关键字', - 'type' => 'string', - 'required' => false, - 'example' => '搜索关键字', - ], + 'schema' => ['title' => '用户表述', 'description' => '用户表述', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '公积金提取'], ], [ - 'name' => 'CategoryIds', + 'name' => 'Perspective', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '类目ID列表', + 'title' => '视角编码，用于调用同一知识标题下不同视角的答案。在拼装请求参数时，需要以Perspective={视角编码}的格式传递参数。如：&Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准。目前仅支持一个视角答案的调用。 （公有云）', + 'description' => '视角编码，用于调用同一知识标题下不同视角的答案。在拼装请求参数时，需要以Perspective={视角编码}的格式传递参数。如：&Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准。目前仅支持一个视角答案的调用', 'type' => 'array', - 'items' => [ - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30000065594', - ], - 'required' => false, - ], - ], - [ - 'name' => 'ProcessStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '任务状态'."\n" - .'-1 排队中'."\n" - .'0 成功'."\n" - .'1 解析中'."\n" - .'2 处理中'."\n" - .'3 处理失败', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '编辑状态：'."\n" - .'1 未发布'."\n" - .'2 已发布'."\n" - .'3 已更新未发布', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'SearchScope', - 'in' => 'query', - 'schema' => [ - 'description' => '搜索范围 '."\n" - .'1 搜索标题'."\n" - .'2 搜索内容', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'CreateUserName', - 'in' => 'query', - 'schema' => [ - 'description' => '创建人名称', - 'type' => 'string', - 'required' => false, - 'example' => '张三', - ], - ], - [ - 'name' => 'ModifyUserName', - 'in' => 'query', - 'schema' => [ - 'description' => '修改人名称', - 'type' => 'string', - 'required' => false, - 'example' => '李四', - ], - ], - [ - 'name' => 'CreateTimeBegin', - 'in' => 'query', - 'schema' => [ - 'description' => '创建开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-02T03:09:30Z', - ], - ], - [ - 'name' => 'CreateTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => '创建结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-02T03:09:30Z', - ], - ], - [ - 'name' => 'ModifyTimeBegin', - 'in' => 'query', - 'schema' => [ - 'description' => '修改开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-02T03:09:30Z', - ], - ], - [ - 'name' => 'ModifyTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => '修改结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-05-02T03:09:30Z', - ], - ], - [ - 'name' => 'StartTimeBegin', - 'in' => 'query', - 'schema' => [ - 'description' => '生效开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-02T03:09:30Z', - ], - ], - [ - 'name' => 'StartTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => '生效结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-03T03:09:30Z', - ], - ], - [ - 'name' => 'EndTimeBegin', - 'in' => 'query', - 'schema' => [ - 'description' => '失效开始时间', - 'type' => 'string', + 'items' => ['description' => '视角', 'type' => 'string', 'required' => false, 'example' => 'FZJBY3raWr'], 'required' => false, - 'example' => '2023-04-02T03:09:30Z', - ], - ], - [ - 'name' => 'EndTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => '失效结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-05-02T03:09:30Z', + 'example' => '["qyzzVfyFfa"]', ], ], [ - 'name' => 'PageNumber', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '分⻚-第⼏⻚', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。', 'description' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。', 'type' => 'string', 'required' => false, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa'], ], [ - 'name' => 'PageSize', + 'name' => 'RecommendNum', 'in' => 'query', - 'schema' => [ - 'description' => '每页数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['title' => '推荐问题数量，1-10，当出推荐的时候才生效，返回不大于RecommendN', 'description' => '推荐问题数量，1-10，当出推荐的时候才生效，返回小于等于RecommendNum的推荐问题', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8'], ], [ - 'name' => 'TagIds', + 'name' => 'AgentKey', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '标签ID列表', - 'description' => '标签ID列表，多个标签时，采用“并集”逻辑进行筛选', - 'type' => 'array', - 'items' => [ - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1201', - ], - 'required' => false, - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -1213,231 +281,60 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', - ], - 'PageNumber' => [ - 'description' => '当前⻚码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '141', - ], - 'DocHits' => [ - 'description' => '文档列表', + 'RequestId' => ['title' => '请求id', 'description' => '请求ID', 'type' => 'string', 'example' => '5C20F0D4-9721-178A-8236-3BF990634962'], + 'Associate' => [ + 'title' => '联想的列表', + 'description' => '联想的列表', 'type' => 'array', 'items' => [ + 'description' => '联想推荐的列表', 'type' => 'object', 'properties' => [ - 'KnowledgeId' => [ - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30002692007', - ], - 'DocName' => [ - 'description' => '文档名称', - 'type' => 'string', - 'example' => '文档名称', - ], - 'BizCode' => [ - 'description' => '业务代码', - 'type' => 'string', - 'example' => 'cn_dytns', - ], - 'Meta' => [ - 'description' => '文档随路数据', - 'type' => 'string', - 'example' => '{"code":"xxx"}', - ], - 'Config' => [ - 'description' => '文档解析/切分配置'."\n" - .'配置项：切分器'."\n" - .'KEY：Splitter'."\n" - .'值选项：paragraphSplitter-识别层级【默认】'."\n" - .'值选项：treeSplitter-规则层级'."\n" - ."\n" - .'配置项：文档切块大小'."\n" - .'KEY：ChunkSize'."\n" - .'VALUE：默认500；范围[200,800]'."\n" - ."\n" - .'配置项：规则层级'."\n" - .'KEY：TreePatterns'."\n" - .'VALUE：默认[]'."\n" - ."\n" - .'配置项：文档标题来源'."\n" - .'KEY：TitleSource'."\n" - .'值选项：ocrTitle - OCR识别标题【默认】'."\n" - .'值选项：docName - 文档名即标题', - 'type' => 'string', - 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}', - ], - 'Url' => [ - 'description' => '文档保存OSS地址', - 'type' => 'string', - 'example' => 'https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf', - ], - 'ModifyTime' => [ - 'description' => '修改时间（UTC时间）', - 'type' => 'string', - 'example' => '2023-06-25T02:27:42Z', - ], - 'ModifyUserName' => [ - 'description' => '修改人名称', - 'type' => 'string', - 'example' => '李四', - ], - 'CreateTime' => [ - 'description' => '创建时间（UTC时间）', - 'type' => 'string', - 'example' => '2023-06-22T03:53:41Z', - ], - 'CreateUserName' => [ - 'description' => '创建人名称', - 'type' => 'string', - 'example' => '张三', - ], - 'CreateUserId' => [ - 'description' => '创建人ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '111111111', - ], - 'ModifyUserId' => [ - 'description' => '修改人ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '222222222', - ], - 'CategoryId' => [ - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000135654', - ], - 'ProcessStatus' => [ - 'description' => '任务处理状态'."\n" - .'-1 排队中'."\n" - .'0 成功'."\n" - .'1 解析中'."\n" - .'2 处理中'."\n" - .'3 处理失败', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProcessMessage' => [ - 'description' => '任务处理信息', - 'type' => 'string', - 'example' => '任务处理成功', - ], - 'ProcessCanRetry' => [ - 'description' => '任务是否可重试'."\n" - .'true：可重试'."\n" - .'false：不可重试', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => '编辑状态： 1 未发布 2 已发布 3 已更新未发布', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EffectStatus' => [ - 'description' => '知识生效状态，根据StartDate，EndDate计算出来：20-生效中，21-已失效，22-待生效', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'StartDate' => [ - 'description' => '生效时间（UTC 时间）', - 'type' => 'string', - 'example' => '2023-02-28T11:40:18Z', - ], - 'EndDate' => [ - 'description' => '失效时间（UTC时间）', - 'type' => 'string', - 'example' => '2099-12-31T16:00:00Z', - ], - 'DocTags' => [ - 'description' => '标签详情列表', - 'type' => 'array', - 'items' => [ - 'description' => '标签详情', - 'type' => 'object', - 'properties' => [ - 'TagId' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1201', - ], - 'TagName' => [ - 'title' => '标签名称', - 'description' => '标签名称', - 'type' => 'string', - 'example' => '小说', - ], - 'GroupId' => [ - 'title' => '标签组ID', - 'description' => '标签组ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3610', - ], - 'GroupName' => [ - 'title' => '标签组名称', - 'description' => '标签组名称', - 'type' => 'string', - 'example' => '文章', - ], - 'DefaultTag' => [ - 'title' => '是否默认全部标签', - 'description' => '是否默认全部标签', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], + 'Meta' => ['title' => '附带信息', 'description' => '附带信息', 'type' => 'string', 'example' => '{}'], + 'Title' => ['title' => '关联问题的标题', 'description' => '关联问题的标题', 'type' => 'string', 'example' => '公积金提取的政策'], ], ], ], + 'SessionId' => ['title' => '本次会话的ID', 'description' => '本次会话的ID', 'type' => 'string', 'example' => '1531ded6b3df4afca4be63943f708bb7'], + 'MessageId' => ['title' => '本条会话应答消息的ID', 'description' => '本条会话应答消息的ID', 'type' => 'string', 'example' => '5ADF0EBD-7C50-1922-A28B-43215B47CC1A'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C20F0D4-9721-178A-8236-3BF990634962\\",\\n \\"Associate\\": [\\n {\\n \\"Meta\\": \\"{}\\",\\n \\"Title\\": \\"公积金提取的政策\\"\\n }\\n ],\\n \\"SessionId\\": \\"1531ded6b3df4afca4be63943f708bb7\\",\\n \\"MessageId\\": \\"5ADF0EBD-7C50-1922-A28B-43215B47CC1A\\"\\n}","type":"json"}]', + 'title' => '会话-联想API', + 'responseParamsDescription' => '### 示例'."\n" + ."\n" + .'#### 响应报文'."\n" + .'```json'."\n" + .'{'."\n" + .' "MessageId":"1eb47d7a1706429081e90c83c62c2f00",'."\n" + .' "SessionId":"93f11165a2a24289a6f869760e8cb3f3",'."\n" + .' "Associate":['."\n" + .' {'."\n" + .' "Meta":"{}",'."\n" + .' "Title": "专业及后勤类岗位职业发展方有哪些？"'."\n" + .' },'."\n" + .' {'."\n" + .' "Meta":"{}",'."\n" + .' "Title": "专业及后勤类岗位职业发展方有哪些？"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Associate'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '搜索文档', + 'ramActions' => [], ], - 'DescribeDoc' => [ - 'summary' => '文档详情。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'BeginSession' => [ + 'summary' => '获取欢迎语接口。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1446,888 +343,168 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebotUKQQ1L'], ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - [ - 'name' => 'KnowledgeId', - 'in' => 'query', - 'schema' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001979424', - ], - ], - [ - 'name' => 'ShowDetail', - 'in' => 'query', - 'schema' => [ - 'title' => '是否展示文档段落详细信息'."\n" - .'true：展示'."\n" - .'false：忽略（默认）', - 'description' => '是否展示文档段落详细信息'."\n" - .'true：展示'."\n" - .'false：忽略（默认）', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => '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' => '7F132693-212A-40A9-8A81-11E7694E478B', - ], - 'KnowledgeId' => [ - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001979424', - ], - 'DocName' => [ - 'description' => '文档名称', - 'type' => 'string', - 'example' => '文档名称', - ], - 'Title' => [ - 'description' => '文档标题', - 'type' => 'string', - 'example' => '测试标题', - ], - 'BizCode' => [ - 'description' => '业务代码', - 'type' => 'string', - 'example' => 'bizcode123', - ], - 'Meta' => [ - 'description' => '文档随路数据', - 'type' => 'string', - 'example' => '{"code":"xxx"}', - ], - 'Config' => [ - 'description' => '文档解析/切分配置的配置项：切分器 KEY：Splitter 值选项：paragraphSplitter-识别层级【默认】 值选项：treeSplitter-规则层级'."\n" - ."\n" - .'配置项：文档切块大小 KEY：ChunkSize VALUE：默认500；范围[200,800]'."\n" - ."\n" - .'配置项：规则层级 KEY：TreePatterns VALUE：默认[]'."\n" - ."\n" - .'配置项：文档标题来源 KEY：TitleSource 值选项：ocrTitle - OCR识别标题【默认】 值选项：docName - 文档名即标题', - 'type' => 'string', - 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}', - ], - 'Url' => [ - 'description' => '文档保存OSS地址', - 'type' => 'string', - 'example' => 'https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf', - ], - 'ModifyTime' => [ - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2020-11-25T08:56:55Z', - ], - 'ModifyUserName' => [ - 'description' => '修改人', - 'type' => 'string', - 'example' => '李四', - ], - 'CreateTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'CreateUserName' => [ - 'description' => '创建人名称', - 'type' => 'string', - 'example' => '张三', - ], - 'CreateUserId' => [ - 'description' => '创建人ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1111111111', - ], - 'ModifyUserId' => [ - 'description' => '修改人ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2222222222', - ], - 'CategoryId' => [ - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000049006', - ], - 'ProcessStatus' => [ - 'description' => '任务处理状态'."\n" - .'-1 排队中'."\n" - .'0 成功'."\n" - .'1 解析中'."\n" - .'2 处理中'."\n" - .'3 处理失败', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProcessMessage' => [ - 'description' => '任务处理信息', - 'type' => 'string', - 'example' => '任务处理成功', - ], - 'ProcessCanRetry' => [ - 'description' => '任务是否可重试'."\n" - .'true：可重试'."\n" - .'false：不可重试', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => '编辑状态：'."\n" - .'1 未发布'."\n" - .'2 已发布'."\n" - .'3 已更新未发布', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EffectStatus' => [ - 'description' => '生效状态'."\n" - .'根据StartDate, EndDate计算出来'."\n" - .'20 生效中'."\n" - .'21 已失效'."\n" - .'22 待生效', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'StartDate' => [ - 'description' => '生效时间（UTC 时间）', - 'type' => 'string', - 'example' => '1979-12-31T16:00:00Z', - ], - 'EndDate' => [ - 'description' => '失效时间（UTC 时间）', - 'type' => 'string', - 'example' => '2023-04-27T06:08:54Z', - ], - 'DocInfo' => [ - 'description' => '文档详情', - 'type' => 'object', - 'properties' => [ - 'DocParas' => [ - 'description' => '文档段落信息', - 'type' => 'array', - 'items' => [ - 'description' => '段落对象', - 'type' => 'object', - 'properties' => [ - 'ParaNo' => [ - 'description' => '段落序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ParaLevel' => [ - 'description' => '段落层级', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ParaType' => [ - 'description' => '段落内容类型'."\n" - .'text-文本'."\n" - .'figure-图片'."\n" - .'table-表格', - 'type' => 'string', - 'example' => 'text', - ], - 'ParaText' => [ - 'description' => '段落内容【纯文本/图片OCR内容/表格的Markdown表示】', - 'type' => 'string', - 'example' => '内容', - ], - ], - ], - ], - ], - ], - 'DocTags' => [ - 'description' => '标签详情列表', - 'type' => 'array', - 'items' => [ - 'description' => '标签详情', - 'type' => 'object', - 'properties' => [ - 'TagId' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1201', - ], - 'TagName' => [ - 'title' => '标签名称', - 'description' => '标签名称', - 'type' => 'string', - 'example' => '小说', - ], - 'GroupId' => [ - 'title' => '标签分组ID', - 'description' => '标签分组ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3610', - ], - 'GroupName' => [ - 'title' => '标签分组名称', - 'description' => '标签分组名称', - 'type' => 'string', - 'example' => '文章', - ], - 'DefaultTag' => [ - 'title' => '是否默认为全部标签', - 'description' => '是否默认为全部标签', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'DocMetadata' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BusinessViewId' => [ - 'type' => 'string', - ], - 'BusinessViewName' => [ - 'title' => '标签名称', - 'description' => '标签名称', - 'type' => 'string', - ], - 'MetaCellInfoDTOList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FieldCode' => [ - 'type' => 'string', - ], - 'FieldName' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '文档详情', - ], - 'CreateCategory' => [ - 'summary' => '新建类目。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '类目名称', - 'description' => '类目名称', - 'type' => 'string', - 'required' => true, - 'example' => '测试1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ - 'name' => 'BizCode', + 'name' => 'SandBox', 'in' => 'formData', - 'schema' => [ - 'title' => '业务代码', - 'description' => '业务代码', - 'type' => 'string', - 'required' => false, - 'example' => 'bizcode123', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''], ], [ - 'name' => 'KnowledgeType', + 'name' => 'VendorParam', 'in' => 'formData', - 'schema' => [ - 'title' => '知识类型，FAQ类目：1，文档类目：3', - 'description' => '知识类型，FAQ类目：1，文档类目：3，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ - 'name' => 'ParentCategoryId', + 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '父类目ID，默认-1，对应根目录', - 'description' => '父类目ID，默认-1，对应根目录', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '-1', - ], - ], - [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A629A28F-F25E-5572-A679-FA46FB0151D6', - ], - 'Category' => [ - 'title' => '类目信息', - 'description' => '类目信息', - 'type' => 'object', - 'properties' => [ - 'CategoryId' => [ - 'title' => '类目ID', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000049006', - ], - 'BizCode' => [ - 'description' => '业务代码', - 'type' => 'string', - 'example' => 'bizcode123', - ], - 'Name' => [ - 'description' => '类目名称', - 'type' => 'string', - 'example' => '类目名称', - ], - 'ParentCategoryId' => [ - 'description' => '父类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'Status' => [ - 'description' => '类目状态，-1：已删除未发布状态，0：正常', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID', 'type' => 'string', 'example' => '149C7528-C104-1B50-A4F9-0C5907A8AD9D'], + 'WelcomeMessage' => ['title' => '欢迎语', 'description' => '欢迎语', 'type' => 'string', 'example' => '智能对话机器人为您服务，请问有什么可以帮您？'], + 'SilenceReplyTimeout' => ['description' => '静默超时时间，单位：秒', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Interruptible' => ['description' => '语音播报是否可打断', 'type' => 'boolean', 'example' => 'false'], + 'AsrMaxEndSilence' => ['description' => 'ASR尾点检测时间，单位：毫秒', 'type' => 'integer', 'format' => 'int32', 'example' => '700'], ], ], ], ], - 'responseDemo' => '', - 'title' => '类目-新建', - ], - 'DeleteCategory' => [ - 'summary' => '删除类目， 已发布的类目变成已删除未发布状态，未发布的类目则直接删除。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'CategoryId', - 'in' => 'formData', - 'schema' => [ - 'title' => '类目ID', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30000049006', - ], - ], - [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"149C7528-C104-1B50-A4F9-0C5907A8AD9D\\",\\n \\"WelcomeMessage\\": \\"智能对话机器人为您服务，请问有什么可以帮您？\\",\\n \\"SilenceReplyTimeout\\": 5,\\n \\"Interruptible\\": false,\\n \\"AsrMaxEndSilence\\": 700\\n}","type":"json"}]', + 'title' => '获取欢迎语', + 'changeSet' => [ + ['createdAt' => '2025-10-16T13:12:58.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-12-28T09:28:13.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-04-18T12:39:08.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'result', - 'description' => '返回值', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55', - ], - ], - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BeginSession'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '类目-删除', + 'ramActions' => [], ], - 'UpdateCategory' => [ - 'summary' => '编辑类目。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CancelChat' => [ + 'summary' => '取消或打断对应对话。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254397', + 'abilityTreeNodes' => ['FEATUREbeebotUKQQ1L'], + ], 'parameters' => [ [ - 'name' => 'CategoryId', + 'name' => 'AgentKey', 'in' => 'formData', - 'schema' => [ - 'title' => '类目ID', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '231001028593', - ], + 'schema' => ['description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'BizCode', + 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '业务代码', - 'description' => '业务代码', - 'type' => 'string', - 'required' => false, - 'example' => 'bizcode123', - ], + 'schema' => ['description' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。长度限制是64个字符', 'type' => 'string', 'required' => false, 'example' => 'c1187530338311ebade7cf3eaeb3668a'], ], [ - 'name' => 'Name', + 'name' => 'ChatId', 'in' => 'formData', - 'schema' => [ - 'title' => '类目名称', - 'description' => '类目名称', - 'type' => 'string', - 'required' => true, - 'example' => '类目名称', - ], + 'schema' => ['description' => '标识单次对话的id', 'type' => 'string', 'required' => false, 'example' => '7105a351-b2e7-4c9e-8437-c43a043c0a4e'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'result', - 'description' => '返回值', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F79E7305-5314-5069-A701-9591AD051902', - ], - ], - ], - ], - ], - 'responseDemo' => '', - 'title' => '类目-更新', - ], - 'DescribeCategory' => [ - 'summary' => '查看单个类目信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'CategoryId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '类目ID', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30000049006', - ], - ], - [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'result', - 'description' => '返回值', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '2B0304FD-3804-5C06-9A83-77F5523664AF', - ], - 'Category' => [ - 'title' => '类目信息', - 'description' => '类目信息', - 'type' => 'object', - 'properties' => [ - 'CategoryId' => [ - 'title' => '类目ID', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000049006', - ], - 'Name' => [ - 'description' => '类⽬名称', - 'type' => 'string', - 'example' => '类目名称', - ], - 'ParentCategoryId' => [ - 'description' => '⽗类⽬id，默认-1，对应根⽬录', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'Status' => [ - 'description' => '类目状态 -1：已删除未发布状态，0：正常', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BizCode' => [ - 'description' => '业务代码', - 'type' => 'string', - 'example' => 'bizcode123', - ], - ], - ], - ], - ], + 'schema' => ['description' => '机器人ID', 'type' => 'string', 'required' => false, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], - ], - 'responseDemo' => '', - 'title' => '类目-详情', - ], - 'ListCategory' => [ - 'summary' => '获取类目列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'KnowledgeType', + 'name' => 'Type', 'in' => 'formData', - 'schema' => [ - 'title' => '知识类型,FAQ类目:1,文档类目:3', - 'description' => '知识类型,FAQ类目:1,文档类目:3,默认1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '打断类型', 'type' => 'string', 'required' => false, 'example' => 'Canceled'], ], [ - 'name' => 'ParentCategoryId', + 'name' => 'Answer', 'in' => 'formData', - 'schema' => [ - 'title' => '父类目ID', - 'description' => '父类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '-1', - ], - ], - [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['description' => '答案正文', 'type' => 'string', 'required' => false, 'example' => '<这个答案被打>'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'Categories' => [ - 'title' => 'list结果', - 'description' => '类目list结果', - 'type' => 'array', - 'items' => [ - 'description' => '类目信息', - 'type' => 'object', - 'properties' => [ - 'CategoryId' => [ - 'title' => '类目ID', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '231001028593', - ], - 'BizCode' => [ - 'description' => '业务代码', - 'type' => 'string', - 'example' => 'bizcode123', - ], - 'Name' => [ - 'description' => '类⽬名称', - 'type' => 'string', - 'example' => '类目名称', - ], - 'ParentCategoryId' => [ - 'description' => '⽗类⽬ID'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'Status' => [ - 'description' => '类目状态，-1：已删除未发布状态，0：正常', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9C5F8186-2D22-433E-9545-606D344F30B5', - ], + 'RequestId' => ['description' => '请求本接口的请求ID', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1'], + 'CancelResult' => ['description' => '调用本接口的结果', 'type' => 'boolean'], ], + 'description' => '', ], ], ], - 'responseDemo' => '', - 'title' => '获取类目列表', - ], - 'TongyiChatDebugInfo' => [ - 'summary' => '大模型问答调试信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3E5C779-A630-45AC-B0F2-A4506A4212F1\\",\\n \\"CancelResult\\": true\\n}","type":"json"}]', + 'title' => '取消或打断给定对话', + 'description' => '仅支持新版机器人，只能查询到90天内的数据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CancelInstancePublishTask' => [ + 'summary' => '在发布机器人的过程中，取消机器人发布任务。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '264606', - 'abilityTreeNodes' => [ - 'FEATUREbeebotUKQQ1L', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '需要提供有效期内的MessageId', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => 'chatbot-cn-7QuUfaqMQe', - ], + 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521'], ], [ - 'name' => 'MessageId', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '本条会话应答消息的ID', - 'type' => 'string', - 'required' => true, - 'example' => '396E74B3-D84B-46CE-9E51-91C06AD22E31', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -2337,411 +514,84 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', - ], - 'MessageId' => [ - 'description' => '本条会话应答消息的ID', + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D'], + 'Id' => ['title' => '任务Id', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8522'], + 'Response' => ['title' => '任务Id', 'description' => '任务ID', 'type' => 'string', 'example' => '8522'], + 'Status' => [ + 'title' => '任务状态', + 'description' => '任务状态', 'type' => 'string', - 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661', + 'enumValueTitles' => ['FE_SUCCESS' => '发布成功', 'FE_ABORTED' => '发布取消', 'FE_FAILED' => '发布失败', 'FE_RUNNING' => '正在发布中'], + 'example' => 'FE_ABORTED', + 'enum' => ['FE_RUNNING：正在发布中', 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], ], - 'Pipeline' => [ - 'description' => '整个问答流程的信息', + 'BizTypeList' => [ + 'title' => '业务类型列表', + 'description' => '业务类型列表', 'type' => 'array', - 'items' => [ - 'description' => '整个问答流程的信息', - 'type' => 'object', - 'properties' => [ - 'NodeType' => [ - 'description' => '节点类型，返回值：'."\n" - .'* **system_strategy**：系统策略。'."\n" - .'* **rewrite_query**：检索问句。'."\n" - .'* **invoke_llm**：LLM调用。'."\n" - .'* **invoke_tools**：工具调用。', - 'type' => 'string', - 'example' => 'system_strategy', - ], - 'Name' => [ - 'description' => '策略名称：'."\n" - .'- 高频问答直出'."\n" - .'- 关键词转人工'."\n" - .'- 全局敏感词'."\n" - ."\n" - .'当NodeType为system_strategy时，才会有本字段', - 'type' => 'string', - 'example' => '关键词转人工', - ], - 'Input' => [ - 'description' => '调试输入信息', - 'type' => 'any', - 'example' => '用户问句：转人工\\n命中规则：[转]人工[客服|服务|坐席]', - ], - 'Output' => [ - 'description' => '输出信息', - 'type' => 'any', - 'example' => 'commands:{\\"sysToAgent\\":\\"{\\\\\\"skillGroup\\\\\\":\\\\\\"\\\\\\",\\\\\\"ext\\\\\\":\\\\\\"\\\\\\",\\\\\\"toAgentReason\\\\\\":\\\\\\"HitKeywords\\\\\\"}\\"}\\nresponse:正在为您转接人工客服', - ], - ], - ], + 'items' => ['description' => '业务列表', 'type' => 'string', 'example' => 'robot'], ], + 'Error' => ['title' => 'job失败信息', 'description' => 'job失败信息', 'type' => 'string', 'example' => '检查待发布模块是否空闲发生错误，faq'], + 'CreateTime' => ['title' => '任务创建的 UTC 时间', 'description' => '任务创建的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'ModifyTime' => ['title' => '任务修改的 UTC 时间', 'description' => '任务修改的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => true, - 'eventNames' => [], - ], - 'responseDemo' => '', - 'title' => '大模型问答调试信息', - 'description' => '仅支持新版机器人，只能查询到90天内的数据', - 'extraInfo' => '### 转人工'."\n" - .'```json'."\n" - .'{'."\n" - .' "RequestId": "D267AB94-2438-1A39-899A-2730BBF808BC",'."\n" - .' "MessageId": "8acb8120-9522-461c-babd-509f2f6814ec",'."\n" - .' "Pipeline": ['."\n" - .' {'."\n" - .' "Input": "用户问句：转人工\\n命中规则：[转]人工[客服|服务|坐席]",'."\n" - .' "NodeType": "system_strategy",'."\n" - .' "Output": "commands:{\\"sysToAgent\\":\\"{\\\\\\"skillGroup\\\\\\":\\\\\\"\\\\\\",\\\\\\"ext\\\\\\":\\\\\\"\\\\\\",\\\\\\"toAgentReason\\\\\\":\\\\\\"HitKeywords\\\\\\"}\\"}\\nresponse:正在为您转接人工客服",'."\n" - .' "Name": "关键词转人工"'."\n" - .' }'."\n" - .' ]'."\n" - .'}'."\n" - .'```'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_ABORTED\\",\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\"\\n}","type":"json"}]', + 'title' => '取消机器人发布', + 'responseParamsDescription' => '### 示例'."\n" + .'#### 响应报文：'."\n" ."\n" - .'### 敏感词'."\n" .'```json'."\n" .'{'."\n" - .' "RequestId": "C1BB266B-A526-1CE1-9DD0-5A008E30B061",'."\n" - .' "MessageId": "b716ba46-d69a-4a07-8883-a3ac9709f446",'."\n" - .' "Pipeline": ['."\n" - .' {'."\n" - .' "Input": "用户问句：你是于鹏飞吗\\n命中规则：于鹏飞",'."\n" - .' "NodeType": "system_strategy",'."\n" - .' "Output": "您说的这个问题我不能回答您，您可以尝试询问其他问题",'."\n" - .' "Name": "全局敏感词"'."\n" - .' }'."\n" - .' ]'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'### 高频问答直出'."\n" - .'```json'."\n" - .'{'."\n" - .' "RequestId": "3708D217-AE5A-139B-A669-150CA359A1D3",'."\n" - .' "MessageId": "77f8ebe3-4134-44be-ae2b-a78eb1206bf5",'."\n" - .' "Pipeline": ['."\n" - .' {'."\n" - .' "Input": "流式会话接口何时触发无答案呀？",'."\n" - .' "NodeType": "invoke_tools",'."\n" - .' "Output": ['."\n" - .' {'."\n" - .' "ToolName": "知识库检索",'."\n" - .' "ToolResult": ['."\n" - .' {'."\n" - .' "Score": "1.0000",'."\n" - .' "Content": "流式会话接口何时触发无答案？",'."\n" - .' "BizKnowType": "FAQ",'."\n" - .' "Name": "流式会话接口何时触发无答案？"'."\n" - .' },'."\n" - .' {'."\n" - .' "Score": "0.5634",'."\n" - .' "Content": "调用流式会话接口不通",'."\n" - .' "BizKnowType": "FAQ",'."\n" - .' "Name": "调用流式会话接口返回HTML内容"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" + .' "ModifyTime": "2022-04-14T03:43:55Z",'."\n" + .' "BizTypeList": ['."\n" + .' "robot"'."\n" + .' ],'."\n" + .' "CreateTime": "2022-04-14T03:43:54Z",'."\n" + .' "RequestId": "c2f542c6-f0e3-464c-9aaf-ad6f6eab8140",'."\n" + .' "Response": "5088",'."\n" + .' "Warnings": {'."\n" + .' "category_bind_chitchat": ['."\n" + .' "以下类目没有发布到正式环境:第一个闲聊包"'."\n" .' ]'."\n" - .' },'."\n" - .' {'."\n" - .' "Input": "高频问答标题：流式会话接口何时触发无答案？\\n置信度：1.0",'."\n" - .' "NodeType": "system_strategy",'."\n" - .' "Output": "<div id=\\"se-knowledge\\"><p><img width=\\"1107\\" height=\\"336\\" src=\\"https://beebot-knowledgecloud-aliyun-public-cn-shanghai.oss-cn-shanghai.aliyuncs.com/kc/1242280/kc-media/kc-faq-oss/1731921908997-image.png\\" slate-data-type=\\"image\\">机器人高级设置里有通识开关，关掉通识的话，会透出无答案，不关掉的话，会有模型兜底回复。</p><link rel=\\"stylesheet\\" href=\\"https://g.alicdn.com/isipfe/docs/rich.css?\\"></div>",'."\n" - .' "Name": "高频问答直出"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'```'."\n" - ."\n" - .'### 正常模型调用'."\n" - .'```json'."\n" - .'{'."\n" - .' "RequestId": "EF047782-B031-1F5F-9E4B-A8C9AD242BC0",'."\n" - .' "MessageId": "f194bd8c-7f11-4fbd-833a-ebc7db08c462",'."\n" - .' "Pipeline": ['."\n" - .' {'."\n" - .' "Input": "错误码有哪些？",'."\n" - .' "NodeType": "rewrite_query",'."\n" - .' "Output": "错误码有哪些？"'."\n" - .' },'."\n" - .' {'."\n" - .' "Input": "错误码有哪些？",'."\n" - .' "NodeType": "invoke_tools",'."\n" - .' "Output": ['."\n" - .' {'."\n" - .' "ToolName": "知识库检索",'."\n" - .' "ToolResult": ['."\n" - .' {'."\n" - .' "Score": "0.6119",'."\n" - .' "Content": "[110202]\\"【文档名】公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心\\n【标题】公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心\\n【正文】联系我们：4008013260\\n[法律声明](link-32472483000.png)[Cookies政策](link-32472483001.png)[廉正举报](link-32472483002.png)[安全举报](link-32472483003.png)[联系我们](link-32472483004.png)[加入我们](link-32472483005.png)\\n### 友情链接\\n[阿里巴巴集团](link-32472483006.png)[淘宝网](link-32472483007.png)[天猫](link-32472483008.png)[全球速卖通](link-32472483009.png)[阿里巴巴国际交易市场](link-32472483010.png)[1688](link-32472483011.png)[阿里妈妈](link-32472483012.png)[飞猪](link-32472483013.png)[阿里云计算](link-32472483014.png)[AliOS](link-32472483015.png)[万网](link-32472483016.png)[高德](link-32472483017.png)[UC](link-32472483018.png)[友盟](link-32472483019.png)[优酷](link-32472483020.png)[钉钉](link-32472483021.png)[支付宝](link-32472483022.png)[达摩院](link-32472483023.png)[淘宝海外](link-32472483024.png)[阿里云盘](link-32472483025.png)[饿了么](link-32472483026.png)\\n© 2009-2025 Aliyun.com 版权所有 增值电信业务经营许可证： [浙B2-20080101](link-32472483027.png) 域名注册服务机构许可： [浙D3-20210002](link-32472483028.png)\\n[](link-32472483030.png)[浙公网安备 33010602009975号](link-32472483032.png)[浙B2-20080101-4](link-32472483033.png)\\"",'."\n" - .' "BizKnowType": "WEBSITE",'."\n" - .' "Name": "公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心"'."\n" - .' },'."\n" - .' {'."\n" - .' "Score": "0.5960",'."\n" - .' "Content": "[110203]\\"【文档名】公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心\\n【标题】公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心\\n【正文】| 403 | InstanceFreezing | The specified instance has been frozen because it has overdue bills. | 当前智能对话机器人版本已产生欠费，导致实例冻结 | [诊断](link-32472482000.png){#error-code-table-4-0-diagnosis-link} |\\n| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 系统内部错误 | [诊断](link-32472482001.png){#error-code-table-4-1-diagnosis-link} |\\n| 400 | InvalidParameter | The specified parameter %s is not valid. | 请求API的参数不合法 | [诊断](link-32472482002.png){#error-code-table-4-2-diagnosis-link} |\\n| 403 | Forbidden | User not authorized to operate on the specified resource. | 该用户未被授权可操作指定资源 | [诊断](link-32472482003.png){#error-code-table-4-3-diagnosis-link} |\\n{#error-code-3}\\n[上一篇：GetBotSessionData - 机器人接待概况](link-32472482004.png)[下一篇：版本说明](link-32472482005.png)\\n该文章对您有帮助吗？\\n反馈\\n### 为什么选择阿里云\\n[什么是云计算](link-32472482006.png)[全球基础设施](link-32472482007.png)[技术领先](link-32472482008.png)[稳定可靠](link-32472482009.png)[安全合规](link-32472482010.png)[分析师报告](link-32472482011.png)\\n### 产品和定价\\n[全部产品](link-32472482012.png)[免费试用](link-32472482013.png)[产品动态](link-32472482014.png)[产品定价](link-32472482015.png)[价格计算器](link-32472482016.png)[云上成本管理](link-32472482017.png)\\n### 解决方案\\n[技术解决方案](link-32472482018.png)\\n### 文档与社区\\n[文档](link-32472482019.png)[开发者社区](link-32472482020.png)[天池大赛](link-32472482021.png)[培训与认证](link-32472482022.png)\\n### 权益中心\\n[免费试用](link-32472482023.png)[高校计划](link-32472482024.png)[企业扶持计划](link-32472482025.png)[推荐返现计划](link-32472482026.png)\\n### 支持与服务\\n[基础服务](link-32472482027.png)[企业增值服务](link-32472482028.png)[迁云服务](link-32472482029.png)[官网公告](link-32472482030.png)[健康看板](link-32472482031.png)[信任中心](link-32472482032.png)\\n### 关注阿里云\\n关注阿里云公众号或下载阿里云APP，关注云资讯，随时随地运维管控云服务\\n\\"",'."\n" - .' "BizKnowType": "WEBSITE",'."\n" - .' "Name": "公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" .' },'."\n" - .' {'."\n" - .' "Input": ['."\n" - .' {'."\n" - .' "Role": "system",'."\n" - .' "Content": "# Environment variables utilization\\n\\n下面是在当前对话中你已知的环境变量信息，包括：当前日期、时间、地点以及其他随路参数：\\n\\n- system_time: 2025-02-27 16:59:10\\n- day_of_week: 星期四\\n- location: \\n- 随路参数取值为: {}\\n\\n可以在必要时候使用上面这些信息"'."\n" - .' }'."\n" - .' ],'."\n" - .' "NodeType": "invoke_llm",'."\n" - .' "Output": "thought:<ref>doc<params>{}\\nresponse: 根据文档显示，主要的错误码及其含义如下：\\n\\n1. 常见错误码：\\n- InvalidInstanceId.NotFound (404): 指定的机器人ID不存在\\n- InvalidParameter (400): 参数不合法\\n- InternalError (500): 内部错误 [110201]\\n\\n2. 公共错误码：\\n- InstanceFreezing (403): 当前智能对话机器人版本已产生欠费，导致实例冻结\\n- InternalError (500): 系统内部错误\\n- InvalidParameter (400): 请求API的参数不合法\\n- Forbidden (403): 该用户未被授权可操作指定资源 [110202, 110203]\\n\\n3. 限流错误：\\n当并发超过版本并发时，会触发限流，错误码为\\"csQueueBusy\\"，提示\\"服务繁忙，请等待\\" [110201]\\n\\n更多错误码信息可以访问[错误中心](link-32471693000.png)查看 [110204]"'."\n" - .' }'."\n" - .' ]'."\n" + .' "Id": 5088,'."\n" + .' "Status": "FE_ABORTED"'."\n" .'}'."\n" - .'```'."\n" - ."\n\n" ."\n" - .'### 插件调用'."\n" - .'```json'."\n" - .'{'."\n" - .' "RequestId": "D7C96E0A-8F1F-15FC-8B53-6BB10BF8AA50",'."\n" - .' "MessageId": "6f2082d7-e32c-4823-90fe-8b0b97b71ae9",'."\n" - .' "Pipeline": ['."\n" - .' {'."\n" - .' "Input": "上海",'."\n" - .' "NodeType": "rewrite_query",'."\n" - .' "Output": "上海天气查询"'."\n" - .' },'."\n" - .' {'."\n" - .' "Input": "上海天气查询",'."\n" - .' "NodeType": "invoke_tools",'."\n" - .' "Output": ['."\n" - .' {'."\n" - .' "ToolName": "知识库检索",'."\n" - .' "ToolResult": ['."\n" - .' {'."\n" - .' "Score": "1.0000",'."\n" - .' "Content": "查天气1119的处理流程：\\nflowchart TD\\nAB000(开始)--查天气-->AB001>根据API: getWeather的定义询问参数并调用]\\nAB001--API getWeather的输出参数weather不为空-->AB002[严格回复：固定回复]\\n\\nAPI: getWeather\\n描述: 查询天气，支持全国地级市天气信息查询，如：北京、上海、杭州、重庆等。\\n输入参数: {\\"type\\":\\"object\\",\\"properties\\":{\\"date\\":{\\"type\\":\\"string\\",\\"description\\":\\"时间\\"},\\"city\\":{\\"type\\":\\"string\\",\\"description\\":\\"城市名称，如北京、上海、杭州、重庆等。参数值请参考以下值：上海\\"}},\\"required\\":[\\"city\\"]}\\n输出结果: {\\"type\\":\\"object\\",\\"properties\\":{\\"weather\\":{\\"type\\":\\"string\\",\\"description\\":\\"具体的天气信息\\"}}}",'."\n" - .' "BizKnowType": "FLOW",'."\n" - .' "Name": "查天气1119"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' {'."\n" - .' "Input": "{\\"city\\":\\"上海\\"}",'."\n" - .' "NodeType": "invoke_tools",'."\n" - .' "Output": ['."\n" - .' {'."\n" - .' "ToolName": "getWeather",'."\n" - .' "ToolResult": "上海市雾，气温 14 摄氏度，东北风 ≤3 级"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .'}'."\n" .'```', - ], - 'ApplyForStreamAccessToken' => [ - 'summary' => '获取流式调用的连接信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - ], - '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' => '736994BD-AA35-4742-88C9-E64BE4BAA14B', - ], - 'AccessToken' => [ - 'description' => '服务的请求Token。', - 'type' => 'string', - 'example' => '63ba97b4f18a4a04f715c81e8e643938', - ], - 'ChannelId' => [ - 'description' => '通道ID', - 'type' => 'string', - 'example' => 'cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d', - ], - 'StreamSecret' => [ - 'description' => '业务空间的密钥，流式请求加签使用', - 'type' => 'string', - 'example' => 'cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d', - ], - ], - ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelInstancePublishTask'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '获取流式调用的连接信息', + 'ramActions' => [], ], - 'Feedback' => [ - 'summary' => '保存用户对于问答结果的评价。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CancelPublishTask' => [ + 'summary' => '取消正在发布中的任务。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'MessageId', - 'in' => 'query', - 'schema' => [ - 'title' => '会话窗单次会话标识', - 'description' => '会话窗单次会话标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '5ca40988-4f99-47ad-ac96-9060d0f81db9', - ], - ], - [ - 'name' => 'Feedback', - 'in' => 'query', - 'schema' => [ - 'title' => 'good-点赞、bad-点踩', - 'description' => '点赞或点踩，对应会话历史API中的FeedbackType'."\n" - ."\n" - .'枚举值：'."\n" - .'good（点赞）'."\n" - .'bad（点踩）', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'bad' => 'bad', - 'good' => 'good', - ], - 'example' => 'good', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '会话Session标识，标识：IM唯一标识会话', - 'description' => '会话Session标识，标识：IM唯一标识会话', - 'type' => 'string', - 'required' => false, - 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', - ], - ], - [ - 'name' => 'FeedbackContent', - 'in' => 'query', - 'schema' => [ - 'title' => '点赞、点踩的内容', - 'description' => '点赞、点踩的内容，可以直接输入反馈的内容；也可以传入示例中的jsonString，content字段对应会话历史中的FeedbackUserInfo，feedbackLabels对应会话历史中的FeedbackLabels。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "content": "我觉得这个答案不对，需要依据事实回答。",'."\n" - .' "feedbackLabels": ['."\n" - .' "存在事实性错误"'."\n" - .' ]'."\n" - .'}', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'schema' => ['title' => '发布任务Id', 'description' => '发布任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -2751,45 +601,52 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求Id', - 'type' => 'string', - 'example' => '4e5eea71-f326-450c-8849-49515473ef64', - ], - 'Feedback' => [ - 'title' => 'good-点赞、bad-点踩', - 'description' => '点赞或点踩'."\n" - ."\n" + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D'], + 'Id' => ['title' => '发布任务Id', 'description' => '发布任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8522'], + 'Response' => ['title' => '发布任务Id，冗余字段，建议使用Id字段获取发布任务Id', 'description' => '发布任务ID，冗余字段，建议使用发布任务ID', 'type' => 'string', 'example' => '8522'], + 'Status' => [ + 'title' => '任务状态（ FE_RUNNING：正在发布中 FE_SUCCESS：发布成功 FE_FAILED：发布失败 FE_ABORTED：发布取消）', + 'description' => '任务状态'."\n" .'枚举值：'."\n" - .'good（点赞）'."\n" - .'bad（点踩）', + ."\n" + .'FE_RUNNING：正在发布中'."\n" + .'FE_SUCCESS：发布成功'."\n" + .'FE_FAILED：发布失败'."\n" + .'FE_ABORTED：发布取消', 'type' => 'string', - 'example' => 'good', + 'example' => 'FE_ABORTED', + 'enum' => ['FE_RUNNING：正在发布中', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], ], - 'MessageId' => [ - 'title' => '会话窗单次会话标识', - 'description' => '会话窗单次会话标识', - 'type' => 'string', - 'example' => '5ca40988-4f99-47ad-ac96-9060d0f81db9', + 'BizTypeList' => [ + 'title' => '业务类型列表', + 'description' => '业务类型列表', + 'type' => 'array', + 'items' => ['description' => '业务类型', 'type' => 'string', 'example' => 'faq'], ], + 'Error' => ['title' => '发布任务失败信息', 'description' => '任务失败信息', 'type' => 'string', 'example' => '检查待发布模块是否空闲发生错误，faq'], + 'CreateTime' => ['title' => '任务创建的 UTC 时间', 'description' => '任务创建的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'ModifyTime' => ['title' => '任务修改的 UTC 时间', 'description' => '任务修改的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z'], ], ], ], ], - 'responseDemo' => '', - 'title' => '问答点赞、点踩', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_ABORTED\\",\\n \\"BizTypeList\\": [\\n \\"faq\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\"\\n}","type":"json"}]', + 'title' => '取消发布任务', + 'changeSet' => [ + ['createdAt' => '2022-12-26T11:37:56.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelPublishTask'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], ], 'Chat' => [ 'summary' => '根据机器人唯一标识（机器人ID）与其进行会话，仅适用于智能对话机器人（旧版）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2797,88 +654,42 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人实例ID。登录云小蜜控制台，机器人详情->会话接口，查看机器人实例信息，可获得该实例ID。', - 'description' => '机器人唯一标识（机器人ID）。登录云小蜜控制台，机器人详情->会话接口，查看机器人实例信息，可获得该实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'schema' => ['title' => '机器人实例ID。登录云小蜜控制台，机器人详情->会话接口，查看机器人实例信息，可获得该实例ID。', 'description' => '机器人唯一标识（机器人ID）。登录云小蜜控制台，机器人详情->会话接口，查看机器人实例信息，可获得该实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ 'name' => 'Utterance', 'in' => 'query', - 'schema' => [ - 'title' => '机器人访问者的输入', - 'description' => '机器人访问者的输入', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '今天天气怎么样？', - ], + 'schema' => ['title' => '机器人访问者的输入', 'description' => '机器人访问者的输入', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '今天天气怎么样？'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'title' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。长度限制是64个字符', - 'description' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。长度限制是64个字符', - 'type' => 'string', - 'required' => false, - 'example' => '9c6ebdc6e66f46ecadab3434314f6959', - ], + 'schema' => ['title' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。长度限制是64个字符', 'description' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。长度限制是64个字符', 'type' => 'string', 'required' => false, 'example' => '9c6ebdc6e66f46ecadab3434314f6959'], ], [ 'name' => 'KnowledgeId', 'in' => 'query', - 'schema' => [ - 'title' => '知识库中知识标题的ID。若指定此ID，那么机器人会直接返回指定知识标题的答案', - 'description' => '知识库中知识标题的ID。若指定此ID，那么机器人会直接返回指定知识标题的答案', - 'type' => 'string', - 'required' => false, - 'example' => '30002406051', - ], + 'schema' => ['title' => '知识库中知识标题的ID。若指定此ID，那么机器人会直接返回指定知识标题的答案', 'description' => '知识库中知识标题的ID。若指定此ID，那么机器人会直接返回指定知识标题的答案', 'type' => 'string', 'required' => false, 'example' => '30002406051'], ], [ 'name' => 'SenderId', 'in' => 'query', - 'schema' => [ - 'title' => '访问者ID。用于识别当前会话中的用户', - 'description' => '访问者ID。用于识别当前会话中的用户', - 'type' => 'string', - 'required' => false, - 'example' => 'custumer_123456', - ], + 'schema' => ['title' => '访问者ID。用于识别当前会话中的用户', 'description' => '访问者ID。用于识别当前会话中的用户', 'type' => 'string', 'required' => false, 'example' => 'custumer_123456'], ], [ 'name' => 'SenderNick', 'in' => 'query', - 'schema' => [ - 'title' => '当前会话中访问的昵称', - 'description' => '当前会话中访问的昵称', - 'type' => 'string', - 'required' => false, - 'example' => '用户123456', - ], + 'schema' => ['title' => '当前会话中访问的昵称', 'description' => '当前会话中访问的昵称', 'type' => 'string', 'required' => false, 'example' => '用户123456'], ], [ 'name' => 'IntentName', 'in' => 'query', - 'schema' => [ - 'title' => '对话流中意图名称。 若指定此名称，机器人会直接进入此意图做问答', - 'description' => '对话流中意图名称。 若指定此名称，机器人会直接进入此意图做问答', - 'type' => 'string', - 'required' => false, - 'example' => '查天气意图', - ], + 'schema' => ['title' => '对话流中意图名称。 若指定此名称，机器人会直接进入此意图做问答', 'description' => '对话流中意图名称。 若指定此名称，机器人会直接进入此意图做问答', 'type' => 'string', 'required' => false, 'example' => '查天气意图'], ], [ 'name' => 'Perspective', @@ -2888,12 +699,7 @@ 'title' => '视角编码，用于调用同一知识标题下不同视角的答案。如：Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准', 'description' => '视角编码数组，用于调用同一知识标题下不同视角的答案。如：Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准', 'type' => 'array', - 'items' => [ - 'description' => '视角编码', - 'type' => 'string', - 'required' => false, - 'example' => 'FZJBY3raWr', - ], + 'items' => ['description' => '视角编码', 'type' => 'string', 'required' => false, 'example' => 'FZJBY3raWr'], 'required' => false, 'maxItems' => 20, ], @@ -2901,35 +707,19 @@ [ 'name' => 'VendorParam', 'in' => 'query', - 'schema' => [ - 'description' => '是一个JSON格式的用户自定义参数集，可以传入用户自定义的参数到各对话引擎', - 'type' => 'string', - 'required' => false, - 'example' => '{"phone":123456789}', - ], + 'schema' => ['description' => '是一个JSON格式的用户自定义参数集，可以传入用户自定义的参数到各对话引擎', 'type' => 'string', 'required' => false, 'example' => '{"phone":123456789}'], ], [ 'name' => 'SandBox', 'in' => 'query', - 'schema' => [ - 'description' => '测试、正式环境标识，默认为正式环境。'."\n" - .'- true：测试环境，仅限测试使用，生产使用有不稳定、QPS限制等风险。'."\n" - .'- false：正式环境', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '测试、正式环境标识，默认为正式环境。'."\n" + .'- true：测试环境，仅限测试使用，生产使用有不稳定、QPS限制等风险。'."\n" + .'- false：正式环境', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -2942,15 +732,11 @@ 'title' => 'query的分词结果，可能为空', 'description' => 'query的分词结果，可能为空', 'type' => 'array', - 'items' => [ - 'description' => '问题的分词数组，如'."\n" - .'['."\n" - .' "查",'."\n" - .' "天气"'."\n" - .' ]', - 'type' => 'string', - 'example' => '天气', - ], + 'items' => ['description' => '问题的分词数组，如'."\n" + .'['."\n" + .' "查",'."\n" + .' "天气"'."\n" + .' ]', 'type' => 'string', 'example' => '天气'], ], 'Messages' => [ 'title' => '消息的列表', @@ -2965,18 +751,8 @@ 'description' => '当AnswerType为Knowledge时，此字段包含机器人返回的Knowledge对象', 'type' => 'object', 'properties' => [ - 'HitStatement' => [ - 'title' => '命中语句', - 'description' => '命中语句', - 'type' => 'string', - 'example' => '公积金', - ], - 'Summary' => [ - 'title' => '命中问题的简介', - 'description' => '命中问题的简介', - 'type' => 'string', - 'example' => '公积金提取', - ], + 'HitStatement' => ['title' => '命中语句', 'description' => '命中语句', 'type' => 'string', 'example' => '公积金'], + 'Summary' => ['title' => '命中问题的简介', 'description' => '命中问题的简介', 'type' => 'string', 'example' => '公积金提取'], 'RelatedKnowledges' => [ 'title' => '关联知识列表', 'description' => '关联知识列表', @@ -2985,74 +761,26 @@ 'description' => '关联知识', 'type' => 'object', 'properties' => [ - 'KnowledgeId' => [ - 'title' => '知识关联知识的ID', - 'description' => '知识关联知识的ID', - 'type' => 'string', - 'example' => '735899', - ], - 'Title' => [ - 'title' => '知识的关联知识的标题', - 'description' => '知识的关联知识的标题', - 'type' => 'string', - 'example' => '公积金查询', - ], + 'KnowledgeId' => ['title' => '知识关联知识的ID', 'description' => '知识关联知识的ID', 'type' => 'string', 'example' => '735899'], + 'Title' => ['title' => '知识的关联知识的标题', 'description' => '知识的关联知识的标题', 'type' => 'string', 'example' => '公积金查询'], ], ], ], - 'Category' => [ - 'title' => '知识类目', - 'description' => '知识类目', - 'type' => 'string', - 'example' => '公积金', - ], - 'Title' => [ - 'title' => '命中问题的标题', - 'description' => '命中问题的标题', - 'type' => 'string', - 'example' => '公积金提取', - ], - 'Content' => [ - 'title' => '命中问题的内容', - 'description' => '命中问题的内容', - 'type' => 'string', - 'example' => '公积金提取，请在首页搜索公积金提取，提交办事的表单', - ], - 'AnswerSource' => [ - 'title' => '区分答案类型。'."\n" - .'KnowledgeBase:知识库条；', - 'description' => '区分答案类型。'."\n" - .'KnowledgeBas：知识库；', - 'type' => 'string', - 'example' => 'KnowledgeBase', - ], - 'Id' => [ - 'title' => '命中问题在知识库中的ID', - 'description' => '命中问题在知识库中的ID', - 'type' => 'string', - 'example' => '735898', - ], - 'Score' => [ - 'title' => '分数', - 'description' => '分数', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.998', - ], + 'Category' => ['title' => '知识类目', 'description' => '知识类目', 'type' => 'string', 'example' => '公积金'], + 'Title' => ['title' => '命中问题的标题', 'description' => '命中问题的标题', 'type' => 'string', 'example' => '公积金提取'], + 'Content' => ['title' => '命中问题的内容', 'description' => '命中问题的内容', 'type' => 'string', 'example' => '公积金提取，请在首页搜索公积金提取，提交办事的表单'], + 'AnswerSource' => ['title' => '区分答案类型。'."\n" + .'KnowledgeBase:知识库条；', 'description' => '区分答案类型。'."\n" + .'KnowledgeBas：知识库；', 'type' => 'string', 'example' => 'KnowledgeBase'], + 'Id' => ['title' => '命中问题在知识库中的ID', 'description' => '命中问题在知识库中的ID', 'type' => 'string', 'example' => '735898'], + 'Score' => ['title' => '分数', 'description' => '分数', 'type' => 'number', 'format' => 'double', 'example' => '0.998'], 'ContentType' => [ 'title' => '纯文本/富文本答案的标示', 'description' => '纯文本或富文本答案的标识', 'type' => 'string', - 'enumValueTitles' => [ - 'PLAIN_TEXT' => '纯本文', - 'RICH_TEXT' => '富文本', - ], + 'enumValueTitles' => ['PLAIN_TEXT' => '纯本文', 'RICH_TEXT' => '富文本'], 'example' => 'PLAIN_TEXT', - 'enum' => [ - 'PLAIN_TEXT：纯本文', - 'RICH_TEXT: 富文本', - 'CARD_TEMPLATE：卡片模版', - ], + 'enum' => ['PLAIN_TEXT：纯本文', 'RICH_TEXT: 富文本', 'CARD_TEMPLATE：卡片模版'], ], ], ], @@ -3061,48 +789,16 @@ 'description' => '当AnswerType为Text时，此字段包含机器人返回的Text对象', 'type' => 'object', 'properties' => [ - 'HitStatement' => [ - 'title' => '命中语句', - 'description' => '命中语句', - 'type' => 'string', - 'example' => '查天气', - ], - 'DialogName' => [ - 'title' => '当AnswerSource为BotFramework时，此字段返回对话单元名称', - 'description' => '当AnswerSource为BotFramework时，此字段返回对话单元名称', - 'type' => 'string', - 'example' => '示例_查天气', - ], - 'ArticleTitle' => [ - 'title' => '当AnswerSource为MACHINE_READ时，此字段返回命中文章标题', - 'description' => '当AnswerSource为MACHINE_READ时，此字段返回命中文章标题', - 'type' => 'string', - 'example' => '备案十一', - ], + 'HitStatement' => ['title' => '命中语句', 'description' => '命中语句', 'type' => 'string', 'example' => '查天气'], + 'DialogName' => ['title' => '当AnswerSource为BotFramework时，此字段返回对话单元名称', 'description' => '当AnswerSource为BotFramework时，此字段返回对话单元名称', 'type' => 'string', 'example' => '示例_查天气'], + 'ArticleTitle' => ['title' => '当AnswerSource为MACHINE_READ时，此字段返回命中文章标题', 'description' => '当AnswerSource为MACHINE_READ时，此字段返回命中文章标题', 'type' => 'string', 'example' => '备案十一'], 'AnswerSource' => [ 'title' => '区分答案类型', 'description' => '区分答案类型', 'type' => 'string', - 'enumValueTitles' => [ - 'TABLEQA' => '表格问答', - 'COMMANDS' => '系统指令', - 'SENSITIVE_WORD' => ' 全局敏感词', - 'BotFramework' => '对话工厂', - 'MACHINE_READ' => '机器阅读', - 'ChitChat' => '闲聊', - 'NO_ANSWER' => '无答案', - ], + 'enumValueTitles' => ['TABLEQA' => '表格问答', 'COMMANDS' => '系统指令', 'SENSITIVE_WORD' => ' 全局敏感词', 'BotFramework' => '对话工厂', 'MACHINE_READ' => '机器阅读', 'ChitChat' => '闲聊', 'NO_ANSWER' => '无答案'], 'example' => 'BotFramework', - 'enum' => [ - 'ChitChat：闲聊', - 'BotFramework：对话工厂', - 'NO_ANSWER：无答案', - 'MACHINE_READ：机器阅读', - 'CardAnswer：卡片答案', - 'SENSITIVE_WORD： 全局敏感词', - 'COMMANDS：系统指令', - 'TABLEQA：表格问答', - ], + 'enum' => ['ChitChat：闲聊', 'BotFramework：对话工厂', 'NO_ANSWER：无答案', 'MACHINE_READ：机器阅读', 'CardAnswer：卡片答案', 'SENSITIVE_WORD： 全局敏感词', 'COMMANDS：系统指令', 'TABLEQA：表格问答'], ], 'Slots' => [ 'title' => '当AnswerSource为BotFramework时，此字段返回专有名词列表', @@ -3112,125 +808,48 @@ 'description' => '槽位信息', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => '具体值', - 'type' => 'string', - 'example' => '北京', - ], - 'Origin' => [ - 'description' => '原始值', - 'type' => 'string', - 'example' => '北京', - ], - 'Name' => [ - 'description' => '名称', - 'type' => 'string', - 'example' => '查天气意图.city', - ], - 'Hit' => [ - 'description' => '是否命中', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Value' => ['description' => '具体值', 'type' => 'string', 'example' => '北京'], + 'Origin' => ['description' => '原始值', 'type' => 'string', 'example' => '北京'], + 'Name' => ['description' => '名称', 'type' => 'string', 'example' => '查天气意图.city'], + 'Hit' => ['description' => '是否命中', 'type' => 'boolean', 'example' => 'false'], ], ], ], - 'NodeName' => [ - 'title' => '当AnswerSource为BotFramework时，此字段返回节点名称', - 'description' => '当AnswerSource为BotFramework时，此字段返回节点名称', - 'type' => 'string', - 'example' => '示例_查天气.查天气填槽.__city', - ], - 'IntentName' => [ - 'title' => '当AnswerSource为BotFramework时，此字段返回意图名称', - 'description' => '当AnswerSource为BotFramework时，此字段返回意图名称', - 'type' => 'string', - 'example' => '查天气意图', - ], - 'MetaData' => [ - 'description' => '元数据', - 'type' => 'string', - 'example' => '[[{\\"columnName\\":\\"姓名\\",\\"stringValue\\":\\"王珊珊\\"}]]', - ], - 'ExternalFlags' => [ - 'title' => '当AnswerSource为BotFramework时，此字段返回透传参数', - 'description' => '当AnswerSource为BotFramework时，此字段返回透传参数', - 'type' => 'object', - ], - 'Ext' => [ - 'title' => '此字段返回透传参数', - 'description' => '此字段返回透传参数', - 'type' => 'object', - 'example' => '{'."\n" - .' "MATCHED_INTENT_SOURCE": "",'."\n" - .' "INTENT_ID": 724414,'."\n" - .' "IntentName": "查天气意图",'."\n" - .' "INTENT_DETAIL": "[我想|我要]查天气",'."\n" - .' "LGF_EXPRESSION": "[我想|我要]查天气",'."\n" - .' "IS_SESSION_FINISHED": false,'."\n" - .' "DsScore": 100.0,'."\n" - .' "DIALOG_ID": "299034",'."\n" - .' "FINISH_LABEL": false,'."\n" - .' "MODULE_START": false,'."\n" - .' "INTENT_NAME": "查天气意图",'."\n" - .' "INTENT_SOURCE": "Lgf",'."\n" - .' "DIALOG_NAME": "示例_查天气"'."\n" - .'}', - ], - 'UserDefinedChatTitle' => [ - 'title' => '自定义闲聊主题title', - 'description' => '自定义闲聊主题标题', - 'type' => 'string', - 'example' => '问候', - ], - 'Content' => [ - 'title' => '文本消息的内容', - 'description' => '文本消息的内容', - 'type' => 'string', - 'example' => '请问您要查哪里的天气？', - ], - 'NodeId' => [ - 'title' => '当AnswerSource为BotFramework时，此字段返回节点Id', - 'description' => '当AnswerSource为BotFramework时，此字段返回节点ID', - 'type' => 'string', - 'example' => '1410-c7a72a78.__city', - ], - 'Score' => [ - 'title' => '分数', - 'description' => '分数', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0', - ], + 'NodeName' => ['title' => '当AnswerSource为BotFramework时，此字段返回节点名称', 'description' => '当AnswerSource为BotFramework时，此字段返回节点名称', 'type' => 'string', 'example' => '示例_查天气.查天气填槽.__city'], + 'IntentName' => ['title' => '当AnswerSource为BotFramework时，此字段返回意图名称', 'description' => '当AnswerSource为BotFramework时，此字段返回意图名称', 'type' => 'string', 'example' => '查天气意图'], + 'MetaData' => ['description' => '元数据', 'type' => 'string', 'example' => '[[{\\"columnName\\":\\"姓名\\",\\"stringValue\\":\\"王珊珊\\"}]]'], + 'ExternalFlags' => ['title' => '当AnswerSource为BotFramework时，此字段返回透传参数', 'description' => '当AnswerSource为BotFramework时，此字段返回透传参数', 'type' => 'object'], + 'Ext' => ['title' => '此字段返回透传参数', 'description' => '此字段返回透传参数', 'type' => 'object', 'example' => '{'."\n" + .' "MATCHED_INTENT_SOURCE": "",'."\n" + .' "INTENT_ID": 724414,'."\n" + .' "IntentName": "查天气意图",'."\n" + .' "INTENT_DETAIL": "[我想|我要]查天气",'."\n" + .' "LGF_EXPRESSION": "[我想|我要]查天气",'."\n" + .' "IS_SESSION_FINISHED": false,'."\n" + .' "DsScore": 100.0,'."\n" + .' "DIALOG_ID": "299034",'."\n" + .' "FINISH_LABEL": false,'."\n" + .' "MODULE_START": false,'."\n" + .' "INTENT_NAME": "查天气意图",'."\n" + .' "INTENT_SOURCE": "Lgf",'."\n" + .' "DIALOG_NAME": "示例_查天气"'."\n" + .'}'], + 'UserDefinedChatTitle' => ['title' => '自定义闲聊主题title', 'description' => '自定义闲聊主题标题', 'type' => 'string', 'example' => '问候'], + 'Content' => ['title' => '文本消息的内容', 'description' => '文本消息的内容', 'type' => 'string', 'example' => '请问您要查哪里的天气？'], + 'NodeId' => ['title' => '当AnswerSource为BotFramework时，此字段返回节点Id', 'description' => '当AnswerSource为BotFramework时，此字段返回节点ID', 'type' => 'string', 'example' => '1410-c7a72a78.__city'], + 'Score' => ['title' => '分数', 'description' => '分数', 'type' => 'number', 'format' => 'double', 'example' => '100.0'], 'ContentType' => [ 'title' => '纯文本/富文本答案的标示', 'description' => '纯文本或富文本答案的标识', 'type' => 'string', - 'enumValueTitles' => [ - 'PLAIN_TEXT' => '纯本文', - 'RICH_TEXT' => '富文本', - ], + 'enumValueTitles' => ['PLAIN_TEXT' => '纯本文', 'RICH_TEXT' => '富文本'], 'example' => 'PLAIN_TEXT', - 'enum' => [ - 'PLAIN_TEXT：纯本文', - 'RICH_TEXT: 富文本', - 'CARD_TEMPLATE：卡片模版', - ], - ], - 'Commands' => [ - 'title' => '指令参数，如转人工指令的转人工技能组', - 'description' => '指令参数，如转人工指令的转人工技能组', - 'type' => 'object', - 'example' => '{'."\n" - .' "sysToAgent": "{\\"skillGroup\\":\\"12\\"}"'."\n" - .'}', - ], - 'ResponseType' => [ - 'title' => '当AnswerSource=BotFramework，ResponseType=SSML时，表示命中对话工厂交互式填槽；否则字段不存在', - 'description' => '当AnswerSource为BotFramework，ResponseType为SSML时，表示命中对话工厂交互式填槽；否则字段不存在', - 'type' => 'string', - 'example' => 'SSML', + 'enum' => ['PLAIN_TEXT：纯本文', 'RICH_TEXT: 富文本', 'CARD_TEMPLATE：卡片模版'], ], + 'Commands' => ['title' => '指令参数，如转人工指令的转人工技能组', 'description' => '指令参数，如转人工指令的转人工技能组', 'type' => 'object', 'example' => '{'."\n" + .' "sysToAgent": "{\\"skillGroup\\":\\"12\\"}"'."\n" + .'}'], + 'ResponseType' => ['title' => '当AnswerSource=BotFramework，ResponseType=SSML时，表示命中对话工厂交互式填槽；否则字段不存在', 'description' => '当AnswerSource为BotFramework，ResponseType为SSML时，表示命中对话工厂交互式填槽；否则字段不存在', 'type' => 'string', 'example' => 'SSML'], ], ], 'Recommends' => [ @@ -3241,45 +860,23 @@ 'description' => 'recommend对象', 'type' => 'object', 'properties' => [ - 'KnowledgeId' => [ - 'title' => '澄清的知识id', - 'description' => '澄清的知识ID', - 'type' => 'string', - 'example' => '4548', - ], - 'Title' => [ - 'title' => '澄清内容，可能是'."\n" - .'图谱问答的实体、'."\n" - .'知识问答的知识标题、'."\n" - .'表格问答的列值', - 'description' => '澄清内容，可能是'."\n" - .'图谱问答的实体、'."\n" - .'知识问答的知识标题、'."\n" - .'表格问答的列值', - 'type' => 'string', - 'example' => '测试纯文本', - ], + 'KnowledgeId' => ['title' => '澄清的知识id', 'description' => '澄清的知识ID', 'type' => 'string', 'example' => '4548'], + 'Title' => ['title' => '澄清内容，可能是'."\n" + .'图谱问答的实体、'."\n" + .'知识问答的知识标题、'."\n" + .'表格问答的列值', 'description' => '澄清内容，可能是'."\n" + .'图谱问答的实体、'."\n" + .'知识问答的知识标题、'."\n" + .'表格问答的列值', 'type' => 'string', 'example' => '测试纯文本'], 'AnswerSource' => [ 'title' => '澄清来源的标识', 'description' => '澄清来源的标识', 'type' => 'string', - 'enumValueTitles' => [ - 'BotFramework' => '对话工厂', - 'Knowledge' => 'FAQ', - ], + 'enumValueTitles' => ['BotFramework' => '对话工厂', 'Knowledge' => 'FAQ'], 'example' => 'KNOWLEDGE', - 'enum' => [ - 'Knowledge：FAQ标题', - 'BotFramework：对话工厂', - ], - ], - 'Score' => [ - 'title' => '推荐内容的分数，当AnswerSource为KNOWLEDGE时，此字段有值', - 'description' => '推荐内容的分数，当AnswerSource为KNOWLEDGE时，此字段有值', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.46', + 'enum' => ['Knowledge：FAQ标题', 'BotFramework：对话工厂'], ], + 'Score' => ['title' => '推荐内容的分数，当AnswerSource为KNOWLEDGE时，此字段有值', 'description' => '推荐内容的分数，当AnswerSource为KNOWLEDGE时，此字段有值', 'type' => 'number', 'format' => 'double', 'example' => '0.46'], ], ], ], @@ -3287,75 +884,32 @@ 'title' => '本条消息的类型', 'description' => '本条消息的类型', 'type' => 'string', - 'enumValueTitles' => [ - 'Recommend' => '澄清或者反问', - 'Text' => '文本', - 'Knowledge' => '知识库知识直出', - ], + 'enumValueTitles' => ['Recommend' => '澄清或者反问', 'Text' => '文本', 'Knowledge' => '知识库知识直出'], 'example' => 'Text', - 'enum' => [ - 'Text：文本', - 'Recommend：澄清或者反问', - 'Knowledge：知识库知识直出', - 'cardAnswer：卡片工坊的卡片答案', - ], + 'enum' => ['Text：文本', 'Recommend：澄清或者反问', 'Knowledge：知识库知识直出', 'cardAnswer：卡片工坊的卡片答案'], ], 'AnswerSource' => [ 'title' => '当AnswerType为Recommend时，此字段表示推荐的答案来源', 'description' => '当AnswerType为Recommend时，此字段表示推荐的答案来源', 'type' => 'string', - 'enumValueTitles' => [ - ' INTENT_FAQ_CLARIFY' => 'FAQ和对话工厂混合澄清', - 'TABLEQA' => '表格问答', - 'KNOWLEDGE' => 'FAQ', - 'BotFramework' => '对话工厂', - ], + 'enumValueTitles' => [' INTENT_FAQ_CLARIFY' => 'FAQ和对话工厂混合澄清', 'TABLEQA' => '表格问答', 'KNOWLEDGE' => 'FAQ', 'BotFramework' => '对话工厂'], 'example' => 'KNOWLEDGE', - 'enum' => [ - 'KNOWLEDGE：知识问答', - 'INTENT_FAQ_CLARIFY：FAQ和对话工厂混合澄清', - 'BotFramework：对话工厂澄清', - 'TABLEQA：表格问答', - ], - ], - 'VoiceTitle' => [ - 'title' => '当AnswerType为Recommend时，并且问答的机器人为语音机器人，此字段表示列表型答案在语音场景渲染之后的答案内容', - 'description' => '语音场景，澄清内容', - 'type' => 'string', - 'example' => '请问你说的是公积金查询，还是公积金提取', - ], - 'Title' => [ - 'title' => '当AnswerType为Recommend时，此字段表示推荐或者反问的标题话术', - 'description' => '在线场景，反问标题', - 'type' => 'string', - 'example' => '请问您想咨询的是哪个投保年龄区间呢？', + 'enum' => ['KNOWLEDGE：知识问答', 'INTENT_FAQ_CLARIFY：FAQ和对话工厂混合澄清', 'BotFramework：对话工厂澄清', 'TABLEQA：表格问答'], ], + 'VoiceTitle' => ['title' => '当AnswerType为Recommend时，并且问答的机器人为语音机器人，此字段表示列表型答案在语音场景渲染之后的答案内容', 'description' => '语音场景，澄清内容', 'type' => 'string', 'example' => '请问你说的是公积金查询，还是公积金提取'], + 'Title' => ['title' => '当AnswerType为Recommend时，此字段表示推荐或者反问的标题话术', 'description' => '在线场景，反问标题', 'type' => 'string', 'example' => '请问您想咨询的是哪个投保年龄区间呢？'], ], ], ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC', - ], - 'SessionId' => [ - 'title' => '本次会话的ID', - 'description' => '本次会话的ID', - 'type' => 'string', - 'example' => 'a6f216a0685c4c8baa0e8beb6d5ec6db', - ], - 'MessageId' => [ - 'title' => '本条会话应答消息的ID', - 'description' => '本条会话应答消息的ID', - 'type' => 'string', - 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC'."\n", - ], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID', 'type' => 'string', 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC'], + 'SessionId' => ['title' => '本次会话的ID', 'description' => '本次会话的ID', 'type' => 'string', 'example' => 'a6f216a0685c4c8baa0e8beb6d5ec6db'], + 'MessageId' => ['title' => '本条会话应答消息的ID', 'description' => '本条会话应答消息的ID', 'type' => 'string', 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC'."\n"], ], + 'description' => '', ], ], ], - 'responseDemo' => '', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QuerySegList\\": [\\n \\"天气\\"\\n ],\\n \\"Messages\\": [\\n {\\n \\"Knowledge\\": {\\n \\"HitStatement\\": \\"公积金\\",\\n \\"Summary\\": \\"公积金提取\\",\\n \\"RelatedKnowledges\\": [\\n {\\n \\"KnowledgeId\\": \\"735899\\",\\n \\"Title\\": \\"公积金查询\\"\\n }\\n ],\\n \\"Category\\": \\"公积金\\",\\n \\"Title\\": \\"公积金提取\\",\\n \\"Content\\": \\"公积金提取，请在首页搜索公积金提取，提交办事的表单\\",\\n \\"AnswerSource\\": \\"KnowledgeBase\\",\\n \\"Id\\": \\"735898\\",\\n \\"Score\\": 0.998,\\n \\"ContentType\\": \\"PLAIN_TEXT\\"\\n },\\n \\"Text\\": {\\n \\"HitStatement\\": \\"查天气\\",\\n \\"DialogName\\": \\"示例_查天气\\",\\n \\"ArticleTitle\\": \\"备案十一\\",\\n \\"AnswerSource\\": \\"BotFramework\\",\\n \\"Slots\\": [\\n {\\n \\"Value\\": \\"北京\\",\\n \\"Origin\\": \\"北京\\",\\n \\"Name\\": \\"查天气意图.city\\",\\n \\"Hit\\": false\\n }\\n ],\\n \\"NodeName\\": \\"示例_查天气.查天气填槽.__city\\",\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"MetaData\\": \\"[[{\\\\\\\\\\\\\\"columnName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"姓名\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"stringValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"王珊珊\\\\\\\\\\\\\\"}]]\\",\\n \\"ExternalFlags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Ext\\": {\\n \\"MATCHED_INTENT_SOURCE\\": \\"\\",\\n \\"INTENT_ID\\": 724414,\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"INTENT_DETAIL\\": \\"[我想|我要]查天气\\",\\n \\"LGF_EXPRESSION\\": \\"[我想|我要]查天气\\",\\n \\"IS_SESSION_FINISHED\\": false,\\n \\"DsScore\\": 100,\\n \\"DIALOG_ID\\": \\"299034\\",\\n \\"FINISH_LABEL\\": false,\\n \\"MODULE_START\\": false,\\n \\"INTENT_NAME\\": \\"查天气意图\\",\\n \\"INTENT_SOURCE\\": \\"Lgf\\",\\n \\"DIALOG_NAME\\": \\"示例_查天气\\"\\n },\\n \\"UserDefinedChatTitle\\": \\"问候\\",\\n \\"Content\\": \\"请问您要查哪里的天气？\\",\\n \\"NodeId\\": \\"1410-c7a72a78.__city\\",\\n \\"Score\\": 100,\\n \\"ContentType\\": \\"PLAIN_TEXT\\",\\n \\"Commands\\": {\\n \\"sysToAgent\\": \\"{\\\\\\"skillGroup\\\\\\":\\\\\\"12\\\\\\"}\\"\\n },\\n \\"ResponseType\\": \\"SSML\\"\\n },\\n \\"Recommends\\": [\\n {\\n \\"KnowledgeId\\": \\"4548\\",\\n \\"Title\\": \\"测试纯文本\\",\\n \\"AnswerSource\\": \\"KNOWLEDGE\\",\\n \\"Score\\": 0.46\\n }\\n ],\\n \\"AnswerType\\": \\"Text\\",\\n \\"AnswerSource\\": \\"KNOWLEDGE\\",\\n \\"VoiceTitle\\": \\"请问你说的是公积金查询，还是公积金提取\\",\\n \\"Title\\": \\"请问您想咨询的是哪个投保年龄区间呢？\\"\\n }\\n ],\\n \\"RequestId\\": \\"A2315C4B-A872-5DEE-9DAD-D73B194A4AEC\\",\\n \\"SessionId\\": \\"a6f216a0685c4c8baa0e8beb6d5ec6db\\",\\n \\"MessageId\\": \\"A2315C4B-A872-5DEE-9DAD-D73B194A4AEC\\\\n\\"\\n}","type":"json"}]', 'title' => '会话', 'responseParamsDescription' => '#### Ext字段说明'."\n" .'**AnswerSource=BotFramework时：**'."\n" @@ -3840,102 +1394,46 @@ .' "Recommend": "https://next.api.aliyun.com/troubleshoot?q=Third party interface error&product=Chatbot"'."\n" .'}'."\n" .'```', - ], - 'Associate' => [ - 'summary' => '根据用户query联想知识库中的FAQ。', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2023-04-27T12:46:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-09-01T02:47:10.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-21T13:43:18.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-17T09:21:16.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Chat'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'ContinueInstancePublishTask' => [ + 'summary' => '机器人发布告警时，忽略告警并继续发布。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], - ], - [ - 'name' => 'Utterance', - 'in' => 'query', - 'schema' => [ - 'title' => '用户表述', - 'description' => '用户表述', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '公积金提取', - ], - ], - [ - 'name' => 'Perspective', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '视角编码，用于调用同一知识标题下不同视角的答案。在拼装请求参数时，需要以Perspective={视角编码}的格式传递参数。如：&Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准。目前仅支持一个视角答案的调用。 （公有云）', - 'description' => '视角编码，用于调用同一知识标题下不同视角的答案。在拼装请求参数时，需要以Perspective={视角编码}的格式传递参数。如：&Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准。目前仅支持一个视角答案的调用', - 'type' => 'array', - 'items' => [ - 'description' => '视角', - 'type' => 'string', - 'required' => false, - 'example' => 'FZJBY3raWr', - ], - 'required' => false, - 'example' => '["qyzzVfyFfa"]', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。', - 'description' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。', - 'type' => 'string', - 'required' => false, - 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ - 'name' => 'RecommendNum', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '推荐问题数量，1-10，当出推荐的时候才生效，返回不大于RecommendN', - 'description' => '推荐问题数量，1-10，当出推荐的时候才生效，返回小于等于RecommendNum的推荐问题', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8', - ], + 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -3945,854 +1443,483 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID', + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D'], + 'Id' => ['title' => '任务Id', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8522'], + 'Response' => ['title' => '任务Id', 'description' => '任务ID', 'type' => 'string', 'example' => '8522'], + 'Status' => [ + 'title' => '任务状态', + 'description' => '任务状态', 'type' => 'string', - 'example' => '5C20F0D4-9721-178A-8236-3BF990634962', + 'enumValueTitles' => ['FE_SUCCESS' => '发布成功', 'FE_ABORTED' => '发布取消', 'FE_WARNING' => '发布警告', 'FE_FAILED' => '发布失败', 'FE_RUNNING' => '正在发布中'], + 'example' => 'FE_RUNNING', + 'enum' => ['FE_RUNNING：正在发布中', 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], ], - 'Associate' => [ - 'title' => '联想的列表', - 'description' => '联想的列表', + 'BizTypeList' => [ + 'title' => '业务类型列表', + 'description' => '业务类型列表', 'type' => 'array', - 'items' => [ - 'description' => '联想推荐的列表', - 'type' => 'object', - 'properties' => [ - 'Meta' => [ - 'title' => '附带信息', - 'description' => '附带信息', - 'type' => 'string', - 'example' => '{}', - ], - 'Title' => [ - 'title' => '关联问题的标题', - 'description' => '关联问题的标题', - 'type' => 'string', - 'example' => '公积金提取的政策', - ], - ], - ], - ], - 'SessionId' => [ - 'title' => '本次会话的ID', - 'description' => '本次会话的ID', - 'type' => 'string', - 'example' => '1531ded6b3df4afca4be63943f708bb7', - ], - 'MessageId' => [ - 'title' => '本条会话应答消息的ID', - 'description' => '本条会话应答消息的ID', - 'type' => 'string', - 'example' => '5ADF0EBD-7C50-1922-A28B-43215B47CC1A', - ], + 'items' => ['description' => '业务类型', 'type' => 'string', 'example' => 'robot'], + ], + 'Error' => ['title' => 'job失败信息', 'description' => 'job失败信息', 'type' => 'string', 'example' => '检查待发布模块是否空闲发生错误，faq'], + 'CreateTime' => ['title' => '任务创建的 UTC 时间', 'description' => '任务创建的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'ModifyTime' => ['title' => '任务修改的 UTC 时间', 'description' => '任务修改的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z'], + 'Warnings' => ['title' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', 'description' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', 'type' => 'object', 'example' => '{'."\n" + .' "category_bind_faq": ['."\n" + .' "以下类目没有发布到正式环境: 项目交付信息汇总"'."\n" + .' ]'."\n" + .'}'], + 'Errors' => ['title' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', 'description' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', 'type' => 'object', 'example' => '{}'], ], ], ], ], - 'responseDemo' => '', - 'title' => '会话-联想API', - 'responseParamsDescription' => '### 示例'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\",\\n \\"Warnings\\": {\\n \\"category_bind_faq\\": [\\n \\"以下类目没有发布到正式环境: 项目交付信息汇总\\"\\n ]\\n },\\n \\"Errors\\": {}\\n}","type":"json"}]', + 'title' => '继续机器人发布', + 'responseParamsDescription' => '### Warnings&Errors 子发布模块枚举：'."\n" + .'| key值 | 含义 |'."\n" + .'| --- | --- |'."\n" + .'| category_bind\\_chitchat | 闲聊绑定关系 |'."\n" + .'| category_bind\\_faq | faq的绑定关系 |'."\n" + .'| robot_ds | 对话工厂对话流 |'."\n" + .'| ds_entity | 对话工厂实体 |'."\n" + .'| ds_intent | 对话工厂意图 |'."\n" ."\n" - .'#### 响应报文'."\n" + .'### 示例'."\n" + .'#### 响应报文：'."\n" .'```json'."\n" .'{'."\n" - .' "MessageId":"1eb47d7a1706429081e90c83c62c2f00",'."\n" - .' "SessionId":"93f11165a2a24289a6f869760e8cb3f3",'."\n" - .' "Associate":['."\n" - .' {'."\n" - .' "Meta":"{}",'."\n" - .' "Title": "专业及后勤类岗位职业发展方有哪些？"'."\n" - .' },'."\n" - .' {'."\n" - .' "Meta":"{}",'."\n" - .' "Title": "专业及后勤类岗位职业发展方有哪些？"'."\n" - .' }'."\n" - .' ]'."\n" + .' "ModifyTime": "2022-04-12T06:32:59Z",'."\n" + .' "BizTypeList": ['."\n" + .' "robot"'."\n" + .' ],'."\n" + .' "CreateTime": "2022-04-12T06:30:17Z",'."\n" + .' "RequestId": "1b6318c2-df76-4117-9c2c-02e22940ff24",'."\n" + .' "Response": "4930",'."\n" + .' "Warnings": {'."\n" + .' "category_bind_faq": ['."\n" + .' "以下类目没有发布到正式环境: 项目交付信息汇总"'."\n" + .' ]'."\n" + .' },'."\n" + .' "Id": 4930,'."\n" + .' "Status": "FE_RUNNING"'."\n" .'}'."\n" .'```', - ], - 'BeginSession' => [ - 'summary' => '获取欢迎语接口。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinueInstancePublishTask'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateCategory' => [ + 'summary' => '新建类目。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotUKQQ1L', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '类目名称', 'description' => '类目名称', 'type' => 'string', 'required' => true, 'example' => '测试1'], ], [ - 'name' => 'InstanceId', + 'name' => 'BizCode', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['title' => '业务代码', 'description' => '业务代码', 'type' => 'string', 'required' => false, 'example' => 'bizcode123'], ], [ - 'name' => 'SandBox', + 'name' => 'KnowledgeType', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['title' => '知识类型，FAQ类目：1，文档类目：3', 'description' => '知识类型，FAQ类目：1，文档类目：3，默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'VendorParam', + 'name' => 'ParentCategoryId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['title' => '父类目ID，默认-1，对应根目录', 'description' => '父类目ID，默认-1，对应根目录', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '-1'], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '149C7528-C104-1B50-A4F9-0C5907A8AD9D', - ], - 'WelcomeMessage' => [ - 'title' => '欢迎语', - 'description' => '欢迎语', - 'type' => 'string', - 'example' => '智能对话机器人为您服务，请问有什么可以帮您？', - ], - 'SilenceReplyTimeout' => [ - 'description' => '静默超时时间，单位：秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Interruptible' => [ - 'description' => '语音播报是否可打断', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AsrMaxEndSilence' => [ - 'description' => 'ASR尾点检测时间，单位：毫秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '700', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A629A28F-F25E-5572-A679-FA46FB0151D6'], + 'Category' => [ + 'title' => '类目信息', + 'description' => '类目信息', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => ['title' => '类目ID', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000049006'], + 'BizCode' => ['description' => '业务代码', 'type' => 'string', 'example' => 'bizcode123'], + 'Name' => ['description' => '类目名称', 'type' => 'string', 'example' => '类目名称'], + 'ParentCategoryId' => ['description' => '父类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'Status' => ['description' => '类目状态，-1：已删除未发布状态，0：正常', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], ], ], ], ], ], - 'responseDemo' => '', - 'title' => '获取欢迎语', - ], - 'Nlu' => [ - 'summary' => '针对用户query，返回机器人有关这个query的语言理解（nlu）结果。当前只支持对话工厂、中控的NLU信息透出，其他引擎后续按需支持。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A629A28F-F25E-5572-A679-FA46FB0151D6\\",\\n \\"Category\\": {\\n \\"CategoryId\\": 30000049006,\\n \\"BizCode\\": \\"bizcode123\\",\\n \\"Name\\": \\"类目名称\\",\\n \\"ParentCategoryId\\": -1,\\n \\"Status\\": 0\\n }\\n}","type":"json"}]', + 'title' => '类目-新建', + 'changeSet' => [ + ['createdAt' => '2024-02-22T12:10:09.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-07-07T11:54:48.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCategory'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateConnQuestion' => [ + 'summary' => '为知识添加关联知识。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'name' => 'ConnQuestionId', + 'in' => 'formData', + 'schema' => ['description' => '关联知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30002654628'], ], [ - 'name' => 'Utterance', - 'in' => 'query', - 'schema' => [ - 'title' => '用户表述', - 'description' => '用户表述', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '北京的天气怎么样', - ], + 'name' => 'KnowledgeId', + 'in' => 'formData', + 'schema' => ['description' => '知识ID'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30002174773'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'Messages' => [ - 'title' => '消息的列表', - 'description' => '消息的列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DialogHubNluInfo' => [ - 'title' => '对话中控的nlu信息', - 'description' => '对话中控的nlu信息', - 'type' => 'object', - 'properties' => [ - 'GlobalDictList' => [ - 'title' => '全局名词列表', - 'description' => '全局名词列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StandardWord' => [ - 'title' => '名词', - 'description' => '名词', - 'type' => 'string', - 'example' => '天气', - ], - 'Word' => [ - 'title' => '同义词', - 'description' => '同义词', - 'type' => 'string', - 'example' => '天气', - ], - ], - ], - ], - 'GlobalSensitiveWordList' => [ - 'title' => '全局敏感词列表', - 'description' => '全局敏感词列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StandardWord' => [ - 'title' => '名词', - 'description' => '名词', - 'type' => 'string', - 'example' => '天气', - ], - 'Word' => [ - 'title' => '同义词', - 'description' => '同义词', - 'type' => 'string', - 'example' => '天气', - ], - ], - ], - ], - ], - ], - 'DsNluInfo' => [ - 'title' => '对话工厂的nlu信息', - 'description' => '对话工厂的nlu信息', - 'type' => 'object', - 'properties' => [ - 'EntityList' => [ - 'title' => '实体列表', - 'description' => '实体列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '实体名称', - 'description' => '实体名称', - 'type' => 'string', - 'example' => '@城市', - ], - 'Origin' => [ - 'title' => '实体原词（实体成员）', - 'description' => '实体原词（实体成员）', - 'type' => 'string', - 'example' => '北京', - ], - 'Type' => [ - 'title' => '实体类型，当前只有text类型', - 'description' => '实体类型，当前只有text类型', - 'type' => 'string', - 'example' => 'text', - ], - 'Value' => [ - 'title' => '实体同义词', - 'description' => '实体同义词', - 'type' => 'string', - 'example' => '首都', - ], - ], - ], - ], - 'IntentList' => [ - 'title' => '意图列表', - 'description' => '意图列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'IntentId' => [ - 'title' => '意图id', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '724387', - ], - 'MatchDetail' => [ - 'title' => '匹配详情（匹配过程）', - 'description' => '匹配详情（匹配过程）', - 'type' => 'string', - 'example' => 'classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]', - ], - 'MatchType' => [ - 'title' => '匹配类型，其枚举值含义如下： Similarity：query与意图通过意图话术相似度匹配 Lgf：query与意图通过LGF匹配 Classify：query与意图通过模型训练匹配 FewShotLearning：query与意图通过系统内置fewshot模型匹配 BuildIn： query与系统内置意图匹配', - 'description' => '匹配类型，其枚举值含义如下： Similarity：query与意图通过意图话术相似度匹配 Lgf：query与意图通过LGF匹配 Classify：query与意图通过模型训练匹配 FewShotLearning：query与意图通过系统内置fewshot模型匹配 BuildIn： query与系统内置意图匹配', - 'type' => 'string', - 'example' => 'FewShotLearning', - ], - 'Name' => [ - 'title' => '意图名称', - 'description' => '意图名称', - 'type' => 'string', - 'example' => '查天气意图', - ], - 'Score' => [ - 'title' => '分数', - 'description' => '分数', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.995', - ], - 'SlotList' => [ - 'title' => '命中意图的槽位列表', - 'description' => '命中意图的槽位列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '实体名称', - 'description' => '实体名称', - 'type' => 'string', - 'example' => '@城市', - ], - 'Origin' => [ - 'title' => '实体原词（实体成员）', - 'description' => '实体原词（实体成员）', - 'type' => 'string', - 'example' => '北京', - ], - 'Type' => [ - 'title' => '实体类型，当前只有text类型', - 'description' => '实体类型，当前只有text类型', - 'type' => 'string', - 'example' => 'text', - ], - 'Value' => [ - 'title' => '实体同义词', - 'description' => '实体同义词', - 'type' => 'string', - 'example' => '首都', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A6357C1B-1D79-1382-B259-BD9E80751B42', - ], - 'MessageId' => [ - 'title' => '本条语言理解应答消息的ID', - 'description' => '本条语言理解应答消息的ID', - 'type' => 'string', - 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661', - ], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => 'C191B48B-9268-4FB1-A3C2-5143B4A91D0C'], + 'OutlineId' => ['title' => '关联关系ID', 'description' => '关联关系ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000002123'], ], ], ], ], - 'responseDemo' => '', - 'title' => '统一NLU接口', - 'responseParamsDescription' => '### 示例'."\n" - ."\n" - .'#### 响应报文'."\n" - .'```json'."\n" - .'{'."\n" - .' "Messages": ['."\n" - .' {'."\n" - .' "DsNluInfo": {'."\n" - .' "EntityList": ['."\n" - .' {'."\n" - .' "Origin": "北京",'."\n" - .' "Name": "@城市",'."\n" - .' "Type": "text",'."\n" - .' "Value": "首都"'."\n" - .' }'."\n" - .' ],'."\n" - .' "IntentList": ['."\n" - .' {'."\n" - .' "Score": 0.995,'."\n" - .' "SlotList": ['."\n" - .' {'."\n" - .' "Origin": "北京",'."\n" - .' "Name": "@城市",'."\n" - .' "Type": "text",'."\n" - .' "Value": "首都"'."\n" - .' }'."\n" - .' ],'."\n" - .' "MatchType": "FewShotLearning",'."\n" - .' "MatchDetail": "classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]",'."\n" - .' "Name": "查天气意图",'."\n" - .' "IntentId": 724387'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "DialogHubNluInfo": {'."\n" - .' "GlobalDictList": ['."\n" - .' {'."\n" - .' "StandardWord": "天气",'."\n" - .' "Word": "天气"'."\n" - .' }'."\n" - .' ],'."\n" - .' "GlobalSensitiveWordList": ['."\n" - .' {'."\n" - .' "StandardWord": "天气",'."\n" - .' "Word": "天气"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' }'."\n" - .' ],'."\n" - .' "RequestId": "5C20F0D4-9721-178A-8236-3BF990634962",'."\n" - .' "MessageId": "e7ac691f-b166-4561-bddf-9dd00c8bdce6"'."\n" - .'}'."\n" - ."\n" - .'```', - ], - 'GetAsyncResult' => [ - 'summary' => '获取异步服务执行结果，配合Chat接口使用。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C191B48B-9268-4FB1-A3C2-5143B4A91D0C\\",\\n \\"OutlineId\\": 1000002123\\n}","type":"json"}]', + 'title' => '创建关联问', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnQuestion'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateDSEntity' => [ + 'summary' => '创建实体，特指实体的Meta信息，如：实体名称、实体类型。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'AgentKey', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '从Chat接口返回参数中获取TASK_ID', - 'description' => '异步服务的任务ID', - 'type' => 'string', - 'required' => true, - 'example' => '从Chat接口中获取TASK_ID', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => ['title' => '实体名称，仅支持中文、大小写字母、数字、下划线', 'description' => '实体名称，仅支持中文、大小写字母、数字、下划线', 'type' => 'string', 'required' => true, 'example' => '实体名称'], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => ['title' => '实体类型：详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', 'description' => '实体类型：[synonyms（同义词），regex（正则）]', 'type' => 'string', 'required' => false, 'example' => 'synonyms', 'default' => 'synonyms'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'BaseResponse<EntityIdResponse>', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '客户服务执行结果数据', - 'type' => 'string', - 'example' => '{"message":"执行完成"}', - ], - 'Status' => [ - 'description' => '执行状态：'."\n" - .'| 字段值 | 含义 |'."\n" - .'|----|----|'."\n" - .'| Success | 任务执行成功 |'."\n" - .'| Runninig | 任务在执行中 |'."\n" - .'| Fail | 任务执行失败 |', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => 'F79E7305-5314-5069-A701-9591AD051902', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'adfad2343f1f2r'], + 'EntityId' => ['description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'example' => '23436345'], ], ], ], ], - 'responseDemo' => '', - 'title' => '获取异步函数执行结果', - 'description' => '获取异步服务执行结果', - ], - 'CreateInstance' => [ - 'summary' => '创建沙箱环境机器人。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorEntity.OutRange', 'errorMessage' => 'The business error Entity is out of range.', 'description' => ''], + ['errorCode' => 'BusinessErrorEntityName.OutRange', 'errorMessage' => 'The business error EntityName is out of range.', 'description' => ''], + ['errorCode' => 'BusinessErrorEntityName.Repeat', 'errorMessage' => 'BusinessErrorEntityName.Repeat The business error EntityName is repeat.', 'description' => ''], + ['errorCode' => 'BusinessErrorEntityName.InvalidCharactor', 'errorMessage' => 'The business error EntityName contains invalid charactor.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"adfad2343f1f2r\\",\\n \\"EntityId\\": 23436345\\n}","errorExample":""},{"type":"xml","example":"<CreateDSEntityResponse>\\n <RequestId>adfad2343f1f2r</RequestId>\\n <EntityId>23436345</EntityId>\\n</CreateDSEntityResponse>","errorExample":""}]', + 'title' => '实体-创建', + 'changeSet' => [ + ['createdAt' => '2022-07-21T13:43:18.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDSEntity'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateDSEntityValue' => [ + 'summary' => '为指定的某个实体，添加实体成员信息，包含：实体值、对应的同义词列表，同一实体内部的实体值、同义词唯一。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '机器人名称，不超过50字', - 'description' => '机器人名称，不超过50个字符', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '小蜜机器人', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'LanguageCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人服务的语言，如zh-cn、en-us，参考 http://www.lingoes.net/zh/translator/langcode.htm 入参全小写，当前只支持 zh-cn、en-us', - 'description' => '机器人服务的语言，如zh-cn、en-us，默认值为业务空间的默认语言。可选值为业务空间支持的语言', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'zh-cn', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'Introduction', + 'name' => 'EntityId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人备注，不超过50字', - 'description' => '机器人备注，不超过50字', - 'type' => 'string', - 'required' => false, - 'example' => '用于手机app的小蜜机器人', - ], + 'schema' => ['title' => '实体ID，修改实体成员时可为空', 'description' => '实体ID，修改实体成员时可为空', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12'], ], [ - 'name' => 'RobotType', + 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'title' => '机器人类型', - 'description' => '机器人类型，默认为scenario_im', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'scenario_callout' => '外呼机器人', - 'scenario_im' => '在线文本机器人', - 'scenario_ivr' => '导航机器人', - ], - 'example' => 'scenario_im', - ], + 'schema' => ['description' => '实体值（或正则表达式）', 'type' => 'string', 'required' => true, 'example' => '书类型'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', + 'name' => 'Synonyms', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'description' => '同义词列表', + 'type' => 'array', + 'items' => ['description' => '同义词值', 'type' => 'string', 'required' => false, 'example' => '书本'], 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'BaseResponse<EntityValueIdResponse>', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A', - ], - 'InstanceId' => [ - 'title' => '机器人唯一标识', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'g763hg48j3f3'], + 'EntityValueId' => ['description' => '实体成员ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2434543453'], ], ], ], ], - 'responseDemo' => '', - 'title' => '机器人-创建', - ], - 'DeleteInstance' => [ - 'summary' => '删除沙箱和线上的机器人。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"g763hg48j3f3\\",\\n \\"EntityValueId\\": 2434543453\\n}","errorExample":""},{"type":"xml","example":"<CreateDSEntityValueResponse>\\n <RequestId>g763hg48j3f3</RequestId>\\n <EntityValueId>2434543453</EntityValueId>\\n</CreateDSEntityValueResponse>","errorExample":""}]', + 'title' => '实体成员-创建', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDSEntityValue'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateDoc' => [ + 'summary' => '文档新建。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'schema' => ['description' => '业务空间key,不传时访问默认业务空间,key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'AgentKey', + 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '文档类目ID', 'description' => '文档类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30000049006'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', - ], - 'Status' => [ - 'title' => '任务状态，可以在GetInstancePublishTaskState API 了解更多的状态', - 'description' => '任务状态，可以在GetInstancePublishTaskState API 了解更多的状态', - 'type' => 'string', - 'example' => 'FE_RUNNING', - ], - 'Response' => [ - 'title' => '任务id', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8521', - ], - 'BizTypeList' => [ - 'title' => '业务类型列表', - 'description' => '业务类型列表', - 'type' => 'array', - 'items' => [ - 'description' => '业务类型', - 'type' => 'string', - 'example' => 'robot', - ], - ], - 'CreateTime' => [ - 'title' => '任务创建的 UTC 时间', - 'description' => '任务创建的 UTC 时间', - 'type' => 'string', - 'example' => '2021-09-11T09:26:14Z', - ], - 'CreateUserId' => [ - 'title' => '任务创建人Id', - 'description' => '任务创建人ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9052', - ], - 'Error' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => '检查待发布模块是否空闲发生错误，faq', - ], - 'Id' => [ - 'title' => '任务id', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8521', - ], - 'CreateUserName' => [ - 'title' => '任务创建人', - 'description' => '任务创建人', - 'type' => 'string', - 'example' => 'xuqiang_test', - ], - ], - ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['title' => '文档标题', 'description' => '文档标题', 'type' => 'string', 'required' => true, 'example' => '测试标题', 'maxLength' => 128, 'minLength' => 1], ], - ], - 'responseDemo' => '', - 'title' => '机器人-删除', - ], - 'UpdateInstance' => [ - 'summary' => '更新机器人名称，描述。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['title' => '文档内容', 'description' => '文档内容,与URL二选一', 'type' => 'string', 'required' => false, 'example' => '测试内容'], ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Config', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'schema' => ['title' => '文档解析/切分配置'."\n" + .'配置项：切分器'."\n" + .'KEY：Splitter'."\n" + .'值选项：ParagraphSplitter-识别层级'."\n" + .'值选项：TreeSplitter-规则层级'."\n" + ."\n" + .'配置项：文档切块大小'."\n" + .'KEY：ChunkSize'."\n" + .'VALUE：默认500；范围[200,800]'."\n" + ."\n" + .'配置项：规则层级'."\n" + .'KEY：TreePatterns'."\n" + .'VALUE：默认[]'."\n" + ."\n" + .'配置项：文档标题来源'."\n" + .'KEY：TitleSource'."\n" + .'值选项：ocrTitle - OCR识别标题【默认】'."\n" + .'值选项：docName - 文档名即标题', 'description' => '文档解析/切分配置'."\n" + .'配置项：切分器'."\n" + .'KEY：Splitter'."\n" + .'值选项：ParagraphSplitter-识别层级'."\n" + .'值选项：TreeSplitter-规则层级'."\n" + ."\n" + .'配置项：文档切块大小'."\n" + .'KEY：ChunkSize'."\n" + .'VALUE：默认500；范围[200,800]'."\n" + ."\n" + .'配置项：规则层级'."\n" + .'KEY：TreePatterns'."\n" + .'VALUE：默认[]'."\n" + ."\n" + .'配置项：文档标题来源'."\n" + .'KEY：TitleSource'."\n" + .'值选项：ocrTitle - OCR识别标题【默认】'."\n" + .'值选项：docName - 文档名即标题', 'type' => 'string', 'required' => false, 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":""}'], ], [ - 'name' => 'Name', + 'name' => 'Meta', 'in' => 'query', - 'schema' => [ - 'title' => '要修改的机器人名称', - 'description' => '要修改的机器人名称，最多50个字符', - 'type' => 'string', - 'required' => false, - 'example' => '智能客服-小C', - ], + 'schema' => ['title' => '文档随路数据', 'description' => '文档随路数据', 'type' => 'string', 'required' => false, 'example' => '{"code":"xxx"}'], ], [ - 'name' => 'Introduction', + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['title' => '生效开始时间', 'description' => '生效开始时间UTC', 'type' => 'string', 'required' => false, 'example' => '2022-05-25T16:28:36Z'."\n"], + ], + [ + 'name' => 'EndDate', 'in' => 'query', + 'schema' => ['title' => '生效结束时间', 'description' => '生效结束时间UTC', 'type' => 'string', 'required' => false, 'example' => '2032-05-25T16:28:36Z'."\n"], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '文档链接URL路径 ', 'description' => '文档链接URL路径，与Content二选一，支持txt、pdf、markdown、doc、docx格式（单个文件：最多100页，txt小于200K，pdf小于100M，markdown小于200K，doc小于100M，docx小于100M）', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/example.pdf'], + ], + [ + 'name' => 'TagIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '要修改的机器人备注', - 'description' => '要修改的机器人备注', - 'type' => 'string', + 'description' => '标签ID列表', + 'type' => 'array', + 'items' => ['description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1201'], 'required' => false, - 'example' => '用于C端问答的机器人', ], ], [ - 'name' => 'AgentKey', + 'name' => 'DocMetadata', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BusinessViewId' => ['type' => 'string', 'required' => false, 'description' => ''], + 'BusinessViewName' => ['type' => 'string', 'required' => false, 'description' => ''], + 'MetaCellInfoDTOList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldCode' => ['type' => 'string', 'required' => false, 'description' => ''], + 'FieldName' => ['type' => 'string', 'required' => false, 'description' => ''], + 'Value' => ['type' => 'string', 'required' => false, 'description' => ''], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'description' => '', + ], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + 'description' => '', ], ], ], @@ -4803,534 +1930,196 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C45BFEE4-F657-1332-8B47-2C757B94C972', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '07B270A4-61D8-57F6-A609-A3C216CFB872'], + 'KnowledgeId' => ['description' => '知识ID'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30001905617'], ], ], ], ], - 'responseDemo' => '', - 'title' => '机器人-更新', - ], - 'LinkInstanceCategory' => [ - 'summary' => '机器人绑定知识类目。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"07B270A4-61D8-57F6-A609-A3C216CFB872\\",\\n \\"KnowledgeId\\": 30001905617\\n}","type":"json"}]', + 'title' => '文档新建', + 'changeSet' => [ + ['createdAt' => '2024-09-26T12:39:56.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-05-17T09:42:04.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDoc'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateFaq' => [ + 'summary' => '创建一条知识。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotW5WL9W', - ], + 'abilityTreeNodes' => ['FEATUREbeebot2KMN8Y'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '机器人唯一标识', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'CategoryIds', + 'name' => 'CategoryId', 'in' => 'formData', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '知识类目Id', - 'description' => '绑定到机器人的FAQ类目ID数组', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '[\\"30000065789\\"]', - ], + 'schema' => ['title' => '知识的类目ID', 'description' => '知识的类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000053274'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'name' => 'Title', + 'in' => 'formData', + 'schema' => ['title' => '知识标题', 'description' => '知识标题，字数上限：120字', 'type' => 'string', 'required' => true, 'example' => '测试标题'], ], [ - 'name' => 'AbilityType', - 'in' => 'query', - 'schema' => [ - 'description' => '类目的能力类型，如FAQ（高频问答），MRC（文档），默认FAQ', - 'type' => 'string', - 'required' => false, - 'example' => 'FAQ,MRC', - 'default' => 'FAQ', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'D8C96601-E645-1BD7-99F3-04EADAB84E29', - ], - ], - ], + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'required' => false, 'example' => '2022-05-25T16:28:36Z'], ], - ], - 'responseDemo' => '', - 'title' => '机器人-绑定类目', - ], - 'DescribeInstance' => [ - 'summary' => '查询机器人详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => ['title' => '失效时间', 'description' => '失效时间', 'type' => 'string', 'required' => false, 'example' => '2030-12-31T16:00:00Z'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotW5WL9W', + [ + 'name' => 'SolutionContent', + 'in' => 'formData', + 'schema' => ['title' => '默认答案内容', 'description' => '默认答案内容（如果兜底视角开启，则此项必填）', 'type' => 'string', 'required' => false, 'example' => '测试答案'], ], - ], - 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'name' => 'SolutionType', + 'in' => 'formData', + 'schema' => ['title' => '默认答案类型', 'description' => '默认答案类型：0-纯文本，1-富文本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', + 'name' => 'TagIdList', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'title' => '标签ID列表', + 'description' => '标签ID列表', + 'type' => 'array', + 'items' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25645645'], 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '907AA5F2-0521-49AB-80AB-1ADEFAB2B901', - ], - 'InstanceId' => [ - 'title' => '机器人唯一标识', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], - 'Name' => [ - 'title' => '机器人名称', - 'description' => '机器人名称', - 'type' => 'string', - 'example' => '智能客服-小C', - ], - 'TimeZone' => [ - 'title' => '机器人的时区，参考《公共-时区码》', - 'description' => '机器人的时区，参考《公共-时区码》', - 'type' => 'string', - 'example' => 'Asia/Chongqing', - ], - 'Introduction' => [ - 'title' => '机器人备注', - 'description' => '机器人备注', - 'type' => 'string', - 'example' => '用于C端问答的机器人', - ], - 'LanguageCode' => [ - 'title' => '机器人服务的语言，如zh-cn、en-us', - 'description' => '机器人服务的语言，如zh-cn、en-us', - 'type' => 'string', - 'enumValueTitles' => [ - 'en-us' => '英文', - 'zh-cn' => '中文', - ], - 'example' => 'zh-cn', - ], - 'RobotType' => [ - 'title' => '机器人类型', - 'description' => '机器人类型', - 'type' => 'string', - 'enumValueTitles' => [ - 'scenario_callout' => '外呼机器人', - 'scenario_im' => '在线文本机器人', - 'scenario_ivr' => '导航机器人', - ], - 'example' => 'scenario_im', - ], - 'Avatar' => [ - 'title' => '机器人头像的URL', - 'description' => '机器人头像的URL', - 'type' => 'string', - 'example' => '/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png', - ], - 'EditStatus' => [ - 'title' => '机器人状态： EDITING(编辑中)、 PUBLISHED(已发布)', - 'description' => '机器人状态', - 'type' => 'string', - 'enumValueTitles' => [ - 'PUBLISHED' => '已发布', - 'EDITING' => '编辑中', - ], - 'example' => 'PUBLISHED', - ], - 'CreateTime' => [ - 'title' => '机器人创建的 UTC 时间', - 'description' => '机器人创建的 UTC 时间', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'Categories' => [ - 'title' => '类目列表', - 'description' => '类目列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CategoryId' => [ - 'title' => '类目id', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000066832', - ], - 'Name' => [ - 'title' => '类目名称', - 'description' => '类目名称', - 'type' => 'string', - 'example' => '杭州市防疫政策', - ], - 'ParentCategoryId' => [ - 'title' => '父类目id，-1表示根目录', - 'description' => '父类目ID，-1表示根目录', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'AbilityType' => [ - 'description' => '类目的能力类型，如FAQ（高频问答），MRC（文档）', - 'type' => 'string', - 'example' => 'FAQ', - ], - ], - ], - ], + 'KnowledgeId' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F'], ], ], ], ], - 'responseDemo' => '', - 'title' => '获取机器人详情', - 'responseParamsDescription' => '### 示例'."\n" - .'#### 响应报文：'."\n" - ."\n" - .'```json'."\n" - .'{'."\n" - .' "Name": "test1",'."\n" - .' "LanguageCode": "zh-cn",'."\n" - .' "RobotType":"scenario_im",'."\n" - .' "Introduction": "客户演示",'."\n" - .' "InstanceId": "chatbot-cn-mp90s2lrk00050",'."\n" - .' "CreateTime": "2018-09-11T09:26:14Z",'."\n" - .' "RequestId": "E7661C58-9CE7-4754-AB98-9BA40EAA7C27",'."\n" - .' "Avatar": "//gw.alicdn.com/tfs/TB1N5CwqTtYBeNjy1XdXXXXyVXa-90-97.png",'."\n" - .' "TimeZone": "Asia/Chongqing",'."\n" - .' "Categories": ['."\n" - .' {'."\n" - .' "Name": "测试类目test11",'."\n" - .' "ParentCategoryId": -1,'."\n" - .' "CategoryId": 1000006427'."\n" - .' }'."\n" - .' ]'."\n" - .'}'."\n" - .'```', - ], - 'ListInstance' => [ - 'summary' => '查询机器人列表。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeId\\": 30001979424,\\n \\"RequestId\\": \\"28805A7C-D695-548C-A31B-67E52C2C274F\\"\\n}","type":"json"}]', + 'title' => '创建FAQ', + 'changeSet' => [ + ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFaq'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateInstance' => [ + 'summary' => '创建沙箱环境机器人。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotW5WL9W', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '分页-第几页，默认1', - 'description' => '分页-第几页，默认1', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '机器人名称，不超过50字', 'description' => '机器人名称，不超过50个字符', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '小蜜机器人'], ], [ - 'name' => 'PageSize', + 'name' => 'LanguageCode', 'in' => 'query', - 'schema' => [ - 'title' => '分页-页面大小，默认10', - 'description' => '分页-页面大小，默认10', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '机器人服务的语言，如zh-cn、en-us，参考 http://www.lingoes.net/zh/translator/langcode.htm 入参全小写，当前只支持 zh-cn、en-us', 'description' => '机器人服务的语言，如zh-cn、en-us，默认值为业务空间的默认语言。可选值为业务空间支持的语言', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'zh-cn'], ], [ - 'name' => 'RobotType', + 'name' => 'Introduction', 'in' => 'query', - 'schema' => [ - 'title' => '按机器人类型筛选', - 'description' => '按机器人类型筛选', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'scenario_callout' => '外呼机器人', - 'scenario_im' => '在线文本机器人', - 'scenario_ivr' => '导航机器人', - ], - 'example' => 'scenario_im', - ], + 'schema' => ['title' => '机器人备注，不超过50字', 'description' => '机器人备注，不超过50字', 'type' => 'string', 'required' => false, 'example' => '用于手机app的小蜜机器人'], ], [ - 'name' => 'Name', + 'name' => 'RobotType', 'in' => 'query', 'schema' => [ - 'title' => '按机器人名称模糊搜索', - 'description' => '按机器人名称模糊搜索', + 'title' => '机器人类型', + 'description' => '机器人类型，默认为scenario_im', 'type' => 'string', 'required' => false, - 'example' => '售前客服', + 'enumValueTitles' => ['scenario_callout' => '外呼机器人', 'scenario_im' => '在线文本机器人', 'scenario_ivr' => '导航机器人'], + 'example' => 'scenario_im', ], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - [ - 'name' => 'Sandbox', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Instances' => [ - 'title' => '机器人列表信息', - 'description' => '机器人列表信息', - 'type' => 'array', - 'items' => [ - 'description' => '机器人信息', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '机器人唯一标识', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], - 'Name' => [ - 'title' => '机器人名称', - 'description' => '机器人名称', - 'type' => 'string', - 'example' => '智能客服-小C', - ], - 'Introduction' => [ - 'title' => '机器人备注', - 'description' => '机器人备注', - 'type' => 'string', - 'example' => '用于C端问答的机器人', - ], - 'LanguageCode' => [ - 'title' => '机器人服务的语言', - 'description' => '机器人服务的语言，如 zh-cn、en-us，参考 http://www.lingoes.net/zh/translator/langcode.htm ', - 'type' => 'string', - 'example' => 'zh-cn', - ], - 'RobotType' => [ - 'title' => '机器人类型', - 'description' => '机器人类型', - 'type' => 'string', - 'enumValueTitles' => [ - 'scenario_callout' => '外呼机器人', - 'scenario_im' => '在线文本机器人', - 'scenario_ivr' => '导航机器人', - ], - 'example' => 'scenario_im', - ], - 'Avatar' => [ - 'title' => '机器人头像的URL', - 'description' => '机器人头像的URL', - 'type' => 'string', - 'example' => '/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png', - ], - 'CreateTime' => [ - 'title' => '机器人创建的 UTC 时间', - 'description' => '机器人创建的 UTC 时间', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '总条数', - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'PageSize' => [ - 'title' => '分页-页面大小', - 'description' => '分页-页面大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'PageNumber' => [ - 'title' => '分页-第几页', - 'description' => '分页-第几页', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A'], + 'InstanceId' => ['title' => '机器人唯一标识', 'description' => '机器人唯一标识', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050'], ], ], ], ], - 'responseDemo' => '', - 'title' => '机器人-列表', - 'responseParamsDescription' => '### 示例'."\n" - .'#### 响应报文：'."\n" - .'```json'."\n" - .' {'."\n" - .' "PageNumber": 1,'."\n" - .' "TotalCount": 1,'."\n" - .' "PageSize": 10,'."\n" - .' "RequestId": "787B6D28-A81E-486F-BC8C-64ADED337B25",'."\n" - .' "Instances":['."\n" - .' {'."\n" - .' "InstanceId":"chatbot-cn-xxxxx",'."\n" - .' "Avatar":"/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png",'."\n" - .' "LanguageCode":"zh-cn",'."\n" - .' "RobotType":"scenario_im",'."\n" - .' "Name":"智能客服-小C",'."\n" - .' "Introduction":"用于C端问答的机器人",'."\n" - .' "CreateTime":"2021-08-12T16:00:01Z"'."\n" - .' }'."\n" - .' ]'."\n" - .'}'."\n" - ."\n" - .'```', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A\\",\\n \\"InstanceId\\": \\"chatbot-cn-mp90s2lrk00050\\"\\n}","type":"json"}]', + 'title' => '机器人-创建', + 'changeSet' => [ + ['createdAt' => '2022-06-20T11:28:21.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-10T03:13:25.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], ], 'CreateInstancePublishTask' => [ 'summary' => '将沙箱机器人发布到线上。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5342,25 +2131,12 @@ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人唯一标识', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'schema' => ['title' => '机器人唯一标识', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -5370,78 +2146,31 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', - ], - 'Id' => [ - 'title' => '任务Id', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8522', - ], - 'Response' => [ - 'title' => '任务Id', - 'description' => '任务ID', - 'type' => 'string', - 'example' => '8522', - ], + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D'], + 'Id' => ['title' => '任务Id', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8522'], + 'Response' => ['title' => '任务Id', 'description' => '任务ID', 'type' => 'string', 'example' => '8522'], 'Status' => [ 'title' => '任务状态', 'description' => '任务状态', 'type' => 'string', - 'enumValueTitles' => [ - 'FE_SUCCESS' => '发布成功', - 'FE_ABORTED' => '发布取消', - 'FE_WARNING' => '有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', - 'FE_FAILED' => '发布失败', - 'FE_RUNNING' => '正在发布中', - ], + 'enumValueTitles' => ['FE_SUCCESS' => '发布成功', 'FE_ABORTED' => '发布取消', 'FE_WARNING' => '有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_FAILED' => '发布失败', 'FE_RUNNING' => '正在发布中'], 'example' => 'FE_RUNNING', - 'enum' => [ - 'FE_RUNNING：正在发布中', - 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', - 'FE_SUCCESS：发布成功', - 'FE_FAILED：发布失败', - 'FE_ABORTED：发布取消', - ], + 'enum' => ['FE_RUNNING：正在发布中', 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '业务类型列表', 'type' => 'array', - 'items' => [ - 'description' => '发布任务的业务类型', - 'type' => 'string', - 'example' => 'robot', - ], - ], - 'Error' => [ - 'title' => 'job失败信息', - 'description' => 'job失败信息', - 'type' => 'string', - 'example' => '检查待发布模块是否空闲发生错误,faq', - ], - 'CreateTime' => [ - 'title' => '任务创建的 UTC 时间', - 'description' => '任务创建的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'ModifyTime' => [ - 'title' => '任务修改的 UTC 时间', - 'description' => '任务修改的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:33Z', + 'items' => ['description' => '发布任务的业务类型', 'type' => 'string', 'example' => 'robot'], ], + 'Error' => ['title' => 'job失败信息', 'description' => 'job失败信息', 'type' => 'string', 'example' => '检查待发布模块是否空闲发生错误,faq'], + 'CreateTime' => ['title' => '任务创建的 UTC 时间', 'description' => '任务创建的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'ModifyTime' => ['title' => '任务修改的 UTC 时间', 'description' => '任务修改的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z'], ], ], ], ], - 'responseDemo' => '', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误,faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\"\\n}","type":"json"}]', 'title' => '创建机器人发布任务', 'responseParamsDescription' => "\n" .'### 示例'."\n" @@ -5461,217 +2190,263 @@ .'}'."\n" ."\n" .'```', - ], - 'CancelInstancePublishTask' => [ - 'summary' => '在发布机器人的过程中，取消机器人发布任务。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstancePublishTask'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateIntent' => [ + 'summary' => '新建意图，主要包含意图的meta信息，如：意图名称、意图别名、意图关联词槽信息；不包含意图话术、LGF。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'Id', + 'name' => 'IntentDefinition', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, + 'title' => '意图定义结构体', + 'description' => '意图定义结构体', + 'type' => 'object', + 'properties' => [ + 'IntentName' => ['title' => '意图名称', 'description' => '意图名称', 'type' => 'string', 'required' => true, 'example' => '查天气意图'], + 'AliasName' => ['title' => '意图别名', 'description' => '意图别名', 'type' => 'string', 'required' => false, 'example' => '查天气意图'], + 'SlotInfos' => [ + 'title' => '槽位信息', + 'description' => '槽位信息', + 'type' => 'array', + 'items' => [ + 'description' => '滑槽信息', + 'type' => 'object', + 'properties' => [ + 'SlotId' => ['description' => '滑槽ID', 'type' => 'string', 'required' => true, 'example' => 'fg452dfg3df23'], + 'Name' => ['title' => '槽位名', 'description' => '槽位名', 'type' => 'string', 'required' => true, 'example' => '天气'], + 'Value' => ['title' => '关联的实体名', 'description' => '关联的实体名', 'type' => 'string', 'required' => true, 'example' => '天气'], + 'Interactive' => ['title' => '是否交互式', 'description' => '是否交互式', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Array' => ['title' => '是否数组', 'description' => '是否数组', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Encrypt' => ['title' => '是否脱敏', 'description' => '是否脱敏', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, 'docRequired' => true, - 'example' => '8521', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息', + 'type' => 'object', + 'properties' => [ + 'IntentId' => ['description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'example' => '43546474'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'df56gjh5et34g3g3'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorIntent.OutRange', 'errorMessage' => 'The business error Intent is out of range.', 'description' => ''], + ['errorCode' => 'BusinessErrorIntentName.OutRange', 'errorMessage' => 'The business error IntentName is out of range.', 'description' => ''], + ['errorCode' => 'BusinessErrorIntentName.Repeat', 'errorMessage' => 'The business error IntentName is repeat.', 'description' => ''], + ['errorCode' => 'BusinessErrorIntentName.InvalidCharactor', 'errorMessage' => 'The business error IntentName contains invalid charactor.', 'description' => ''], + ['errorCode' => 'BusinessErrorIntentEntity.NotExists', 'errorMessage' => 'The business error IntentEntity is not exists.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IntentId\\": 43546474,\\n \\"RequestId\\": \\"df56gjh5et34g3g3\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIntentResponse>\\n <IntentId>43546474</IntentId>\\n <RequestId>df56gjh5et34g3g3</RequestId>\\n</CreateIntentResponse>","errorExample":""}]', + 'title' => '意图-创建', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntent'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'CreateLgf' => [ + 'summary' => '为指定意图创建高级语义配置（LGF）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'LgfDefinition', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'description' => 'LGF定义信息', + 'type' => 'object', + 'properties' => [ + 'IntentId' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '4675678567'], + 'RuleText' => ['title' => 'LGF配置', 'description' => 'LGF配置', 'type' => 'string', 'required' => true, 'example' => '.{0,10}北京天气'], + ], 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', - ], - 'Id' => [ - 'title' => '任务Id', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8522', - ], - 'Response' => [ - 'title' => '任务Id', - 'description' => '任务ID', - 'type' => 'string', - 'example' => '8522', - ], - 'Status' => [ - 'title' => '任务状态', - 'description' => '任务状态', - 'type' => 'string', - 'enumValueTitles' => [ - 'FE_SUCCESS' => '发布成功', - 'FE_ABORTED' => '发布取消', - 'FE_FAILED' => '发布失败', - 'FE_RUNNING' => '正在发布中', - ], - 'example' => 'FE_ABORTED', - 'enum' => [ - 'FE_RUNNING：正在发布中', - 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', - 'FE_SUCCESS：发布成功', - 'FE_FAILED：发布失败', - 'FE_ABORTED：发布取消', - ], - ], - 'BizTypeList' => [ - 'title' => '业务类型列表', - 'description' => '业务类型列表', - 'type' => 'array', - 'items' => [ - 'description' => '业务列表', - 'type' => 'string', - 'example' => 'robot', - ], - ], - 'Error' => [ - 'title' => 'job失败信息', - 'description' => 'job失败信息', - 'type' => 'string', - 'example' => '检查待发布模块是否空闲发生错误，faq', - ], - 'CreateTime' => [ - 'title' => '任务创建的 UTC 时间', - 'description' => '任务创建的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'ModifyTime' => [ - 'title' => '任务修改的 UTC 时间', - 'description' => '任务修改的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:33Z', - ], + 'LgfId' => ['description' => 'LGF ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123453433453'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'af5fg3sdf457j5'], ], ], ], ], - 'responseDemo' => '', - 'title' => '取消机器人发布', - 'responseParamsDescription' => '### 示例'."\n" - .'#### 响应报文：'."\n" - ."\n" - .'```json'."\n" - .'{'."\n" - .' "ModifyTime": "2022-04-14T03:43:55Z",'."\n" - .' "BizTypeList": ['."\n" - .' "robot"'."\n" - .' ],'."\n" - .' "CreateTime": "2022-04-14T03:43:54Z",'."\n" - .' "RequestId": "c2f542c6-f0e3-464c-9aaf-ad6f6eab8140",'."\n" - .' "Response": "5088",'."\n" - .' "Warnings": {'."\n" - .' "category_bind_chitchat": ['."\n" - .' "以下类目没有发布到正式环境:第一个闲聊包"'."\n" - .' ]'."\n" - .' },'."\n" - .' "Id": 5088,'."\n" - .' "Status": "FE_ABORTED"'."\n" - .'}'."\n" - ."\n" - .'```', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LgfId\\": 123453433453,\\n \\"RequestId\\": \\"af5fg3sdf457j5\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLgfResponse>\\n <LgfId>123453433453</LgfId>\\n <RequestId>af5fg3sdf457j5</RequestId>\\n</CreateLgfResponse>","errorExample":""}]', + 'title' => '意图-LGF-创建', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLgf'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], ], - 'ContinueInstancePublishTask' => [ - 'summary' => '机器人发布告警时，忽略告警并继续发布。', - 'methods' => [ - 'get', - 'post', + 'CreatePerspective' => [ + 'summary' => '创建视角。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '视角名称，长度不超过50字', 'description' => '视角名称，长度不超过50字', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '移动端视角'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '视角描述', 'description' => '视角描述', 'type' => 'string', 'required' => false, 'example' => '用于购物APP的移动端视角'], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101'], + 'PerspectiveId' => ['title' => '视角主键（code_id）', 'description' => '视角ID', 'type' => 'string', 'example' => '3001'], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F285D735-D580-18A8-B97F-B2E72B00F101\\",\\n \\"PerspectiveId\\": \\"3001\\"\\n}","type":"json"}]', + 'title' => '视角-创建', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePerspective'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'CreatePublishTask' => [ + 'summary' => '创建发布中心的发布任务。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'BizType', 'in' => 'query', 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', + 'title' => '发布任务的业务类型，若发布机器人请使用 CreateInstancePublishTask API', + 'description' => '发布单元类型，机器人发布请使用 CreateInstancePublishTask API', 'type' => 'string', 'required' => false, 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', + 'enumValueTitles' => ['chitchat' => '闲聊库', 'service_center' => '全局服务', 'faq' => '高频问答/FAQ知识库', 'dict' => '全局名词[仅旧版]', 'sensitive' => '全局敏感词', 'command' => '全局指令', 'mrc' => '文档库'], + 'example' => 'faq', + 'enum' => [], ], ], [ - 'name' => 'Id', + 'name' => 'DataIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '业务类型附加信息，当前仅支持BizType为faq的传参，此字段指定faq类目Id列表，表示只发布指定类目下面的faq知识', + 'description' => '附加发布信息，当前支持：如果BizType是faq，此字段填写类目ID，表示只发布这些类目下面的知识', + 'type' => 'array', + 'items' => ['title' => '具体附加发布信息，如faq类目信息'."\n", 'description' => 'FAQ类目ID', 'type' => 'string', 'required' => false, 'example' => '8521'], 'required' => false, - 'docRequired' => true, - 'example' => '8521', + 'enumValueTitles' => [], + 'example' => '["8521"]', ], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key，若不指定则请求默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -5681,135 +2456,52 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', - ], - 'Id' => [ - 'title' => '任务Id', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8522', - ], - 'Response' => [ - 'title' => '任务Id', - 'description' => '任务ID', - 'type' => 'string', - 'example' => '8522', - ], + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D'], + 'Id' => ['title' => '发布任务Id', 'description' => '发布任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8522'], + 'Response' => ['title' => '发布任务Id，冗余字段，建议使用Id字段获取发布任务Id', 'description' => '发布任务ID，冗余字段，建议使用发布任务ID', 'type' => 'string', 'example' => '8522'], 'Status' => [ - 'title' => '任务状态', - 'description' => '任务状态', + 'title' => '任务状态（ FE_RUNNING：正在发布中 FE_SUCCESS：发布成功 FE_FAILED：发布失败 FE_ABORTED：发布取消）', + 'description' => '任务状态'."\n" + .'枚举值：'."\n" + ."\n" + .'FE_RUNNING：正在发布中'."\n" + .'FE_SUCCESS：发布成功'."\n" + .'FE_FAILED：发布失败'."\n" + .'FE_ABORTED：发布取消', 'type' => 'string', - 'enumValueTitles' => [ - 'FE_SUCCESS' => '发布成功', - 'FE_ABORTED' => '发布取消', - 'FE_WARNING' => '发布警告', - 'FE_FAILED' => '发布失败', - 'FE_RUNNING' => '正在发布中', - ], 'example' => 'FE_RUNNING', - 'enum' => [ - 'FE_RUNNING：正在发布中', - 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', - 'FE_SUCCESS：发布成功', - 'FE_FAILED：发布失败', - 'FE_ABORTED：发布取消', - ], + 'enum' => ['FE_RUNNING：正在发布中', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '业务类型列表', 'type' => 'array', - 'items' => [ - 'description' => '业务类型', - 'type' => 'string', - 'example' => 'robot', - ], - ], - 'Error' => [ - 'title' => 'job失败信息', - 'description' => 'job失败信息', - 'type' => 'string', - 'example' => '检查待发布模块是否空闲发生错误，faq', - ], - 'CreateTime' => [ - 'title' => '任务创建的 UTC 时间', - 'description' => '任务创建的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'ModifyTime' => [ - 'title' => '任务修改的 UTC 时间', - 'description' => '任务修改的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:33Z', - ], - 'Warnings' => [ - 'title' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', - 'description' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', - 'type' => 'object', - 'example' => '{'."\n" - .' "category_bind_faq": ['."\n" - .' "以下类目没有发布到正式环境: 项目交付信息汇总"'."\n" - .' ]'."\n" - .'}', - ], - 'Errors' => [ - 'title' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', - 'description' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', - 'type' => 'object', - 'example' => '{}', + 'items' => ['description' => '业务类型', 'type' => 'string', 'example' => 'faq'], ], + 'Error' => ['title' => '发布任务失败信息', 'description' => '任务失败信息', 'type' => 'string', 'example' => '检查待发布模块是否空闲发生错误，faq'], + 'CreateTime' => ['title' => '任务创建的 UTC 时间', 'description' => '任务创建的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'ModifyTime' => ['title' => '任务修改的 UTC 时间', 'description' => '任务修改的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z'], ], ], ], ], - 'responseDemo' => '', - 'title' => '继续机器人发布', - 'responseParamsDescription' => '### Warnings&Errors 子发布模块枚举：'."\n" - .'| key值 | 含义 |'."\n" - .'| --- | --- |'."\n" - .'| category_bind\\_chitchat | 闲聊绑定关系 |'."\n" - .'| category_bind\\_faq | faq的绑定关系 |'."\n" - .'| robot_ds | 对话工厂对话流 |'."\n" - .'| ds_entity | 对话工厂实体 |'."\n" - .'| ds_intent | 对话工厂意图 |'."\n" - ."\n" - .'### 示例'."\n" - .'#### 响应报文：'."\n" - .'```json'."\n" - .'{'."\n" - .' "ModifyTime": "2022-04-12T06:32:59Z",'."\n" - .' "BizTypeList": ['."\n" - .' "robot"'."\n" - .' ],'."\n" - .' "CreateTime": "2022-04-12T06:30:17Z",'."\n" - .' "RequestId": "1b6318c2-df76-4117-9c2c-02e22940ff24",'."\n" - .' "Response": "4930",'."\n" - .' "Warnings": {'."\n" - .' "category_bind_faq": ['."\n" - .' "以下类目没有发布到正式环境: 项目交付信息汇总"'."\n" - .' ]'."\n" - .' },'."\n" - .' "Id": 4930,'."\n" - .' "Status": "FE_RUNNING"'."\n" - .'}'."\n" - .'```', - ], - 'GetInstancePublishTaskState' => [ - 'summary' => '查询机器人发布进度。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"faq\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\"\\n}","type":"json"}]', + 'title' => '创建发布任务', + 'changeSet' => [ + ['createdAt' => '2022-12-26T11:37:56.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePublishTask'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateSimQuestion' => [ + 'summary' => '创建相似问题。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5819,193 +2511,50 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'chatbot-cn-mp90s2lrk00050', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '8521', - ], + 'name' => 'KnowledgeId', + 'in' => 'formData', + 'schema' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'name' => 'Title', + 'in' => 'formData', + 'schema' => ['title' => '相似问标题，字数上限-120', 'description' => '相似问标题，字数上限：120字', 'type' => 'string', 'required' => true, 'example' => '测试相似问标题'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', - ], - 'Id' => [ - 'title' => '任务Id', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8522', - ], - 'Response' => [ - 'title' => '任务Id', - 'description' => '任务ID', - 'type' => 'string', - 'example' => '8522', - ], - 'Status' => [ - 'title' => '任务状态', - 'description' => '任务状态', - 'type' => 'string', - 'enumValueTitles' => [ - 'FE_SUCCESS' => '发布成功', - 'FE_ABORTED' => '发布取消', - 'FE_WARNING' => '有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', - 'FE_FAILED' => '发布失败', - 'FE_RUNNING' => '正在发布中', - ], - 'example' => 'FE_RUNNING', - 'enum' => [ - 'FE_RUNNING：正在发布中', - 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', - 'FE_SUCCESS：发布成功', - 'FE_FAILED：发布失败', - 'FE_ABORTED：发布取消', - ], - ], - 'BizTypeList' => [ - 'title' => '业务类型列表', - 'description' => '业务类型列表', - 'type' => 'array', - 'items' => [ - 'description' => '发布任务的业务类型', - 'type' => 'string', - 'example' => 'robot', - ], - ], - 'Error' => [ - 'title' => 'job失败信息', - 'description' => 'job失败信息', - 'type' => 'string', - 'example' => '检查待发布模块是否空闲发生错误，faq', - ], - 'CreateTime' => [ - 'title' => '任务创建的 UTC 时间', - 'description' => '任务创建的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'ModifyTime' => [ - 'title' => '任务修改的 UTC 时间', - 'description' => '任务修改的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:33Z', - ], - 'Warnings' => [ - 'title' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', - 'description' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', - 'type' => 'object', - 'example' => '{'."\n" - .' "category_bind_faq": ['."\n" - .' "以下类目没有发布到正式环境：项目交付类目"'."\n" - .' ]'."\n" - .'}', - ], - 'Errors' => [ - 'title' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', - 'description' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', - 'type' => 'object', - 'example' => '{'."\n" - .' "robot_ds": ['."\n" - .' "{\\"dialogName\\":\\"TEST\\",\\"errorMessage\\":[\\"medusa@invocation.error.service.offline@请发布对话流所引用服务后重试！\\"],\\"needRefresh\\":false,\\"success\\":false}"'."\n" - .' ]'."\n" - .'}', - ], + 'SimQuestionId' => ['title' => '相似问ID', 'description' => '相似问ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000002788'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '16AC1B3C-66E0-438B-BB7C-71B692407B67'], ], ], ], ], - 'responseDemo' => '', - 'title' => '查询机器人发布进度', - 'responseParamsDescription' => "\n" - .'### Status字段枚举：'."\n" - .'| 字段名 | 枚举值 | 含义 |'."\n" - .'| --- | --- | --- |'."\n" - .'| Status | FE_RUNNING | 正在发布中 |'."\n" - .'| Status | FE_WARNING | 有警告，若需继续，请调用`ContinueInstancePublishTask`接口继续发布 |'."\n" - .'| Status | FE_SUCCESS | 发布成功 |'."\n" - .'| Status | FE_FAILED | 发布失败 |'."\n" - .'| Status | FE_ABORTED | 发布取消 |'."\n" - ."\n" - .'### Warnings&Errors 子发布模块枚举：'."\n" - .'| key值 | 含义 |'."\n" - .'| --- | --- |'."\n" - .'| category\\_bind\\_chitchat | 闲聊绑定关系 |'."\n" - .'| category\\_bind\\_faq | faq的绑定关系 |'."\n" - .'| robot_ds | 对话工厂对话流 |'."\n" - .'| ds_entity | 对话工厂实体 |'."\n" - .'| ds_intent | 对话工厂意图 |'."\n" - ."\n" - .'### 示例'."\n" - .'#### 响应报文：'."\n" - ."\n" - .'```json'."\n" - .'{'."\n" - .' "ModifyTime": "2022-04-12T06:30:21Z",'."\n" - .' "BizTypeList": ['."\n" - .' "robot"'."\n" - .' ],'."\n" - .' "CreateTime": "2022-04-12T06:30:17Z",'."\n" - .' "RequestId": "cddf472f-6ce3-4eef-a969-1e8b16850cb4",'."\n" - .' "Response": "4930",'."\n" - .' "Warnings": {'."\n" - .' "category_bind_faq": ['."\n" - .' "以下类目没有发布到正式环境：项目交付类目"'."\n" - .' ]'."\n" - .' },'."\n" - .' "Id": 4930,'."\n" - .' "Status": "FE_WARNING"'."\n" - .'}'."\n" - .'```', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SimQuestionId\\": 1000002788,\\n \\"RequestId\\": \\"16AC1B3C-66E0-438B-BB7C-71B692407B67\\"\\n}","type":"json"}]', + 'title' => '创建相似问', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSimQuestion'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], ], 'CreateSolution' => [ 'summary' => '创建知识答案。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6017,49 +2566,23 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotVKU6KE', - ], + 'abilityTreeNodes' => ['FEATUREbeebotVKU6KE'], ], 'parameters' => [ [ 'name' => 'KnowledgeId', 'in' => 'query', - 'schema' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], + 'schema' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617'], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'title' => '答案内容', - 'description' => '答案内容', - 'type' => 'string', - 'required' => true, - 'example' => '答案内容', - ], + 'schema' => ['title' => '答案内容', 'description' => '答案内容', 'type' => 'string', 'required' => true, 'example' => '答案内容'], ], [ 'name' => 'ContentType', 'in' => 'query', - 'schema' => [ - 'title' => '答案类型', - 'description' => '答案类型：0-纯文本，1-富文本', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '答案类型', 'description' => '答案类型：0-纯文本，1-富文本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PerspectiveCodes', @@ -6069,12 +2592,7 @@ 'title' => '视角code列表', 'description' => '视角code列表', 'type' => 'array', - 'items' => [ - 'description' => '视角code', - 'type' => 'string', - 'required' => false, - 'example' => 'm8qAIvUUAIf', - ], + 'items' => ['description' => '视角code', 'type' => 'string', 'required' => false, 'example' => 'm8qAIvUUAIf'], 'required' => true, 'maxItems' => 10, ], @@ -6087,27 +2605,14 @@ 'title' => '标签ID列表', 'description' => '标签ID列表', 'type' => 'array', - 'items' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '25645645', - ], + 'items' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25645645'], 'required' => false, ], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -6118,277 +2623,177 @@ 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419', - ], - 'SolutionId' => [ - 'title' => '答案ID', - 'description' => '答案ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001089003', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419'], + 'SolutionId' => ['title' => '答案ID', 'description' => '答案ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100001089003'], ], ], ], ], - 'responseDemo' => '', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F55D90C1-31BE-4B2A-AA3F-25EFC36F9419\\",\\n \\"SolutionId\\": 100001089003\\n}","type":"json"}]', 'title' => '创建FAQ答案', - ], - 'DeleteSolution' => [ - 'summary' => '删除答案。', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSolution'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'CreateUserSay' => [ + 'summary' => '为指定意图添加话术的信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SolutionId', - 'in' => 'formData', - 'schema' => [ - 'title' => '答案ID', - 'description' => '答案ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '100001321580', - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'UserSayDefinition', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'description' => '用户话术定义信息', + 'type' => 'object', + 'properties' => [ + 'IntentId' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123232'], + 'Content' => ['title' => '用户话术', 'description' => '用户话术', 'type' => 'string', 'required' => true, 'example' => '请问明天北京的天气'], + 'SlotInfos' => [ + 'title' => '划槽信息', + 'description' => '划槽信息', + 'type' => 'array', + 'items' => [ + 'description' => '滑槽信息说明', + 'type' => 'object', + 'properties' => [ + 'SlotId' => ['title' => '划槽ID', 'description' => '划槽ID', 'type' => 'string', 'required' => false, 'example' => 'fb34adf2fv43f2'], + 'StartIndex' => ['title' => '槽位在意图话术中的起始下标', 'description' => '槽位在意图话术中的起始下标', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + 'EndIndex' => ['title' => '槽位在意图话术中的结束下标（不含）', 'description' => '槽位在意图话术中的结束下标（不含）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => 'F79E7305-5314-5069-A701-9591AD051902', - ], + 'UserSayId' => ['description' => '意图-话术唯一ID', 'type' => 'integer', 'format' => 'int64', 'example' => '46456176856'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8g4n8bnd236fg79'], ], ], ], ], - 'responseDemo' => '', - 'title' => '删除FAQ答案', - ], - 'UpdateSolution' => [ - 'summary' => '更新答案。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"UserSayId\\": 46456176856,\\n \\"RequestId\\": \\"8g4n8bnd236fg79\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateUserSayResponse>\\n <UserSayId>46456176856</UserSayId>\\n <RequestId>8g4n8bnd236fg79</RequestId>\\n</CreateUserSayResponse>","errorExample":""}]', + 'title' => '意图-话术创建', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserSay'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteCategory' => [ + 'summary' => '删除类目， 已发布的类目变成已删除未发布状态，未发布的类目则直接删除。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotVKU6KE', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SolutionId', - 'in' => 'formData', - 'schema' => [ - 'title' => '答案ID', - 'description' => '答案ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '100001333260', - ], - ], - [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'title' => '答案内容', - 'description' => '答案内容', - 'type' => 'string', - 'required' => true, - 'example' => '修改的答案内容', - ], - ], - [ - 'name' => 'ContentType', - 'in' => 'formData', - 'schema' => [ - 'title' => '答案类型', - 'description' => '答案类型：0-纯文本，1-富文本', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PerspectiveCodes', + 'name' => 'CategoryId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '视角code列表', - 'description' => '视角code列表', - 'type' => 'array', - 'items' => [ - 'description' => '视角code', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'required' => true, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'TagIdList', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '标签ID列表', - 'description' => '标签ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '25645645', - ], - 'required' => false, - ], + 'schema' => ['title' => '类目ID', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30000049006'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8B8F098D-A338-54DD-B19C-24BBBCBD8498', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55'], ], ], ], ], - 'responseDemo' => '', - 'title' => '更新FAQ答案', - ], - 'ListSolution' => [ - 'summary' => '查询知识的答案列表。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55\\"\\n}","type":"json"}]', + 'title' => '类目-删除', + 'changeSet' => [ + ['createdAt' => '2024-02-22T12:10:08.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCategory'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteConnQuestion' => [ + 'summary' => '删除知识的关联知识。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotVKU6KE', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'KnowledgeId', + 'name' => 'OutlineId', 'in' => 'formData', - 'schema' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], + 'schema' => ['description' => '关联关系ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '877397683'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -6399,300 +2804,213 @@ 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'Solutions' => [ - 'title' => '答案列表', - 'description' => '答案列表', - 'type' => 'array', - 'items' => [ - 'description' => '答案信息', - 'type' => 'object', - 'properties' => [ - 'SolutionId' => [ - 'title' => '答案ID', - 'description' => '答案ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '496', - ], - 'ModifyTime' => [ - 'title' => '修改时间(UTC 时间)', - 'description' => '修改时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-03-29T06:23:53Z', - ], - 'CreateTime' => [ - 'title' => '创建时间(UTC 时间)', - 'description' => '创建时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-03-29T03:55:04Z', - ], - 'Content' => [ - 'title' => '答案内容', - 'description' => '答案内容', - 'type' => 'string', - 'example' => '答案内容', - ], - 'ContentType' => [ - 'title' => '答案类型(0纯文本，1富文本）', - 'description' => '答案类型：0-纯文本，1-富文本', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PlainText' => [ - 'title' => '答案纯文本内容', - 'description' => '答案纯文本内容', - 'type' => 'string', - 'example' => '答案内容', - ], - 'PerspectiveCodes' => [ - 'title' => '视角code列表', - 'description' => '视角code列表', - 'type' => 'array', - 'items' => [ - 'description' => '视角code', - 'type' => 'string', - 'example' => 'm8qAIvUUAIf', - ], - ], - 'TagIdList' => [ - 'title' => '标签ID列表', - 'description' => '标签ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1232342', - ], - ], - ], - ], - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5B29DB5E-251D-5A73-84B5-A12DF795F231', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'FC323352-3AD7-59A1-9088-A64470BAFC9D'], ], ], ], ], - 'responseDemo' => '', - 'title' => '获取FAQ答案列表', - ], - 'CreateConnQuestion' => [ - 'summary' => '为知识添加关联知识。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC323352-3AD7-59A1-9088-A64470BAFC9D\\"\\n}","type":"json"}]', + 'title' => '删除FAQ关联问', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConnQuestion'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteDSEntity' => [ + 'summary' => '删除一个实体，会级联删除该实体下所有的实体成员及同义词、正则表达式。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ConnQuestionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '关联知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30002654628', - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'KnowledgeId', - 'in' => 'formData', - 'schema' => [ - 'description' => '知识ID'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30002174773', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'AgentKey', + 'name' => 'EntityId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', + 'title' => 'BaseResponse<EntityIdResponse>', 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => 'C191B48B-9268-4FB1-A3C2-5143B4A91D0C', - ], - 'OutlineId' => [ - 'title' => '关联关系ID', - 'description' => '关联关系ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000002123', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4dfghf56235asdf452'], + 'EntityId' => ['description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], ], ], ], ], - 'responseDemo' => '', - 'title' => '创建关联问', - ], - 'DeleteConnQuestion' => [ - 'summary' => '删除知识的关联知识。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4dfghf56235asdf452\\",\\n \\"EntityId\\": 123\\n}","errorExample":""},{"type":"xml","example":"<DeleteDSEntityResponse>\\n <RequestId>4dfghf56235asdf452</RequestId>\\n <EntityId>2345346475</EntityId>\\n</DeleteDSEntityResponse>","errorExample":""}]', + 'title' => '实体-删除', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDSEntity'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteDSEntityValue' => [ + 'summary' => '删除某个实体的某个成员；若为标准实体，会同步删除其同义词（若有）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OutlineId', - 'in' => 'formData', - 'schema' => [ - 'description' => '关联关系ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '877397683', - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '345346223452'], + ], + [ + 'name' => 'EntityValueId', + 'in' => 'query', + 'schema' => ['title' => '实体成员ID', 'description' => '实体成员ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '3453453452'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'FC323352-3AD7-59A1-9088-A64470BAFC9D', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'dfdf2t3rfvb45y'], + 'EntityValueId' => ['description' => '实体成员ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3453453452'], ], ], ], ], - 'responseDemo' => '', - 'title' => '删除FAQ关联问', - ], - 'UpdateConnQuestion' => [ - 'summary' => '更新关联关系。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], + ['errorCode' => 'BusinessErrorEntityValueId.NotExists', 'errorMessage' => 'The business error EntityValueId is not exists.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"dfdf2t3rfvb45y\\",\\n \\"EntityValueId\\": 3453453452\\n}","errorExample":""},{"type":"xml","example":"<DeleteDSEntityValueResponse>\\n <RequestId>dfdf2t3rfvb45y</RequestId>\\n <EntityValueId>3453453452</EntityValueId>\\n</DeleteDSEntityValueResponse>","errorExample":""}]', + 'title' => '实体-实体成员-删除', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDSEntityValue'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteDoc' => [ + 'summary' => '删除文档。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ConnQuestionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '关联知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '1000000295', - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'OutlineId', - 'in' => 'formData', + 'name' => 'KnowledgeId', + 'in' => 'query', + 'schema' => ['description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '30001905617'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '关联关系ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '877397683', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910'], + 'KnowledgeId' => ['description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30002406051'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DFB71B34-4188-4EA2-9988-EF3014E75910\\",\\n \\"KnowledgeId\\": 30002406051\\n}","type":"json"}]', + 'title' => '删除文档', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDoc'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'DeleteFaq' => [ + 'summary' => '删除一条知识。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ + 'name' => 'KnowledgeId', + 'in' => 'formData', + 'schema' => ['title' => '知识ID，创建知识该值为空', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617'], ], ], 'responses' => [ @@ -6703,28 +3021,26 @@ 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '004EB5C0-9DEB-53BF-A57A-0407A6D6B3C9', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902'], ], ], ], ], - 'responseDemo' => '', - 'title' => '更新FAQ关联问', - ], - 'ListConnQuestion' => [ - 'summary' => '查询知识的关联问题列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\"\\n}","type":"json"}]', + 'title' => '删除FAQ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaq'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteInstance' => [ + 'summary' => '删除沙箱和线上的机器人。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6734,299 +3050,237 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'KnowledgeId', - 'in' => 'formData', - 'schema' => [ - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B', - ], - 'Outlines' => [ - 'description' => '关联问题列表', + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D'], + 'Status' => ['title' => '任务状态，可以在GetInstancePublishTaskState API 了解更多的状态', 'description' => '任务状态，可以在GetInstancePublishTaskState API 了解更多的状态', 'type' => 'string', 'example' => 'FE_RUNNING'], + 'Response' => ['title' => '任务id', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8521'], + 'BizTypeList' => [ + 'title' => '业务类型列表', + 'description' => '业务类型列表', 'type' => 'array', - 'items' => [ - 'description' => '关联问信息', - 'type' => 'object', - 'properties' => [ - 'OutlineId' => [ - 'title' => '关联关系ID', - 'description' => '关联关系ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '797', - ], - 'ConnQuestionId' => [ - 'title' => '关联知识ID', - 'description' => '关联知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001979424', - ], - 'Title' => [ - 'title' => '关联知识题目', - 'description' => '关联知识标题', - 'type' => 'string', - 'example' => '关联问', - ], - 'ModifyTime' => [ - 'title' => '修改时间(UTC 时间)', - 'description' => '修改时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-26T10:18:15Z', - ], - 'CreateTime' => [ - 'title' => '创建时间(UTC 时间)', - 'description' => '创建时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-02-25T02:47:18Z', - ], - ], - ], + 'items' => ['description' => '业务类型', 'type' => 'string', 'example' => 'robot'], ], + 'CreateTime' => ['title' => '任务创建的 UTC 时间', 'description' => '任务创建的 UTC 时间', 'type' => 'string', 'example' => '2021-09-11T09:26:14Z'], + 'CreateUserId' => ['title' => '任务创建人Id', 'description' => '任务创建人ID', 'type' => 'integer', 'format' => 'int64', 'example' => '9052'], + 'Error' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '检查待发布模块是否空闲发生错误，faq'], + 'Id' => ['title' => '任务id', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8521'], + 'CreateUserName' => ['title' => '任务创建人', 'description' => '任务创建人', 'type' => 'string', 'example' => 'xuqiang_test'], ], ], ], ], - 'responseDemo' => '', - 'title' => '获取关联问列表', - ], - 'CreateSimQuestion' => [ - 'summary' => '创建相似问题。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"Response\\": 8521,\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"CreateTime\\": \\"2021-09-11T09:26:14Z\\",\\n \\"CreateUserId\\": 9052,\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"Id\\": 8521,\\n \\"CreateUserName\\": \\"xuqiang_test\\"\\n}","type":"json"}]', + 'title' => '机器人-删除', + 'changeSet' => [ + ['createdAt' => '2022-07-07T11:54:48.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteIntent' => [ + 'summary' => '删除一个意图，会级联删除该意图下所有的意图话术和高级语义配置（LGF）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'KnowledgeId', - 'in' => 'formData', - 'schema' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'Title', - 'in' => 'formData', - 'schema' => [ - 'title' => '相似问标题，字数上限-120', - 'description' => '相似问标题，字数上限：120字', - 'type' => 'string', - 'required' => true, - 'example' => '测试相似问标题', - ], + 'name' => 'IntentId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12345'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'SimQuestionId' => [ - 'title' => '相似问ID', - 'description' => '相似问ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000002788', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '16AC1B3C-66E0-438B-BB7C-71B692407B67', - ], + 'IntentId' => ['description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3464dfg3qwr34tf34'], ], ], ], ], - 'responseDemo' => '', - 'title' => '创建相似问', - ], - 'DeleteSimQuestion' => [ - 'summary' => '删除相似问题。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IntentId\\": 12345,\\n \\"RequestId\\": \\"3464dfg3qwr34tf34\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIntentResponse>\\n <IntentId>12345</IntentId>\\n <RequestId>3464dfg3qwr34tf34</RequestId>\\n</DeleteIntentResponse>","errorExample":""}]', + 'title' => '意图-删除', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntent'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteLgf' => [ + 'summary' => '删除指定高级语义配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'SimQuestionId', - 'in' => 'formData', - 'schema' => [ - 'title' => '相似问ID', - 'description' => '相似问ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '1000002788', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => ['description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '23242342'], + ], + [ + 'name' => 'LgfId', + 'in' => 'query', + 'schema' => ['description' => 'lgf Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '2342424'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '6419BA93-D111-5225-8998-13E63E6D3940', - ], + 'LgfId' => ['description' => 'LGF ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2342424'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'dgw2342424qw42'], ], ], ], ], - 'responseDemo' => '', - 'title' => '删除FAQ相似问', - ], - 'UpdateSimQuestion' => [ - 'summary' => '更新相似问题。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LgfId\\": 2342424,\\n \\"RequestId\\": \\"dgw2342424qw42\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLgfResponse>\\n <LgfId>2342424</LgfId>\\n <RequestId>dgw2342424qw42</RequestId>\\n</DeleteLgfResponse>","errorExample":""}]', + 'title' => '意图-LGF-删除', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLgf'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeletePerspective' => [ + 'summary' => '删除视角。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ + 'name' => 'PerspectiveId', + 'in' => 'query', + 'schema' => ['title' => '视角主键（code_id）', 'description' => '视角ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001'], + ], + [ 'name' => 'AgentKey', 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E'], + 'Result' => ['title' => '删除视角的结果', 'description' => '删除视角的结果', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC384CE1-8D42-1900-84E1-F33F990F2B5E\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => '视角-删除', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePerspective'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'DeleteSimQuestion' => [ + 'summary' => '删除相似问题。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Title', - 'in' => 'formData', - 'schema' => [ - 'title' => '相似问标题，字数上限-120', - 'description' => '相似问标题，字数上限：120字', - 'type' => 'string', - 'required' => true, - 'example' => '测试相似问标题', - ], + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ 'name' => 'SimQuestionId', 'in' => 'formData', - 'schema' => [ - 'title' => '相似问ID', - 'description' => '相似问ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '1000002788', - ], + 'schema' => ['title' => '相似问ID', 'description' => '相似问ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000002788'], ], ], 'responses' => [ @@ -7037,28 +3291,26 @@ 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '6419BA93-D111-5225-8998-13E63E6D3940'], ], ], ], ], - 'responseDemo' => '', - 'title' => '更新FAQ相似问', - ], - 'ListSimQuestion' => [ - 'summary' => '查询知识的相似问题列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6419BA93-D111-5225-8998-13E63E6D3940\\"\\n}","type":"json"}]', + 'title' => '删除FAQ相似问', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSimQuestion'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteSolution' => [ + 'summary' => '删除答案。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7068,31 +3320,14 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'name' => 'SolutionId', + 'in' => 'formData', + 'schema' => ['title' => '答案ID', 'description' => '答案ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '100001321580'], ], [ - 'name' => 'KnowledgeId', - 'in' => 'formData', - 'schema' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30002299537', - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -7103,64 +3338,26 @@ 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51', - ], - 'SimQuestions' => [ - 'title' => '相似问列表', - 'description' => '相似问列表', - 'type' => 'array', - 'items' => [ - 'description' => '相似问信息', - 'type' => 'object', - 'properties' => [ - 'SimQuestionId' => [ - 'title' => '相似问ID', - 'description' => '相似问ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001979424', - ], - 'ModifyTime' => [ - 'title' => '修改时间(UTC 时间)', - 'description' => '修改时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-13T03:49:28Z', - ], - 'CreateTime' => [ - 'title' => '创建时间(UTC 时间)', - 'description' => '创建时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-30T02:08:33Z', - ], - 'Title' => [ - 'title' => '相似问标题', - 'description' => '相似问标题', - 'type' => 'string', - 'example' => '相似问', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902'], ], ], ], ], - 'responseDemo' => '', - 'title' => '获取FAQ相似问列表', - ], - 'CreateFaq' => [ - 'summary' => '创建一条知识。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\"\\n}","type":"json"}]', + 'title' => '删除FAQ答案', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSolution'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DeleteUserSay' => [ + 'summary' => '修改意图话术信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -7168,363 +3365,347 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebot2KMN8Y', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'CategoryId', - 'in' => 'formData', - 'schema' => [ - 'title' => '知识的类目ID', - 'description' => '知识的类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '1000053274', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => '343df2sdf23'], ], [ - 'name' => 'Title', - 'in' => 'formData', - 'schema' => [ - 'title' => '知识标题', - 'description' => '知识标题，字数上限：120字', - 'type' => 'string', - 'required' => true, - 'example' => '测试标题', - ], + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => ['description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5564564546'], ], [ - 'name' => 'StartDate', - 'in' => 'formData', - 'schema' => [ - 'title' => '生效时间', - 'description' => '生效时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-25T16:28:36Z', - ], + 'name' => 'UserSayId', + 'in' => 'query', + 'schema' => ['description' => '话术ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '4562121234'], ], - [ - 'name' => 'EndDate', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '失效时间', - 'description' => '失效时间', - 'type' => 'string', - 'required' => false, - 'example' => '2030-12-31T16:00:00Z', + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'UserSayId' => ['description' => '话术ID', 'type' => 'integer', 'format' => 'int64', 'example' => '4562121234'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'dfgdg324gf34t34g34g3'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"UserSayId\\": 4562121234,\\n \\"RequestId\\": \\"dfgdg324gf34t34g34g3\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteUserSayResponse>\\n <UserSayId>4562121234</UserSayId>\\n <RequestId>dfgdg324gf34t34g34g3</RequestId>\\n</DeleteUserSayResponse>","errorExample":""}]', + 'title' => '意图-话术-删除', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserSay'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'DescribeCategory' => [ + 'summary' => '查看单个类目信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SolutionContent', - 'in' => 'formData', - 'schema' => [ - 'title' => '默认答案内容', - 'description' => '默认答案内容（如果兜底视角开启，则此项必填）', - 'type' => 'string', - 'required' => false, - 'example' => '测试答案', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'SolutionType', + 'name' => 'CategoryId', 'in' => 'formData', - 'schema' => [ - 'title' => '默认答案类型', - 'description' => '默认答案类型：0-纯文本，1-富文本', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '类目ID', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30000049006'], ], [ - 'name' => 'TagIdList', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '标签ID列表', - 'description' => '标签ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '25645645', - ], - 'required' => false, - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'KnowledgeId' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001979424', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2B0304FD-3804-5C06-9A83-77F5523664AF'], + 'Category' => [ + 'title' => '类目信息', + 'description' => '类目信息', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => ['title' => '类目ID', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000049006'], + 'Name' => ['description' => '类⽬名称', 'type' => 'string', 'example' => '类目名称'], + 'ParentCategoryId' => ['description' => '⽗类⽬id，默认-1，对应根⽬录', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'Status' => ['description' => '类目状态 -1：已删除未发布状态，0：正常', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BizCode' => ['description' => '业务代码', 'type' => 'string', 'example' => 'bizcode123'], + ], ], ], ], ], ], - 'responseDemo' => '', - 'title' => '创建FAQ', - ], - 'DeleteFaq' => [ - 'summary' => '删除一条知识。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B0304FD-3804-5C06-9A83-77F5523664AF\\",\\n \\"Category\\": {\\n \\"CategoryId\\": 30000049006,\\n \\"Name\\": \\"类目名称\\",\\n \\"ParentCategoryId\\": -1,\\n \\"Status\\": 0,\\n \\"BizCode\\": \\"bizcode123\\"\\n }\\n}","type":"json"}]', + 'title' => '类目-详情', + 'changeSet' => [ + ['createdAt' => '2024-02-22T12:10:08.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCategory'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DescribeDSEntity' => [ + 'summary' => '查询指定机器人下指定实体的meta信息，如：实体类型、实体名称、创建时间、修改时间等。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'KnowledgeId', - 'in' => 'formData', - 'schema' => [ - 'title' => '知识ID，创建知识该值为空', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'description' => '返回参数说明', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F79E7305-5314-5069-A701-9591AD051902', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'ad23234dsf234fga'], + 'EntityId' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'EntityName' => ['title' => '实体名称，仅支持中文、大小写字母、数字、下划线', 'description' => '实体名称，仅支持中文、大小写字母、数字、下划线', 'type' => 'string', 'example' => '书类型'], + 'SysEntityCode' => ['title' => '系统实体code，如@sys.date', 'description' => '系统实体code，如sys.date；用户实体时为空', 'type' => 'string', 'example' => 'sys.date'], + 'EntityType' => ['title' => '实体类型：详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', 'description' => '实体类型：[synonyms（同义词），regex（正则）]', 'type' => 'string', 'example' => 'synonyms'], + 'CreateTime' => ['description' => '创建时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'ModifyTime' => ['description' => '修改时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'CreateUserId' => ['description' => '创建者ID', 'type' => 'string', 'example' => '123231'], + 'CreateUserName' => ['description' => '创建人名称', 'type' => 'string', 'example' => 'test'], + 'ModifyUserId' => ['description' => '修改人唯一标识', 'type' => 'string', 'example' => '123231'], + 'ModifyUserName' => ['description' => '修改人名称', 'type' => 'string', 'example' => 'test'], ], ], ], ], - 'responseDemo' => '', - 'title' => '删除FAQ', - ], - 'UpdateFaq' => [ - 'summary' => '编辑一条知识。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ad23234dsf234fga\\",\\n \\"EntityId\\": 123,\\n \\"EntityName\\": \\"书类型\\",\\n \\"SysEntityCode\\": \\"sys.date\\",\\n \\"EntityType\\": \\"synonyms\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"CreateUserId\\": \\"123231\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"ModifyUserId\\": \\"123231\\",\\n \\"ModifyUserName\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDSEntityResponse>\\n <RequestId>ad23234dsf234fga</RequestId>\\n <EntityId>345344</EntityId>\\n <EntityName>书类型</EntityName>\\n <EntityType>synonyms</EntityType>\\n <CreateTime>1652883349000</CreateTime>\\n <ModifyTime>1652883349000</ModifyTime>\\n <CreateUserId>123231</CreateUserId>\\n <CreateUserName>test</CreateUserName>\\n <ModifyUserId>123231</ModifyUserId>\\n <ModifyUserName>test</ModifyUserName>\\n</DescribeDSEntityResponse>","errorExample":""}]', + 'title' => '实体-详情', + 'responseParamsDescription' => '如果是系统实体，SysEntityCode返回系统实体key，例如：@sys.date', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDSEntity'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DescribeDoc' => [ + 'summary' => '文档详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebot2KMN8Y', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ 'name' => 'KnowledgeId', - 'in' => 'formData', - 'schema' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001905617', - ], - ], - [ - 'name' => 'CategoryId', - 'in' => 'formData', - 'schema' => [ - 'title' => '知识的类目ID', - 'description' => '知识的类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30000049006', - ], - ], - [ - 'name' => 'Title', - 'in' => 'formData', - 'schema' => [ - 'title' => '知识标题', - 'description' => '知识标题', - 'type' => 'string', - 'required' => true, - 'example' => '测试标题', - ], - ], - [ - 'name' => 'StartDate', - 'in' => 'formData', - 'schema' => [ - 'title' => '生效时间', - 'description' => '生效时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-27T05:18:20Z', - ], - ], - [ - 'name' => 'EndDate', - 'in' => 'formData', - 'schema' => [ - 'title' => '失效时间', - 'description' => '失效时间', - 'type' => 'string', - 'required' => false, - 'example' => '2030-12-31T16:00:00Z', - ], + 'in' => 'query', + 'schema' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001979424'], ], [ - 'name' => 'TagIdList', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '标签ID列表', - 'description' => '标签ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '25645645', - ], - 'required' => false, - ], + 'name' => 'ShowDetail', + 'in' => 'query', + 'schema' => ['title' => '是否展示文档段落详细信息'."\n" + .'true：展示'."\n" + .'false：忽略（默认）', 'description' => '是否展示文档段落详细信息'."\n" + .'true：展示'."\n" + .'false：忽略（默认）', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '736994BD-AA35-4742-88C9-E64BE4BAA14B', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7F132693-212A-40A9-8A81-11E7694E478B'], + 'KnowledgeId' => ['description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424'], + 'DocName' => ['description' => '文档名称', 'type' => 'string', 'example' => '文档名称'], + 'Title' => ['description' => '文档标题', 'type' => 'string', 'example' => '测试标题'], + 'BizCode' => ['description' => '业务代码', 'type' => 'string', 'example' => 'bizcode123'], + 'Meta' => ['description' => '文档随路数据', 'type' => 'string', 'example' => '{"code":"xxx"}'], + 'Config' => ['description' => '文档解析/切分配置的配置项：切分器 KEY：Splitter 值选项：paragraphSplitter-识别层级【默认】 值选项：treeSplitter-规则层级'."\n" + ."\n" + .'配置项：文档切块大小 KEY：ChunkSize VALUE：默认500；范围[200,800]'."\n" + ."\n" + .'配置项：规则层级 KEY：TreePatterns VALUE：默认[]'."\n" + ."\n" + .'配置项：文档标题来源 KEY：TitleSource 值选项：ocrTitle - OCR识别标题【默认】 值选项：docName - 文档名即标题', 'type' => 'string', 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}'], + 'Url' => ['description' => '文档保存OSS地址', 'type' => 'string', 'example' => 'https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf'], + 'ModifyTime' => ['description' => '修改时间', 'type' => 'string', 'example' => '2020-11-25T08:56:55Z'], + 'ModifyUserName' => ['description' => '修改人', 'type' => 'string', 'example' => '李四'], + 'CreateTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'CreateUserName' => ['description' => '创建人名称', 'type' => 'string', 'example' => '张三'], + 'CreateUserId' => ['description' => '创建人ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111'], + 'ModifyUserId' => ['description' => '修改人ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2222222222'], + 'CategoryId' => ['description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000049006'], + 'ProcessStatus' => ['description' => '任务处理状态'."\n" + .'-1 排队中'."\n" + .'0 成功'."\n" + .'1 解析中'."\n" + .'2 处理中'."\n" + .'3 处理失败', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ProcessMessage' => ['description' => '任务处理信息', 'type' => 'string', 'example' => '任务处理成功'], + 'ProcessCanRetry' => ['description' => '任务是否可重试'."\n" + .'true：可重试'."\n" + .'false：不可重试', 'type' => 'boolean', 'example' => 'true'], + 'Status' => ['description' => '编辑状态：'."\n" + .'1 未发布'."\n" + .'2 已发布'."\n" + .'3 已更新未发布', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'EffectStatus' => ['description' => '生效状态'."\n" + .'根据StartDate, EndDate计算出来'."\n" + .'20 生效中'."\n" + .'21 已失效'."\n" + .'22 待生效', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'StartDate' => ['description' => '生效时间（UTC 时间）', 'type' => 'string', 'example' => '1979-12-31T16:00:00Z'], + 'EndDate' => ['description' => '失效时间（UTC 时间）', 'type' => 'string', 'example' => '2023-04-27T06:08:54Z'], + 'DocInfo' => [ + 'description' => '文档详情', + 'type' => 'object', + 'properties' => [ + 'DocParas' => [ + 'description' => '文档段落信息', + 'type' => 'array', + 'items' => [ + 'description' => '段落对象', + 'type' => 'object', + 'properties' => [ + 'ParaNo' => ['description' => '段落序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ParaLevel' => ['description' => '段落层级', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ParaType' => ['description' => '段落内容类型'."\n" + .'text-文本'."\n" + .'figure-图片'."\n" + .'table-表格', 'type' => 'string', 'example' => 'text'], + 'ParaText' => ['description' => '段落内容【纯文本/图片OCR内容/表格的Markdown表示】', 'type' => 'string', 'example' => '内容'], + ], + ], + ], + ], + ], + 'DocTags' => [ + 'description' => '标签详情列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情', + 'type' => 'object', + 'properties' => [ + 'TagId' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1201'], + 'TagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'example' => '小说'], + 'GroupId' => ['title' => '标签分组ID', 'description' => '标签分组ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3610'], + 'GroupName' => ['title' => '标签分组名称', 'description' => '标签分组名称', 'type' => 'string', 'example' => '文章'], + 'DefaultTag' => ['title' => '是否默认为全部标签', 'description' => '是否默认为全部标签', 'type' => 'boolean', 'example' => 'false'], + ], + ], + ], + 'DocMetadata' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BusinessViewId' => ['type' => 'string', 'description' => ''], + 'BusinessViewName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string'], + 'MetaCellInfoDTOList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldCode' => ['type' => 'string', 'description' => ''], + 'FieldName' => ['type' => 'string', 'description' => ''], + 'Value' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', + ], + ], + 'description' => '', + ], + 'description' => '', ], ], ], ], ], - 'responseDemo' => '', - 'title' => '修改FAQ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F132693-212A-40A9-8A81-11E7694E478B\\",\\n \\"KnowledgeId\\": 30001979424,\\n \\"DocName\\": \\"文档名称\\",\\n \\"Title\\": \\"测试标题\\",\\n \\"BizCode\\": \\"bizcode123\\",\\n \\"Meta\\": \\"{\\\\\\"code\\\\\\":\\\\\\"xxx\\\\\\"}\\",\\n \\"Config\\": \\"{\\\\\\"Splitter\\\\\\":\\\\\\"treeSplitter\\\\\\",\\\\\\"ChunkSize\\\\\\":500,\\\\\\"TreePatterns\\\\\\":[\\\\\\"^# .*\\\\\\",\\\\\\"^## .*\\\\\\",\\\\\\"^### .*\\\\\\",\\\\\\"^#### .*\\\\\\"],\\\\\\"TitleSource\\\\\\":\\\\\\"docName\\\\\\"}\\",\\n \\"Url\\": \\"https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf\\",\\n \\"ModifyTime\\": \\"2020-11-25T08:56:55Z\\",\\n \\"ModifyUserName\\": \\"李四\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"CreateUserName\\": \\"张三\\",\\n \\"CreateUserId\\": 1111111111,\\n \\"ModifyUserId\\": 2222222222,\\n \\"CategoryId\\": 30000049006,\\n \\"ProcessStatus\\": 0,\\n \\"ProcessMessage\\": \\"任务处理成功\\",\\n \\"ProcessCanRetry\\": true,\\n \\"Status\\": 1,\\n \\"EffectStatus\\": 20,\\n \\"StartDate\\": \\"1979-12-31T16:00:00Z\\",\\n \\"EndDate\\": \\"2023-04-27T06:08:54Z\\",\\n \\"DocInfo\\": {\\n \\"DocParas\\": [\\n {\\n \\"ParaNo\\": 1,\\n \\"ParaLevel\\": 1,\\n \\"ParaType\\": \\"text\\",\\n \\"ParaText\\": \\"内容\\"\\n }\\n ]\\n },\\n \\"DocTags\\": [\\n {\\n \\"TagId\\": 1201,\\n \\"TagName\\": \\"小说\\",\\n \\"GroupId\\": 3610,\\n \\"GroupName\\": \\"文章\\",\\n \\"DefaultTag\\": false\\n }\\n ],\\n \\"DocMetadata\\": [\\n {\\n \\"BusinessViewId\\": \\"\\",\\n \\"BusinessViewName\\": \\"\\",\\n \\"MetaCellInfoDTOList\\": [\\n {\\n \\"FieldCode\\": \\"\\",\\n \\"FieldName\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '文档详情', + 'changeSet' => [ + ['createdAt' => '2024-09-26T12:39:56.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-05-17T09:42:04.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDoc'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], ], 'DescribeFaq' => [ 'summary' => '查询知识详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7536,37 +3717,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebot2KMN8Y', - ], + 'abilityTreeNodes' => ['FEATUREbeebot2KMN8Y'], ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', - 'schema' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-9223372036854775808', - 'exclusiveMinimum' => true, - 'example' => '30001979424', - ], + 'schema' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001979424'], ], ], 'responses' => [ @@ -7577,76 +3739,17 @@ 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'KnowledgeId' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001979424', - ], - 'Title' => [ - 'title' => '标题', - 'description' => '标题', - 'type' => 'string', - 'example' => '测试标题', - ], - 'ModifyTime' => [ - 'title' => '修改时间（UTC时间）', - 'description' => '修改时间（UTC 时间）', - 'type' => 'string', - 'example' => '2020-12-02T06:35:50Z', - ], - 'ModifyUserName' => [ - 'title' => '修改人', - 'description' => '修改人', - 'type' => 'string', - 'example' => 'test01', - ], - 'CreateTime' => [ - 'title' => '创建时间（UTC时间）', - 'description' => '创建时间（UTC 时间）', - 'type' => 'string', - 'example' => '2020-11-30T03:03:37Z', - ], - 'CreateUserName' => [ - 'title' => '创建人', - 'description' => '创建人', - 'type' => 'string', - 'example' => 'test01', - ], - 'CategoryId' => [ - 'title' => '类目ID', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000055617', - ], - 'Status' => [ - 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', - 'description' => '知识状态： -1-已删除未发布，1-未发布，2-已发布，3-已更新未发布', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'EffectStatus' => [ - 'title' => '知识生效状态,根据StartDate, EndDate计算出来: 20-生效中, 21-已失效, 22-待生效', - 'description' => '知识生效状态，根据StartDate， EndDate计算出来：20-生效中，21-已失效，22-待生效', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'StartDate' => [ - 'title' => '生效时间（UTC时间）', - 'description' => '生效时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-04-27T07:04:39Z', - ], - 'EndDate' => [ - 'title' => '失效时间（UTC时间）', - 'description' => '失效时间（UTC 时间）', - 'type' => 'string', - 'example' => '2023-04-27T06:08:54Z', - ], + 'KnowledgeId' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424'], + 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '测试标题'], + 'ModifyTime' => ['title' => '修改时间（UTC时间）', 'description' => '修改时间（UTC 时间）', 'type' => 'string', 'example' => '2020-12-02T06:35:50Z'], + 'ModifyUserName' => ['title' => '修改人', 'description' => '修改人', 'type' => 'string', 'example' => 'test01'], + 'CreateTime' => ['title' => '创建时间（UTC时间）', 'description' => '创建时间（UTC 时间）', 'type' => 'string', 'example' => '2020-11-30T03:03:37Z'], + 'CreateUserName' => ['title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => 'test01'], + 'CategoryId' => ['title' => '类目ID', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000055617'], + 'Status' => ['title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', 'description' => '知识状态： -1-已删除未发布，1-未发布，2-已发布，3-已更新未发布', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'EffectStatus' => ['title' => '知识生效状态,根据StartDate, EndDate计算出来: 20-生效中, 21-已失效, 22-待生效', 'description' => '知识生效状态，根据StartDate， EndDate计算出来：20-生效中，21-已失效，22-待生效', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'StartDate' => ['title' => '生效时间（UTC时间）', 'description' => '生效时间（UTC 时间）', 'type' => 'string', 'example' => '2022-04-27T07:04:39Z'], + 'EndDate' => ['title' => '失效时间（UTC时间）', 'description' => '失效时间（UTC 时间）', 'type' => 'string', 'example' => '2023-04-27T06:08:54Z'], 'SimQuestions' => [ 'title' => '相似问列表', 'description' => '相似问列表', @@ -7655,31 +3758,10 @@ 'description' => '相似问信息', 'type' => 'object', 'properties' => [ - 'SimQuestionId' => [ - 'title' => '相似问ID', - 'description' => '相似问ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000000581', - ], - 'ModifyTime' => [ - 'title' => '修改时间(UTC 时间)', - 'description' => '修改时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-29T03:55:07Z', - ], - 'CreateTime' => [ - 'title' => '创建时间(UTC 时间)', - 'description' => '创建时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-26T10:24:00Z', - ], - 'Title' => [ - 'title' => '相似问标题', - 'description' => '相似问标题', - 'type' => 'string', - 'example' => '测试相似问标题', - ], + 'SimQuestionId' => ['title' => '相似问ID', 'description' => '相似问ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000581'], + 'ModifyTime' => ['title' => '修改时间(UTC 时间)', 'description' => '修改时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-29T03:55:07Z'], + 'CreateTime' => ['title' => '创建时间(UTC 时间)', 'description' => '创建时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-26T10:24:00Z'], + 'Title' => ['title' => '相似问标题', 'description' => '相似问标题', 'type' => 'string', 'example' => '测试相似问标题'], ], ], ], @@ -7691,66 +3773,23 @@ 'description' => '答案信息', 'type' => 'object', 'properties' => [ - 'SolutionId' => [ - 'title' => '答案ID', - 'description' => '答案ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000003071', - ], - 'ModifyTime' => [ - 'title' => '修改时间(UTC 时间)', - 'description' => '修改时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-29T07:07:13Z', - ], - 'CreateTime' => [ - 'title' => '创建时间(UTC 时间)', - 'description' => '创建时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-26T10:24:00Z', - ], - 'Content' => [ - 'title' => '答案内容', - 'description' => '答案内容', - 'type' => 'string', - 'example' => '测试答案内容', - ], - 'ContentType' => [ - 'title' => '答案类型(0纯文本，1富文本）', - 'description' => '答案类型：0-纯文本，1-富文本', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PlainText' => [ - 'title' => '答案纯文本内容', - 'description' => '答案纯文本内容', - 'type' => 'string', - 'example' => '测试答案内容', - ], + 'SolutionId' => ['title' => '答案ID', 'description' => '答案ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000003071'], + 'ModifyTime' => ['title' => '修改时间(UTC 时间)', 'description' => '修改时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-29T07:07:13Z'], + 'CreateTime' => ['title' => '创建时间(UTC 时间)', 'description' => '创建时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-26T10:24:00Z'], + 'Content' => ['title' => '答案内容', 'description' => '答案内容', 'type' => 'string', 'example' => '测试答案内容'], + 'ContentType' => ['title' => '答案类型(0纯文本，1富文本）', 'description' => '答案类型：0-纯文本，1-富文本', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'PlainText' => ['title' => '答案纯文本内容', 'description' => '答案纯文本内容', 'type' => 'string', 'example' => '测试答案内容'], 'PerspectiveCodes' => [ 'title' => '视角code列表', 'description' => '视角code列表', 'type' => 'array', - 'items' => [ - 'title' => '视角code', - 'description' => '视角code', - 'type' => 'string', - 'example' => 'default', - ], + 'items' => ['title' => '视角code', 'description' => '视角code', 'type' => 'string', 'example' => 'default'], ], 'TagIdList' => [ 'title' => '标签ID集合', 'description' => '标签ID集合', 'type' => 'array', - 'items' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '322353453', - ], + 'items' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '322353453'], 'required' => false, ], ], @@ -7764,782 +3803,884 @@ 'description' => '关联问信息', 'type' => 'object', 'properties' => [ - 'OutlineId' => [ - 'title' => '关联关系ID', - 'description' => '关联关系ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '797', - ], - 'ConnQuestionId' => [ - 'title' => '关联知识ID', - 'description' => '关联知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000098002', - ], - 'Title' => [ - 'title' => '关联知识标题', - 'description' => '关联知识标题', - 'type' => 'string', - 'example' => '测试关联问标题', - ], - 'ModifyTime' => [ - 'title' => '修改时间(UTC 时间)', - 'description' => '修改时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-26T18:12:02Z', - ], - 'CreateTime' => [ - 'title' => '创建时间(UTC 时间)', - 'description' => '创建时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-05-26T10:24:00Z', - ], + 'OutlineId' => ['title' => '关联关系ID', 'description' => '关联关系ID', 'type' => 'integer', 'format' => 'int64', 'example' => '797'], + 'ConnQuestionId' => ['title' => '关联知识ID', 'description' => '关联知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000098002'], + 'Title' => ['title' => '关联知识标题', 'description' => '关联知识标题', 'type' => 'string', 'example' => '测试关联问标题'], + 'ModifyTime' => ['title' => '修改时间(UTC 时间)', 'description' => '修改时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-26T18:12:02Z'], + 'CreateTime' => ['title' => '创建时间(UTC 时间)', 'description' => '创建时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-26T10:24:00Z'], ], ], ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32'], 'TagIdList' => [ 'title' => '标签ID列表', 'description' => '标签ID列表', 'type' => 'array', - 'items' => [ - 'title' => '标签ID', - 'description' => '标签ID', - 'type' => 'integer', - 'format' => 'int64', - ], + 'items' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64'], ], ], ], ], ], - 'responseDemo' => '', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeId\\": 30001979424,\\n \\"Title\\": \\"测试标题\\",\\n \\"ModifyTime\\": \\"2020-12-02T06:35:50Z\\",\\n \\"ModifyUserName\\": \\"test01\\",\\n \\"CreateTime\\": \\"2020-11-30T03:03:37Z\\",\\n \\"CreateUserName\\": \\"test01\\",\\n \\"CategoryId\\": 30000055617,\\n \\"Status\\": 3,\\n \\"EffectStatus\\": 20,\\n \\"StartDate\\": \\"2022-04-27T07:04:39Z\\",\\n \\"EndDate\\": \\"2023-04-27T06:08:54Z\\",\\n \\"SimQuestions\\": [\\n {\\n \\"SimQuestionId\\": 10000000581,\\n \\"ModifyTime\\": \\"2022-05-29T03:55:07Z\\",\\n \\"CreateTime\\": \\"2022-05-26T10:24:00Z\\",\\n \\"Title\\": \\"测试相似问标题\\"\\n }\\n ],\\n \\"Solutions\\": [\\n {\\n \\"SolutionId\\": 10000003071,\\n \\"ModifyTime\\": \\"2022-05-29T07:07:13Z\\",\\n \\"CreateTime\\": \\"2022-05-26T10:24:00Z\\",\\n \\"Content\\": \\"测试答案内容\\",\\n \\"ContentType\\": 0,\\n \\"PlainText\\": \\"测试答案内容\\",\\n \\"PerspectiveCodes\\": [\\n \\"default\\"\\n ],\\n \\"TagIdList\\": [\\n 322353453\\n ]\\n }\\n ],\\n \\"Outlines\\": [\\n {\\n \\"OutlineId\\": 797,\\n \\"ConnQuestionId\\": 1000098002,\\n \\"Title\\": \\"测试关联问标题\\",\\n \\"ModifyTime\\": \\"2022-05-26T18:12:02Z\\",\\n \\"CreateTime\\": \\"2022-05-26T10:24:00Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"8AD9FA10-7780-5E12-B701-13C928524F32\\",\\n \\"TagIdList\\": [\\n 0\\n ]\\n}","type":"json"}]', 'title' => '获取FAQ详情', - ], - 'SearchFaq' => [ - 'summary' => '搜索知识。', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFaq'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'DescribeInstance' => [ + 'summary' => '查询机器人详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebotW5WL9W'], + ], 'parameters' => [ [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], + ], + [ 'name' => 'AgentKey', 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '907AA5F2-0521-49AB-80AB-1ADEFAB2B901'], + 'InstanceId' => ['title' => '机器人唯一标识', 'description' => '机器人唯一标识', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050'], + 'Name' => ['title' => '机器人名称', 'description' => '机器人名称', 'type' => 'string', 'example' => '智能客服-小C'], + 'TimeZone' => ['title' => '机器人的时区，参考《公共-时区码》', 'description' => '机器人的时区，参考《公共-时区码》', 'type' => 'string', 'example' => 'Asia/Chongqing'], + 'Introduction' => ['title' => '机器人备注', 'description' => '机器人备注', 'type' => 'string', 'example' => '用于C端问答的机器人'], + 'LanguageCode' => [ + 'title' => '机器人服务的语言，如zh-cn、en-us', + 'description' => '机器人服务的语言，如zh-cn、en-us', + 'type' => 'string', + 'enumValueTitles' => ['en-us' => '英文', 'zh-cn' => '中文'], + 'example' => 'zh-cn', + ], + 'RobotType' => [ + 'title' => '机器人类型', + 'description' => '机器人类型', + 'type' => 'string', + 'enumValueTitles' => ['scenario_callout' => '外呼机器人', 'scenario_im' => '在线文本机器人', 'scenario_ivr' => '导航机器人'], + 'example' => 'scenario_im', + ], + 'Avatar' => ['title' => '机器人头像的URL', 'description' => '机器人头像的URL', 'type' => 'string', 'example' => '/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png'], + 'EditStatus' => [ + 'title' => '机器人状态： EDITING(编辑中)、 PUBLISHED(已发布)', + 'description' => '机器人状态', + 'type' => 'string', + 'enumValueTitles' => ['PUBLISHED' => '已发布', 'EDITING' => '编辑中'], + 'example' => 'PUBLISHED', + ], + 'CreateTime' => ['title' => '机器人创建的 UTC 时间', 'description' => '机器人创建的 UTC 时间', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'Categories' => [ + 'title' => '类目列表', + 'description' => '类目列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CategoryId' => ['title' => '类目id', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000066832'], + 'Name' => ['title' => '类目名称', 'description' => '类目名称', 'type' => 'string', 'example' => '杭州市防疫政策'], + 'ParentCategoryId' => ['title' => '父类目id，-1表示根目录', 'description' => '父类目ID，-1表示根目录', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'AbilityType' => ['description' => '类目的能力类型，如FAQ（高频问答），MRC（文档）', 'type' => 'string', 'example' => 'FAQ'], + ], + 'description' => '', + ], + ], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"907AA5F2-0521-49AB-80AB-1ADEFAB2B901\\",\\n \\"InstanceId\\": \\"chatbot-cn-mp90s2lrk00050\\",\\n \\"Name\\": \\"智能客服-小C\\",\\n \\"TimeZone\\": \\"Asia/Chongqing\\",\\n \\"Introduction\\": \\"用于C端问答的机器人\\",\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"RobotType\\": \\"scenario_im\\",\\n \\"Avatar\\": \\"/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png\\",\\n \\"EditStatus\\": \\"PUBLISHED\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"Categories\\": [\\n {\\n \\"CategoryId\\": 30000066832,\\n \\"Name\\": \\"杭州市防疫政策\\",\\n \\"ParentCategoryId\\": -1,\\n \\"AbilityType\\": \\"FAQ\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取机器人详情', + 'responseParamsDescription' => '### 示例'."\n" + .'#### 响应报文：'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Name": "test1",'."\n" + .' "LanguageCode": "zh-cn",'."\n" + .' "RobotType":"scenario_im",'."\n" + .' "Introduction": "客户演示",'."\n" + .' "InstanceId": "chatbot-cn-mp90s2lrk00050",'."\n" + .' "CreateTime": "2018-09-11T09:26:14Z",'."\n" + .' "RequestId": "E7661C58-9CE7-4754-AB98-9BA40EAA7C27",'."\n" + .' "Avatar": "//gw.alicdn.com/tfs/TB1N5CwqTtYBeNjy1XdXXXXyVXa-90-97.png",'."\n" + .' "TimeZone": "Asia/Chongqing",'."\n" + .' "Categories": ['."\n" + .' {'."\n" + .' "Name": "测试类目test11",'."\n" + .' "ParentCategoryId": -1,'."\n" + .' "CategoryId": 1000006427'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```', + 'changeSet' => [ + ['createdAt' => '2025-08-20T07:52:54.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-10T03:13:25.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'DescribeIntent' => [ + 'summary' => '返回指定意图的 meta 信息，如：意图类型、意图名称、创建时间、修改时间等。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'title' => '关键字', - 'description' => '关键字', - 'type' => 'string', - 'required' => false, - 'example' => '搜索标题', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'CategoryIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '类目唯一标识', - 'description' => '类目唯一标识', - 'type' => 'array', - 'items' => [ - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30000065594', - ], - 'required' => false, - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'Status', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'IntentId', 'in' => 'formData', + 'schema' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', - 'description' => '知识状态：-1-已删除未发布，1-未发布，2-已发布，3-已更新未发布', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => '未发布', - '已发布', - '已更新未发布', - -1 => '已删除未发布', + 'title' => 'BaseResponse<DsPaasIntentDTO>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'a22afaf2adfasf2gr345fga45ada'], + 'IntentId' => ['description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'example' => '84243341'], + 'IntentName' => ['description' => '意图名称', 'type' => 'string', 'example' => '查天气意图'], + 'AliasName' => ['description' => '意图别名', 'type' => 'string', 'example' => '查天气意图'], + 'SlotInfos' => [ + 'description' => '意图关联的槽位信息', + 'type' => 'array', + 'items' => [ + 'description' => '意图关联的槽位信息', + 'type' => 'object', + 'properties' => [ + 'SlotId' => ['description' => '槽位唯一标识', 'type' => 'string', 'example' => 'aa4d2a343a3ad4afad'], + 'Name' => ['description' => '槽位名称', 'type' => 'string', 'example' => '天气'], + 'Value' => ['description' => '槽位划词结果', 'type' => 'string', 'example' => '天气'], + 'Interactive' => ['description' => '是否交互式填槽，默认为false', 'type' => 'boolean', 'example' => 'false'], + 'Array' => ['description' => '是否数组', 'type' => 'boolean', 'example' => 'false'], + 'Encrypt' => ['description' => '是否敏感', 'type' => 'boolean', 'example' => 'false'], + ], + ], + ], + 'CreateTime' => ['description' => '创建时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'ModifyTime' => ['description' => '修改时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'CreateUserId' => ['description' => '创建人唯一标识', 'type' => 'string', 'example' => '123231'], + 'CreateUserName' => ['description' => '创建人名称', 'type' => 'string', 'example' => 'test'], + 'ModifyUserId' => ['description' => '修改人唯一标识', 'type' => 'string', 'example' => '123231'], + 'ModifyUserName' => ['description' => '修改人名称', 'type' => 'string', 'example' => 'test'], ], - 'example' => '1', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error IntentId is not exists.', 'description' => ''], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"a22afaf2adfasf2gr345fga45ada\\",\\n \\"IntentId\\": 84243341,\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"AliasName\\": \\"查天气意图\\",\\n \\"SlotInfos\\": [\\n {\\n \\"SlotId\\": \\"aa4d2a343a3ad4afad\\",\\n \\"Name\\": \\"天气\\",\\n \\"Value\\": \\"天气\\",\\n \\"Interactive\\": false,\\n \\"Array\\": false,\\n \\"Encrypt\\": false\\n }\\n ],\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"CreateUserId\\": \\"123231\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"ModifyUserId\\": \\"123231\\",\\n \\"ModifyUserName\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeIntentResponse>\\n <RequestId>a22afaf2adfasf2gr345fga45ada</RequestId>\\n <IntentId>84243341</IntentId>\\n <IntentName>查天气意图</IntentName>\\n <AliasName>查天气意图</AliasName>\\n <SlotInfos>\\n <SlotId>aa4d2a343a3ad4afad</SlotId>\\n <Name>天气</Name>\\n <Value>天气</Value>\\n <Interactive>false</Interactive>\\n <Array>false</Array>\\n <Encrypt>false</Encrypt>\\n </SlotInfos>\\n <CreateTime>1652883349000</CreateTime>\\n <ModifyTime>1652883349000</ModifyTime>\\n <CreateUserId>123231</CreateUserId>\\n <CreateUserName>test</CreateUserName>\\n <ModifyUserId>123231</ModifyUserId>\\n <ModifyUserName>test</ModifyUserName>\\n</DescribeIntentResponse>","errorExample":""}]', + 'title' => '意图-详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIntent'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'DescribePerspective' => [ + 'summary' => '查询视角详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SearchScope', - 'in' => 'formData', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'PerspectiveId', + 'in' => 'query', + 'schema' => ['title' => '视角Id', 'description' => '视角ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001'], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '搜索范围： 1-搜索标题相似问, 2-搜索答案, 3-搜索全部', - 'description' => '搜索范围：1-搜索标题相似问，2-搜索答案，3-搜索全部', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => '搜索标题和相似问', - '搜索答案', - '搜索全部', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101'], + 'Status' => ['title' => '数据状态：3：选中；1：未选中', 'description' => '数据状态：3：启用；1：未启用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PerspectiveCode' => ['title' => '视角编码（用于问答api）', 'description' => '视角编码（用于问答API）', 'type' => 'string', 'example' => 'FZJBY3raWr'], + 'ModifyTime' => ['title' => '修改时间 UTC时间', 'description' => '修改时间 UTC时间', 'type' => 'string', 'example' => '2021-07-26T07:05:37Z'], + 'SelfDefine' => ['title' => '是否自定义', 'description' => '是否自定义', 'type' => 'boolean', 'example' => 'true'], + 'CreateTime' => ['title' => '创建时间 UTC时间', 'description' => '创建时间 UTC时间', 'type' => 'string', 'example' => '2021-07-27T07:05:37Z'], + 'PerspectiveId' => ['title' => '视角主键（code_id）', 'description' => '视角ID', 'type' => 'string', 'example' => '3001'], + 'Name' => ['title' => '视角名称', 'description' => '视角名称', 'type' => 'string', 'example' => '移动端视角'], ], - 'example' => '1', + 'description' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F285D735-D580-18A8-B97F-B2E72B00F101\\",\\n \\"Status\\": 1,\\n \\"PerspectiveCode\\": \\"FZJBY3raWr\\",\\n \\"ModifyTime\\": \\"2021-07-26T07:05:37Z\\",\\n \\"SelfDefine\\": true,\\n \\"CreateTime\\": \\"2021-07-27T07:05:37Z\\",\\n \\"PerspectiveId\\": \\"3001\\",\\n \\"Name\\": \\"移动端视角\\"\\n}","type":"json"}]', + 'title' => '视角-详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePerspective'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'Feedback' => [ + 'summary' => '保存用户对于问答结果的评价。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CreateUserName', - 'in' => 'formData', - 'schema' => [ - 'title' => '创建人', - 'description' => '创建人', - 'type' => 'string', - 'required' => false, - 'example' => 'test01', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ - 'name' => 'ModifyUserName', - 'in' => 'formData', - 'schema' => [ - 'title' => '修改人', - 'description' => '修改人', - 'type' => 'string', - 'required' => false, - 'example' => 'test01', - ], + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => ['title' => '会话窗单次会话标识', 'description' => '会话窗单次会话标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5ca40988-4f99-47ad-ac96-9060d0f81db9'], ], [ - 'name' => 'CreateTimeBegin', - 'in' => 'formData', + 'name' => 'Feedback', + 'in' => 'query', 'schema' => [ - 'title' => '创建开始时间', - 'description' => '创建开始时间', + 'title' => 'good-点赞、bad-点踩', + 'description' => '点赞或点踩，对应会话历史API中的FeedbackType'."\n" + ."\n" + .'枚举值：'."\n" + .'good（点赞）'."\n" + .'bad（点踩）', 'type' => 'string', 'required' => false, - 'example' => '2022-04-02T03:09:30Z', + 'docRequired' => true, + 'enumValueTitles' => ['bad' => 'bad', 'good' => 'good'], + 'example' => 'good', ], ], [ - 'name' => 'CreateTimeEnd', - 'in' => 'formData', - 'schema' => [ - 'title' => '创建结束时间', - 'description' => '创建结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-02T03:09:30Z', - ], + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['title' => '会话Session标识，标识：IM唯一标识会话', 'description' => '会话Session标识，标识：IM唯一标识会话', 'type' => 'string', 'required' => false, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa'], ], [ - 'name' => 'ModifyTimeBegin', - 'in' => 'formData', - 'schema' => [ - 'title' => '修改开始时间', - 'description' => '修改开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-02T03:09:30Z', - ], + 'name' => 'FeedbackContent', + 'in' => 'query', + 'schema' => ['title' => '点赞、点踩的内容', 'description' => '点赞、点踩的内容，可以直接输入反馈的内容；也可以传入示例中的jsonString，content字段对应会话历史中的FeedbackUserInfo，feedbackLabels对应会话历史中的FeedbackLabels。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "content": "我觉得这个答案不对，需要依据事实回答。",'."\n" + .' "feedbackLabels": ['."\n" + .' "存在事实性错误"'."\n" + .' ]'."\n" + .'}'], ], [ - 'name' => 'ModifyTimeEnd', - 'in' => 'formData', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'example' => 'chatbot-cn-mp90s2lrk00050'], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '修改结束时间', - 'description' => '修改结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-05-02T03:09:30Z', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求id', 'description' => '请求Id', 'type' => 'string', 'example' => '4e5eea71-f326-450c-8849-49515473ef64'], + 'Feedback' => ['title' => 'good-点赞、bad-点踩', 'description' => '点赞或点踩'."\n" + ."\n" + .'枚举值：'."\n" + .'good（点赞）'."\n" + .'bad（点踩）', 'type' => 'string', 'example' => 'good'], + 'MessageId' => ['title' => '会话窗单次会话标识', 'description' => '会话窗单次会话标识', 'type' => 'string', 'example' => '5ca40988-4f99-47ad-ac96-9060d0f81db9'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4e5eea71-f326-450c-8849-49515473ef64\\",\\n \\"Feedback\\": \\"good\\",\\n \\"MessageId\\": \\"5ca40988-4f99-47ad-ac96-9060d0f81db9\\"\\n}","type":"json"}]', + 'title' => '问答点赞、点踩', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Feedback'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'GenerateUserAccessToken' => [ + 'summary' => '用于聊天窗用户免登时，获取Token，通过该Token可将用户的企业身份带入。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTimeBegin', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebotJ8IS68'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ExpireTime', 'in' => 'formData', - 'schema' => [ - 'title' => '生效开始时间', - 'description' => '生效开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-02T03:09:30Z', - ], + 'schema' => ['title' => '保留参数，无需传入', 'description' => '保留参数，无需传入', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3600', 'minimum' => '0', 'example' => '1000'], ], [ - 'name' => 'StartTimeEnd', + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '坐席密钥', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ + 'name' => 'ExtraInfo', 'in' => 'formData', - 'schema' => [ - 'title' => '生效结束时间', - 'description' => '生效结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-03T03:09:30Z', - ], + 'schema' => ['title' => '附加信息，json字符串', 'description' => '附加信息，json字符串', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "xx": 123,'."\n" + .' "yy": 22332,'."\n" + .' "customerNameCard": ['."\n" + .' {'."\n" + .' "key": "姓名",'."\n" + .' "value": "张三"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "等级",'."\n" + .' "value": "v2"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "联系方式",'."\n" + .' "value": "123"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'], ], [ - 'name' => 'EndTimeBegin', + 'name' => 'Email', 'in' => 'formData', - 'schema' => [ - 'title' => '失效开始时间', - 'description' => '失效开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-02T03:09:30Z', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ - 'name' => 'EndTimeEnd', + 'name' => 'Telephone', 'in' => 'formData', - 'schema' => [ - 'title' => '失效结束时间', - 'description' => '失效结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-05-02T03:09:30Z', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ForeignId', 'in' => 'formData', - 'schema' => [ - 'title' => '页码 默认1', - 'description' => '页码默认1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '用户外部的userid', 'description' => '用户外部的userid', 'type' => 'string', 'required' => true, 'example' => '8882022040000000171'], ], [ - 'name' => 'PageSize', + 'name' => 'Nick', 'in' => 'formData', - 'schema' => [ - 'title' => '每页数量，默认10，最大50', - 'description' => '每页数量，默认10，最大100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '访问者昵称', 'description' => '访问者昵称', 'type' => 'string', 'required' => true, 'example' => '张三'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'result', - 'description' => '返回值', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'FaqHits' => [ - 'description' => '知识搜索结果', - 'type' => 'array', - 'items' => [ - 'description' => '知识信息', - 'type' => 'object', - 'properties' => [ - 'KnowledgeId' => [ - 'title' => '知识ID', - 'description' => '知识ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30002145804', - ], - 'ModifyTime' => [ - 'title' => '修改时间（UTC时间）', - 'description' => '修改时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-04-02T03:09:30Z', - ], - 'ModifyUserName' => [ - 'title' => '修改人', - 'description' => '修改人', - 'type' => 'string', - 'example' => 'test01', - ], - 'CreateTime' => [ - 'title' => '创建时间（UTC时间）', - 'description' => '创建时间（UTC 时间）', - 'type' => 'string', - 'example' => '2022-04-02T03:09:30Z', - ], - 'CreateUserName' => [ - 'title' => '创建人', - 'description' => '创建人', - 'type' => 'string', - 'example' => 'test01', - ], - 'CreateUserId' => [ - 'title' => '创建人ID', - 'description' => '创建人ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18453', - ], - 'ModifyUserId' => [ - 'title' => '修改人ID', - 'description' => '修改人ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18453', - ], - 'CategoryId' => [ - 'title' => '类目ID', - 'description' => '类目ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000055639', - ], - 'Status' => [ - 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', - 'description' => '知识状态：-1-已删除未发布，1-未发布，2-已发布，3-已更新未发布', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - 1 => '未发布', - '已发布', - '已更新未发布', - -1 => '已删除未发布', - ], - 'example' => '3', - ], - 'EffectStatus' => [ - 'title' => '知识生效状态,根据StartDate, EndDate计算出来: 20-生效中, 21-已失效, 22-待生效', - 'description' => '知识生效状态，根据StartDate，EndDate计算出来：20-生效中，21-已失效，22-待生效', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - 20 => '生效中', - '已失效', - '待生效', - ], - 'example' => '20', - ], - 'Title' => [ - 'title' => '标题', - 'description' => '标题', - 'type' => 'string', - 'example' => '测试标题', - ], - 'HitSimilarTitles' => [ - 'title' => '命中的相似问', - 'description' => '命中的相似问题列表', - 'type' => 'array', - 'items' => [ - 'description' => '相似问题', - 'type' => 'string', - 'example' => '测试命中的标题', - ], - ], - 'HitSolutions' => [ - 'title' => '命中的答案', - 'description' => '命中的答案列表', - 'type' => 'array', - 'items' => [ - 'description' => '命中的答案', - 'type' => 'string', - 'example' => '测试命中的答案', - ], - ], - ], - ], - ], - 'PageNumber' => [ - 'title' => '页码 默认1', - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页数量，默认10，最大500', - 'description' => '每页数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => '总条数', - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1075', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'E45491D5-7E0A-42C6-9B21-91D1066B1475', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E6988CE6-41CF-1103-9BEC-2B20D26C0B51'], + 'Success' => ['title' => '是否操作成功：false：否；true：是', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => '请求消息', 'description' => '返回编码', 'type' => 'string', 'example' => '200'], + 'Message' => ['title' => '错误信息', 'description' => '异常信息', 'type' => 'string', 'example' => 'Parameter.Invalid'], + 'Data' => ['title' => '请求id', 'description' => 'Token值', 'type' => 'string', 'example' => 'DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF'], ], ], ], ], - 'responseDemo' => '', - 'title' => 'FAQ搜索', - ], - 'CreateDSEntity' => [ - 'summary' => '创建实体，特指实体的Meta信息，如：实体名称、实体类型。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6988CE6-41CF-1103-9BEC-2B20D26C0B51\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Parameter.Invalid\\",\\n \\"Data\\": \\"DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF\\"\\n}","type":"json"}]', + 'title' => '获取用户免登Token', + 'description' => '由于安全问题，生成的Token仅第一次使用有效（过期时间内），如同一个用户多浏览器登录，需要多次调用。', + 'changeSet' => [ + ['createdAt' => '2025-12-11T03:00:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-08-07T08:17:02.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-25T09:30:04.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-25T01:55:14.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-13T04:38:41.000Z', 'description' => '请求参数发生变更、错误码发生变更'], + ['createdAt' => '2022-07-12T06:38:21.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateUserAccessToken'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'GetAgentInfo' => [ + 'summary' => '获取业务空间ID。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'beebot_bot_public_cn-ca36x8v3n1x'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + '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' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter.Invalid'], + 'Data' => [ + 'description' => '业务空间数据', + 'type' => 'object', + 'properties' => [ + 'AgentName' => ['description' => '业务空间名称', 'type' => 'string', 'example' => '业务空间_881'], + 'AgentKey' => ['description' => '业务空间签名，用于PAAS接口指定业务空间时使用', 'type' => 'string', 'example' => '4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public'], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC384CE1-8D42-1900-84E1-F33F990F2B5E\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter.Invalid\\",\\n \\"Data\\": {\\n \\"AgentName\\": \\"业务空间_881\\",\\n \\"AgentKey\\": \\"4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public\\"\\n }\\n}","type":"json"}]', + 'title' => '根据实例ID获取业务空间信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentInfo'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'GetAsyncResult' => [ + 'summary' => '获取异步服务执行结果，配合Chat接口使用。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'EntityName', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '实体名称，仅支持中文、大小写字母、数字、下划线', - 'description' => '实体名称，仅支持中文、大小写字母、数字、下划线', - 'type' => 'string', - 'required' => true, - 'example' => '实体名称', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '从Chat接口返回参数中获取TASK_ID', 'description' => '异步服务的任务ID', 'type' => 'string', 'required' => true, 'example' => '从Chat接口中获取TASK_ID'], ], [ - 'name' => 'EntityType', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '实体类型：详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', - 'description' => '实体类型：[synonyms（同义词），regex（正则）]', - 'type' => 'string', - 'required' => false, - 'example' => 'synonyms', - 'default' => 'synonyms', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse<EntityIdResponse>', - 'description' => '返回值', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'adfad2343f1f2r', - ], - 'EntityId' => [ - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23436345', - ], + 'Data' => ['description' => '客户服务执行结果数据', 'type' => 'string', 'example' => '{"message":"执行完成"}'], + 'Status' => ['description' => '执行状态：'."\n" + .'| 字段值 | 含义 |'."\n" + .'|----|----|'."\n" + .'| Success | 任务执行成功 |'."\n" + .'| Runninig | 任务在执行中 |'."\n" + .'| Fail | 任务执行失败 |', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorEntity.OutRange', - 'errorMessage' => 'The business error Entity is out of range.', - ], - [ - 'errorCode' => 'BusinessErrorEntityName.OutRange', - 'errorMessage' => 'The business error EntityName is out of range.', - ], - [ - 'errorCode' => 'BusinessErrorEntityName.Repeat', - 'errorMessage' => 'BusinessErrorEntityName.Repeat The business error EntityName is repeat.', - ], - [ - 'errorCode' => 'BusinessErrorEntityName.InvalidCharactor', - 'errorMessage' => 'The business error EntityName contains invalid charactor.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\\\"message\\\\\\":\\\\\\"执行完成\\\\\\"}\\",\\n \\"Status\\": \\"Success\\",\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\"\\n}","type":"json"}]', + 'title' => '获取异步函数执行结果', + 'description' => '获取异步服务执行结果', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncResult'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '实体-创建', + 'ramActions' => [], ], - 'DeleteDSEntity' => [ - 'summary' => '删除一个实体，会级联删除该实体下所有的实体成员及同义词、正则表达式。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetBotSessionData' => [ + 'summary' => '查询机器⼈问答概览指标。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['description' => '查询开始时间，时间格式为yyyyMMdd，⽐如20240505', 'type' => 'string', 'required' => true, 'example' => '20240505'], ], [ - 'name' => 'InstanceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['description' => '查询结束时间，时间格式为yyyyMMdd，⽐如20240605', 'type' => 'string', 'required' => true, 'example' => '20240605'], ], [ - 'name' => 'EntityId', + 'name' => 'RobotInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实体ID', - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '123', - ], + 'schema' => ['description' => '机器⼈实例id', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe'], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse<EntityIdResponse>', - 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '4dfghf56235asdf452', - ], - 'EntityId' => [ - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'CostTime' => ['description' => 'API调用耗时，单位毫秒ms。', 'type' => 'string', 'example' => '116'], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51'], + 'Datas' => [ + 'description' => '数据详情', + 'type' => 'array', + 'items' => ['description' => '数据详情', 'type' => 'object', 'example' => '参考JSON示例'], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorEntityId.NotExists', - 'errorMessage' => 'The business error EntityId is not exists.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostTime\\": \\"116\\",\\n \\"RequestId\\": \\"15CD94CC-CBEB-4189-806C-A132D1F45D51\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '机器人接待概况', + 'description' => '仅支持查询T-1（不含当天）的数据', + 'responseParamsDescription' => '**Datas**'."\n" + .'| 字段名 | 类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| SidCnt | int | 接待⼈次 |'."\n" + .'| ChatCnt | int | 对话请求量 |'."\n" + .'| AvgChatCnt | int | 平均对话轮次 |'."\n" + .'| SolutionSidCnt | int | 解决接待量 |'."\n" + .'| NoSolutionRate | double | 未解决率 |'."\n" + .'|NoAnswerRate| double |⽆答案率|'."\n" + .'|FeedbackChatCnt |int |点评量 |'."\n" + .'| FeedbackGoodChatCnt | int |点赞量 |'."\n" + .'|FeedbackBadChatCnt | int | 点踩量 |'."\n" + ."\n" + .'> Datas数组元素中的各个字段是以String类型返回的，如需转换为数字类型请按需解析', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBotSessionData'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '实体-删除', + 'ramActions' => [], ], - 'UpdateDSEntity' => [ - 'summary' => '实体meta信息修改，仅支持修改实体名称；实体类型不支持修改。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetInstancePublishTaskState' => [ + 'summary' => '查询机器人发布进度。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521'], ], [ - 'name' => 'EntityId', + 'name' => 'AgentKey', 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实体ID', - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '123', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D'], + 'Id' => ['title' => '任务Id', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8522'], + 'Response' => ['title' => '任务Id', 'description' => '任务ID', 'type' => 'string', 'example' => '8522'], + 'Status' => [ + 'title' => '任务状态', + 'description' => '任务状态', + 'type' => 'string', + 'enumValueTitles' => ['FE_SUCCESS' => '发布成功', 'FE_ABORTED' => '发布取消', 'FE_WARNING' => '有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_FAILED' => '发布失败', 'FE_RUNNING' => '正在发布中'], + 'example' => 'FE_RUNNING', + 'enum' => ['FE_RUNNING：正在发布中', 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], + ], + 'BizTypeList' => [ + 'title' => '业务类型列表', + 'description' => '业务类型列表', + 'type' => 'array', + 'items' => ['description' => '发布任务的业务类型', 'type' => 'string', 'example' => 'robot'], + ], + 'Error' => ['title' => 'job失败信息', 'description' => 'job失败信息', 'type' => 'string', 'example' => '检查待发布模块是否空闲发生错误，faq'], + 'CreateTime' => ['title' => '任务创建的 UTC 时间', 'description' => '任务创建的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'ModifyTime' => ['title' => '任务修改的 UTC 时间', 'description' => '任务修改的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z'], + 'Warnings' => ['title' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', 'description' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', 'type' => 'object', 'example' => '{'."\n" + .' "category_bind_faq": ['."\n" + .' "以下类目没有发布到正式环境：项目交付类目"'."\n" + .' ]'."\n" + .'}'], + 'Errors' => ['title' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', 'description' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', 'type' => 'object', 'example' => '{'."\n" + .' "robot_ds": ['."\n" + .' "{\\"dialogName\\":\\"TEST\\",\\"errorMessage\\":[\\"medusa@invocation.error.service.offline@请发布对话流所引用服务后重试！\\"],\\"needRefresh\\":false,\\"success\\":false}"'."\n" + .' ]'."\n" + .'}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\",\\n \\"Warnings\\": {\\n \\"category_bind_faq\\": [\\n \\"以下类目没有发布到正式环境：项目交付类目\\"\\n ]\\n },\\n \\"Errors\\": {\\n \\"robot_ds\\": [\\n \\"{\\\\\\"dialogName\\\\\\":\\\\\\"TEST\\\\\\",\\\\\\"errorMessage\\\\\\":[\\\\\\"medusa@invocation.error.service.offline@请发布对话流所引用服务后重试！\\\\\\"],\\\\\\"needRefresh\\\\\\":false,\\\\\\"success\\\\\\":false}\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询机器人发布进度', + 'responseParamsDescription' => "\n" + .'### Status字段枚举：'."\n" + .'| 字段名 | 枚举值 | 含义 |'."\n" + .'| --- | --- | --- |'."\n" + .'| Status | FE_RUNNING | 正在发布中 |'."\n" + .'| Status | FE_WARNING | 有警告，若需继续，请调用`ContinueInstancePublishTask`接口继续发布 |'."\n" + .'| Status | FE_SUCCESS | 发布成功 |'."\n" + .'| Status | FE_FAILED | 发布失败 |'."\n" + .'| Status | FE_ABORTED | 发布取消 |'."\n" + ."\n" + .'### Warnings&Errors 子发布模块枚举：'."\n" + .'| key值 | 含义 |'."\n" + .'| --- | --- |'."\n" + .'| category\\_bind\\_chitchat | 闲聊绑定关系 |'."\n" + .'| category\\_bind\\_faq | faq的绑定关系 |'."\n" + .'| robot_ds | 对话工厂对话流 |'."\n" + .'| ds_entity | 对话工厂实体 |'."\n" + .'| ds_intent | 对话工厂意图 |'."\n" + ."\n" + .'### 示例'."\n" + .'#### 响应报文：'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "ModifyTime": "2022-04-12T06:30:21Z",'."\n" + .' "BizTypeList": ['."\n" + .' "robot"'."\n" + .' ],'."\n" + .' "CreateTime": "2022-04-12T06:30:17Z",'."\n" + .' "RequestId": "cddf472f-6ce3-4eef-a969-1e8b16850cb4",'."\n" + .' "Response": "4930",'."\n" + .' "Warnings": {'."\n" + .' "category_bind_faq": ['."\n" + .' "以下类目没有发布到正式环境：项目交付类目"'."\n" + .' ]'."\n" + .' },'."\n" + .' "Id": 4930,'."\n" + .' "Status": "FE_WARNING"'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstancePublishTaskState'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'GetPublishTaskState' => [ + 'summary' => '查询发布进度。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EntityName', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '实体名称，仅支持中文、大小写字母、数字、下划线', - 'description' => '实体名称，仅支持中文、大小写字母、数字、下划线', - 'type' => 'string', - 'required' => true, - 'example' => '实体名称', - ], + 'schema' => ['title' => '发布任务Id', 'description' => '发布任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521'], ], [ - 'name' => 'EntityType', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '实体类型：详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', - 'description' => '实体类型：[synonyms（同义词），regex（正则）]', - 'type' => 'string', - 'required' => false, - 'example' => 'synonyms', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse<EntityIdResponse>', - 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D'], + 'Id' => ['title' => '发布任务Id', 'description' => '发布任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8522'], + 'Response' => ['title' => '发布任务Id，冗余字段，建议使用Id字段获取发布任务Id', 'description' => '发布任务ID,冗余字段,建议使用发布任务ID', 'type' => 'string', 'example' => '8522'], + 'Status' => [ + 'title' => '任务状态（ FE_RUNNING：正在发布中 FE_SUCCESS：发布成功 FE_FAILED：发布失败 FE_ABORTED：发布取消）', + 'description' => '任务状态'."\n" + .'枚举值：'."\n" + .'- FE_RUNNING：正在发布中'."\n" + .'- FE_SUCCESS：发布成功'."\n" + .'- FE_FAILED：发布失败'."\n" + .'- FE_ABORTED：发布取消', 'type' => 'string', - 'example' => 'df23fgh4hyj67hn56', - ], - 'EntityId' => [ - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'enumValueTitles' => [], + 'example' => 'FE_RUNNING', + 'enum' => ['FE_RUNNING：正在发布中', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], ], + 'BizTypeList' => [ + 'title' => '业务类型列表', + 'description' => '业务类型列表', + 'type' => 'array', + 'items' => ['description' => '发布任务的业务类型', 'type' => 'string', 'example' => 'faq'], + ], + 'Error' => ['title' => '发布任务失败信息', 'description' => '任务失败信息', 'type' => 'string', 'example' => '检查待发布模块是否空闲发生错误，faq'], + 'CreateTime' => ['title' => '任务创建的 UTC 时间', 'description' => '任务创建的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'ModifyTime' => ['title' => '任务修改的 UTC 时间', 'description' => '任务修改的 UTC 时间', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z'], + 'Errors' => ['title' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', 'description' => '各子发布模块的错误信息,key是子发布模块,value是错误信息', 'type' => 'object', 'example' => '{'."\n" + .' "faq": ['."\n" + .' "答案资源未发布，资源类型：全局服务，名称：动态答案服务"'."\n" + .' ]'."\n" + .'}'], + 'Warnings' => ['title' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', 'description' => '各子发布模块的警告信息,key是子发布模块,value是警告信息', 'type' => 'object', 'example' => '{'."\n" + .' "faq": ['."\n" + .' "答案资源未发布，类型：service，名称：null，答案资源未发布，类型：service，名称：null"'."\n" + .' ]'."\n" + .'}'."\n"], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorEntityId.NotExists', - 'errorMessage' => 'The business error EntityId is not exists.', - ], - [ - 'errorCode' => 'BusinessErrorEntityName.OutRange', - 'errorMessage' => 'The business error EntityName is out of range.', - ], - [ - 'errorCode' => 'BusinessErrorEntityName.Repeat', - 'errorMessage' => 'The business error EntityName is repeat.', - ], - [ - 'errorCode' => 'BusinessErrorEntityName.InvalidCharactor', - 'errorMessage' => 'The business error EntityName contains invalid charactor.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"faq\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\",\\n \\"Errors\\": {\\n \\"faq\\": [\\n \\"答案资源未发布，资源类型：全局服务，名称：动态答案服务\\"\\n ]\\n },\\n \\"Warnings\\": {\\n \\"faq\\": [\\n \\"答案资源未发布，类型：service，名称：null，答案资源未发布，类型：service，名称：null\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询发布进度', + 'changeSet' => [ + ['createdAt' => '2022-12-26T11:37:56.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPublishTaskState'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '实体-修改', + 'ramActions' => [], ], - 'DescribeDSEntity' => [ - 'summary' => '查询指定机器人下指定实体的meta信息，如：实体类型、实体名称、创建时间、修改时间等。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InitIMConnect' => [ + 'summary' => '通过渠道后台配置生成的from值，自定义初始化im连接信息，初始化时支持传递用户鉴权token。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8547,311 +4688,200 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebotJ8IS68'], + 'autoTest' => true, + ], 'parameters' => [ [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'name' => 'From', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'name' => 'UserAccessToken', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ - 'name' => 'EntityId', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '实体ID', - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '123', - ], + 'schema' => ['description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回参数说明', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'ad23234dsf234fga', - ], - 'EntityId' => [ - 'title' => '实体ID', - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'EntityName' => [ - 'title' => '实体名称，仅支持中文、大小写字母、数字、下划线', - 'description' => '实体名称，仅支持中文、大小写字母、数字、下划线', - 'type' => 'string', - 'example' => '书类型', - ], - 'SysEntityCode' => [ - 'title' => '系统实体code，如@sys.date', - 'description' => '系统实体code，如sys.date；用户实体时为空', - 'type' => 'string', - 'example' => 'sys.date', - ], - 'EntityType' => [ - 'title' => '实体类型：详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', - 'description' => '实体类型：[synonyms（同义词），regex（正则）]', - 'type' => 'string', - 'example' => 'synonyms', - ], - 'CreateTime' => [ - 'description' => '创建时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'ModifyTime' => [ - 'description' => '修改时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'CreateUserId' => [ - 'description' => '创建者ID', - 'type' => 'string', - 'example' => '123231', - ], - 'CreateUserName' => [ - 'description' => '创建人名称', - 'type' => 'string', - 'example' => 'test', - ], - 'ModifyUserId' => [ - 'description' => '修改人唯一标识', - 'type' => 'string', - 'example' => '123231', - ], - 'ModifyUserName' => [ - 'description' => '修改人名称', - 'type' => 'string', - 'example' => 'test', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E6988CE6-41CF-1103-9BEC-2B20D26C0B52'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '返回编码', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '异常信息', 'type' => 'string', 'example' => 'Parameter.Invalid'], + 'Data' => ['description' => 'im连接信息', 'type' => 'string', 'example' => '{ "imDomain": "im.alimebot.com", "appKey": "WDg2VfNv", "token": "QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==" }'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorEntityId.NotExists', - 'errorMessage' => 'The business error EntityId is not exists.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6988CE6-41CF-1103-9BEC-2B20D26C0B52\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Parameter.Invalid\\",\\n \\"Data\\": \\"{ \\\\\\"imDomain\\\\\\": \\\\\\"im.alimebot.com\\\\\\", \\\\\\"appKey\\\\\\": \\\\\\"WDg2VfNv\\\\\\", \\\\\\"token\\\\\\": \\\\\\"QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==\\\\\\" }\\"\\n}","type":"json"}]', + 'title' => '初始化im连接', + 'responseParamsDescription' => 'imDomain: im连接域名，'."\n" + .'appKey: im认证key，'."\n" + .'token: im连接token。', + 'changeSet' => [ + ['createdAt' => '2025-12-11T03:00:23.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-26T07:22:12.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitIMConnect'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '实体-详情', - 'responseParamsDescription' => '如果是系统实体，SysEntityCode返回系统实体key，例如：@sys.date', + 'ramActions' => [], ], - 'ListDSEntity' => [ - 'summary' => '查询指定机器人下的实体列表数据，仅返回每个实体的meta信息，如：实体类型、实体名称、创建时间、修改时间等。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'LinkInstanceCategory' => [ + 'summary' => '机器人绑定知识类目。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebotW5WL9W'], + ], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '机器人唯一标识', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'name' => 'CategoryIds', + 'in' => 'formData', + 'allowEmptyValue' => true, + 'schema' => ['title' => '知识类目Id', 'description' => '绑定到机器人的FAQ类目ID数组', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[\\"30000065789\\"]'], ], [ - 'name' => 'Keyword', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '筛选项，contains匹配，范围：实体名称（未来扩展：实体成员、同义词）', - 'description' => '筛选项，contains匹配，范围：实体名称（未来扩展：实体成员、同义词）', - 'type' => 'string', - 'required' => false, - 'example' => '实体', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'EntityType', + 'name' => 'AbilityType', 'in' => 'query', + 'schema' => ['description' => '类目的能力类型，如FAQ（高频问答），MRC（文档），默认FAQ', 'type' => 'string', 'required' => false, 'example' => 'FAQ,MRC', 'default' => 'FAQ'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '为空：全量自定义实体（默认）', - 'description' => '为空：全量自定义实体（默认）', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'regex' => 'regex', - 'system' => 'system', - 'synonyms' => 'synonyms', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => 'D8C96601-E645-1BD7-99F3-04EADAB84E29'], ], - 'example' => 'synonyms'."\n" - .'regex'."\n" - .'system', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8C96601-E645-1BD7-99F3-04EADAB84E29\\"\\n}","type":"json"}]', + 'title' => '机器人-绑定类目', + 'changeSet' => [ + ['createdAt' => '2025-08-20T07:52:54.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-09T12:50:08.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LinkInstanceCategory'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'ListAgent' => [ + 'summary' => '获取当前阿里云账号的业务空间列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebotS5PR8Q'], + ], + 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '当前⻚码，默认值是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => '返回结果中每页显示的记录数量。最大取值100，默认值是10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'AgentName', + 'in' => 'query', + 'schema' => ['description' => '业务空间名称，按照名称检索', 'type' => 'string', 'required' => false, 'example' => '业务空间_001'], + ], + [ + 'name' => 'GoodsCodes', + 'in' => 'query', 'schema' => [ - 'description' => '当前页数量，默认10', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '商品code，可按照商品code进行过滤，查询实例信息', + 'type' => 'string', 'required' => false, - 'example' => '10', - 'default' => '10', + 'enumValueTitles' => ['G_cloudBeeBot_public' => 'G_cloudBeeBot_public'], + 'example' => 'G_cloudBeeBot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息说明', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'ga4h345defgwet2sdf223', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页面大小，默认10', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Entities' => [ - 'description' => '实体列表信息', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419'], + 'PageNumber' => ['description' => '当前⻚，默认1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '返回结果中每页显示的记录数量。最大取值100，默认值是10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'Data' => [ + 'description' => '业务空间列表', 'type' => 'array', 'items' => [ - 'description' => '实体列表信息说明', + 'description' => '业务空间数据', 'type' => 'object', 'properties' => [ - 'EntityId' => [ - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234564567445', - ], - 'EntityName' => [ - 'description' => '实体名称', - 'type' => 'string', - 'example' => '书实体', - ], - 'SysEntityCode' => [ - 'title' => '系统实体code，如@sys.date', - 'description' => '系统实体code，如sys.date；用户实体时为空', - 'type' => 'string', - 'example' => 'sys_date', - ], - 'EntityType' => [ - 'description' => '实体类型（synonyms | regex | system)', - 'type' => 'string', - 'example' => 'synonyms', - ], - 'CreateTime' => [ - 'description' => '创建时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'ModifyTime' => [ - 'description' => '修改时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'CreateUserId' => [ - 'description' => '创建人ID', - 'type' => 'string', - 'example' => '123231', - ], - 'CreateUserName' => [ - 'description' => '创建人名称', - 'type' => 'string', - 'example' => 'test', - ], - 'ModifyUserId' => [ - 'description' => '修改人ID', - 'type' => 'string', - 'example' => '123231', - ], - 'ModifyUserName' => [ - 'description' => '修改人名称', - 'type' => 'string', - 'example' => 'test', + 'AgentId' => ['description' => '业务空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '881'], + 'AgentKey' => ['description' => '业务空间签名，用于PAAS接口指定业务空间时使用', 'type' => 'string', 'example' => '4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public'], + 'AgentName' => ['description' => '业务空间名称', 'type' => 'string', 'example' => '业务空间_881'], + 'InstanceInfos' => [ + 'description' => '商品实例信息', + 'type' => 'object', + 'enumValueTitles' => ['G_cloudBeeBot_public' => 'G_cloudBeeBot_public'], ], ], ], @@ -8860,364 +4890,240 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Ds.IllegalAccess.BotIdNotExists', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F55D90C1-31BE-4B2A-AA3F-25EFC36F9419\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 6,\\n \\"Data\\": [\\n {\\n \\"AgentId\\": 881,\\n \\"AgentKey\\": \\"4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public\\",\\n \\"AgentName\\": \\"业务空间_881\\",\\n \\"InstanceInfos\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取业务空间列表', + 'responseParamsDescription' => 'InstanceInfos示例。'."\n" + .'"InstanceInfos": {'."\n" + .' "GoodsCode": {'."\n" + .' "InstanceId": "xxxxxx"'."\n" + .' }'."\n" + .' }'."\n" + .'//GoodsCode参考枚举值', + 'changeSet' => [ + ['createdAt' => '2024-05-15T03:39:47.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-04-16T08:50:12.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgent'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '实体-列表', + 'ramActions' => [], ], - 'CreateDSEntityValue' => [ - 'summary' => '为指定的某个实体，添加实体成员信息，包含：实体值、对应的同义词列表，同一实体内部的实体值、同义词唯一。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListCategory' => [ + 'summary' => '获取类目列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'name' => 'KnowledgeType', + 'in' => 'formData', + 'schema' => ['title' => '知识类型,FAQ类目:1,文档类目:3', 'description' => '知识类型,FAQ类目:1,文档类目:3,默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'EntityId', - 'in' => 'query', - 'schema' => [ - 'title' => '实体ID，修改实体成员时可为空', - 'description' => '实体ID，修改实体成员时可为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '12', - ], + 'name' => 'ParentCategoryId', + 'in' => 'formData', + 'schema' => ['title' => '父类目ID', 'description' => '父类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '-1'], ], [ - 'name' => 'Content', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '实体值（或正则表达式）', - 'type' => 'string', - 'required' => true, - 'example' => '书类型', - ], - ], - [ - 'name' => 'Synonyms', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '同义词列表', - 'type' => 'array', - 'items' => [ - 'description' => '同义词值', - 'type' => 'string', - 'required' => false, - 'example' => '书本', - ], - 'required' => false, - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse<EntityValueIdResponse>', 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'g763hg48j3f3', - ], - 'EntityValueId' => [ - 'description' => '实体成员ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2434543453', + 'Categories' => [ + 'title' => 'list结果', + 'description' => '类目list结果', + 'type' => 'array', + 'items' => [ + 'description' => '类目信息', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => ['title' => '类目ID', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '231001028593'], + 'BizCode' => ['description' => '业务代码', 'type' => 'string', 'example' => 'bizcode123'], + 'Name' => ['description' => '类⽬名称', 'type' => 'string', 'example' => '类目名称'], + 'ParentCategoryId' => ['description' => '⽗类⽬ID'."\n" + ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'Status' => ['description' => '类目状态，-1：已删除未发布状态，0：正常', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + ], ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9C5F8186-2D22-433E-9545-606D344F30B5'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorEntityId.NotExists', - 'errorMessage' => 'The business error EntityId is not exists.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Categories\\": [\\n {\\n \\"CategoryId\\": 231001028593,\\n \\"BizCode\\": \\"bizcode123\\",\\n \\"Name\\": \\"类目名称\\",\\n \\"ParentCategoryId\\": -1,\\n \\"Status\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"9C5F8186-2D22-433E-9545-606D344F30B5\\"\\n}","type":"json"}]', + 'title' => '获取类目列表', + 'changeSet' => [ + ['createdAt' => '2024-02-22T12:10:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCategory'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '实体成员-创建', + 'ramActions' => [], ], - 'DeleteDSEntityValue' => [ - 'summary' => '删除某个实体的某个成员；若为标准实体，会同步删除其同义词（若有）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListConnQuestion' => [ + 'summary' => '查询知识的关联问题列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], - ], - [ - 'name' => 'EntityId', - 'in' => 'query', - 'schema' => [ - 'title' => '实体ID', - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '345346223452', - ], + 'name' => 'KnowledgeId', + 'in' => 'formData', + 'schema' => ['description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617'], ], [ - 'name' => 'EntityValueId', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '实体成员ID', - 'description' => '实体成员ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '3453453452', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '返回信息说明', + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'dfdf2t3rfvb45y', - ], - 'EntityValueId' => [ - 'description' => '实体成员ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3453453452', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B'], + 'Outlines' => [ + 'description' => '关联问题列表', + 'type' => 'array', + 'items' => [ + 'description' => '关联问信息', + 'type' => 'object', + 'properties' => [ + 'OutlineId' => ['title' => '关联关系ID', 'description' => '关联关系ID', 'type' => 'integer', 'format' => 'int64', 'example' => '797'], + 'ConnQuestionId' => ['title' => '关联知识ID', 'description' => '关联知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424'], + 'Title' => ['title' => '关联知识题目', 'description' => '关联知识标题', 'type' => 'string', 'example' => '关联问'], + 'ModifyTime' => ['title' => '修改时间(UTC 时间)', 'description' => '修改时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-26T10:18:15Z'], + 'CreateTime' => ['title' => '创建时间(UTC 时间)', 'description' => '创建时间（UTC 时间）', 'type' => 'string', 'example' => '2022-02-25T02:47:18Z'], + ], + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorEntityId.NotExists', - 'errorMessage' => 'The business error EntityId is not exists.', - ], - [ - 'errorCode' => 'BusinessErrorEntityValueId.NotExists', - 'errorMessage' => 'The business error EntityValueId is not exists.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"92B81548-42B9-4B34-924B-4E778AEB412B\\",\\n \\"Outlines\\": [\\n {\\n \\"OutlineId\\": 797,\\n \\"ConnQuestionId\\": 30001979424,\\n \\"Title\\": \\"关联问\\",\\n \\"ModifyTime\\": \\"2022-05-26T10:18:15Z\\",\\n \\"CreateTime\\": \\"2022-02-25T02:47:18Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取关联问列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnQuestion'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '实体-实体成员-删除', + 'ramActions' => [], ], - 'UpdateDSEntityValue' => [ - 'summary' => '修改某个实体的某个实体成员，有实体值&同义词、正则表达式两类数据修改。注意：往一个标准实体中添加正则表达式是不被允许的，反之亦然。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDSEntity' => [ + 'summary' => '查询指定机器人下的实体列表数据，仅返回每个实体的meta信息，如：实体类型、实体名称、创建时间、修改时间等。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'EntityId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'title' => '实体ID，修改实体成员时可为空', - 'description' => '实体ID，修改实体成员时可为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '223423423', - ], + 'schema' => ['title' => '筛选项，contains匹配，范围：实体名称（未来扩展：实体成员、同义词）', 'description' => '筛选项，contains匹配，范围：实体名称（未来扩展：实体成员、同义词）', 'type' => 'string', 'required' => false, 'example' => '实体'], ], [ - 'name' => 'EntityValueId', + 'name' => 'EntityType', 'in' => 'query', 'schema' => [ - 'title' => '实体成员ID，创建实体成员时为空', - 'description' => '实体成员ID，创建实体成员时为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '2342377423', + 'title' => '为空：全量自定义实体（默认）', + 'description' => '为空：全量自定义实体（默认）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['regex' => 'regex', 'system' => 'system', 'synonyms' => 'synonyms'], + 'example' => 'synonyms'."\n" + .'regex'."\n" + .'system', ], ], [ - 'name' => 'Content', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '实体类型为synonyms时，表示实体归一化值；当实体类型为regex时，表示正则表达式文本', - 'description' => '实体类型为synonyms时，表示实体归一化值；当实体类型为regex时，表示正则表达式文本', - 'type' => 'string', - 'required' => true, - 'example' => '书本类型', - ], + 'schema' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'Synonyms', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '实体同义词', - 'description' => '同义词列表', - 'type' => 'array', - 'items' => [ - 'description' => '实体同义词', - 'type' => 'string', - 'required' => false, - 'example' => '小说', - ], - 'required' => false, - 'maxItems' => 10, - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '当前页数量，默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse<EntityValueIdResponse>', - 'description' => '返回值', + 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'sDag3g43wesf2', - ], - 'EntityValueId' => [ - 'description' => '实体成员ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2342377423', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'ga4h345defgwet2sdf223'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页面大小，默认10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Entities' => [ + 'description' => '实体列表信息', + 'type' => 'array', + 'items' => [ + 'description' => '实体列表信息说明', + 'type' => 'object', + 'properties' => [ + 'EntityId' => ['description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'example' => '234564567445'], + 'EntityName' => ['description' => '实体名称', 'type' => 'string', 'example' => '书实体'], + 'SysEntityCode' => ['title' => '系统实体code，如@sys.date', 'description' => '系统实体code，如sys.date；用户实体时为空', 'type' => 'string', 'example' => 'sys_date'], + 'EntityType' => ['description' => '实体类型（synonyms | regex | system)', 'type' => 'string', 'example' => 'synonyms'], + 'CreateTime' => ['description' => '创建时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'ModifyTime' => ['description' => '修改时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'CreateUserId' => ['description' => '创建人ID', 'type' => 'string', 'example' => '123231'], + 'CreateUserName' => ['description' => '创建人名称', 'type' => 'string', 'example' => 'test'], + 'ModifyUserId' => ['description' => '修改人ID', 'type' => 'string', 'example' => '123231'], + 'ModifyUserName' => ['description' => '修改人名称', 'type' => 'string', 'example' => 'test'], + ], + ], ], ], ], @@ -9225,25 +5131,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BusinessErrorEntityId.NotExists', - 'errorMessage' => 'The business error EntityId is not exists.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Ds.IllegalAccess.BotIdNotExists', 'description' => ''], ], ], - 'responseDemo' => '', - 'title' => '实体成员-修改', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ga4h345defgwet2sdf223\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Entities\\": [\\n {\\n \\"EntityId\\": 234564567445,\\n \\"EntityName\\": \\"书实体\\",\\n \\"SysEntityCode\\": \\"sys_date\\",\\n \\"EntityType\\": \\"synonyms\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"CreateUserId\\": \\"123231\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"ModifyUserId\\": \\"123231\\",\\n \\"ModifyUserName\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDSEntityResponse>\\n <RequestId>ga4h345defgwet2sdf223</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Entities>\\n <EntityId>234564567445</EntityId>\\n <EntityName>书实体</EntityName>\\n <EntityType>synonyms</EntityType>\\n <CreateTime>1654567002000</CreateTime>\\n <ModifyTime>1654567002000</ModifyTime>\\n <CreateUserId>123231</CreateUserId>\\n <CreateUserName>test</CreateUserName>\\n <ModifyUserId>123231</ModifyUserId>\\n <ModifyUserName>test</ModifyUserName>\\n </Entities>\\n</ListDSEntityResponse>","errorExample":""}]', + 'title' => '实体-列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDSEntity'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], ], 'ListDSEntityValue' => [ 'summary' => '查询指定实体的实体成员列表及详情数据，同时支持关键词筛选（contains），筛选范围：实体值、同义词。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9256,93 +5161,37 @@ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ 'name' => 'EntityId', 'in' => 'formData', - 'schema' => [ - 'title' => '实体ID', - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '123', - ], + 'schema' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123'], ], [ 'name' => 'EntityValueId', 'in' => 'formData', - 'schema' => [ - 'title' => '实体成员ID', - 'description' => '实体成员ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '234', - ], + 'schema' => ['title' => '实体成员ID', 'description' => '实体成员ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '234'], ], [ 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'title' => '实体成员名称搜索关键词', - 'description' => '实体成员名称搜索关键词', - 'type' => 'string', - 'required' => false, - 'example' => '书', - ], + 'schema' => ['title' => '实体成员名称搜索关键词', 'description' => '实体成员名称搜索关键词', 'type' => 'string', 'required' => false, 'example' => '书'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'], ], ], 'responses' => [ @@ -9351,11 +5200,7 @@ 'description' => '返回值信息', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求唯一标识', - 'type' => 'string', - 'example' => 'n3fg34gbfj8adf2gj923', - ], + 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'n3fg34gbfj8adf2gj923'], 'EntityValues' => [ 'description' => '实体列表', 'type' => 'array', @@ -9363,325 +5208,255 @@ 'description' => '实体列表信息', 'type' => 'object', 'properties' => [ - 'EntityId' => [ - 'description' => '实体ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34313785463', - ], - 'EntityValueId' => [ - 'description' => '实体成员ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3467858234534534532', - ], - 'Content' => [ - 'description' => '实体成员名称（实体值或正则表达式）', - 'type' => 'string', - 'example' => '书类型', - ], + 'EntityId' => ['description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'example' => '34313785463'], + 'EntityValueId' => ['description' => '实体成员ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3467858234534534532'], + 'Content' => ['description' => '实体成员名称（实体值或正则表达式）', 'type' => 'string', 'example' => '书类型'], 'Synonyms' => [ 'description' => '同义词列表', 'type' => 'array', - 'items' => [ - 'description' => '同义词列表说明', - 'type' => 'string', - 'example' => '小说', - ], - ], - 'CreateTime' => [ - 'description' => '创建时间(UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'ModifyTime' => [ - 'description' => '修改时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', + 'items' => ['description' => '同义词列表说明', 'type' => 'string', 'example' => '小说'], ], + 'CreateTime' => ['description' => '创建时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'ModifyTime' => ['description' => '修改时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], ], ], ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页面大小，默认10', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页面大小，默认10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BusinessErrorEntityId.NotExists', - 'errorMessage' => 'The business error EntityId is not exists.', - ], + ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], ], ], - 'responseDemo' => '', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"n3fg34gbfj8adf2gj923\\",\\n \\"EntityValues\\": [\\n {\\n \\"EntityId\\": 34313785463,\\n \\"EntityValueId\\": 3467858234534534700,\\n \\"Content\\": \\"书类型\\",\\n \\"Synonyms\\": [\\n \\"小说\\"\\n ],\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListDSEntityValueResponse>\\n <RequestId>n3fg34gbfj8adf2gj923</RequestId>\\n <EntityValues>\\n <EntityId>34313785463</EntityId>\\n <EntityValueId>3467858234534534700</EntityValueId>\\n <Content>书类型</Content>\\n <Synonyms>小说</Synonyms>\\n <CreateTime>1652883349000</CreateTime>\\n <ModifyTime>1652883349000</ModifyTime>\\n </EntityValues>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n</ListDSEntityValueResponse>","errorExample":""}]', 'title' => '实体成员-列表', - ], - 'CreateIntent' => [ - 'summary' => '新建意图，主要包含意图的meta信息，如：意图名称、意图别名、意图关联词槽信息；不包含意图话术、LGF。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDSEntityValue'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'ListInstance' => [ + 'summary' => '查询机器人列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebotW5WL9W'], + ], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '分页-第几页，默认1', 'description' => '分页-第几页，默认1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '分页-页面大小，默认10', 'description' => '分页-页面大小，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RobotType', 'in' => 'query', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'title' => '按机器人类型筛选', + 'description' => '按机器人类型筛选', 'type' => 'string', 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + 'enumValueTitles' => ['scenario_callout' => '外呼机器人', 'scenario_im' => '在线文本机器人', 'scenario_ivr' => '导航机器人'], + 'example' => 'scenario_im', ], ], [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['title' => '按机器人名称模糊搜索', 'description' => '按机器人名称模糊搜索', 'type' => 'string', 'required' => false, 'example' => '售前客服'], ], [ - 'name' => 'IntentDefinition', + 'name' => 'AgentKey', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ + 'name' => 'Sandbox', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '意图定义结构体', - 'description' => '意图定义结构体', 'type' => 'object', 'properties' => [ - 'IntentName' => [ - 'title' => '意图名称', - 'description' => '意图名称', - 'type' => 'string', - 'required' => true, - 'example' => '查天气意图', - ], - 'AliasName' => [ - 'title' => '意图别名', - 'description' => '意图别名', - 'type' => 'string', - 'required' => false, - 'example' => '查天气意图', - ], - 'SlotInfos' => [ - 'title' => '槽位信息', - 'description' => '槽位信息', + 'Instances' => [ + 'title' => '机器人列表信息', + 'description' => '机器人列表信息', 'type' => 'array', 'items' => [ - 'description' => '滑槽信息', + 'description' => '机器人信息', 'type' => 'object', 'properties' => [ - 'SlotId' => [ - 'description' => '滑槽ID', - 'type' => 'string', - 'required' => true, - 'example' => 'fg452dfg3df23', - ], - 'Name' => [ - 'title' => '槽位名', - 'description' => '槽位名', - 'type' => 'string', - 'required' => true, - 'example' => '天气', - ], - 'Value' => [ - 'title' => '关联的实体名', - 'description' => '关联的实体名', + 'InstanceId' => ['title' => '机器人唯一标识', 'description' => '机器人唯一标识', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050'], + 'Name' => ['title' => '机器人名称', 'description' => '机器人名称', 'type' => 'string', 'example' => '智能客服-小C'], + 'Introduction' => ['title' => '机器人备注', 'description' => '机器人备注', 'type' => 'string', 'example' => '用于C端问答的机器人'], + 'LanguageCode' => ['title' => '机器人服务的语言', 'description' => '机器人服务的语言，如 zh-cn、en-us，参考 http://www.lingoes.net/zh/translator/langcode.htm ', 'type' => 'string', 'example' => 'zh-cn'], + 'RobotType' => [ + 'title' => '机器人类型', + 'description' => '机器人类型', 'type' => 'string', - 'required' => true, - 'example' => '天气', - ], - 'Interactive' => [ - 'title' => '是否交互式', - 'description' => '是否交互式', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Array' => [ - 'title' => '是否数组', - 'description' => '是否数组', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Encrypt' => [ - 'title' => '是否脱敏', - 'description' => '是否脱敏', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'enumValueTitles' => ['scenario_callout' => '外呼机器人', 'scenario_im' => '在线文本机器人', 'scenario_ivr' => '导航机器人'], + 'example' => 'scenario_im', ], + 'Avatar' => ['title' => '机器人头像的URL', 'description' => '机器人头像的URL', 'type' => 'string', 'example' => '/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png'], + 'CreateTime' => ['title' => '机器人创建的 UTC 时间', 'description' => '机器人创建的 UTC 时间', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], ], - 'required' => false, ], - 'required' => false, ], + 'TotalCount' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], + 'PageSize' => ['title' => '分页-页面大小', 'description' => '分页-页面大小', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'PageNumber' => ['title' => '分页-第几页', 'description' => '分页-第几页', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B'], ], - 'required' => true, - 'docRequired' => true, + 'description' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回信息', - 'type' => 'object', - 'properties' => [ - 'IntentId' => [ - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43546474', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'df56gjh5et34g3g3', - ], - ], - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"chatbot-cn-mp90s2lrk00050\\",\\n \\"Name\\": \\"智能客服-小C\\",\\n \\"Introduction\\": \\"用于C端问答的机器人\\",\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"RobotType\\": \\"scenario_im\\",\\n \\"Avatar\\": \\"/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"PageSize\\": 5,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"92B81548-42B9-4B34-924B-4E778AEB412B\\"\\n}","type":"json"}]', + 'title' => '机器人-列表', + 'responseParamsDescription' => '### 示例'."\n" + .'#### 响应报文：'."\n" + .'```json'."\n" + .' {'."\n" + .' "PageNumber": 1,'."\n" + .' "TotalCount": 1,'."\n" + .' "PageSize": 10,'."\n" + .' "RequestId": "787B6D28-A81E-486F-BC8C-64ADED337B25",'."\n" + .' "Instances":['."\n" + .' {'."\n" + .' "InstanceId":"chatbot-cn-xxxxx",'."\n" + .' "Avatar":"/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png",'."\n" + .' "LanguageCode":"zh-cn",'."\n" + .' "RobotType":"scenario_im",'."\n" + .' "Name":"智能客服-小C",'."\n" + .' "Introduction":"用于C端问答的机器人",'."\n" + .' "CreateTime":"2021-08-12T16:00:01Z"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + ."\n" + .'```', + 'changeSet' => [ + ['createdAt' => '2022-06-10T03:13:25.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorIntent.OutRange', - 'errorMessage' => 'The business error Intent is out of range.', - ], - [ - 'errorCode' => 'BusinessErrorIntentName.OutRange', - 'errorMessage' => 'The business error IntentName is out of range.', - ], - [ - 'errorCode' => 'BusinessErrorIntentName.Repeat', - 'errorMessage' => 'The business error IntentName is repeat.', - ], - [ - 'errorCode' => 'BusinessErrorIntentName.InvalidCharactor', - 'errorMessage' => 'The business error IntentName contains invalid charactor.', - ], - [ - 'errorCode' => 'BusinessErrorIntentEntity.NotExists', - 'errorMessage' => 'The business error IntentEntity is not exists.', - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstance'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '意图-创建', + 'ramActions' => [], ], - 'DeleteIntent' => [ - 'summary' => '删除一个意图，会级联删除该意图下所有的意图话术和高级语义配置（LGF）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListIntent' => [ + 'summary' => '查询指定机器人下的意图列表数据，仅返回每个意图的 meta 信息，如：意图类型、意图名称、创建时间、修改时间等。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'IntentId', + 'name' => 'IntentName', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '12345', - ], + 'schema' => ['title' => '意图名称', 'description' => '意图名称', 'type' => 'string', 'required' => false, 'example' => '查天气'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999', 'minimum' => '1', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页面大小，默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '10', 'default' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息说明', + 'title' => 'BaseResponse<DsIntentPageData>', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'IntentId' => [ - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '3464dfg3qwr34tf34', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '23dsfa34r2s2s2sd12'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页面大小，默认10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Intents' => [ + 'description' => '意图列表', + 'type' => 'array', + 'items' => [ + 'description' => '意图列表说明', + 'type' => 'object', + 'properties' => [ + 'IntentId' => ['description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'example' => '234234234234'], + 'IntentName' => ['description' => '意图名称', 'type' => 'string', 'example' => '查天气意图'], + 'AliasName' => ['description' => '意图别名', 'type' => 'string', 'example' => '查天气意图'], + 'SlotInfos' => [ + 'description' => '意图关联的槽位信息', + 'type' => 'array', + 'items' => [ + 'description' => '意图关联的槽位信息说明', + 'type' => 'object', + 'properties' => [ + 'SlotId' => ['title' => '槽位ID', 'description' => '槽位ID', 'type' => 'string', 'example' => '12134223'], + 'Name' => ['title' => '槽位名', 'description' => '槽位名', 'type' => 'string', 'example' => '天气'], + 'Value' => ['title' => '槽位值（实体名）', 'description' => '槽位值（实体名）', 'type' => 'string', 'example' => '天气'], + 'Interactive' => ['title' => '是否交互式收集', 'description' => '是否交互式收集', 'type' => 'boolean', 'example' => 'false'], + 'Array' => ['title' => '是否数组', 'description' => '是否数组', 'type' => 'boolean', 'example' => 'false'], + 'Encrypt' => ['title' => '是否敏感', 'description' => '是否敏感', 'type' => 'boolean', 'example' => 'false'], + ], + ], + ], + 'CreateTime' => ['description' => '创建时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'ModifyTime' => ['description' => '修改时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'CreateUserId' => ['description' => '创建人唯一标识', 'type' => 'string', 'example' => '123231'], + 'CreateUserName' => ['description' => '创建人名称', 'type' => 'string', 'example' => 'test'], + 'ModifyUserId' => ['description' => '修改人唯一标识', 'type' => 'string', 'example' => '123231'], + 'ModifyUserName' => ['description' => '修改人名称', 'type' => 'string', 'example' => 'test'], + ], + ], ], ], ], @@ -9689,201 +5464,110 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BusinessErrorIntentId.NotExists', - 'errorMessage' => 'The business error Intent is not exists.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter InstanceId is not valid!', 'description' => ''], ], ], - 'responseDemo' => '', - 'title' => '意图-删除', - ], - 'UpdateIntent' => [ - 'summary' => '修改意图，主要包含意图的meta信息，如：意图名称、意图别名、意图关联词槽信息；不包含意图话术、LGF。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"23dsfa34r2s2s2sd12\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Intents\\": [\\n {\\n \\"IntentId\\": 234234234234,\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"AliasName\\": \\"查天气意图\\",\\n \\"SlotInfos\\": [\\n {\\n \\"SlotId\\": \\"12134223\\",\\n \\"Name\\": \\"天气\\",\\n \\"Value\\": \\"天气\\",\\n \\"Interactive\\": false,\\n \\"Array\\": false,\\n \\"Encrypt\\": false\\n }\\n ],\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"CreateUserId\\": \\"123231\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"ModifyUserId\\": \\"123231\\",\\n \\"ModifyUserName\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListIntentResponse>\\n <RequestId>23dsfa34r2s2s2sd12</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <Intents>\\n <IntentId>234234234234</IntentId>\\n <IntentName>查天气意图</IntentName>\\n <AliasName>查天气意图</AliasName>\\n <SlotInfos>\\n <SlotId>12134223</SlotId>\\n <Name>天气</Name>\\n <Value>天气</Value>\\n <Interactive>false</Interactive>\\n <Array>false</Array>\\n <Encrypt>false</Encrypt>\\n </SlotInfos>\\n <CreateTime>1652883349000</CreateTime>\\n <ModifyTime>1652883349000</ModifyTime>\\n <CreateUserId>123231</CreateUserId>\\n <CreateUserName>test</CreateUserName>\\n <ModifyUserId>123231</ModifyUserId>\\n <ModifyUserName>test</ModifyUserName>\\n </Intents>\\n</ListIntentResponse>","errorExample":""}]', + 'title' => '意图-列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntent'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'ListLgf' => [ + 'summary' => '查询指定意图的高级语义配置（LGF）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ 'name' => 'IntentId', 'in' => 'query', - 'schema' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '234234234534', - ], + 'schema' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123'], ], [ - 'name' => 'IntentDefinition', + 'name' => 'LgfText', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '筛选语义配置内容', 'description' => '筛选语义配置内容', 'type' => 'string', 'required' => false, 'example' => '.{0,5}北京天气'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页面大小，默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '意图定义结构体', - 'description' => '意图定义结构体', + 'title' => 'BaseResponse<DsLgfPageData>', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'IntentName' => [ - 'title' => '意图名称', - 'description' => '意图名称', - 'type' => 'string', - 'required' => true, - 'example' => '查天气意图', - ], - 'AliasName' => [ - 'title' => '意图别名', - 'description' => '意图别名', - 'type' => 'string', - 'required' => false, - 'example' => '查天气意图', - ], - 'SlotInfos' => [ - 'title' => '槽位信息', - 'description' => '槽位信息', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '34fg57h2gh5783'], + 'Lgfs' => [ + 'description' => 'LGF列表', 'type' => 'array', 'items' => [ - 'description' => '槽位信息', + 'description' => 'LGF列表说明', 'type' => 'object', 'properties' => [ - 'SlotId' => [ - 'description' => '槽位ID', - 'type' => 'string', - 'required' => true, - 'example' => 'dgadf23dfg2f', - ], - 'Name' => [ - 'title' => '槽位名', - 'description' => '槽位名', - 'type' => 'string', - 'required' => true, - 'example' => '天气', - ], - 'Value' => [ - 'title' => '关联的实体名', - 'description' => '关联的实体名', - 'type' => 'string', - 'required' => true, - 'example' => '天气', - ], - 'Interactive' => [ - 'title' => '是否交互式', - 'description' => '是否交互式', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Array' => [ - 'title' => '是否数组', - 'description' => '是否数组', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Encrypt' => [ - 'title' => '是否脱敏', - 'description' => '是否脱敏', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'IntentId' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'example' => '256756734345'], + 'LgfId' => ['title' => 'LGF ID', 'description' => 'LGF ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'RuleText' => ['title' => 'LGF规则', 'description' => 'LGF规则', 'type' => 'string', 'example' => '.{0,5}北京天气'], + 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], ], - 'required' => false, ], - 'required' => false, ], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页面大小，默认10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], - 'required' => true, - 'docRequired' => true, ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回信息说明', - 'type' => 'object', - 'properties' => [ - 'IntentId' => [ - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234234234534', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'dfaf23dfas234234234534', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorIntentId.NotExists', - 'errorMessage' => 'The business error Intent is not exists.', - ], - [ - 'errorCode' => 'BusinessErrorIntent.OutRange', - 'errorMessage' => 'The business error Intent is out of range.', - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34fg57h2gh5783\\",\\n \\"Lgfs\\": [\\n {\\n \\"IntentId\\": 256756734345,\\n \\"LgfId\\": 123,\\n \\"RuleText\\": \\".{0,5}北京天气\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListLgfResponse>\\n <RequestId>34fg57h2gh5783</RequestId>\\n <Lgfs>\\n <IntentId>256756734345</IntentId>\\n <LgfId>34564574546</LgfId>\\n <RuleText>.{0,5}北京天气</RuleText>\\n <CreateTime>1652883349000</CreateTime>\\n <ModifyTime>1652883349000</ModifyTime>\\n </Lgfs>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>11</PageSize>\\n</ListLgfResponse>","errorExample":""}]', + 'title' => '意图-LGF-列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLgf'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '意图-修改', + 'ramActions' => [], ], - 'DescribeIntent' => [ - 'summary' => '返回指定意图的 meta 信息，如：意图类型、意图名称、创建时间、修改时间等。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSaasInfo' => [ + 'summary' => '获取SaaS被集成信息列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9896,166 +5580,63 @@ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'InstanceId', + 'name' => 'SaasName', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['description' => '业务方用户名', 'type' => 'string', 'required' => true, 'example' => 'userTest'], ], [ - 'name' => 'IntentId', - 'in' => 'formData', - 'schema' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '123', - ], + 'name' => 'SaasGroupCodes', + 'in' => 'query', + 'schema' => ['description' => '用户所拥有的saas权限组code，多个用英文逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'DS,FAQ'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse<DsPaasIntentDTO>', - 'description' => '返回值', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求唯一标识', - 'type' => 'string', - 'example' => 'a22afaf2adfasf2gr345fga45ada', - ], - 'IntentId' => [ - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '84243341', - ], - 'IntentName' => [ - 'description' => '意图名称', - 'type' => 'string', - 'example' => '查天气意图', - ], - 'AliasName' => [ - 'description' => '意图别名', - 'type' => 'string', - 'example' => '查天气意图', - ], - 'SlotInfos' => [ - 'description' => '意图关联的槽位信息', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A629A28F-F25E-5572-A679-FA46FB0151D6'], + 'Data' => [ + 'description' => 'SaaS被集成列表', 'type' => 'array', 'items' => [ - 'description' => '意图关联的槽位信息', + 'description' => 'SaaS被集成信息', 'type' => 'object', 'properties' => [ - 'SlotId' => [ - 'description' => '槽位唯一标识', - 'type' => 'string', - 'example' => 'aa4d2a343a3ad4afad', - ], - 'Name' => [ - 'description' => '槽位名称', - 'type' => 'string', - 'example' => '天气', - ], - 'Value' => [ - 'description' => '槽位划词结果', - 'type' => 'string', - 'example' => '天气', - ], - 'Interactive' => [ - 'description' => '是否交互式填槽，默认为false', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Array' => [ - 'description' => '是否数组', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Encrypt' => [ - 'description' => '是否敏感', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['description' => 'SaaS原子化页面唯一标识，可用来关联和查询原子页面的相关信息', 'type' => 'string', 'example' => 'GLOBAL_SERVICE'], + 'Name' => ['description' => '原子页面的中文名称', 'type' => 'string', 'example' => '全局服务'], + 'Url' => ['description' => '原子页面的链接地址', 'type' => 'string', 'example' => 'https://alime.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot'], + 'EnName' => ['description' => '原子页面的英文名称', 'type' => 'string', 'example' => 'GLOBAL SERVICE'], + 'ServiceUrl' => ['description' => 'iframe嵌套SaaS页面链接', 'type' => 'string', 'example' => 'https://pre-alime4service.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot'], ], ], ], - 'CreateTime' => [ - 'description' => '创建时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'ModifyTime' => [ - 'description' => '修改时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'CreateUserId' => [ - 'description' => '创建人唯一标识', - 'type' => 'string', - 'example' => '123231', - ], - 'CreateUserName' => [ - 'description' => '创建人名称', - 'type' => 'string', - 'example' => 'test', - ], - 'ModifyUserId' => [ - 'description' => '修改人唯一标识', - 'type' => 'string', - 'example' => '123231', - ], - 'ModifyUserName' => [ - 'description' => '修改人名称', - 'type' => 'string', - 'example' => 'test', - ], + 'SaasToken' => ['description' => '云小蜜颁发的SaaS被集成Token', 'type' => 'string', 'example' => '06614fdb-c72f-436e-8003-dfe8a2854a15'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorIntentId.NotExists', - 'errorMessage' => 'The business error IntentId is not exists.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A629A28F-F25E-5572-A679-FA46FB0151D6\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"GLOBAL_SERVICE\\",\\n \\"Name\\": \\"全局服务\\",\\n \\"Url\\": \\"https://alime.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot\\",\\n \\"EnName\\": \\"GLOBAL SERVICE\\",\\n \\"ServiceUrl\\": \\"https://pre-alime4service.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot\\"\\n }\\n ],\\n \\"SaasToken\\": \\"06614fdb-c72f-436e-8003-dfe8a2854a15\\"\\n}","type":"json"}]', + 'title' => '获取SaaS被集成信息列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSaasInfo'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'staticInfo' => [], - 'responseDemo' => '', - 'title' => '意图-详情', + 'ramActions' => [], ], - 'ListIntent' => [ - 'summary' => '查询指定机器人下的意图列表数据，仅返回每个意图的 meta 信息，如：意图类型、意图名称、创建时间、修改时间等。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSaasPermissionGroupInfos' => [ + 'summary' => '获取权限被集成信息列表，可通过该列表返回的权限组，给用户授权。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10068,194 +5649,40 @@ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], - ], - [ - 'name' => 'IntentName', - 'in' => 'query', - 'schema' => [ - 'title' => '意图名称', - 'description' => '意图名称', - 'type' => 'string', - 'required' => false, - 'example' => '查天气', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '999999', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '页面大小，默认10', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => true, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse<DsIntentPageData>', - 'description' => '返回值', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '23dsfa34r2s2s2sd12', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页面大小，默认10', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Intents' => [ - 'description' => '意图列表', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32'], + 'Data' => [ + 'description' => 'SaaS各集成页面权限列表', 'type' => 'array', 'items' => [ - 'description' => '意图列表说明', + 'description' => 'SaaS各集成页面权限', 'type' => 'object', 'properties' => [ - 'IntentId' => [ - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234234234234', - ], - 'IntentName' => [ - 'description' => '意图名称', - 'type' => 'string', - 'example' => '查天气意图', - ], - 'AliasName' => [ - 'description' => '意图别名', - 'type' => 'string', - 'example' => '查天气意图', - ], - 'SlotInfos' => [ - 'description' => '意图关联的槽位信息', + 'SaasCode' => ['description' => 'SaaS原子化页面唯一标识', 'type' => 'string', 'example' => 'FAQ'], + 'Name' => ['description' => '原子页面的中文名称', 'type' => 'string', 'example' => '发布中心'], + 'EnName' => ['description' => '原子页面的英文名称', 'type' => 'string', 'example' => 'Release Center'], + 'PgInfos' => [ + 'description' => 'SaaS权限组列表', 'type' => 'array', 'items' => [ - 'description' => '意图关联的槽位信息说明', + 'description' => 'SaaS权限组信息', 'type' => 'object', 'properties' => [ - 'SlotId' => [ - 'title' => '槽位ID', - 'description' => '槽位ID', - 'type' => 'string', - 'example' => '12134223', - ], - 'Name' => [ - 'title' => '槽位名', - 'description' => '槽位名', - 'type' => 'string', - 'example' => '天气', - ], - 'Value' => [ - 'title' => '槽位值（实体名）', - 'description' => '槽位值（实体名）', - 'type' => 'string', - 'example' => '天气', - ], - 'Interactive' => [ - 'title' => '是否交互式收集', - 'description' => '是否交互式收集', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Array' => [ - 'title' => '是否数组', - 'description' => '是否数组', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Encrypt' => [ - 'title' => '是否敏感', - 'description' => '是否敏感', - 'type' => 'boolean', - 'example' => 'false', - ], + 'PgCode' => ['description' => 'SaaS权限组Code', 'type' => 'string', 'example' => 'FAQ'], + 'PgName' => ['description' => 'SaaS权限组中文名', 'type' => 'string', 'example' => 'FAQ管理'], + 'PgEnName' => ['description' => 'SaaS权限组英文名', 'type' => 'string', 'example' => 'FAQ'], ], ], ], - 'CreateTime' => [ - 'description' => '创建时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'ModifyTime' => [ - 'description' => '修改时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'CreateUserId' => [ - 'description' => '创建人唯一标识', - 'type' => 'string', - 'example' => '123231', - ], - 'CreateUserName' => [ - 'description' => '创建人名称', - 'type' => 'string', - 'example' => 'test', - ], - 'ModifyUserId' => [ - 'description' => '修改人唯一标识', - 'type' => 'string', - 'example' => '123231', - ], - 'ModifyUserName' => [ - 'description' => '修改人名称', - 'type' => 'string', - 'example' => 'test', - ], ], ], ], @@ -10263,419 +5690,355 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter InstanceId is not valid!', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8AD9FA10-7780-5E12-B701-13C928524F32\\",\\n \\"Data\\": [\\n {\\n \\"SaasCode\\": \\"FAQ\\",\\n \\"Name\\": \\"发布中心\\",\\n \\"EnName\\": \\"Release Center\\",\\n \\"PgInfos\\": [\\n {\\n \\"PgCode\\": \\"FAQ\\",\\n \\"PgName\\": \\"FAQ管理\\",\\n \\"PgEnName\\": \\"FAQ\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取权限被集成信息列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSaasPermissionGroupInfos'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'staticInfo' => [], - 'responseDemo' => '', - 'title' => '意图-列表', + 'ramActions' => [], ], - 'CreateUserSay' => [ - 'summary' => '为指定意图添加话术的信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListSimQuestion' => [ + 'summary' => '查询知识的相似问题列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'name' => 'KnowledgeId', + 'in' => 'formData', + 'schema' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30002299537'], ], - [ - 'name' => 'UserSayDefinition', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '用户话术定义信息', + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'IntentId' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123232', - ], - 'Content' => [ - 'title' => '用户话术', - 'description' => '用户话术', - 'type' => 'string', - 'required' => true, - 'example' => '请问明天北京的天气', - ], - 'SlotInfos' => [ - 'title' => '划槽信息', - 'description' => '划槽信息', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51'], + 'SimQuestions' => [ + 'title' => '相似问列表', + 'description' => '相似问列表', 'type' => 'array', 'items' => [ - 'description' => '滑槽信息说明', + 'description' => '相似问信息', 'type' => 'object', 'properties' => [ - 'SlotId' => [ - 'title' => '划槽ID', - 'description' => '划槽ID', - 'type' => 'string', - 'required' => false, - 'example' => 'fb34adf2fv43f2', - ], - 'StartIndex' => [ - 'title' => '槽位在意图话术中的起始下标', - 'description' => '槽位在意图话术中的起始下标', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - 'EndIndex' => [ - 'title' => '槽位在意图话术中的结束下标（不含）', - 'description' => '槽位在意图话术中的结束下标（不含）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', - ], + 'SimQuestionId' => ['title' => '相似问ID', 'description' => '相似问ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424'], + 'ModifyTime' => ['title' => '修改时间(UTC 时间)', 'description' => '修改时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-13T03:49:28Z'], + 'CreateTime' => ['title' => '创建时间(UTC 时间)', 'description' => '创建时间（UTC 时间）', 'type' => 'string', 'example' => '2022-05-30T02:08:33Z'], + 'Title' => ['title' => '相似问标题', 'description' => '相似问标题', 'type' => 'string', 'example' => '相似问'], ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 10, ], ], - 'required' => false, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15CD94CC-CBEB-4189-806C-A132D1F45D51\\",\\n \\"SimQuestions\\": [\\n {\\n \\"SimQuestionId\\": 30001979424,\\n \\"ModifyTime\\": \\"2022-05-13T03:49:28Z\\",\\n \\"CreateTime\\": \\"2022-05-30T02:08:33Z\\",\\n \\"Title\\": \\"相似问\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取FAQ相似问列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSimQuestion'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'ListSolution' => [ + 'summary' => '查询知识的答案列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebotVKU6KE'], + ], + 'parameters' => [ + [ + 'name' => 'KnowledgeId', + 'in' => 'formData', + 'schema' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617'], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '返回信息说明', + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'UserSayId' => [ - 'description' => '意图-话术唯一ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '46456176856', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8g4n8bnd236fg79', + 'Solutions' => [ + 'title' => '答案列表', + 'description' => '答案列表', + 'type' => 'array', + 'items' => [ + 'description' => '答案信息', + 'type' => 'object', + 'properties' => [ + 'SolutionId' => ['title' => '答案ID', 'description' => '答案ID', 'type' => 'integer', 'format' => 'int64', 'example' => '496'], + 'ModifyTime' => ['title' => '修改时间(UTC 时间)', 'description' => '修改时间（UTC 时间）', 'type' => 'string', 'example' => '2022-03-29T06:23:53Z'], + 'CreateTime' => ['title' => '创建时间(UTC 时间)', 'description' => '创建时间（UTC 时间）', 'type' => 'string', 'example' => '2022-03-29T03:55:04Z'], + 'Content' => ['title' => '答案内容', 'description' => '答案内容', 'type' => 'string', 'example' => '答案内容'], + 'ContentType' => ['title' => '答案类型(0纯文本，1富文本）', 'description' => '答案类型：0-纯文本，1-富文本', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PlainText' => ['title' => '答案纯文本内容', 'description' => '答案纯文本内容', 'type' => 'string', 'example' => '答案内容'], + 'PerspectiveCodes' => [ + 'title' => '视角code列表', + 'description' => '视角code列表', + 'type' => 'array', + 'items' => ['description' => '视角code', 'type' => 'string', 'example' => 'm8qAIvUUAIf'], + ], + 'TagIdList' => [ + 'title' => '标签ID列表', + 'description' => '标签ID列表', + 'type' => 'array', + 'items' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1232342'], + ], + ], + ], ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '5B29DB5E-251D-5A73-84B5-A12DF795F231'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorIntentId.NotExists', - 'errorMessage' => 'The business error Intent is not exists.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Solutions\\": [\\n {\\n \\"SolutionId\\": 496,\\n \\"ModifyTime\\": \\"2022-03-29T06:23:53Z\\",\\n \\"CreateTime\\": \\"2022-03-29T03:55:04Z\\",\\n \\"Content\\": \\"答案内容\\",\\n \\"ContentType\\": 1,\\n \\"PlainText\\": \\"答案内容\\",\\n \\"PerspectiveCodes\\": [\\n \\"m8qAIvUUAIf\\"\\n ],\\n \\"TagIdList\\": [\\n 1232342\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"5B29DB5E-251D-5A73-84B5-A12DF795F231\\"\\n}","type":"json"}]', + 'title' => '获取FAQ答案列表', + 'changeSet' => [ + ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSolution'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '意图-话术创建', + 'ramActions' => [], ], - 'DeleteUserSay' => [ - 'summary' => '修改意图话术信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListTongyiChatHistorys' => [ + 'summary' => '获取会话历史明细。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['description' => '查询开始时间,时间格式为yyyy-MM-dd HH:mm:ss,⽐如 2024-04-01 00:00:00', 'type' => 'string', 'required' => true, 'example' => '2024-04-01 00:00:00'], ], [ - 'name' => 'InstanceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => '343df2sdf23', - ], + 'schema' => ['description' => '查询结束时间,时间格式为yyyy-MM-dd HH:mm:ss,⽐如 2024-04-01 08:00:00', 'type' => 'string', 'required' => true, 'example' => '2024-04-01 08:00:00'], ], [ - 'name' => 'IntentId', + 'name' => 'RobotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '5564564546', - ], + 'schema' => ['description' => '机器⼈实例id', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe'], ], [ - 'name' => 'UserSayId', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '4562121234', - ], + 'schema' => ['description' => '数据条数,默认30条,最大值为500', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息说明', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'UserSayId' => [ - 'description' => '话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4562121234', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'dfgdg324gf34t34g34g3', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => 'D0DDFC4C-D66D-4787-9AE4-4D757481EDEE'], + 'CostTime' => ['description' => '请求消耗时间', 'type' => 'string', 'example' => '116'], + 'Datas' => [ + 'description' => '数据详情', + 'type' => 'array', + 'items' => ['description' => '数据详情', 'type' => 'object', 'example' => '参考ChatHistoryDTO'], ], ], ], ], ], - 'responseDemo' => '', - 'title' => '意图-话术-删除', - ], - 'UpdateUserSay' => [ - 'summary' => '修改意图话术信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DDFC4C-D66D-4787-9AE4-4D757481EDEE\\",\\n \\"CostTime\\": \\"116\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '会话历史明细', + 'responseParamsDescription' => '**ChatHistoryDTO**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| QueryTime | String | 提问时间 |'."\n" + .'| Question | String | 提问内容 |'."\n" + .'| Answer | String | 答案内容|'."\n" + .'| AnswerSource | String | 答案类型 |'."\n" + .'| SessionId | String | 多轮对话的会话ID |'."\n" + .'| ChatId | String | 单次问答的请求ID |'."\n" + .'| UserId | String | 访问者ID，即对话接口中传入的SenderId |'."\n" + .'| Username | String | 当前会话中访问的昵称，即对话接口中传入的SenderNick |'."\n" + .'| FeedbackType | String | 用户反馈|'."\n" + .'| FeedbackLabels | String | 反馈详情 |'."\n" + .'| FeedbackUserInfo | String | 用户反馈说明 |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTongyiChatHistorys'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'ListTongyiConversationLogs' => [ + 'summary' => '查询对话机器人通义版的单个会话对话记录。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREbeebot2KBZDS'], + ], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'RobotInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['description' => '机器⼈实例id', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe'], ], [ - 'name' => 'InstanceId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['description' => '会话ID', 'type' => 'string', 'required' => true, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa'], ], [ - 'name' => 'UserSayId', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '用户话术ID', - 'description' => '用户话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '34512323', - ], - ], - [ - 'name' => 'UserSayDefinition', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '用户话术定义信息', - 'type' => 'object', - 'properties' => [ - 'IntentId' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '123', - ], - 'Content' => [ - 'title' => '用户话术', - 'description' => '用户话术', - 'type' => 'string', - 'required' => true, - 'example' => '做核酸了吗您', - ], - 'SlotInfos' => [ - 'title' => '划槽信息', - 'description' => '划槽信息', - 'type' => 'array', - 'items' => [ - 'description' => '滑槽信息说明', - 'type' => 'object', - 'properties' => [ - 'SlotId' => [ - 'title' => '划槽ID', - 'description' => '划槽ID', - 'type' => 'string', - 'required' => false, - 'example' => '346ffg3q23dv', - ], - 'StartIndex' => [ - 'title' => '槽位在意图话术中的起始下标', - 'description' => '槽位在意图话术中的起始下标', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'EndIndex' => [ - 'title' => '槽位在意图话术中的结束下标（不含）', - 'description' => '槽位在意图话术中的结束下标（不含）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - 'required' => false, - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'UserSayId' => [ - 'description' => '话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34512323', + 'CostTime' => ['title' => '请求消耗时间', 'description' => '请求消耗时间', 'type' => 'string', 'example' => '66'], + 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F'], + 'Datas' => [ + 'title' => '数据详情', + 'description' => '数据详情', + 'type' => 'array', + 'items' => ['title' => '数据详情', 'description' => '数据详情', 'type' => 'object', 'example' => '参考JSON示例'], ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '2356fg3wf34634vdt23wef2', + 'SessionFlowDebugInfo' => [ + 'title' => '会话流程调试信息', + 'description' => '会话流程调试信息', + 'type' => 'object', + 'properties' => [ + 'ApiParams' => ['title' => '会话流程调试信息的API参数', 'description' => '会话流程调试信息的API参数', 'type' => 'object'], + 'SlotParams' => ['title' => '会话流程调试信息的槽位参数', 'description' => '会话流程调试信息的槽位参数', 'type' => 'object'], + ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorIntentId.NotExists', - 'errorMessage' => 'The business error Intent is not exists.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '', - 'title' => '意图-话术-修改', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostTime\\": \\"66\\",\\n \\"RequestId\\": \\"28805A7C-D695-548C-A31B-67E52C2C274F\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"SessionFlowDebugInfo\\": {\\n \\"ApiParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SlotParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询单个会话的对话记录', + 'description' => '仅支持查询近2小时的对话记录', + 'responseParamsDescription' => '```json'."\n" + .'{'."\n" + .' "CostTime": "36",'."\n" + .' "RequestId": "E1B076C5-F7DD-1B63-B691-E7E90F4A5770",'."\n" + .' "Datas": ['."\n" + .' {'."\n" + .' "Answer": "您好！为了给您提供准确的信息，请您告诉我您想了解哪一场比赛的时间是2022年12月2号，并告诉我这个队伍的名字。这样我才能告诉您该队伍在那天有没有比赛。\\n\\n例如：\\n- 如果您想了解“北京国安队”在2022年12月2号的比赛，请提供：“北京国安队 2022年12月2号的比赛”。",'."\n" + .' "ToAgent": "false",'."\n" + .' "QueryTime": "2024-10-16 10:11:12",'."\n" + .' "Question": "比赛时间在2022年12月2号有哪个队伍的比赛",'."\n" + .' "SessionId": "6b762779ba334ab1a79b331426247933",'."\n" + .' "ChatId": "ac5c1b6c-768c-488a-9d4d-186c30f3b5b2"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'**出参说明**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| QueryTime | String | 提问时间 |'."\n" + .'| Question | String | 提问内容 |'."\n" + .'| Answer | String | 答案内容|'."\n" + .'| ToAgent | String | 是否命中转人工|'."\n" + .'| SessionId | String | SessionId |'."\n" + .'| ChatId | String | ChatId |', + 'changeSet' => [ + ['createdAt' => '2025-11-25T01:18:04.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], ], 'ListUserSay' => [ 'summary' => '查询指定意图的话术内容及关联槽位信息，支持关键话术筛选（contains）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -10688,73 +6051,32 @@ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ 'name' => 'IntentId', 'in' => 'query', - 'schema' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '232', - ], + 'schema' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '232'], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'title' => '筛选用户话术', - 'description' => '筛选用户话术', - 'type' => 'string', - 'required' => false, - 'example' => '您做核酸了嘛', - ], + 'schema' => ['title' => '筛选用户话术', 'description' => '筛选用户话术', 'type' => 'string', 'required' => false, 'example' => '您做核酸了嘛'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '页面大小，默认10，最大值1000', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '页面大小，默认10，最大值1000', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -10764,11 +6086,7 @@ 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'fs1fg4512v43572v23', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'fs1fg4512v43572v23'], 'UserSays' => [ 'description' => '话术列表', 'type' => 'array', @@ -10776,23 +6094,9 @@ 'description' => '话术列表说明', 'type' => 'object', 'properties' => [ - 'IntentId' => [ - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235564564', - ], - 'UserSayId' => [ - 'description' => '话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3453452138', - ], - 'Content' => [ - 'description' => '话术内容', - 'type' => 'string', - 'example' => '您做核酸了嘛', - ], + 'IntentId' => ['description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'example' => '235564564'], + 'UserSayId' => ['description' => '话术ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3453452138'], + 'Content' => ['description' => '话术内容', 'type' => 'string', 'example' => '您做核酸了嘛'], 'SlotInfos' => [ 'description' => '关联槽位信息', 'type' => 'array', @@ -10800,170 +6104,242 @@ 'description' => '关联槽位信息说明', 'type' => 'object', 'properties' => [ - 'SlotId' => [ - 'title' => '意图槽位ID', - 'description' => '意图槽位ID', - 'type' => 'string', - 'example' => '3456sdfg3tu', - ], - 'StartIndex' => [ - 'title' => '槽位在意图话术中的下标', - 'description' => '槽位在意图话术中的下标', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'EndIndex' => [ - 'title' => '槽位在意图话术中的下标', - 'description' => '槽位在意图话术中的下标（不含）', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], + 'SlotId' => ['title' => '意图槽位ID', 'description' => '意图槽位ID', 'type' => 'string', 'example' => '3456sdfg3tu'], + 'StartIndex' => ['title' => '槽位在意图话术中的下标', 'description' => '槽位在意图话术中的下标', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'EndIndex' => ['title' => '槽位在意图话术中的下标', 'description' => '槽位在意图话术中的下标（不含）', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], ], ], ], - 'CreateTime' => [ - 'description' => '创建时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'ModifyTime' => [ - 'description' => '修改时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], + 'CreateTime' => ['description' => '创建时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], + 'ModifyTime' => ['description' => '修改时间（UTC时间）', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z'], ], ], ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页面大小，默认10', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页，默认1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页面大小，默认10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - 'responseDemo' => '', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"fs1fg4512v43572v23\\",\\n \\"UserSays\\": [\\n {\\n \\"IntentId\\": 235564564,\\n \\"UserSayId\\": 3453452138,\\n \\"Content\\": \\"您做核酸了嘛\\",\\n \\"SlotInfos\\": [\\n {\\n \\"SlotId\\": \\"3456sdfg3tu\\",\\n \\"StartIndex\\": 2,\\n \\"EndIndex\\": 4\\n }\\n ],\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListUserSayResponse>\\n <RequestId>fs1fg4512v43572v23</RequestId>\\n <UserSays>\\n <IntentId>235564564</IntentId>\\n <UserSayId>3453452138</UserSayId>\\n <Content>您做核酸了嘛</Content>\\n <SlotInfos>\\n <SlotId>3456sdfg3tu</SlotId>\\n <StartIndex>2</StartIndex>\\n <EndIndex>4</EndIndex>\\n </SlotInfos>\\n <CreateTime>1652883349000</CreateTime>\\n <ModifyTime>1652883349000</ModifyTime>\\n </UserSays>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n</ListUserSayResponse>","errorExample":""}]', 'title' => '意图-话术-列表', - ], - 'CreateLgf' => [ - 'summary' => '为指定意图创建高级语义配置（LGF）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserSay'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'Nlu' => [ + 'summary' => '针对用户query，返回机器人有关这个query的语言理解（nlu）结果。当前只支持对话工厂、中控的NLU信息透出，其他引擎后续按需支持。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ - 'name' => 'InstanceId', + 'name' => 'Utterance', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['title' => '用户表述', 'description' => '用户表述', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '北京的天气怎么样'], ], [ - 'name' => 'LgfDefinition', + 'name' => 'AgentKey', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'LGF定义信息', - 'type' => 'object', - 'properties' => [ - 'IntentId' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '4675678567', - ], - 'RuleText' => [ - 'title' => 'LGF配置', - 'description' => 'LGF配置', - 'type' => 'string', - 'required' => true, - 'example' => '.{0,10}北京天气', - ], - ], - 'required' => false, - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'LgfId' => [ - 'description' => 'LGF ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123453433453', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'af5fg3sdf457j5', + 'Messages' => [ + 'title' => '消息的列表', + 'description' => '消息的列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DialogHubNluInfo' => [ + 'title' => '对话中控的nlu信息', + 'description' => '对话中控的nlu信息', + 'type' => 'object', + 'properties' => [ + 'GlobalDictList' => [ + 'title' => '全局名词列表', + 'description' => '全局名词列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StandardWord' => ['title' => '名词', 'description' => '名词', 'type' => 'string', 'example' => '天气'], + 'Word' => ['title' => '同义词', 'description' => '同义词', 'type' => 'string', 'example' => '天气'], + ], + 'description' => '', + ], + ], + 'GlobalSensitiveWordList' => [ + 'title' => '全局敏感词列表', + 'description' => '全局敏感词列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StandardWord' => ['title' => '名词', 'description' => '名词', 'type' => 'string', 'example' => '天气'], + 'Word' => ['title' => '同义词', 'description' => '同义词', 'type' => 'string', 'example' => '天气'], + ], + 'description' => '', + ], + ], + ], + ], + 'DsNluInfo' => [ + 'title' => '对话工厂的nlu信息', + 'description' => '对话工厂的nlu信息', + 'type' => 'object', + 'properties' => [ + 'EntityList' => [ + 'title' => '实体列表', + 'description' => '实体列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '实体名称', 'description' => '实体名称', 'type' => 'string', 'example' => '@城市'], + 'Origin' => ['title' => '实体原词（实体成员）', 'description' => '实体原词（实体成员）', 'type' => 'string', 'example' => '北京'], + 'Type' => ['title' => '实体类型，当前只有text类型', 'description' => '实体类型，当前只有text类型', 'type' => 'string', 'example' => 'text'], + 'Value' => ['title' => '实体同义词', 'description' => '实体同义词', 'type' => 'string', 'example' => '首都'], + ], + 'description' => '', + ], + ], + 'IntentList' => [ + 'title' => '意图列表', + 'description' => '意图列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IntentId' => ['title' => '意图id', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'example' => '724387'], + 'MatchDetail' => ['title' => '匹配详情（匹配过程）', 'description' => '匹配详情（匹配过程）', 'type' => 'string', 'example' => 'classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]'], + 'MatchType' => ['title' => '匹配类型，其枚举值含义如下： Similarity：query与意图通过意图话术相似度匹配 Lgf：query与意图通过LGF匹配 Classify：query与意图通过模型训练匹配 FewShotLearning：query与意图通过系统内置fewshot模型匹配 BuildIn： query与系统内置意图匹配', 'description' => '匹配类型，其枚举值含义如下： Similarity：query与意图通过意图话术相似度匹配 Lgf：query与意图通过LGF匹配 Classify：query与意图通过模型训练匹配 FewShotLearning：query与意图通过系统内置fewshot模型匹配 BuildIn： query与系统内置意图匹配', 'type' => 'string', 'example' => 'FewShotLearning'], + 'Name' => ['title' => '意图名称', 'description' => '意图名称', 'type' => 'string', 'example' => '查天气意图'], + 'Score' => ['title' => '分数', 'description' => '分数', 'type' => 'number', 'format' => 'double', 'example' => '0.995'], + 'SlotList' => [ + 'title' => '命中意图的槽位列表', + 'description' => '命中意图的槽位列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '实体名称', 'description' => '实体名称', 'type' => 'string', 'example' => '@城市'], + 'Origin' => ['title' => '实体原词（实体成员）', 'description' => '实体原词（实体成员）', 'type' => 'string', 'example' => '北京'], + 'Type' => ['title' => '实体类型，当前只有text类型', 'description' => '实体类型，当前只有text类型', 'type' => 'string', 'example' => 'text'], + 'Value' => ['title' => '实体同义词', 'description' => '实体同义词', 'type' => 'string', 'example' => '首都'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], ], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID', 'type' => 'string', 'example' => 'A6357C1B-1D79-1382-B259-BD9E80751B42'], + 'MessageId' => ['title' => '本条语言理解应答消息的ID', 'description' => '本条语言理解应答消息的ID', 'type' => 'string', 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661'], ], + 'description' => '', ], ], ], - 'responseDemo' => '', - 'title' => '意图-LGF-创建', - ], - 'DeleteLgf' => [ - 'summary' => '删除指定高级语义配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Messages\\": [\\n {\\n \\"DialogHubNluInfo\\": {\\n \\"GlobalDictList\\": [\\n {\\n \\"StandardWord\\": \\"天气\\",\\n \\"Word\\": \\"天气\\"\\n }\\n ],\\n \\"GlobalSensitiveWordList\\": [\\n {\\n \\"StandardWord\\": \\"天气\\",\\n \\"Word\\": \\"天气\\"\\n }\\n ]\\n },\\n \\"DsNluInfo\\": {\\n \\"EntityList\\": [\\n {\\n \\"Name\\": \\"@城市\\",\\n \\"Origin\\": \\"北京\\",\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"首都\\"\\n }\\n ],\\n \\"IntentList\\": [\\n {\\n \\"IntentId\\": 724387,\\n \\"MatchDetail\\": \\"classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]\\",\\n \\"MatchType\\": \\"FewShotLearning\\",\\n \\"Name\\": \\"查天气意图\\",\\n \\"Score\\": 0.995,\\n \\"SlotList\\": [\\n {\\n \\"Name\\": \\"@城市\\",\\n \\"Origin\\": \\"北京\\",\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"首都\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"A6357C1B-1D79-1382-B259-BD9E80751B42\\",\\n \\"MessageId\\": \\"2828708A-2C7A-1BAE-B810-87DB9DA9C661\\"\\n}","type":"json"}]', + 'title' => '统一NLU接口', + 'responseParamsDescription' => '### 示例'."\n" + ."\n" + .'#### 响应报文'."\n" + .'```json'."\n" + .'{'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "DsNluInfo": {'."\n" + .' "EntityList": ['."\n" + .' {'."\n" + .' "Origin": "北京",'."\n" + .' "Name": "@城市",'."\n" + .' "Type": "text",'."\n" + .' "Value": "首都"'."\n" + .' }'."\n" + .' ],'."\n" + .' "IntentList": ['."\n" + .' {'."\n" + .' "Score": 0.995,'."\n" + .' "SlotList": ['."\n" + .' {'."\n" + .' "Origin": "北京",'."\n" + .' "Name": "@城市",'."\n" + .' "Type": "text",'."\n" + .' "Value": "首都"'."\n" + .' }'."\n" + .' ],'."\n" + .' "MatchType": "FewShotLearning",'."\n" + .' "MatchDetail": "classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]",'."\n" + .' "Name": "查天气意图",'."\n" + .' "IntentId": 724387'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "DialogHubNluInfo": {'."\n" + .' "GlobalDictList": ['."\n" + .' {'."\n" + .' "StandardWord": "天气",'."\n" + .' "Word": "天气"'."\n" + .' }'."\n" + .' ],'."\n" + .' "GlobalSensitiveWordList": ['."\n" + .' {'."\n" + .' "StandardWord": "天气",'."\n" + .' "Word": "天气"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "5C20F0D4-9721-178A-8236-3BF990634962",'."\n" + .' "MessageId": "e7ac691f-b166-4561-bddf-9dd00c8bdce6"'."\n" + .'}'."\n" + ."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Nlu'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'QueryPerspectives' => [ + 'summary' => '查询视角列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10971,220 +6347,108 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], - ], - [ - 'name' => 'IntentId', - 'in' => 'query', - 'schema' => [ - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '23242342', - ], - ], - [ - 'name' => 'LgfId', - 'in' => 'query', - 'schema' => [ - 'description' => 'lgf Id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '2342424', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'LgfId' => [ - 'description' => 'LGF ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2342424', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'dgw2342424qw42', + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101'], + 'Perspectives' => [ + 'title' => '视角列表', + 'description' => '视角列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '数据状态：3：选中；1：未选中', 'description' => '数据状态：3：启用；1：未启用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CreateTime' => ['title' => '创建时间 UTC时间', 'description' => '创建时间 UTC时间', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z'], + 'PerspectiveId' => ['title' => '视角主键（code_id）', 'description' => '视角ID', 'type' => 'string', 'example' => '3001'], + 'SelfDefine' => ['title' => '是否自定义', 'description' => '是否自定义', 'type' => 'boolean', 'example' => 'true'], + 'Name' => ['title' => '视角名称', 'description' => '视角名称', 'type' => 'string', 'example' => '移动端视角'], + 'PerspectiveCode' => ['title' => '视角编码（用于问答api）', 'description' => '视角编码（用于问答API）', 'type' => 'string', 'example' => 'FZJBY3raWr'], + 'ModifyTime' => ['title' => '修改时间 UTC时间', 'description' => '修改时间 UTC时间', 'type' => 'string', 'example' => '2022-04-29T03:38:54Z'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '', - 'title' => '意图-LGF-删除', - ], - 'UpdateLgf' => [ - 'summary' => '为指定意图创建高级语义配置（LGF）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F285D735-D580-18A8-B97F-B2E72B00F101\\",\\n \\"Perspectives\\": [\\n {\\n \\"Status\\": 1,\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"PerspectiveId\\": \\"3001\\",\\n \\"SelfDefine\\": true,\\n \\"Name\\": \\"移动端视角\\",\\n \\"PerspectiveCode\\": \\"FZJBY3raWr\\",\\n \\"ModifyTime\\": \\"2022-04-29T03:38:54Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '视角-列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPerspectives'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'RetryDoc' => [ + 'summary' => '文档重试。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'e2a20f74cd9042558002c0f7dc873739_p_outbound_public'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], - ], - [ - 'name' => 'LgfId', - 'in' => 'query', - 'schema' => [ - 'title' => 'LGF ID', - 'description' => 'LGF ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '12121', - ], - ], - [ - 'name' => 'LgfDefinition', + 'name' => 'KnowledgeId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'LGF 信息', - 'type' => 'object', - 'properties' => [ - 'IntentId' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '23234523522', - ], - 'RuleText' => [ - 'title' => 'LGF配置', - 'description' => 'LGF配置', - 'type' => 'string', - 'required' => true, - 'example' => '.{0,10}[天气]', - ], - ], - 'required' => true, - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息说明', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'LgfId' => [ - 'description' => 'LGF唯一标识', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2342556223532', - ], - 'RequestId' => [ - 'description' => '请求唯一标识', - 'type' => 'string', - 'example' => '289dfa131adf23wqe2r', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '6419BA93-D111-5225-8998-13E63E6D3940'], + 'KnowledgeId' => ['description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30001905617'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BusinessErrorIntentId.NotExists', - 'errorMessage' => 'The business error IntentId is not exists.', - ], - [ - 'errorCode' => '400 BusinessErrorIntentLgfId.NotExists', - 'errorMessage' => 'The business error IntentLgfId is not exists.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6419BA93-D111-5225-8998-13E63E6D3940\\",\\n \\"KnowledgeId\\": 30001905617\\n}","type":"json"}]', + 'title' => '文档重试', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetryDoc'], ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => 'LGF-修改', + 'ramActions' => [], ], - 'ListLgf' => [ - 'summary' => '查询指定意图的高级语义配置（LGF）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SearchDoc' => [ + 'summary' => '搜索文档。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11192,665 +6456,458 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', + 'schema' => ['description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => '关键字', 'type' => 'string', 'required' => false, 'example' => '搜索关键字'], + ], + [ + 'name' => 'CategoryIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'description' => '类目ID列表', + 'type' => 'array', + 'items' => ['description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000065594'], 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ - 'name' => 'InstanceId', + 'name' => 'ProcessStatus', 'in' => 'query', - 'schema' => [ - 'title' => '机器人ID', - 'description' => '机器人ID', - 'type' => 'string', - 'required' => true, - 'example' => ' chatbot-cn-yjzbyrEvqd', - ], + 'schema' => ['description' => '任务状态'."\n" + .'-1 排队中'."\n" + .'0 成功'."\n" + .'1 解析中'."\n" + .'2 处理中'."\n" + .'3 处理失败', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'IntentId', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '123', - ], + 'schema' => ['description' => '编辑状态：'."\n" + .'1 未发布'."\n" + .'2 已发布'."\n" + .'3 已更新未发布', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'LgfText', + 'name' => 'SearchScope', 'in' => 'query', - 'schema' => [ - 'title' => '筛选语义配置内容', - 'description' => '筛选语义配置内容', - 'type' => 'string', - 'required' => false, - 'example' => '.{0,5}北京天气', - ], + 'schema' => ['description' => '搜索范围 '."\n" + .'1 搜索标题'."\n" + .'2 搜索内容', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CreateUserName', + 'in' => 'query', + 'schema' => ['description' => '创建人名称', 'type' => 'string', 'required' => false, 'example' => '张三'], + ], + [ + 'name' => 'ModifyUserName', + 'in' => 'query', + 'schema' => ['description' => '修改人名称', 'type' => 'string', 'required' => false, 'example' => '李四'], + ], + [ + 'name' => 'CreateTimeBegin', + 'in' => 'query', + 'schema' => ['description' => '创建开始时间', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z'], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => ['description' => '创建结束时间', 'type' => 'string', 'required' => false, 'example' => '2022-05-02T03:09:30Z'], + ], + [ + 'name' => 'ModifyTimeBegin', + 'in' => 'query', + 'schema' => ['description' => '修改开始时间', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z'], + ], + [ + 'name' => 'ModifyTimeEnd', + 'in' => 'query', + 'schema' => ['description' => '修改结束时间', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z'], + ], + [ + 'name' => 'StartTimeBegin', + 'in' => 'query', + 'schema' => ['description' => '生效开始时间', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z'], + ], + [ + 'name' => 'StartTimeEnd', + 'in' => 'query', + 'schema' => ['description' => '生效结束时间', 'type' => 'string', 'required' => false, 'example' => '2022-04-03T03:09:30Z'], + ], + [ + 'name' => 'EndTimeBegin', + 'in' => 'query', + 'schema' => ['description' => '失效开始时间', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z'], + ], + [ + 'name' => 'EndTimeEnd', + 'in' => 'query', + 'schema' => ['description' => '失效结束时间', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分⻚-第⼏⻚', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'TagIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '页面大小，默认10', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '标签ID列表', + 'description' => '标签ID列表，多个标签时，采用“并集”逻辑进行筛选', + 'type' => 'array', + 'items' => ['description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1201'], 'required' => false, - 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse<DsLgfPageData>', - 'description' => '返回值', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '34fg57h2gh5783', - ], - 'Lgfs' => [ - 'description' => 'LGF列表', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1'], + 'PageNumber' => ['description' => '当前⻚码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '141'], + 'DocHits' => [ + 'description' => '文档列表', 'type' => 'array', 'items' => [ - 'description' => 'LGF列表说明', 'type' => 'object', 'properties' => [ - 'IntentId' => [ - 'title' => '意图ID', - 'description' => '意图ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '256756734345', - ], - 'LgfId' => [ - 'title' => 'LGF ID', - 'description' => 'LGF ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RuleText' => [ - 'title' => 'LGF规则', - 'description' => 'LGF规则', - 'type' => 'string', - 'example' => '.{0,5}北京天气', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间(UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', - ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => '修改时间（UTC时间）', - 'type' => 'string', - 'example' => '2021-08-12T16:00:01Z', + 'KnowledgeId' => ['description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30002692007'], + 'DocName' => ['description' => '文档名称', 'type' => 'string', 'example' => '文档名称'], + 'BizCode' => ['description' => '业务代码', 'type' => 'string', 'example' => 'cn_dytns'], + 'Meta' => ['description' => '文档随路数据', 'type' => 'string', 'example' => '{"code":"xxx"}'], + 'Config' => ['description' => '文档解析/切分配置'."\n" + .'配置项：切分器'."\n" + .'KEY：Splitter'."\n" + .'值选项：paragraphSplitter-识别层级【默认】'."\n" + .'值选项：treeSplitter-规则层级'."\n" + ."\n" + .'配置项：文档切块大小'."\n" + .'KEY：ChunkSize'."\n" + .'VALUE：默认500；范围[200,800]'."\n" + ."\n" + .'配置项：规则层级'."\n" + .'KEY：TreePatterns'."\n" + .'VALUE：默认[]'."\n" + ."\n" + .'配置项：文档标题来源'."\n" + .'KEY：TitleSource'."\n" + .'值选项：ocrTitle - OCR识别标题【默认】'."\n" + .'值选项：docName - 文档名即标题', 'type' => 'string', 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}'], + 'Url' => ['description' => '文档保存OSS地址', 'type' => 'string', 'example' => 'https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf'], + 'ModifyTime' => ['description' => '修改时间（UTC时间）', 'type' => 'string', 'example' => '2023-06-25T02:27:42Z'], + 'ModifyUserName' => ['description' => '修改人名称', 'type' => 'string', 'example' => '李四'], + 'CreateTime' => ['description' => '创建时间（UTC时间）', 'type' => 'string', 'example' => '2023-06-22T03:53:41Z'], + 'CreateUserName' => ['description' => '创建人名称', 'type' => 'string', 'example' => '张三'], + 'CreateUserId' => ['description' => '创建人ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111'], + 'ModifyUserId' => ['description' => '修改人ID', 'type' => 'integer', 'format' => 'int64', 'example' => '222222222'], + 'CategoryId' => ['description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000135654'], + 'ProcessStatus' => ['description' => '任务处理状态'."\n" + .'-1 排队中'."\n" + .'0 成功'."\n" + .'1 解析中'."\n" + .'2 处理中'."\n" + .'3 处理失败', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ProcessMessage' => ['description' => '任务处理信息', 'type' => 'string', 'example' => '任务处理成功'], + 'ProcessCanRetry' => ['description' => '任务是否可重试'."\n" + .'true：可重试'."\n" + .'false：不可重试', 'type' => 'boolean', 'example' => 'true'], + 'Status' => ['description' => '编辑状态： 1 未发布 2 已发布 3 已更新未发布', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'EffectStatus' => ['description' => '知识生效状态，根据StartDate，EndDate计算出来：20-生效中，21-已失效，22-待生效', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'StartDate' => ['description' => '生效时间（UTC 时间）', 'type' => 'string', 'example' => '2023-02-28T11:40:18Z'], + 'EndDate' => ['description' => '失效时间（UTC时间）', 'type' => 'string', 'example' => '2099-12-31T16:00:00Z'], + 'DocTags' => [ + 'description' => '标签详情列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情', + 'type' => 'object', + 'properties' => [ + 'TagId' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1201'], + 'TagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'example' => '小说'], + 'GroupId' => ['title' => '标签组ID', 'description' => '标签组ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3610'], + 'GroupName' => ['title' => '标签组名称', 'description' => '标签组名称', 'type' => 'string', 'example' => '文章'], + 'DefaultTag' => ['title' => '是否默认全部标签', 'description' => '是否默认全部标签', 'type' => 'boolean', 'example' => 'false'], + ], + ], ], ], + 'description' => '', ], ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页面大小，默认10', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], ], ], ], ], - 'responseDemo' => '', - 'title' => '意图-LGF-列表', - ], - 'CreatePerspective' => [ - 'summary' => '创建视角。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3E5C779-A630-45AC-B0F2-A4506A4212F1\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 141,\\n \\"DocHits\\": [\\n {\\n \\"KnowledgeId\\": 30002692007,\\n \\"DocName\\": \\"文档名称\\",\\n \\"BizCode\\": \\"cn_dytns\\",\\n \\"Meta\\": \\"{\\\\\\"code\\\\\\":\\\\\\"xxx\\\\\\"}\\",\\n \\"Config\\": \\"{\\\\\\"Splitter\\\\\\":\\\\\\"treeSplitter\\\\\\",\\\\\\"ChunkSize\\\\\\":500,\\\\\\"TreePatterns\\\\\\":[\\\\\\"^# .*\\\\\\",\\\\\\"^## .*\\\\\\",\\\\\\"^### .*\\\\\\",\\\\\\"^#### .*\\\\\\"],\\\\\\"TitleSource\\\\\\":\\\\\\"docName\\\\\\"}\\",\\n \\"Url\\": \\"https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf\\",\\n \\"ModifyTime\\": \\"2023-06-25T02:27:42Z\\",\\n \\"ModifyUserName\\": \\"李四\\",\\n \\"CreateTime\\": \\"2023-06-22T03:53:41Z\\",\\n \\"CreateUserName\\": \\"张三\\",\\n \\"CreateUserId\\": 111111111,\\n \\"ModifyUserId\\": 222222222,\\n \\"CategoryId\\": 30000135654,\\n \\"ProcessStatus\\": 0,\\n \\"ProcessMessage\\": \\"任务处理成功\\",\\n \\"ProcessCanRetry\\": true,\\n \\"Status\\": 1,\\n \\"EffectStatus\\": 20,\\n \\"StartDate\\": \\"2023-02-28T11:40:18Z\\",\\n \\"EndDate\\": \\"2099-12-31T16:00:00Z\\",\\n \\"DocTags\\": [\\n {\\n \\"TagId\\": 1201,\\n \\"TagName\\": \\"小说\\",\\n \\"GroupId\\": 3610,\\n \\"GroupName\\": \\"文章\\",\\n \\"DefaultTag\\": false\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '搜索文档', + 'changeSet' => [ + ['createdAt' => '2024-05-17T09:42:04.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchDoc'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'SearchFaq' => [ + 'summary' => '搜索知识。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '视角名称，长度不超过50字', - 'description' => '视角名称，长度不超过50字', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '移动端视角', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '视角描述', - 'description' => '视角描述', - 'type' => 'string', - 'required' => false, - 'example' => '用于购物APP的移动端视角', - ], + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['title' => '关键字', 'description' => '关键字', 'type' => 'string', 'required' => false, 'example' => '搜索标题'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', + 'name' => 'CategoryIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'title' => '类目唯一标识', + 'description' => '类目唯一标识', + 'type' => 'array', + 'items' => ['description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000065594'], 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', - ], - 'PerspectiveId' => [ - 'title' => '视角主键（code_id）', - 'description' => '视角ID', - 'type' => 'string', - 'example' => '3001', - ], - ], - ], - ], - ], - 'responseDemo' => '', - 'title' => '视角-创建', - ], - 'DeletePerspective' => [ - 'summary' => '删除视角。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'PerspectiveId', - 'in' => 'query', + 'name' => 'Status', + 'in' => 'formData', 'schema' => [ - 'title' => '视角主键（code_id）', - 'description' => '视角ID', - 'type' => 'string', + 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', + 'description' => '知识状态：-1-已删除未发布，1-未发布，2-已发布，3-已更新未发布', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'docRequired' => true, - 'example' => '3001', + 'enumValueTitles' => [1 => '未发布', '已发布', '已更新未发布', -1 => '已删除未发布'], + 'example' => '1', ], ], [ - 'name' => 'AgentKey', - 'in' => 'query', + 'name' => 'SearchScope', + 'in' => 'formData', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'title' => '搜索范围： 1-搜索标题相似问, 2-搜索答案, 3-搜索全部', + 'description' => '搜索范围：1-搜索标题相似问，2-搜索答案，3-搜索全部', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + 'enumValueTitles' => [1 => '搜索标题和相似问', '搜索答案', '搜索全部'], + 'example' => '1', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', - ], - 'Result' => [ - 'title' => '删除视角的结果', - 'description' => '删除视角的结果', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + [ + 'name' => 'CreateUserName', + 'in' => 'formData', + 'schema' => ['title' => '创建人', 'description' => '创建人', 'type' => 'string', 'required' => false, 'example' => 'test01'], ], - ], - 'responseDemo' => '', - 'title' => '视角-删除', - ], - 'UpdatePerspective' => [ - 'summary' => '更新视角名称和描述。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ModifyUserName', + 'in' => 'formData', + 'schema' => ['title' => '修改人', 'description' => '修改人', 'type' => 'string', 'required' => false, 'example' => 'test01'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'PerspectiveId', - 'in' => 'query', - 'schema' => [ - 'title' => '视角主键（code_id）', - 'description' => '视角ID', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '3001', - ], + 'name' => 'CreateTimeBegin', + 'in' => 'formData', + 'schema' => ['title' => '创建开始时间', 'description' => '创建开始时间', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z'], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '视角名称', - 'description' => '视角名称，长度不超过50字', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '客户端视角', - ], + 'name' => 'CreateTimeEnd', + 'in' => 'formData', + 'schema' => ['title' => '创建结束时间', 'description' => '创建结束时间', 'type' => 'string', 'required' => false, 'example' => '2022-05-02T03:09:30Z'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'name' => 'ModifyTimeBegin', + 'in' => 'formData', + 'schema' => ['title' => '修改开始时间', 'description' => '修改开始时间', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', - ], - ], - ], + [ + 'name' => 'ModifyTimeEnd', + 'in' => 'formData', + 'schema' => ['title' => '修改结束时间', 'description' => '修改结束时间', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z'], ], - ], - 'responseDemo' => '', - 'title' => '视角-更新', - ], - 'DescribePerspective' => [ - 'summary' => '查询视角详情。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'StartTimeBegin', + 'in' => 'formData', + 'schema' => ['title' => '生效开始时间', 'description' => '生效开始时间', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'PerspectiveId', - 'in' => 'query', - 'schema' => [ - 'title' => '视角Id', - 'description' => '视角ID', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '3001', - ], + 'name' => 'StartTimeEnd', + 'in' => 'formData', + 'schema' => ['title' => '生效结束时间', 'description' => '生效结束时间', 'type' => 'string', 'required' => false, 'example' => '2022-04-03T03:09:30Z'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'name' => 'EndTimeBegin', + 'in' => 'formData', + 'schema' => ['title' => '失效开始时间', 'description' => '失效开始时间', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', - ], - 'Status' => [ - 'title' => '数据状态：3：选中；1：未选中', - 'description' => '数据状态：3：启用；1：未启用', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PerspectiveCode' => [ - 'title' => '视角编码（用于问答api）', - 'description' => '视角编码（用于问答API）', - 'type' => 'string', - 'example' => 'FZJBY3raWr', - ], - 'ModifyTime' => [ - 'title' => '修改时间 UTC时间', - 'description' => '修改时间 UTC时间', - 'type' => 'string', - 'example' => '2021-07-26T07:05:37Z', - ], - 'SelfDefine' => [ - 'title' => '是否自定义', - 'description' => '是否自定义', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CreateTime' => [ - 'title' => '创建时间 UTC时间', - 'description' => '创建时间 UTC时间', - 'type' => 'string', - 'example' => '2021-07-27T07:05:37Z', - ], - 'PerspectiveId' => [ - 'title' => '视角主键（code_id）', - 'description' => '视角ID', - 'type' => 'string', - 'example' => '3001', - ], - 'Name' => [ - 'title' => '视角名称', - 'description' => '视角名称', - 'type' => 'string', - 'example' => '移动端视角', - ], - ], - ], + [ + 'name' => 'EndTimeEnd', + 'in' => 'formData', + 'schema' => ['title' => '失效结束时间', 'description' => '失效结束时间', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z'], ], - ], - 'responseDemo' => '', - 'title' => '视角-详情', - ], - 'QueryPerspectives' => [ - 'summary' => '查询视角列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => '页码 默认1', 'description' => '页码默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'AgentKey', - 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => '每页数量，默认10，最大50', 'description' => '每页数量，默认10，最大100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', - ], - 'Perspectives' => [ - 'title' => '视角列表', - 'description' => '视角列表', + 'FaqHits' => [ + 'description' => '知识搜索结果', 'type' => 'array', 'items' => [ + 'description' => '知识信息', 'type' => 'object', 'properties' => [ + 'KnowledgeId' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30002145804'], + 'ModifyTime' => ['title' => '修改时间（UTC时间）', 'description' => '修改时间（UTC 时间）', 'type' => 'string', 'example' => '2022-04-02T03:09:30Z'], + 'ModifyUserName' => ['title' => '修改人', 'description' => '修改人', 'type' => 'string', 'example' => 'test01'], + 'CreateTime' => ['title' => '创建时间（UTC时间）', 'description' => '创建时间（UTC 时间）', 'type' => 'string', 'example' => '2022-04-02T03:09:30Z'], + 'CreateUserName' => ['title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => 'test01'], + 'CreateUserId' => ['title' => '创建人ID', 'description' => '创建人ID', 'type' => 'integer', 'format' => 'int64', 'example' => '18453'], + 'ModifyUserId' => ['title' => '修改人ID', 'description' => '修改人ID', 'type' => 'integer', 'format' => 'int64', 'example' => '18453'], + 'CategoryId' => ['title' => '类目ID', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000055639'], 'Status' => [ - 'title' => '数据状态：3：选中；1：未选中', - 'description' => '数据状态：3：启用；1：未启用', + 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', + 'description' => '知识状态：-1-已删除未发布，1-未发布，2-已发布，3-已更新未发布', 'type' => 'integer', 'format' => 'int32', - 'example' => '1', - ], - 'CreateTime' => [ - 'title' => '创建时间 UTC时间', - 'description' => '创建时间 UTC时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'PerspectiveId' => [ - 'title' => '视角主键（code_id）', - 'description' => '视角ID', - 'type' => 'string', - 'example' => '3001', - ], - 'SelfDefine' => [ - 'title' => '是否自定义', - 'description' => '是否自定义', - 'type' => 'boolean', - 'example' => 'true', + 'enumValueTitles' => [1 => '未发布', '已发布', '已更新未发布', -1 => '已删除未发布'], + 'example' => '3', ], - 'Name' => [ - 'title' => '视角名称', - 'description' => '视角名称', - 'type' => 'string', - 'example' => '移动端视角', + 'EffectStatus' => [ + 'title' => '知识生效状态,根据StartDate, EndDate计算出来: 20-生效中, 21-已失效, 22-待生效', + 'description' => '知识生效状态，根据StartDate，EndDate计算出来：20-生效中，21-已失效，22-待生效', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [20 => '生效中', '已失效', '待生效'], + 'example' => '20', ], - 'PerspectiveCode' => [ - 'title' => '视角编码（用于问答api）', - 'description' => '视角编码（用于问答API）', - 'type' => 'string', - 'example' => 'FZJBY3raWr', + 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '测试标题'], + 'HitSimilarTitles' => [ + 'title' => '命中的相似问', + 'description' => '命中的相似问题列表', + 'type' => 'array', + 'items' => ['description' => '相似问题', 'type' => 'string', 'example' => '测试命中的标题'], ], - 'ModifyTime' => [ - 'title' => '修改时间 UTC时间', - 'description' => '修改时间 UTC时间', - 'type' => 'string', - 'example' => '2022-04-29T03:38:54Z', + 'HitSolutions' => [ + 'title' => '命中的答案', + 'description' => '命中的答案列表', + 'type' => 'array', + 'items' => ['description' => '命中的答案', 'type' => 'string', 'example' => '测试命中的答案'], ], ], ], ], + 'PageNumber' => ['title' => '页码 默认1', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '每页数量，默认10，最大500', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1075'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E45491D5-7E0A-42C6-9B21-91D1066B1475'], ], ], ], ], - 'responseDemo' => '', - 'title' => '视角-列表', - ], - 'CreatePublishTask' => [ - 'summary' => '创建发布中心的发布任务。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FaqHits\\": [\\n {\\n \\"KnowledgeId\\": 30002145804,\\n \\"ModifyTime\\": \\"2022-04-02T03:09:30Z\\",\\n \\"ModifyUserName\\": \\"test01\\",\\n \\"CreateTime\\": \\"2022-04-02T03:09:30Z\\",\\n \\"CreateUserName\\": \\"test01\\",\\n \\"CreateUserId\\": 18453,\\n \\"ModifyUserId\\": 18453,\\n \\"CategoryId\\": 30000055639,\\n \\"Status\\": 3,\\n \\"EffectStatus\\": 20,\\n \\"Title\\": \\"测试标题\\",\\n \\"HitSimilarTitles\\": [\\n \\"测试命中的标题\\"\\n ],\\n \\"HitSolutions\\": [\\n \\"测试命中的答案\\"\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1075,\\n \\"RequestId\\": \\"E45491D5-7E0A-42C6-9B21-91D1066B1475\\"\\n}","type":"json"}]', + 'title' => 'FAQ搜索', + 'changeSet' => [ + ['createdAt' => '2022-12-26T11:45:18.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchFaq'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'TongyiChatDebugInfo' => [ + 'summary' => '大模型问答调试信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264606', + 'abilityTreeNodes' => ['FEATUREbeebotUKQQ1L'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '需要提供有效期内的MessageId', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'BizType', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '发布任务的业务类型，若发布机器人请使用 CreateInstancePublishTask API', - 'description' => '发布单元类型，机器人发布请使用 CreateInstancePublishTask API', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'chitchat' => '闲聊库', - 'service_center' => '全局服务', - 'faq' => '高频问答/FAQ知识库', - 'dict' => '全局名词[仅旧版]', - 'sensitive' => '全局敏感词', - 'command' => '全局指令', - 'mrc' => '文档库', - ], - 'example' => 'faq', - 'enum' => [], - ], + 'schema' => ['description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'DataIdList', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '业务类型附加信息，当前仅支持BizType为faq的传参，此字段指定faq类目Id列表，表示只发布指定类目下面的faq知识', - 'description' => '附加发布信息，当前支持：如果BizType是faq，此字段填写类目ID，表示只发布这些类目下面的知识', - 'type' => 'array', - 'items' => [ - 'title' => '具体附加发布信息，如faq类目信息'."\n", - 'description' => 'FAQ类目ID', - 'type' => 'string', - 'required' => false, - 'example' => '8521', - ], - 'required' => false, - 'enumValueTitles' => [], - 'example' => '["8521"]', - ], + 'schema' => ['description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe'], ], [ - 'name' => 'AgentKey', + 'name' => 'MessageId', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key，若不指定则请求默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['description' => '本条会话应答消息的ID', 'type' => 'string', 'required' => true, 'example' => '396E74B3-D84B-46CE-9E51-91C06AD22E31'], ], ], 'responses' => [ @@ -11860,692 +6917,667 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', - ], - 'Id' => [ - 'title' => '发布任务Id', - 'description' => '发布任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8522', - ], - 'Response' => [ - 'title' => '发布任务Id，冗余字段，建议使用Id字段获取发布任务Id', - 'description' => '发布任务ID，冗余字段，建议使用发布任务ID', - 'type' => 'string', - 'example' => '8522', - ], - 'Status' => [ - 'title' => '任务状态（ FE_RUNNING：正在发布中 FE_SUCCESS：发布成功 FE_FAILED：发布失败 FE_ABORTED：发布取消）', - 'description' => '任务状态'."\n" - .'枚举值：'."\n" - ."\n" - .'FE_RUNNING：正在发布中'."\n" - .'FE_SUCCESS：发布成功'."\n" - .'FE_FAILED：发布失败'."\n" - .'FE_ABORTED：发布取消', - 'type' => 'string', - 'example' => 'FE_RUNNING', - 'enum' => [ - 'FE_RUNNING：正在发布中', - 'FE_SUCCESS：发布成功', - 'FE_FAILED：发布失败', - 'FE_ABORTED：发布取消', - ], - ], - 'BizTypeList' => [ - 'title' => '业务类型列表', - 'description' => '业务类型列表', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1'], + 'MessageId' => ['description' => '本条会话应答消息的ID', 'type' => 'string', 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661'], + 'Pipeline' => [ + 'description' => '整个问答流程的信息', 'type' => 'array', 'items' => [ - 'description' => '业务类型', - 'type' => 'string', - 'example' => 'faq', + 'description' => '整个问答流程的信息', + 'type' => 'object', + 'properties' => [ + 'NodeType' => ['description' => '节点类型，返回值：'."\n" + .'* **system_strategy**：系统策略。'."\n" + .'* **rewrite_query**：检索问句。'."\n" + .'* **invoke_llm**：LLM调用。'."\n" + .'* **invoke_tools**：工具调用。', 'type' => 'string', 'example' => 'system_strategy'], + 'Name' => ['description' => '策略名称：'."\n" + .'- 高频问答直出'."\n" + .'- 关键词转人工'."\n" + .'- 全局敏感词'."\n" + ."\n" + .'当NodeType为system_strategy时，才会有本字段', 'type' => 'string', 'example' => '关键词转人工'], + 'Input' => ['description' => '调试输入信息', 'type' => 'any', 'example' => '用户问句：转人工\\n命中规则：[转]人工[客服|服务|坐席]'], + 'Output' => ['description' => '输出信息', 'type' => 'any', 'example' => 'commands:{\\"sysToAgent\\":\\"{\\\\\\"skillGroup\\\\\\":\\\\\\"\\\\\\",\\\\\\"ext\\\\\\":\\\\\\"\\\\\\",\\\\\\"toAgentReason\\\\\\":\\\\\\"HitKeywords\\\\\\"}\\"}\\nresponse:正在为您转接人工客服'], + ], ], ], - 'Error' => [ - 'title' => '发布任务失败信息', - 'description' => '任务失败信息', - 'type' => 'string', - 'example' => '检查待发布模块是否空闲发生错误，faq', - ], - 'CreateTime' => [ - 'title' => '任务创建的 UTC 时间', - 'description' => '任务创建的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'ModifyTime' => [ - 'title' => '任务修改的 UTC 时间', - 'description' => '任务修改的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:33Z', + 'AnswerInfo' => [ + 'type' => 'object', + 'properties' => [ + 'MessageBody' => [ + 'type' => 'object', + 'properties' => [ + 'DirectMessageBody' => [ + 'type' => 'object', + 'properties' => [ + 'ContentType' => ['type' => 'string'], + 'relatedQuestionList' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'sentenceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => ['type' => 'string'], + 'ReferNumber' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + ], + 'TransitionList' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + 'Commands' => ['type' => 'any'], + ], + ], + 'AnswerReferenceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'ItemList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Number' => ['type' => 'integer', 'format' => 'int32'], + 'Title' => ['type' => 'string'], + 'Id' => ['type' => 'string'], + 'DataSource' => ['type' => 'string'], + 'ContentType' => ['type' => 'string'], + 'ReferenceExt' => ['type' => 'any'], + ], + ], + ], + ], + ], + ], ], ], ], ], ], - 'responseDemo' => '', - 'title' => '创建发布任务', - ], - 'CancelPublishTask' => [ - 'summary' => '取消正在发布中的任务。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => true, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3E5C779-A630-45AC-B0F2-A4506A4212F1\\",\\n \\"MessageId\\": \\"2828708A-2C7A-1BAE-B810-87DB9DA9C661\\",\\n \\"Pipeline\\": [\\n {\\n \\"NodeType\\": \\"system_strategy\\",\\n \\"Name\\": \\"关键词转人工\\",\\n \\"Input\\": \\"用户问句：转人工\\\\\\\\n命中规则：[转]人工[客服|服务|坐席]\\",\\n \\"Output\\": \\"commands:{\\\\\\\\\\\\\\"sysToAgent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"skillGroup\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"ext\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"toAgentReason\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"HitKeywords\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"}\\\\\\\\nresponse:正在为您转接人工客服\\"\\n }\\n ],\\n \\"AnswerInfo\\": {\\n \\"MessageBody\\": {\\n \\"DirectMessageBody\\": {\\n \\"ContentType\\": \\"\\",\\n \\"relatedQuestionList\\": [\\n \\"\\"\\n ],\\n \\"sentenceList\\": [\\n {\\n \\"Content\\": \\"\\",\\n \\"ReferNumber\\": 0\\n }\\n ],\\n \\"TransitionList\\": [\\n \\"\\"\\n ]\\n },\\n \\"Commands\\": \\"\\"\\n },\\n \\"AnswerReferenceInfo\\": {\\n \\"ItemList\\": [\\n {\\n \\"Number\\": 0,\\n \\"Title\\": \\"\\",\\n \\"Id\\": \\"\\",\\n \\"DataSource\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"ReferenceExt\\": \\"\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '大模型问答调试信息', + 'description' => '仅支持新版机器人，只能查询到90天内的数据', + 'extraInfo' => '### 转人工'."\n" + .'```json'."\n" + .'{'."\n" + .' "RequestId": "D267AB94-2438-1A39-899A-2730BBF808BC",'."\n" + .' "MessageId": "8acb8120-9522-461c-babd-509f2f6814ec",'."\n" + .' "Pipeline": ['."\n" + .' {'."\n" + .' "Input": "用户问句：转人工\\n命中规则：[转]人工[客服|服务|坐席]",'."\n" + .' "NodeType": "system_strategy",'."\n" + .' "Output": "commands:{\\"sysToAgent\\":\\"{\\\\\\"skillGroup\\\\\\":\\\\\\"\\\\\\",\\\\\\"ext\\\\\\":\\\\\\"\\\\\\",\\\\\\"toAgentReason\\\\\\":\\\\\\"HitKeywords\\\\\\"}\\"}\\nresponse:正在为您转接人工客服",'."\n" + .' "Name": "关键词转人工"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### 敏感词'."\n" + .'```json'."\n" + .'{'."\n" + .' "RequestId": "C1BB266B-A526-1CE1-9DD0-5A008E30B061",'."\n" + .' "MessageId": "b716ba46-d69a-4a07-8883-a3ac9709f446",'."\n" + .' "Pipeline": ['."\n" + .' {'."\n" + .' "Input": "用户问句：你是于鹏飞吗\\n命中规则：于鹏飞",'."\n" + .' "NodeType": "system_strategy",'."\n" + .' "Output": "您说的这个问题我不能回答您，您可以尝试询问其他问题",'."\n" + .' "Name": "全局敏感词"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### 高频问答直出'."\n" + .'```json'."\n" + .'{'."\n" + .' "RequestId": "3708D217-AE5A-139B-A669-150CA359A1D3",'."\n" + .' "MessageId": "77f8ebe3-4134-44be-ae2b-a78eb1206bf5",'."\n" + .' "Pipeline": ['."\n" + .' {'."\n" + .' "Input": "流式会话接口何时触发无答案呀？",'."\n" + .' "NodeType": "invoke_tools",'."\n" + .' "Output": ['."\n" + .' {'."\n" + .' "ToolName": "知识库检索",'."\n" + .' "ToolResult": ['."\n" + .' {'."\n" + .' "Score": "1.0000",'."\n" + .' "Content": "流式会话接口何时触发无答案？",'."\n" + .' "BizKnowType": "FAQ",'."\n" + .' "Name": "流式会话接口何时触发无答案？"'."\n" + .' },'."\n" + .' {'."\n" + .' "Score": "0.5634",'."\n" + .' "Content": "调用流式会话接口不通",'."\n" + .' "BizKnowType": "FAQ",'."\n" + .' "Name": "调用流式会话接口返回HTML内容"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "Input": "高频问答标题：流式会话接口何时触发无答案？\\n置信度：1.0",'."\n" + .' "NodeType": "system_strategy",'."\n" + .' "Output": "<div id=\\"se-knowledge\\"><p><img width=\\"1107\\" height=\\"336\\" src=\\"https://beebot-knowledgecloud-aliyun-public-cn-shanghai.oss-cn-shanghai.aliyuncs.com/kc/1242280/kc-media/kc-faq-oss/1731921908997-image.png\\" slate-data-type=\\"image\\">机器人高级设置里有通识开关，关掉通识的话，会透出无答案，不关掉的话，会有模型兜底回复。</p><link rel=\\"stylesheet\\" href=\\"https://g.alicdn.com/isipfe/docs/rich.css?\\"></div>",'."\n" + .' "Name": "高频问答直出"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'```'."\n" + ."\n" + .'### 正常模型调用'."\n" + .'```json'."\n" + .'{'."\n" + .' "RequestId": "EF047782-B031-1F5F-9E4B-A8C9AD242BC0",'."\n" + .' "MessageId": "f194bd8c-7f11-4fbd-833a-ebc7db08c462",'."\n" + .' "Pipeline": ['."\n" + .' {'."\n" + .' "Input": "错误码有哪些？",'."\n" + .' "NodeType": "rewrite_query",'."\n" + .' "Output": "错误码有哪些？"'."\n" + .' },'."\n" + .' {'."\n" + .' "Input": "错误码有哪些？",'."\n" + .' "NodeType": "invoke_tools",'."\n" + .' "Output": ['."\n" + .' {'."\n" + .' "ToolName": "知识库检索",'."\n" + .' "ToolResult": ['."\n" + .' {'."\n" + .' "Score": "0.6119",'."\n" + .' "Content": "[110202]\\"【文档名】公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心\\n【标题】公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心\\n【正文】联系我们：4008013260\\n[法律声明](link-32472483000.png)[Cookies政策](link-32472483001.png)[廉正举报](link-32472483002.png)[安全举报](link-32472483003.png)[联系我们](link-32472483004.png)[加入我们](link-32472483005.png)\\n### 友情链接\\n[阿里巴巴集团](link-32472483006.png)[淘宝网](link-32472483007.png)[天猫](link-32472483008.png)[全球速卖通](link-32472483009.png)[阿里巴巴国际交易市场](link-32472483010.png)[1688](link-32472483011.png)[阿里妈妈](link-32472483012.png)[飞猪](link-32472483013.png)[阿里云计算](link-32472483014.png)[AliOS](link-32472483015.png)[万网](link-32472483016.png)[高德](link-32472483017.png)[UC](link-32472483018.png)[友盟](link-32472483019.png)[优酷](link-32472483020.png)[钉钉](link-32472483021.png)[支付宝](link-32472483022.png)[达摩院](link-32472483023.png)[淘宝海外](link-32472483024.png)[阿里云盘](link-32472483025.png)[饿了么](link-32472483026.png)\\n© 2009-2025 Aliyun.com 版权所有 增值电信业务经营许可证： [浙B2-20080101](link-32472483027.png) 域名注册服务机构许可： [浙D3-20210002](link-32472483028.png)\\n[](link-32472483030.png)[浙公网安备 33010602009975号](link-32472483032.png)[浙B2-20080101-4](link-32472483033.png)\\"",'."\n" + .' "BizKnowType": "WEBSITE",'."\n" + .' "Name": "公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心"'."\n" + .' },'."\n" + .' {'."\n" + .' "Score": "0.5960",'."\n" + .' "Content": "[110203]\\"【文档名】公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心\\n【标题】公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心\\n【正文】| 403 | InstanceFreezing | The specified instance has been frozen because it has overdue bills. | 当前智能对话机器人版本已产生欠费，导致实例冻结 | [诊断](link-32472482000.png){#error-code-table-4-0-diagnosis-link} |\\n| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 系统内部错误 | [诊断](link-32472482001.png){#error-code-table-4-1-diagnosis-link} |\\n| 400 | InvalidParameter | The specified parameter %s is not valid. | 请求API的参数不合法 | [诊断](link-32472482002.png){#error-code-table-4-2-diagnosis-link} |\\n| 403 | Forbidden | User not authorized to operate on the specified resource. | 该用户未被授权可操作指定资源 | [诊断](link-32472482003.png){#error-code-table-4-3-diagnosis-link} |\\n{#error-code-3}\\n[上一篇：GetBotSessionData - 机器人接待概况](link-32472482004.png)[下一篇：版本说明](link-32472482005.png)\\n该文章对您有帮助吗？\\n反馈\\n### 为什么选择阿里云\\n[什么是云计算](link-32472482006.png)[全球基础设施](link-32472482007.png)[技术领先](link-32472482008.png)[稳定可靠](link-32472482009.png)[安全合规](link-32472482010.png)[分析师报告](link-32472482011.png)\\n### 产品和定价\\n[全部产品](link-32472482012.png)[免费试用](link-32472482013.png)[产品动态](link-32472482014.png)[产品定价](link-32472482015.png)[价格计算器](link-32472482016.png)[云上成本管理](link-32472482017.png)\\n### 解决方案\\n[技术解决方案](link-32472482018.png)\\n### 文档与社区\\n[文档](link-32472482019.png)[开发者社区](link-32472482020.png)[天池大赛](link-32472482021.png)[培训与认证](link-32472482022.png)\\n### 权益中心\\n[免费试用](link-32472482023.png)[高校计划](link-32472482024.png)[企业扶持计划](link-32472482025.png)[推荐返现计划](link-32472482026.png)\\n### 支持与服务\\n[基础服务](link-32472482027.png)[企业增值服务](link-32472482028.png)[迁云服务](link-32472482029.png)[官网公告](link-32472482030.png)[健康看板](link-32472482031.png)[信任中心](link-32472482032.png)\\n### 关注阿里云\\n关注阿里云公众号或下载阿里云APP，关注云资讯，随时随地运维管控云服务\\n\\"",'."\n" + .' "BizKnowType": "WEBSITE",'."\n" + .' "Name": "公共错误码_智能对话机器人(Chatbot)-阿里云帮助中心"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "Input": ['."\n" + .' {'."\n" + .' "Role": "system",'."\n" + .' "Content": "# Environment variables utilization\\n\\n下面是在当前对话中你已知的环境变量信息，包括：当前日期、时间、地点以及其他随路参数：\\n\\n- system_time: 2025-02-27 16:59:10\\n- day_of_week: 星期四\\n- location: \\n- 随路参数取值为: {}\\n\\n可以在必要时候使用上面这些信息"'."\n" + .' }'."\n" + .' ],'."\n" + .' "NodeType": "invoke_llm",'."\n" + .' "Output": "thought:<ref>doc<params>{}\\nresponse: 根据文档显示，主要的错误码及其含义如下：\\n\\n1. 常见错误码：\\n- InvalidInstanceId.NotFound (404): 指定的机器人ID不存在\\n- InvalidParameter (400): 参数不合法\\n- InternalError (500): 内部错误 [110201]\\n\\n2. 公共错误码：\\n- InstanceFreezing (403): 当前智能对话机器人版本已产生欠费，导致实例冻结\\n- InternalError (500): 系统内部错误\\n- InvalidParameter (400): 请求API的参数不合法\\n- Forbidden (403): 该用户未被授权可操作指定资源 [110202, 110203]\\n\\n3. 限流错误：\\n当并发超过版本并发时，会触发限流，错误码为\\"csQueueBusy\\"，提示\\"服务繁忙，请等待\\" [110201]\\n\\n更多错误码信息可以访问[错误中心](link-32471693000.png)查看 [110204]"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n\n" + ."\n" + .'### 插件调用'."\n" + .'```json'."\n" + .'{'."\n" + .' "RequestId": "D7C96E0A-8F1F-15FC-8B53-6BB10BF8AA50",'."\n" + .' "MessageId": "6f2082d7-e32c-4823-90fe-8b0b97b71ae9",'."\n" + .' "Pipeline": ['."\n" + .' {'."\n" + .' "Input": "上海",'."\n" + .' "NodeType": "rewrite_query",'."\n" + .' "Output": "上海天气查询"'."\n" + .' },'."\n" + .' {'."\n" + .' "Input": "上海天气查询",'."\n" + .' "NodeType": "invoke_tools",'."\n" + .' "Output": ['."\n" + .' {'."\n" + .' "ToolName": "知识库检索",'."\n" + .' "ToolResult": ['."\n" + .' {'."\n" + .' "Score": "1.0000",'."\n" + .' "Content": "查天气1119的处理流程：\\nflowchart TD\\nAB000(开始)--查天气-->AB001>根据API: getWeather的定义询问参数并调用]\\nAB001--API getWeather的输出参数weather不为空-->AB002[严格回复：固定回复]\\n\\nAPI: getWeather\\n描述: 查询天气，支持全国地级市天气信息查询，如：北京、上海、杭州、重庆等。\\n输入参数: {\\"type\\":\\"object\\",\\"properties\\":{\\"date\\":{\\"type\\":\\"string\\",\\"description\\":\\"时间\\"},\\"city\\":{\\"type\\":\\"string\\",\\"description\\":\\"城市名称，如北京、上海、杭州、重庆等。参数值请参考以下值：上海\\"}},\\"required\\":[\\"city\\"]}\\n输出结果: {\\"type\\":\\"object\\",\\"properties\\":{\\"weather\\":{\\"type\\":\\"string\\",\\"description\\":\\"具体的天气信息\\"}}}",'."\n" + .' "BizKnowType": "FLOW",'."\n" + .' "Name": "查天气1119"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "Input": "{\\"city\\":\\"上海\\"}",'."\n" + .' "NodeType": "invoke_tools",'."\n" + .' "Output": ['."\n" + .' {'."\n" + .' "ToolName": "getWeather",'."\n" + .' "ToolResult": "上海市雾，气温 14 摄氏度，东北风 ≤3 级"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'UpdateCategory' => [ + 'summary' => '编辑类目。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '发布任务Id', - 'description' => '发布任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '8521', - ], + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => ['title' => '类目ID', 'description' => '类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '231001028593'], + ], + [ + 'name' => 'BizCode', + 'in' => 'formData', + 'schema' => ['title' => '业务代码', 'description' => '业务代码', 'type' => 'string', 'required' => false, 'example' => 'bizcode123'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '类目名称', 'description' => '类目名称', 'type' => 'string', 'required' => true, 'example' => '类目名称'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', - ], - 'Id' => [ - 'title' => '发布任务Id', - 'description' => '发布任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8522', - ], - 'Response' => [ - 'title' => '发布任务Id，冗余字段，建议使用Id字段获取发布任务Id', - 'description' => '发布任务ID，冗余字段，建议使用发布任务ID', - 'type' => 'string', - 'example' => '8522', - ], - 'Status' => [ - 'title' => '任务状态（ FE_RUNNING：正在发布中 FE_SUCCESS：发布成功 FE_FAILED：发布失败 FE_ABORTED：发布取消）', - 'description' => '任务状态'."\n" - .'枚举值：'."\n" - ."\n" - .'FE_RUNNING：正在发布中'."\n" - .'FE_SUCCESS：发布成功'."\n" - .'FE_FAILED：发布失败'."\n" - .'FE_ABORTED：发布取消', - 'type' => 'string', - 'example' => 'FE_ABORTED', - 'enum' => [ - 'FE_RUNNING：正在发布中', - 'FE_SUCCESS：发布成功', - 'FE_FAILED：发布失败', - 'FE_ABORTED：发布取消', - ], - ], - 'BizTypeList' => [ - 'title' => '业务类型列表', - 'description' => '业务类型列表', - 'type' => 'array', - 'items' => [ - 'description' => '业务类型', - 'type' => 'string', - 'example' => 'faq', - ], - ], - 'Error' => [ - 'title' => '发布任务失败信息', - 'description' => '任务失败信息', - 'type' => 'string', - 'example' => '检查待发布模块是否空闲发生错误，faq', - ], - 'CreateTime' => [ - 'title' => '任务创建的 UTC 时间', - 'description' => '任务创建的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'ModifyTime' => [ - 'title' => '任务修改的 UTC 时间', - 'description' => '任务修改的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:33Z', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902'], ], ], ], ], - 'responseDemo' => '', - 'title' => '取消发布任务', - ], - 'GetPublishTaskState' => [ - 'summary' => '查询发布进度。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\"\\n}","type":"json"}]', + 'title' => '类目-更新', + 'changeSet' => [ + ['createdAt' => '2024-02-22T12:10:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCategory'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'UpdateConnQuestion' => [ + 'summary' => '更新关联关系。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '发布任务Id', - 'description' => '发布任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '8521', - ], + 'name' => 'ConnQuestionId', + 'in' => 'formData', + 'schema' => ['description' => '关联知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000000295'], + ], + [ + 'name' => 'OutlineId', + 'in' => 'formData', + 'schema' => ['description' => '关联关系ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '877397683'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', - ], - 'Id' => [ - 'title' => '发布任务Id', - 'description' => '发布任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8522', - ], - 'Response' => [ - 'title' => '发布任务Id，冗余字段，建议使用Id字段获取发布任务Id', - 'description' => '发布任务ID,冗余字段,建议使用发布任务ID', - 'type' => 'string', - 'example' => '8522', - ], - 'Status' => [ - 'title' => '任务状态（ FE_RUNNING：正在发布中 FE_SUCCESS：发布成功 FE_FAILED：发布失败 FE_ABORTED：发布取消）', - 'description' => '任务状态'."\n" - .'枚举值：'."\n" - .'- FE_RUNNING：正在发布中'."\n" - .'- FE_SUCCESS：发布成功'."\n" - .'- FE_FAILED：发布失败'."\n" - .'- FE_ABORTED：发布取消', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'FE_RUNNING', - 'enum' => [ - 'FE_RUNNING：正在发布中', - 'FE_SUCCESS：发布成功', - 'FE_FAILED：发布失败', - 'FE_ABORTED：发布取消', - ], - ], - 'BizTypeList' => [ - 'title' => '业务类型列表', - 'description' => '业务类型列表', - 'type' => 'array', - 'items' => [ - 'description' => '发布任务的业务类型', - 'type' => 'string', - 'example' => 'faq', - ], - ], - 'Error' => [ - 'title' => '发布任务失败信息', - 'description' => '任务失败信息', - 'type' => 'string', - 'example' => '检查待发布模块是否空闲发生错误，faq', - ], - 'CreateTime' => [ - 'title' => '任务创建的 UTC 时间', - 'description' => '任务创建的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:17Z', - ], - 'ModifyTime' => [ - 'title' => '任务修改的 UTC 时间', - 'description' => '任务修改的 UTC 时间', - 'type' => 'string', - 'example' => '2022-04-12T06:30:33Z', - ], - 'Errors' => [ - 'title' => '各子发布模块的错误信息，key是子发布模块，value是错误信息', - 'description' => '各子发布模块的错误信息,key是子发布模块,value是错误信息', - 'type' => 'object', - 'example' => '{'."\n" - .' "faq": ['."\n" - .' "答案资源未发布, 资源类型: 全局服务,名称: 动态答案服务"'."\n" - .' ]'."\n" - .'}', - ], - 'Warnings' => [ - 'title' => '各子发布模块的警告信息，key是子发布模块，value是警告信息', - 'description' => '各子发布模块的警告信息,key是子发布模块,value是警告信息', - 'type' => 'object', - 'example' => '{'."\n" - .' "faq": ['."\n" - .' "答案资源未发布,类型:service名称:null,答案资源未发布,类型:service名称:null"'."\n" - .' ]'."\n" - .'}'."\n", - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '004EB5C0-9DEB-53BF-A57A-0407A6D6B3C9'], ], ], ], ], - 'responseDemo' => '', - 'title' => '查询发布进度', - ], - 'GetAgentInfo' => [ - 'summary' => '获取业务空间ID。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"004EB5C0-9DEB-53BF-A57A-0407A6D6B3C9\\"\\n}","type":"json"}]', + 'title' => '更新FAQ关联问', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConnQuestion'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'UpdateDSEntity' => [ + 'summary' => '实体meta信息修改，仅支持修改实体名称；实体类型不支持修改。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'beebot_bot_public_cn-ca36x8v3n1x', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123'], + ], + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => ['title' => '实体名称，仅支持中文、大小写字母、数字、下划线', 'description' => '实体名称，仅支持中文、大小写字母、数字、下划线', 'type' => 'string', 'required' => true, 'example' => '实体名称'], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => ['title' => '实体类型：详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', 'description' => '实体类型：[synonyms（同义词），regex（正则）]', 'type' => 'string', 'required' => false, 'example' => 'synonyms'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'BaseResponse<EntityIdResponse>', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter.Invalid', - ], - 'Data' => [ - 'description' => '业务空间数据', - 'type' => 'object', - 'properties' => [ - 'AgentName' => [ - 'description' => '业务空间名称', - 'type' => 'string', - 'example' => '业务空间_881', - ], - 'AgentKey' => [ - 'description' => '业务空间签名，用于PAAS接口指定业务空间时使用', - 'type' => 'string', - 'example' => '4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public', - ], - ], - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'df23fgh4hyj67hn56'], + 'EntityId' => ['description' => '实体ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '根据实例ID获取业务空间信息', - ], - 'ListAgent' => [ - 'summary' => '获取当前阿里云账号的业务空间列表。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], + ['errorCode' => 'BusinessErrorEntityName.OutRange', 'errorMessage' => 'The business error EntityName is out of range.', 'description' => ''], + ['errorCode' => 'BusinessErrorEntityName.Repeat', 'errorMessage' => 'The business error EntityName is repeat.', 'description' => ''], + ['errorCode' => 'BusinessErrorEntityName.InvalidCharactor', 'errorMessage' => 'The business error EntityName contains invalid charactor.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"df23fgh4hyj67hn56\\",\\n \\"EntityId\\": 123\\n}","errorExample":""},{"type":"xml","example":"<UpdateDSEntityResponse>\\n <RequestId>df23fgh4hyj67hn56</RequestId>\\n <EntityId>243345345</EntityId>\\n</UpdateDSEntityResponse>","errorExample":""}]', + 'title' => '实体-修改', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDSEntity'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'UpdateDSEntityValue' => [ + 'summary' => '修改某个实体的某个实体成员，有实体值&同义词、正则表达式两类数据修改。注意：往一个标准实体中添加正则表达式是不被允许的，反之亦然。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotS5PR8Q', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '当前⻚码，默认值是1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '返回结果中每页显示的记录数量。最大取值100，默认值是10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'AgentName', + 'name' => 'EntityId', 'in' => 'query', - 'schema' => [ - 'description' => '业务空间名称，按照名称检索', - 'type' => 'string', - 'required' => false, - 'example' => '业务空间_001', - ], + 'schema' => ['title' => '实体ID，修改实体成员时可为空', 'description' => '实体ID，修改实体成员时可为空', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '223423423'], ], [ - 'name' => 'GoodsCodes', + 'name' => 'EntityValueId', + 'in' => 'query', + 'schema' => ['title' => '实体成员ID，创建实体成员时为空', 'description' => '实体成员ID，创建实体成员时为空', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '2342377423'], + ], + [ + 'name' => 'Content', 'in' => 'query', + 'schema' => ['title' => '实体类型为synonyms时，表示实体归一化值；当实体类型为regex时，表示正则表达式文本', 'description' => '实体类型为synonyms时，表示实体归一化值；当实体类型为regex时，表示正则表达式文本', 'type' => 'string', 'required' => true, 'example' => '书本类型'], + ], + [ + 'name' => 'Synonyms', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '商品code，可按照商品code进行过滤，查询实例信息', - 'type' => 'string', + 'title' => '实体同义词', + 'description' => '同义词列表', + 'type' => 'array', + 'items' => ['description' => '实体同义词', 'type' => 'string', 'required' => false, 'example' => '小说'], 'required' => false, - 'enumValueTitles' => [ - 'G_cloudBeeBot_public' => 'G_cloudBeeBot_public', - ], - 'example' => 'G_cloudBeeBot_public', + 'maxItems' => 10, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'BaseResponse<EntityValueIdResponse>', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419', - ], - 'PageNumber' => [ - 'description' => '当前⻚，默认1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '返回结果中每页显示的记录数量。最大取值100，默认值是10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Data' => [ - 'description' => '业务空间列表', - 'type' => 'array', - 'items' => [ - 'description' => '业务空间数据', - 'type' => 'object', - 'properties' => [ - 'AgentId' => [ - 'description' => '业务空间ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '881', - ], - 'AgentKey' => [ - 'description' => '业务空间签名，用于PAAS接口指定业务空间时使用', - 'type' => 'string', - 'example' => '4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public', - ], - 'AgentName' => [ - 'description' => '业务空间名称', - 'type' => 'string', - 'example' => '业务空间_881', - ], - 'InstanceInfos' => [ - 'description' => '商品实例信息', - 'type' => 'object', - 'enumValueTitles' => [ - 'G_cloudBeeBot_public' => 'G_cloudBeeBot_public', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'sDag3g43wesf2'], + 'EntityValueId' => ['description' => '实体成员ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2342377423'], ], ], ], ], - 'responseDemo' => '', - 'title' => '获取业务空间列表', - 'responseParamsDescription' => 'InstanceInfos示例。'."\n" - .'"InstanceInfos": {'."\n" - .' "GoodsCode": {'."\n" - .' "InstanceId": "xxxxxx"'."\n" - .' }'."\n" - .' }'."\n" - .'//GoodsCode参考枚举值', - ], - 'GenerateUserAccessToken' => [ - 'summary' => '用于聊天窗用户免登时，获取Token，通过该Token可将用户的企业身份带入。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"sDag3g43wesf2\\",\\n \\"EntityValueId\\": 2342377423\\n}","errorExample":""},{"type":"xml","example":"<UpdateDSEntityValueResponse>\\n <RequestId>sDag3g43wesf2</RequestId>\\n <EntityValueId>2342377423</EntityValueId>\\n</UpdateDSEntityValueResponse>","errorExample":""}]', + 'title' => '实体成员-修改', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDSEntityValue'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'UpdateDoc' => [ + 'summary' => '更新文档。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotJ8IS68', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'ExpireTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '保留参数，无需传入', - 'description' => '保留参数，无需传入', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '3600', - 'minimum' => '0', - 'example' => '1000', - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'AgentKey', + 'name' => 'KnowledgeId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席密钥', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '文档ID', 'description' => '文档ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617'], ], [ - 'name' => 'ExtraInfo', - 'in' => 'formData', - 'schema' => [ - 'title' => '附加信息，json字符串', - 'description' => '附加信息，json字符串', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "xx": 123,'."\n" - .' "yy": 22332,'."\n" - .' "customerNameCard": ['."\n" - .' {'."\n" - .' "key": "姓名",'."\n" - .' "value": "张三"'."\n" - .' },'."\n" - .' {'."\n" - .' "key": "等级",'."\n" - .' "value": "v2"'."\n" - .' },'."\n" - .' {'."\n" - .' "key": "联系方式",'."\n" - .' "value": "123"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => ['title' => '文档类目ID', 'description' => '文档类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '231001028593'], ], [ - 'name' => 'Email', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'DocName', + 'in' => 'query', + 'schema' => ['title' => '文档名称', 'description' => '文档名称', 'type' => 'string', 'required' => false, 'example' => '文档问答模块功能说明文档', 'maxLength' => 128, 'minLength' => 1], ], [ - 'name' => 'Telephone', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['title' => '文档标题', 'description' => '文档标题', 'type' => 'string', 'required' => false, 'example' => '文档问答功能说明', 'maxLength' => 128, 'minLength' => 1], ], [ - 'name' => 'ForeignId', - 'in' => 'formData', + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['title' => '文档内容', 'description' => '文档内容', 'type' => 'string', 'required' => false, 'example' => '文档内容', 'maxLength' => 40000], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => ['title' => '文档解析/切分配置'."\n" + .'配置项：切分器'."\n" + .'KEY：Splitter'."\n" + .'值选项：ParagraphSplitter-识别层级【默认】'."\n" + .'值选项：TreeSplitter-规则层级'."\n" + ."\n" + .'配置项：文档切块大小'."\n" + .'KEY：ChunkSize'."\n" + .'VALUE：默认500；范围[200,800]'."\n" + ."\n" + .'配置项：规则层级'."\n" + .'KEY：TreePatterns'."\n" + .'VALUE：默认[]'."\n" + ."\n" + .'配置项：文档标题来源'."\n" + .'KEY：TitleSource'."\n" + .'值选项：ocrTitle - OCR识别标题【默认】'."\n" + .'值选项：docName - 文档名即标题', 'description' => '文档解析/切分配置'."\n" + .'配置项：切分器'."\n" + .'KEY：Splitter'."\n" + .'值选项：paragraphSplitter-识别层级【默认】'."\n" + .'值选项：treeSplitter-规则层级'."\n" + ."\n" + .'配置项：文档切块大小'."\n" + .'KEY：ChunkSize'."\n" + .'VALUE：默认500；范围[200,800]'."\n" + ."\n" + .'配置项：规则层级'."\n" + .'KEY：TreePatterns'."\n" + .'VALUE：默认[]'."\n" + ."\n" + .'配置项：文档标题来源'."\n" + .'KEY：TitleSource'."\n" + .'值选项：ocrTitle - OCR识别标题【默认】'."\n" + .'值选项：docName - 文档名即标题', 'type' => 'string', 'required' => false, 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":""}'], + ], + [ + 'name' => 'Meta', + 'in' => 'query', + 'schema' => ['title' => '文档随路数据', 'description' => '文档随路数据', 'type' => 'string', 'required' => false, 'example' => '{"code":"xxx"}', 'maxLength' => 1000], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['description' => '开始生效时间', 'type' => 'string', 'required' => false, 'example' => '2022-05-25T16:28:36Z'], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['description' => '结束生效时间', 'type' => 'string', 'required' => false, 'example' => '2023-03-11T23:59:59Z'], + ], + [ + 'name' => 'TagIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '用户外部的userid', - 'description' => '用户外部的userid', - 'type' => 'string', - 'required' => true, - 'example' => '8882022040000000171', + 'description' => '标签ID列表，为空时解除绑定', + 'type' => 'array', + 'items' => ['description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1201'], + 'required' => false, ], ], [ - 'name' => 'Nick', - 'in' => 'formData', + 'name' => 'DocMetadata', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '访问者昵称', - 'description' => '访问者昵称', - 'type' => 'string', - 'required' => true, - 'example' => '张三', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BusinessViewId' => ['type' => 'string', 'required' => false, 'description' => ''], + 'BusinessViewName' => ['type' => 'string', 'required' => false, 'description' => ''], + 'MetaCellInfoDTOList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldCode' => ['type' => 'string', 'required' => false, 'description' => ''], + 'FieldName' => ['type' => 'string', 'required' => false, 'description' => ''], + 'Value' => ['type' => 'string', 'required' => false, 'description' => ''], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'description' => '', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'description' => '', ], ], ], @@ -12556,263 +7588,145 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'E6988CE6-41CF-1103-9BEC-2B20D26C0B51', - ], - 'Success' => [ - 'title' => '是否操作成功：false：否；true：是', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => '请求消息', - 'description' => '返回编码', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '异常信息', - 'type' => 'string', - 'example' => 'Parameter.Invalid', - ], - 'Data' => [ - 'title' => '请求id', - 'description' => 'Token值', - 'type' => 'string', - 'example' => 'DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0F9F136A-1BF6-5CC1-9D57-9717761F03B8'], + 'KnowledgeId' => ['description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30002406051'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '获取用户免登Token', - 'description' => '由于安全问题，生成的Token仅第一次使用有效（过期时间内），如同一个用户多浏览器登录，需要多次调用。', - ], - 'ListTongyiConversationLogs' => [ - 'summary' => '查询对话机器人通义版的单个会话对话记录。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F9F136A-1BF6-5CC1-9D57-9717761F03B8\\",\\n \\"KnowledgeId\\": 30002406051\\n}","type":"json"}]', + 'title' => '更新文档', + 'changeSet' => [ + ['createdAt' => '2024-09-26T12:39:56.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-05-17T09:42:04.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDoc'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'UpdateFaq' => [ + 'summary' => '编辑一条知识。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebot2KBZDS', - ], + 'abilityTreeNodes' => ['FEATUREbeebot2KMN8Y'], ], 'parameters' => [ [ - 'name' => 'RobotInstanceId', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '机器⼈实例id', - 'type' => 'string', - 'required' => true, - 'example' => 'chatbot-cn-7QuUfaqMQe', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '会话ID', - 'type' => 'string', - 'required' => true, - 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', - ], + 'name' => 'KnowledgeId', + 'in' => 'formData', + 'schema' => ['title' => '知识ID', 'description' => '知识ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617'], ], [ - 'name' => 'AgentKey', - 'in' => 'query', + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => ['title' => '知识的类目ID', 'description' => '知识的类目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30000049006'], + ], + [ + 'name' => 'Title', + 'in' => 'formData', + 'schema' => ['title' => '知识标题', 'description' => '知识标题', 'type' => 'string', 'required' => true, 'example' => '测试标题'], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'required' => false, 'example' => '2022-05-27T05:18:20Z'], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => ['title' => '失效时间', 'description' => '失效时间', 'type' => 'string', 'required' => false, 'example' => '2030-12-31T16:00:00Z'], + ], + [ + 'name' => 'TagIdList', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', + 'title' => '标签ID列表', + 'description' => '标签ID列表', + 'type' => 'array', + 'items' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25645645'], 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'CostTime' => [ - 'title' => '请求消耗时间', - 'description' => '请求消耗时间', - 'type' => 'string', - 'example' => '66', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求id', - 'type' => 'string', - 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F', - ], - 'Datas' => [ - 'title' => '数据详情', - 'description' => '数据详情', - 'type' => 'array', - 'items' => [ - 'title' => '数据详情', - 'description' => '数据详情', - 'type' => 'object', - 'example' => '参考JSON示例', - ], - ], - 'SessionFlowDebugInfo' => [ - 'title' => '会话流程调试信息', - 'description' => '会话流程调试信息', - 'type' => 'object', - 'properties' => [ - 'ApiParams' => [ - 'title' => '会话流程调试信息的API参数', - 'description' => '会话流程调试信息的API参数', - 'type' => 'object', - ], - 'SlotParams' => [ - 'title' => '会话流程调试信息的槽位参数', - 'description' => '会话流程调试信息的槽位参数', - 'type' => 'object', - ], - ], - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '736994BD-AA35-4742-88C9-E64BE4BAA14B'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"736994BD-AA35-4742-88C9-E64BE4BAA14B\\"\\n}","type":"json"}]', + 'title' => '修改FAQ', + 'changeSet' => [ + ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => '请求参数发生变更'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFaq'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '查询单个会话的对话记录', - 'description' => '仅支持查询近2小时的对话记录', - 'responseParamsDescription' => '```json'."\n" - .'{'."\n" - .' "CostTime": "36",'."\n" - .' "RequestId": "E1B076C5-F7DD-1B63-B691-E7E90F4A5770",'."\n" - .' "Datas": ['."\n" - .' {'."\n" - .' "Answer": "您好！为了给您提供准确的信息，请您告诉我您想了解哪一场比赛的时间是2022年12月2号，并告诉我这个队伍的名字。这样我才能告诉您该队伍在那天有没有比赛。\\n\\n例如：\\n- 如果您想了解“北京国安队”在2022年12月2号的比赛，请提供：“北京国安队 2022年12月2号的比赛”。",'."\n" - .' "ToAgent": "false",'."\n" - .' "QueryTime": "2024-10-16 10:11:12",'."\n" - .' "Question": "比赛时间在2022年12月2号有哪个队伍的比赛",'."\n" - .' "SessionId": "6b762779ba334ab1a79b331426247933",'."\n" - .' "ChatId": "ac5c1b6c-768c-488a-9d4d-186c30f3b5b2"'."\n" - .' }'."\n" - .' ]'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'**出参说明**'."\n" - .'| 字段名 |类型 | 描述 |'."\n" - .'| ------------- |------------ | ----- |'."\n" - .'| QueryTime | String | 提问时间 |'."\n" - .'| Question | String | 提问内容 |'."\n" - .'| Answer | String | 答案内容|'."\n" - .'| ToAgent | String | 是否命中转人工|'."\n" - .'| SessionId | String | SessionId |'."\n" - .'| ChatId | String | ChatId |', + 'ramActions' => [], ], - 'ListTongyiChatHistorys' => [ - 'summary' => '获取会话历史明细。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateInstance' => [ + 'summary' => '更新机器人名称，描述。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间,时间格式为yyyy-MM-dd HH:mm:ss,⽐如 2024-04-01 00:00:00', - 'type' => 'string', - 'required' => true, - 'example' => '2024-04-01 00:00:00', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间,时间格式为yyyy-MM-dd HH:mm:ss,⽐如 2024-04-01 08:00:00', - 'type' => 'string', - 'required' => true, - 'example' => '2024-04-01 08:00:00', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ - 'name' => 'RobotInstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '机器⼈实例id', - 'type' => 'string', - 'required' => true, - 'example' => 'chatbot-cn-7QuUfaqMQe', - ], + 'schema' => ['title' => '要修改的机器人名称', 'description' => '要修改的机器人名称，最多50个字符', 'type' => 'string', 'required' => false, 'example' => '智能客服-小C'], ], [ - 'name' => 'Limit', + 'name' => 'Introduction', 'in' => 'query', - 'schema' => [ - 'description' => '数据条数,默认30条,最大值为500', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['title' => '要修改的机器人备注', 'description' => '要修改的机器人备注', 'type' => 'string', 'required' => false, 'example' => '用于C端问答的机器人'], ], [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ @@ -12822,599 +7736,794 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id', - 'type' => 'string', - 'example' => 'D0DDFC4C-D66D-4787-9AE4-4D757481EDEE', - ], - 'CostTime' => [ - 'description' => '请求消耗时间', - 'type' => 'string', - 'example' => '116', - ], - 'Datas' => [ - 'description' => '数据详情', - 'type' => 'array', - 'items' => [ - 'description' => '数据详情', - 'type' => 'object', - 'example' => '参考ChatHistoryDTO', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'C45BFEE4-F657-1332-8B47-2C757B94C972'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C45BFEE4-F657-1332-8B47-2C757B94C972\\"\\n}","type":"json"}]', + 'title' => '机器人-更新', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '会话历史明细', - 'responseParamsDescription' => '**ChatHistoryDTO**'."\n" - .'| 字段名 |类型 | 描述 |'."\n" - .'| ------------- |------------ | ----- |'."\n" - .'| QueryTime | String | 提问时间 |'."\n" - .'| Question | String | 提问内容 |'."\n" - .'| Answer | String | 答案内容|'."\n" - .'| AnswerSource | String | 答案类型 |'."\n" - .'| SessionId | String | 多轮对话的会话ID |'."\n" - .'| ChatId | String | 单次问答的请求ID |'."\n" - .'| UserId | String | 访问者ID，即对话接口中传入的SenderId |'."\n" - .'| Username | String | 当前会话中访问的昵称，即对话接口中传入的SenderNick |'."\n" - .'| FeedbackType | String | 用户反馈|'."\n" - .'| FeedbackLabels | String | 反馈详情 |'."\n" - .'| FeedbackUserInfo | String | 用户反馈说明 |', + 'ramActions' => [], ], - 'GetBotSessionData' => [ - 'summary' => '查询机器⼈问答概览指标。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateIntent' => [ + 'summary' => '修改意图，主要包含意图的meta信息，如：意图名称、意图别名、意图关联词槽信息；不包含意图话术、LGF。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，时间格式为yyyyMMdd，⽐如20240505', - 'type' => 'string', - 'required' => true, - 'example' => '20240505', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'EndTime', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，时间格式为yyyyMMdd，⽐如20240605', - 'type' => 'string', - 'required' => true, - 'example' => '20240605', - ], + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'RobotInstanceId', + 'name' => 'IntentId', 'in' => 'query', - 'schema' => [ - 'description' => '机器⼈实例id', - 'type' => 'string', - 'required' => true, - 'example' => 'chatbot-cn-7QuUfaqMQe', - ], + 'schema' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '234234234534'], ], [ - 'name' => 'AgentKey', + 'name' => 'IntentDefinition', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + 'title' => '意图定义结构体', + 'description' => '意图定义结构体', 'type' => 'object', 'properties' => [ - 'CostTime' => [ - 'description' => 'API调用耗时，单位毫秒ms。', - 'type' => 'string', - 'example' => '116', - ], - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51', - ], - 'Datas' => [ - 'description' => '数据详情', + 'IntentName' => ['title' => '意图名称', 'description' => '意图名称', 'type' => 'string', 'required' => true, 'example' => '查天气意图'], + 'AliasName' => ['title' => '意图别名', 'description' => '意图别名', 'type' => 'string', 'required' => false, 'example' => '查天气意图'], + 'SlotInfos' => [ + 'title' => '槽位信息', + 'description' => '槽位信息', 'type' => 'array', 'items' => [ - 'description' => '数据详情', + 'description' => '槽位信息', 'type' => 'object', - 'example' => '参考JSON示例', + 'properties' => [ + 'SlotId' => ['description' => '槽位ID', 'type' => 'string', 'required' => true, 'example' => 'dgadf23dfg2f'], + 'Name' => ['title' => '槽位名', 'description' => '槽位名', 'type' => 'string', 'required' => true, 'example' => '天气'], + 'Value' => ['title' => '关联的实体名', 'description' => '关联的实体名', 'type' => 'string', 'required' => true, 'example' => '天气'], + 'Interactive' => ['title' => '是否交互式', 'description' => '是否交互式', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Array' => ['title' => '是否数组', 'description' => '是否数组', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Encrypt' => ['title' => '是否脱敏', 'description' => '是否脱敏', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + 'required' => false, ], + 'required' => false, ], ], + 'required' => true, + 'docRequired' => true, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'IntentId' => ['description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'example' => '234234234534'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'dfaf23dfas234234234534'], + ], + ], + ], ], - 'responseDemo' => '', - 'title' => '机器人接待概况', - 'description' => '仅支持查询T-1（不含当天）的数据', - 'responseParamsDescription' => '**Datas**'."\n" - .'| 字段名 | 类型 | 描述 |'."\n" - .'| ------------- |------------ | ----- |'."\n" - .'| SidCnt | int | 接待⼈次 |'."\n" - .'| ChatCnt | int | 对话请求量 |'."\n" - .'| AvgChatCnt | int | 平均对话轮次 |'."\n" - .'| SolutionSidCnt | int | 解决接待量 |'."\n" - .'| NoSolutionRate | double | 未解决率 |'."\n" - .'|NoAnswerRate| double |⽆答案率|'."\n" - .'|FeedbackChatCnt |int |点评量 |'."\n" - .'| FeedbackGoodChatCnt | int |点赞量 |'."\n" - .'|FeedbackBadChatCnt | int | 点踩量 |'."\n" - ."\n" - .'> Datas数组元素中的各个字段是以String类型返回的，如需转换为数字类型请按需解析', - ], - 'InitIMConnect' => [ - 'summary' => '通过渠道后台配置生成的from值，自定义初始化im连接信息，初始化时支持传递用户鉴权token。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', 'description' => ''], + ['errorCode' => 'BusinessErrorIntent.OutRange', 'errorMessage' => 'The business error Intent is out of range.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IntentId\\": 234234234534,\\n \\"RequestId\\": \\"dfaf23dfas234234234534\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIntentResponse>\\n <IntentId>234234234534</IntentId>\\n <RequestId>dfaf23dfas234234234534</RequestId>\\n</UpdateIntentResponse>","errorExample":""}]', + 'title' => '意图-修改', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntent'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'UpdateLgf' => [ + 'summary' => '为指定意图创建高级语义配置（LGF）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREbeebotJ8IS68', - ], - 'autoTest' => true, - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'From', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], [ - 'name' => 'UserAccessToken', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], ], [ - 'name' => 'AgentKey', + 'name' => 'LgfId', 'in' => 'query', + 'schema' => ['title' => 'LGF ID', 'description' => 'LGF ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12121'], + ], + [ + 'name' => 'LgfDefinition', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + 'description' => 'LGF 信息', + 'type' => 'object', + 'properties' => [ + 'IntentId' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '23234523522'], + 'RuleText' => ['title' => 'LGF配置', 'description' => 'LGF配置', 'type' => 'string', 'required' => true, 'example' => '.{0,10}[天气]'], + ], + 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'E6988CE6-41CF-1103-9BEC-2B20D26C0B52', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '返回编码', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '异常信息', - 'type' => 'string', - 'example' => 'Parameter.Invalid', - ], - 'Data' => [ - 'description' => 'im连接信息', - 'type' => 'string', - 'example' => '{ "imDomain": "im.alimebot.com", "appKey": "WDg2VfNv", "token": "QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==" }', - ], + 'LgfId' => ['description' => 'LGF唯一标识', 'type' => 'integer', 'format' => 'int64', 'example' => '2342556223532'], + 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '289dfa131adf23wqe2r'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '', - 'title' => '初始化im连接', - 'responseParamsDescription' => 'imDomain: im连接域名，'."\n" - .'appKey: im认证key，'."\n" - .'token: im连接token。', - ], - 'ListSaasInfo' => [ - 'summary' => '获取SaaS被集成信息列表。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error IntentId is not exists.', 'description' => ''], + ['errorCode' => '400 BusinessErrorIntentLgfId.NotExists', 'errorMessage' => 'The business error IntentLgfId is not exists.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LgfId\\": 2342556223532,\\n \\"RequestId\\": \\"289dfa131adf23wqe2r\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLgfResponse>\\n <LgfId>2342556223532</LgfId>\\n <RequestId>289dfa131adf23wqe2r</RequestId>\\n</UpdateLgfResponse>","errorExample":""}]', + 'title' => 'LGF-修改', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLgf'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], + 'ramActions' => [], + ], + 'UpdatePerspective' => [ + 'summary' => '更新视角名称和描述。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'PerspectiveId', 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '视角主键（code_id）', 'description' => '视角ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001'], ], [ - 'name' => 'SaasName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '业务方用户名', - 'type' => 'string', - 'required' => true, - 'example' => 'userTest', - ], + 'schema' => ['title' => '视角名称', 'description' => '视角名称，长度不超过50字', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '客户端视角'], ], [ - 'name' => 'SaasGroupCodes', + 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '用户所拥有的saas权限组code，多个用英文逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'DS,FAQ', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], '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' => 'A629A28F-F25E-5572-A679-FA46FB0151D6', - ], - 'Data' => [ - 'description' => 'SaaS被集成列表', - 'type' => 'array', - 'items' => [ - 'description' => 'SaaS被集成信息', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'SaaS原子化页面唯一标识，可用来关联和查询原子页面的相关信息', - 'type' => 'string', - 'example' => 'GLOBAL_SERVICE', - ], - 'Name' => [ - 'description' => '原子页面的中文名称', - 'type' => 'string', - 'example' => '全局服务', - ], - 'Url' => [ - 'description' => '原子页面的链接地址', - 'type' => 'string', - 'example' => 'https://alime.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot', - ], - 'EnName' => [ - 'description' => '原子页面的英文名称', - 'type' => 'string', - 'example' => 'GLOBAL SERVICE', - ], - 'ServiceUrl' => [ - 'description' => 'iframe嵌套SaaS页面链接', - 'type' => 'string', - 'example' => 'https://pre-alime4service.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot', - ], - ], - ], - ], - 'SaasToken' => [ - 'description' => '云小蜜颁发的SaaS被集成Token', - 'type' => 'string', - 'example' => '06614fdb-c72f-436e-8003-dfe8a2854a15', - ], + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID', 'type' => 'string', 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC384CE1-8D42-1900-84E1-F33F990F2B5E\\"\\n}","type":"json"}]', + 'title' => '视角-更新', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePerspective'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '获取SaaS被集成信息列表', + 'ramActions' => [], ], - 'ListSaasPermissionGroupInfos' => [ - 'summary' => '获取权限被集成信息列表，可通过该列表返回的权限组，给用户授权。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateSimQuestion' => [ + 'summary' => '更新相似问题。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', - 'schema' => [ - 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => true, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ + 'name' => 'Title', + 'in' => 'formData', + 'schema' => ['title' => '相似问标题，字数上限-120', 'description' => '相似问标题，字数上限：120字', 'type' => 'string', 'required' => true, 'example' => '测试相似问标题'], + ], + [ + 'name' => 'SimQuestionId', + 'in' => 'formData', + 'schema' => ['title' => '相似问ID', 'description' => '相似问ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000002788'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'result', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32', - ], - 'Data' => [ - 'description' => 'SaaS各集成页面权限列表', - 'type' => 'array', - 'items' => [ - 'description' => 'SaaS各集成页面权限', - 'type' => 'object', - 'properties' => [ - 'SaasCode' => [ - 'description' => 'SaaS原子化页面唯一标识', - 'type' => 'string', - 'example' => 'FAQ', - ], - 'Name' => [ - 'description' => '原子页面的中文名称', - 'type' => 'string', - 'example' => '发布中心', - ], - 'EnName' => [ - 'description' => '原子页面的英文名称', - 'type' => 'string', - 'example' => 'Release Center', - ], - 'PgInfos' => [ - 'description' => 'SaaS权限组列表', - 'type' => 'array', - 'items' => [ - 'description' => 'SaaS权限组信息', - 'type' => 'object', - 'properties' => [ - 'PgCode' => [ - 'description' => 'SaaS权限组Code', - 'type' => 'string', - 'example' => 'FAQ', - ], - 'PgName' => [ - 'description' => 'SaaS权限组中文名', - 'type' => 'string', - 'example' => 'FAQ管理', - ], - 'PgEnName' => [ - 'description' => 'SaaS权限组英文名', - 'type' => 'string', - 'example' => 'FAQ', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DFB71B34-4188-4EA2-9988-EF3014E75910\\"\\n}","type":"json"}]', + 'title' => '更新FAQ相似问', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSimQuestion'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], - 'responseDemo' => '', - 'title' => '获取权限被集成信息列表', + 'ramActions' => [], ], - 'CancelChat' => [ - 'summary' => '取消或打断对应对话。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateSolution' => [ + 'summary' => '更新答案。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '254397', - 'abilityTreeNodes' => [ - 'FEATUREbeebotUKQQ1L', - ], + 'abilityTreeNodes' => ['FEATUREbeebotVKU6KE'], ], 'parameters' => [ [ - 'name' => 'AgentKey', + 'name' => 'SolutionId', 'in' => 'formData', - 'schema' => [ - 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', - 'type' => 'string', - 'required' => false, - 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', - ], + 'schema' => ['title' => '答案ID', 'description' => '答案ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '100001333260'], ], [ - 'name' => 'SessionId', + 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'description' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。长度限制是64个字符', - 'type' => 'string', - 'required' => false, - 'example' => 'c1187530338311ebade7cf3eaeb3668a', - ], + 'schema' => ['title' => '答案内容', 'description' => '答案内容', 'type' => 'string', 'required' => true, 'example' => '修改的答案内容'], ], [ - 'name' => 'ChatId', + 'name' => 'ContentType', + 'in' => 'formData', + 'schema' => ['title' => '答案类型', 'description' => '答案类型：0-纯文本，1-富文本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PerspectiveCodes', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '标识单次对话的id', - 'type' => 'string', - 'required' => false, - 'example' => '7105a351-b2e7-4c9e-8437-c43a043c0a4e', + 'title' => '视角code列表', + 'description' => '视角code列表', + 'type' => 'array', + 'items' => ['description' => '视角code', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'required' => true, + 'maxItems' => 10, ], ], [ - 'name' => 'InstanceId', + 'name' => 'TagIdList', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '机器人ID', - 'type' => 'string', + 'title' => '标签ID列表', + 'description' => '标签ID列表', + 'type' => 'array', + 'items' => ['title' => '标签ID', 'description' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25645645'], 'required' => false, - 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ - 'name' => 'Type', - 'in' => 'formData', + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '打断类型', - 'type' => 'string', - 'required' => false, - 'example' => 'Canceled', + 'title' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8B8F098D-A338-54DD-B19C-24BBBCBD8498'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B8F098D-A338-54DD-B19C-24BBBCBD8498\\"\\n}","type":"json"}]', + 'title' => '更新FAQ答案', + 'changeSet' => [ + ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSolution'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], + ], + 'UpdateUserSay' => [ + 'summary' => '修改意图话术信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Answer', - 'in' => 'formData', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => ['title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '机器人ID', 'description' => '机器人ID', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd'], + ], + [ + 'name' => 'UserSayId', + 'in' => 'query', + 'schema' => ['title' => '用户话术ID', 'description' => '用户话术ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '34512323'], + ], + [ + 'name' => 'UserSayDefinition', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '答案正文', - 'type' => 'string', + 'description' => '用户话术定义信息', + 'type' => 'object', + 'properties' => [ + 'IntentId' => ['title' => '意图ID', 'description' => '意图ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123'], + 'Content' => ['title' => '用户话术', 'description' => '用户话术', 'type' => 'string', 'required' => true, 'example' => '做核酸了吗您'], + 'SlotInfos' => [ + 'title' => '划槽信息', + 'description' => '划槽信息', + 'type' => 'array', + 'items' => [ + 'description' => '滑槽信息说明', + 'type' => 'object', + 'properties' => [ + 'SlotId' => ['title' => '划槽ID', 'description' => '划槽ID', 'type' => 'string', 'required' => false, 'example' => '346ffg3q23dv'], + 'StartIndex' => ['title' => '槽位在意图话术中的起始下标', 'description' => '槽位在意图话术中的起始下标', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'EndIndex' => ['title' => '槽位在意图话术中的结束下标（不含）', 'description' => '槽位在意图话术中的结束下标（不含）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], 'required' => false, - 'example' => '<这个答案被打>', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回信息说明', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求本接口的请求ID', - 'type' => 'string', - 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', - ], - 'CancelResult' => [ - 'description' => '调用本接口的结果', - 'type' => 'boolean', - ], + 'UserSayId' => ['description' => '话术ID', 'type' => 'integer', 'format' => 'int64', 'example' => '34512323'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2356fg3wf34634vdt23wef2'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', 'description' => ''], + ], ], - 'responseDemo' => '', - 'title' => '取消或打断给定对话', - 'description' => '仅支持新版机器人，只能查询到90天内的数据', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"UserSayId\\": 34512323,\\n \\"RequestId\\": \\"2356fg3wf34634vdt23wef2\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateUserSayResponse>\\n <UserSayId>34512323</UserSayId>\\n <RequestId>2356fg3wf34634vdt23wef2</RequestId>\\n</UpdateUserSayResponse>","errorExample":""}]', + 'title' => '意图-话术-修改', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserSay'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ramActions' => [], ], ], 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'chatbot.cn-shanghai.aliyuncs.com', 'endpoint' => 'chatbot.cn-shanghai.aliyuncs.com', 'vpc' => 'chatbot-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => '该用户未被授权可操作指定资源'], + ['code' => 'InstanceFreezing', 'message' => 'The specified instance has been frozen because it has overdue bills.', 'http_code' => 403, 'description' => '当前智能对话机器人版本已产生欠费，导致实例冻结'], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => '系统内部错误'], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is not valid.', 'http_code' => 400, 'description' => '请求API的参数不合法'], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter InstanceId is not valid', 'http_code' => 400, 'description' => '机器人实例ID不存在'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'BeginSession'], + ], + 'createdAt' => '2026-03-24T01:58:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListInstance'], + ], + 'createdAt' => '2026-02-04T11:35:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GenerateUserAccessToken'], + ['description' => '请求参数发生变更', 'api' => 'InitIMConnect'], + ], + 'createdAt' => '2025-12-11T03:00:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListTongyiConversationLogs'], + ], + 'createdAt' => '2025-11-25T01:18:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateFaq'], + ['description' => '请求参数发生变更', 'api' => 'CreateSolution'], + ['description' => '响应参数发生变更', 'api' => 'DescribeFaq'], + ['description' => '响应参数发生变更', 'api' => 'ListSolution'], + ['description' => '请求参数发生变更', 'api' => 'UpdateFaq'], + ['description' => '请求参数发生变更', 'api' => 'UpdateSolution'], + ], + 'createdAt' => '2025-11-11T13:28:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDoc'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDoc'], + ['description' => '请求参数发生变更', 'api' => 'UpdateDoc'], + ], + 'createdAt' => '2024-09-26T12:39:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GenerateUserAccessToken'], + ], + 'createdAt' => '2024-08-07T08:16:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDoc'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDoc'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'SearchDoc'], + ['description' => '请求参数发生变更', 'api' => 'UpdateDoc'], + ], + 'createdAt' => '2024-05-17T09:41:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAgent'], + ], + 'createdAt' => '2024-05-15T03:39:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'ListAgent'], + ], + 'createdAt' => '2024-04-16T08:50:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'CreateCategory'], + ['description' => '响应参数发生变更', 'api' => 'DeleteCategory'], + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'DescribeCategory'], + ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'ListCategory'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'UpdateCategory'], + ], + 'createdAt' => '2024-02-22T12:09:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'BeginSession'], + ], + 'createdAt' => '2023-12-28T09:28:07.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'chatbot.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'Chat'], + ], + 'createdAt' => '2023-04-27T12:46:09.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'chatbot.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'BeginSession'], + ], + 'createdAt' => '2023-04-18T12:34:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'SearchFaq'], + ], + 'createdAt' => '2022-12-26T11:43:36.000Z', + 'description' => '取消搜索FAQ的类目Id数组的长度限制', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CancelPublishTask'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreatePublishTask'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetPublishTaskState'], + ], + 'createdAt' => '2022-12-26T11:37:51.000Z', + 'description' => '发布中心API，字段描述规划化', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'InitIMConnect'], + ], + 'createdAt' => '2022-12-26T07:08:11.000Z', + 'description' => '开放小蜜IM连接能力', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'Chat'], + ], + 'createdAt' => '2022-09-01T02:47:47.000Z', + 'description' => '问答接口支持表格问答', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GenerateUserAccessToken'], + ], + 'createdAt' => '2022-07-25T09:30:29.000Z', + 'description' => '修改Nick foreignId字段的必填信息。在文档透出', ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GenerateUserAccessToken'], + ], + 'createdAt' => '2022-07-25T01:55:32.000Z', + 'description' => '增加对字段必填的校验', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'Chat'], + ['description' => '请求参数发生变更', 'api' => 'CreateDSEntity'], + ], + 'createdAt' => '2022-07-21T13:43:35.000Z', + 'description' => '5.7.0', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'GenerateUserAccessToken'], + ], + 'createdAt' => '2022-07-13T04:38:57.000Z', + 'description' => '通过基蜜网关暴露服务API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GenerateUserAccessToken'], + ], + 'createdAt' => '2022-07-12T06:38:42.000Z', + 'description' => '新增渠道获取用户Token API', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateCategory'], + ['description' => '响应参数发生变更', 'api' => 'DeleteInstance'], + ], + 'createdAt' => '2022-07-07T12:38:08.000Z', + 'description' => '1. 创建类目API，父类目参数从必填调整为可选项，默认值为-1，表示根目录2. 删除机器人出参，requestId从byte数组修复为string', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateInstance'], + ], + 'createdAt' => '2022-06-20T11:30:03.000Z', + 'description' => 'Chatbot新版本2022-04-08调整CreateInstance的LanguageCode字段为选填', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'Chat'], + ], + 'createdAt' => '2022-06-17T09:22:20.000Z', + 'description' => 'Chat新版本2022-04-08 OpenApi发布', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateInstance'], + ['description' => '响应参数发生变更', 'api' => 'DescribeInstance'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListInstance'], + ], + 'createdAt' => '2022-06-10T03:14:42.000Z', + 'description' => '调整说明', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'LinkInstanceCategory'], + ], + 'createdAt' => '2022-06-09T13:09:47.000Z', + 'description' => 'faq，机器人管理，任务中心新版本2022-04-08 OpenApi发布', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCategory'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinueInstancePublishTask'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSolution'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSimQuestion'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSolution'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSimQuestion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitIMConnect'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCategory'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelPublishTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstancePublishTaskState'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDSEntity'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLgf'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDSEntity'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLgf'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePerspective'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSolution'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConnQuestion'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIntent'], + ['threshold' => '600', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateUserAccessToken'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyForStreamAccessToken'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDSEntity'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSimQuestion'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDoc'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCategory'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BeginSession'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserSay'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDSEntity'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgent'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntent'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePerspective'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFaq'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConnQuestion'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSolution'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncResult'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePublishTask'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LinkInstanceCategory'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntent'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCategory'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserSay'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLgf'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDSEntityValue'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchDoc'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnQuestion'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPublishTaskState'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchFaq'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstancePublishTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFaq'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPerspectives'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePerspective'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDoc'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDSEntityValue'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Feedback'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntent'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Nlu'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnQuestion'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Chat'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserSay'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaq'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSaasPermissionGroupInfos'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntent'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDoc'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTongyiChatHistorys'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLgf'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelInstancePublishTask'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSimQuestion'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDSEntityValue'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSaasInfo'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserSay'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePerspective'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentInfo'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBotSessionData'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDSEntityValue'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetryDoc'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFaq'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDSEntity'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Associate'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCategory'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDoc'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], + ], + 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], + ], + 'ram' => [ + 'productCode' => 'Chatbot', + 'productName' => '智能对话机器人', + 'ramCodes' => ['chatbot'], + 'ramLevel' => '服务级', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; |