diff options
Diffstat (limited to 'data/zh_cn/chatbot')
| -rw-r--r-- | data/zh_cn/chatbot/2017-10-11/api-docs.php | 9137 | ||||
| -rw-r--r-- | data/zh_cn/chatbot/2022-04-08/api-docs.php | 13420 |
2 files changed, 22557 insertions, 0 deletions
diff --git a/data/zh_cn/chatbot/2017-10-11/api-docs.php b/data/zh_cn/chatbot/2017-10-11/api-docs.php new file mode 100644 index 0000000..7a3a861 --- /dev/null +++ b/data/zh_cn/chatbot/2017-10-11/api-docs.php @@ -0,0 +1,9137 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Chatbot', + 'version' => '2017-10-11', + ], + 'directories' => [ + [ + 'id' => 113830, + 'title' => '问答', + 'type' => 'directory', + 'children' => [ + 'GetAsyncResult', + 'Associate', + 'Chat', + 'Feedback', + ], + ], + [ + 'id' => 113835, + 'title' => '视角管理', + 'type' => 'directory', + 'children' => [ + 'CreatePerspective', + 'DeletePerspective', + 'UpdatePerspective', + 'ActivatePerspective', + 'DescribePerspective', + 'QueryPerspectives', + ], + ], + [ + 'id' => 113841, + 'title' => 'FAQ库管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 113842, + 'title' => 'FAQ库-类目', + 'type' => 'directory', + 'children' => [ + 'CreateCategory', + 'DeleteCategory', + 'UpdateCategory', + 'DescribeCategory', + 'QueryCategories', + ], + ], + [ + 'id' => 113848, + 'title' => 'FAQ库-知识管理', + 'type' => 'directory', + 'children' => [ + 'CreateKnowledge', + 'DeleteKnowledge', + 'UpdateKnowledge', + 'DisableKnowledge', + 'DescribeKnowledge', + 'GetBotKnowledgeStatData', + 'QueryKnowledges', + 'PublishKnowledge', + 'MoveKnowledgeCategory', + ], + ], + [ + 'id' => 113858, + 'title' => 'FAQ库-核心词', + 'type' => 'directory', + 'children' => [ + 'AddSynonym', + 'CreateCoreWord', + 'DeleteCoreWord', + 'UpdateCoreWord', + 'DescribeCoreWord', + 'QueryCoreWords', + 'RemoveSynonym', + ], + ], + ], + ], + [ + 'id' => 113866, + 'title' => '对话工厂管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 113867, + 'title' => '对话工厂-专有名词', + 'type' => 'directory', + 'children' => [ + 'CreateEntity', + 'DeleteEntity', + 'UpdateEntity', + 'DescribeEntities', + 'QuerySystemEntities', + 'QueryEntities', + 'AppendEntityMember', + 'RemoveEntityMember', + ], + ], + [ + 'id' => 113876, + 'title' => '对话工厂-对话单元', + 'type' => 'directory', + 'children' => [ + 'CreateDialog', + 'DeleteDialog', + 'UpdateDialog', + 'DescribeDialog', + 'QueryDialogs', + ], + ], + [ + 'id' => 113882, + 'title' => '对话工厂-对话流', + 'type' => 'directory', + 'children' => [ + 'DisableDialogFlow', + 'UpdateDialogFlow', + 'DescribeDialogFlow', + 'PublishDialogFlow', + 'TestDialogFlow', + ], + ], + [ + 'id' => 113888, + 'title' => '对话工厂-意图', + 'type' => 'directory', + 'children' => [ + 'CreateIntent', + 'DeleteIntent', + 'UpdateIntent', + 'QueryIntents', + 'DescribeIntent', + ], + ], + ], + ], + [ + 'id' => 113894, + 'title' => '机器人管理', + 'type' => 'directory', + 'children' => [ + 'CreateBot', + 'DeleteBot', + 'DescribeBot', + 'QueryBots', + ], + ], + [ + 'id' => 113899, + 'title' => '数据看板', + 'type' => 'directory', + 'children' => [ + 'ListConversationLogs', + 'ListBotChatHistorys', + 'GetConversationList', + 'GetBotDsStatData', + 'ListBotColdDsDatas', + 'ListBotDsDetails', + 'ListBotHotDsDatas', + 'GetBotChatData', + 'GetBotSessionData', + 'ListBotColdKnowledges', + 'ListBotHotKnowledges', + 'ListBotKnowledgeDetails', + 'ListBotReceptionDetailDatas', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'Children' => [ + 'title' => 'Children', + 'description' => '类目信息', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'title' => '分类Id', + 'description' => '类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30000049006', + ], + 'ParentCategoryId' => [ + 'title' => '父分类Id', + 'description' => '⽗类⽬id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'AreaCode' => [ + 'title' => '地区代号', + 'description' => '地区编码'."\n", + 'type' => 'string', + 'example' => 'bizcode1', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '类⽬名称'."\n", + 'type' => 'string', + 'example' => '测试1', + ], + 'Childrens' => [ + 'title' => '子元素', + 'description' => '子类目列表', + 'type' => 'array', + 'items' => [ + 'description' => '子类目信息', + '$ref' => '#/components/schemas/Children', + ], + ], + ], + ], + 'IntentCreateDTO' => [ + 'title' => 'IntentCreateDTO', + 'description' => '意图定义', + 'type' => 'object', + 'properties' => [ + 'IntentId' => [ + 'title' => 'IntentId', + 'description' => '意图ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '126558', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '意图名称', + 'type' => 'string', + 'example' => 'test', + ], + 'UserSay' => [ + 'title' => 'UserSay', + 'description' => 'array', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/UsersayMtopDTO', + ], + ], + 'RuleCheck' => [ + 'title' => 'RuleCheck', + 'description' => 'LGF意图表述表达式', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/RuleMtopDTO', + ], + ], + 'Slot' => [ + 'description' => '意图槽位信息', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/SlotrecordMtopDTO', + ], + ], + ], + ], + 'PaasButtonDTO' => [ + 'title' => 'PaasButtonDTO', + 'description' => 'PaasButtonDTO', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'Name', + 'description' => '按钮名称', + 'type' => 'string', + 'example' => '测试1', + ], + 'Text' => [ + 'title' => 'Text', + 'description' => '按钮文案', + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'title' => 'Type', + 'description' => '按钮类型', + 'type' => 'string', + 'example' => 'str', + ], + ], + ], + 'PaasButtonListDTO' => [ + 'title' => 'PaasButtonDTO', + 'description' => 'PaasButtonListDTO', + 'type' => 'object', + 'properties' => [ + 'Button' => [ + 'title' => 'Button', + 'description' => 'array'."\n", + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/PaasButtonDTO', + ], + ], + 'Intro' => [ + 'title' => 'Intro', + 'description' => '说明 ', + 'type' => 'string', + 'example' => '说明 ', + ], + ], + ], + 'PaasConditionEntryDTO' => [ + 'title' => 'PaasConditionEntryDTO', + 'description' => 'PaasConditionEntryDTO', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Id', + 'description' => '规则id', + 'type' => 'string', + 'example' => '61834a1af175c63df54684ce', + ], + 'Term' => [ + 'title' => 'Term', + 'description' => '具体条件', + 'type' => 'string', + 'example' => 'duration', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '条件Label', + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'title' => 'Type', + 'description' => '条件类型', + 'type' => 'string', + 'example' => '0', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => '数据Value。', + 'type' => 'string', + 'example' => 'customized', + ], + ], + ], + 'PaasConditionSetDTO' => [ + 'title' => 'PaasConditionSetDTO', + 'description' => 'PaasConditionSetDTO', + 'type' => 'object', + 'properties' => [ + 'ConditionEntries' => [ + 'title' => 'ConditionEntries', + 'description' => 'array', + 'type' => 'array', + 'items' => [ + 'description' => '见具体DTO定义', + 'example' => 'Object', + '$ref' => '#/components/schemas/PaasConditionEntryDTO', + ], + ], + ], + ], + 'PaasEdgeDTO' => [ + 'title' => 'PaasEdgeDTO', + 'description' => 'PaasEdgeDTO', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'title' => 'Target', + 'description' => '目标节点ID', + 'type' => 'string', + 'example' => '315c7052-9350-4cdc-972a-6a46bc77d9ed', + ], + 'Id' => [ + 'title' => 'Id', + 'description' => '边的ID', + 'type' => 'string', + 'example' => 'FJ-AF2174A7B2D68522', + ], + 'Source' => [ + 'title' => 'Source', + 'description' => '源节点ID', + 'type' => 'string', + 'example' => '315c7052-9350-4cdc-972a-6a46bc77d9ed', + ], + 'Label' => [ + 'title' => 'Label', + 'description' => '边的标签', + 'type' => 'string', + 'example' => 'porn', + ], + ], + ], + 'PaasEntryDTO' => [ + 'title' => 'PaasEntryDTO', + 'description' => 'PaasEntryDTO', + 'type' => 'object', + 'properties' => [ + 'PluginFieldDataEntry' => [ + 'title' => 'PluginFieldDataEntry', + 'description' => '见具体DTO定义 ', + 'example' => 'Object', + '$ref' => '#/components/schemas/PaasEntryPluginFieldDataDTO', + ], + ], + ], + 'PaasEntryPluginFieldDataDTO' => [ + 'title' => 'PaasEntryPluginFieldDataDTO', + 'description' => 'PaasEntryPluginFieldDataDTO', + 'type' => 'object', + 'properties' => [ + 'ContentEntry' => [ + 'title' => 'ContentEntry', + 'description' => 'array', + 'type' => 'array', + 'items' => [ + 'description' => '见具体DTO定义', + 'example' => 'Object', + '$ref' => '#/components/schemas/PaasConditionSetDTO', + ], + ], + 'LifeSpan' => [ + 'title' => 'LifeSpan', + 'description' => '有效对话轮数，默认5轮', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => 'Entry名称', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'PaasFunctionDTO' => [ + 'title' => 'PaasFunctionDTO', + 'description' => 'PaasFunctionDTO', + 'type' => 'object', + 'properties' => [ + 'PluginFieldDataFunction' => [ + 'title' => 'PluginFieldDataFunction', + '$ref' => '#/components/schemas/PaasFunctionPluginFieldDataDTO', + ], + ], + ], + 'PaasFunctionPluginFieldDataDTO' => [ + 'title' => 'A short description of struct', + 'description' => 'PaasFunctionPluginFieldDataDTO', + 'type' => 'object', + 'properties' => [ + 'Function' => [ + 'title' => 'Function', + 'description' => '函数信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'AliyunFunction' => [ + 'title' => 'AliyunFunction', + 'description' => '阿里云函数信息', + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'title' => 'Type', + 'description' => '类型', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'title' => 'Description', + 'description' => '描述', + 'type' => 'string', + 'example' => '002测试示例', + ], + 'EndPoint' => [ + 'title' => 'EndPoint', + 'description' => '接入端点。', + 'type' => 'string', + 'example' => 'https://prodapigw-sofastack.cloud.alipay.com/gateway.do', + ], + 'Code' => [ + 'title' => 'Code', + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '函数组件名称', + 'type' => 'string', + 'example' => '测试11', + ], + 'AliyunService' => [ + 'title' => 'AliyunService', + 'description' => '阿里云服务', + 'type' => 'string', + 'example' => 'test', + ], + 'Switch' => [ + 'title' => 'Switch', + 'description' => 'array', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/PaasSwitchCaseDTO', + ], + ], + 'Params' => [ + 'title' => 'Params', + 'description' => '参数字典', + 'type' => 'object', + 'example' => 'map', + ], + ], + ], + 'PaasFunctionPluginParams' => [ + 'title' => 'PaasFunctionPluginParams', + 'description' => 'PaasFunctionPluginParams', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => 'Method', + 'type' => 'string', + 'required' => true, + ], + 'Query' => [ + 'title' => 'Query', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'Header' => [ + 'title' => 'Header', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'Body' => [ + 'title' => 'Body', + 'type' => 'string', + ], + 'Url' => [ + 'title' => 'Url', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'PaasNodeDTO' => [ + 'title' => 'PaasNodeDTO', + 'description' => 'PaasNodeDTO', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => 'Code', + 'description' => '状态码', + 'type' => 'string', + 'example' => '0', + ], + 'Id' => [ + 'title' => 'Id', + 'description' => '节点ID', + 'type' => 'string', + 'example' => '6128a89f61eaa63de9cf434e', + ], + 'Label' => [ + 'title' => 'Label', + 'description' => '标签', + 'type' => 'string', + 'example' => 'sceneId', + ], + 'Xx' => [ + 'title' => 'Xx', + 'description' => 'x轴坐标', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.11', + ], + 'Yy' => [ + 'title' => 'Yy', + 'description' => 'y轴坐标', + 'type' => 'number', + 'format' => 'double', + 'example' => '302.1', + ], + 'PluginData' => [ + 'title' => 'PluginData', + 'description' => 'PluginData', + '$ref' => '#/components/schemas/PaasPluginDataDTO', + ], + ], + ], + 'PaasPluginDataDTO' => [ + 'title' => 'PaasPluginDataDTO', + 'description' => 'PaasPluginDataDTO', + 'type' => 'object', + 'properties' => [ + 'Entry' => [ + '$ref' => '#/components/schemas/PaasEntryDTO', + ], + 'Slot' => [ + '$ref' => '#/components/schemas/PaasSlotDTO', + ], + 'Response' => [ + '$ref' => '#/components/schemas/PaasResponseDTO', + ], + 'Function' => [ + '$ref' => '#/components/schemas/PaasFunctionDTO', + ], + ], + ], + 'PaasProcessData' => [ + 'title' => 'A short description of struct', + 'description' => 'moduleDefinition', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'title' => 'Nodes', + 'description' => 'Nodes', + 'type' => 'array', + 'items' => [ + 'description' => '节点', + '$ref' => '#/components/schemas/PaasNodeDTO', + ], + ], + 'Edges' => [ + 'title' => 'Edges', + 'description' => 'Edges', + 'type' => 'array', + 'items' => [ + 'description' => '边', + '$ref' => '#/components/schemas/PaasEdgeDTO', + ], + ], + ], + ], + 'PaasResponseDTO' => [ + 'title' => 'PaasResponseDTO', + 'description' => 'PaasResponseDTO', + 'type' => 'object', + 'properties' => [ + 'PluginFieldDataResponse' => [ + '$ref' => '#/components/schemas/PaasResponsePluginFieldDataDTO', + ], + ], + ], + 'PaasResponseNodeContentDTO' => [ + 'title' => 'PaasButtonListDTO', + 'description' => 'PaasResponseNodeContentDTO', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'Type', + 'description' => '回复话术类型', + 'type' => 'string', + 'example' => 'Text', + ], + 'Text' => [ + 'title' => 'Text', + 'description' => '文本内容', + 'type' => 'string', + 'example' => '【檬主价到】芙丽芳丝氨基酸净润洗面奶100g(官方无塑封无封口)', + ], + 'Image' => [ + 'title' => 'Image', + 'description' => 'base64后的图片数据', + 'type' => 'string', + 'example' => 'test', + ], + 'ButtonList' => [ + 'title' => 'ButtonList', + 'description' => 'ButtonList', + '$ref' => '#/components/schemas/PaasButtonListDTO', + ], + ], + ], + 'PaasResponsePluginFieldDataDTO' => [ + 'title' => 'A short description of struct', + 'description' => 'PaasResponsePluginFieldDataDTO', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'Name', + 'description' => '回复组件名称', + 'type' => 'string', + 'example' => 'test', + ], + 'ContentResponse' => [ + 'title' => 'ContentResponse', + 'description' => 'ContentResponse', + '$ref' => '#/components/schemas/PaasResponseNodeContentDTO', + ], + ], + ], + 'PaasSlotConfigDTO' => [ + 'title' => 'PaasSlotConfigDTO', + 'description' => 'PaasSlotConfigDTO', + 'type' => 'object', + 'properties' => [ + 'IsArray' => [ + 'title' => 'IsArray', + 'description' => '是否为数组', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsNecessary' => [ + 'title' => 'IsNecessary', + 'description' => '是否必填', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => '槽位值', + 'type' => 'string', + 'example' => '100', + ], + 'LifeSpan' => [ + 'title' => 'LifeSpan', + 'description' => '有效对话轮数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '槽位名称', + 'type' => 'string', + 'example' => '测试11', + ], + 'Question' => [ + 'title' => 'Question', + 'description' => '问题。', + 'type' => 'array', + 'items' => [ + 'description' => '具体问法', + 'type' => 'string', + 'example' => '北京天气', + ], + ], + ], + ], + 'PaasSlotDTO' => [ + 'title' => 'PaasSlotDTO', + 'description' => 'PaasSlotDTO', + 'type' => 'object', + 'properties' => [ + 'PluginFieldDataSlot' => [ + '$ref' => '#/components/schemas/PaasSlotPluginFieldDataDTO', + ], + ], + ], + 'PaasSlotPluginFieldDataDTO' => [ + 'title' => 'PaasSlotPluginFieldDataDTO', + 'description' => 'PaasSlotPluginFieldDataDTO', + 'type' => 'object', + 'properties' => [ + 'IntentName' => [ + 'title' => 'IntentName', + 'description' => '意图名称', + 'type' => 'string', + 'example' => '意图名称', + ], + 'IntentId' => [ + 'title' => 'IntentId', + 'description' => '意图 ID', + 'type' => 'string', + 'example' => '59055', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '意图名称', + 'type' => 'string', + 'example' => '测试1', + ], + 'IsSysIntent' => [ + 'title' => 'IsSysIntent', + 'description' => '是否为系统意图', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ContentSlot' => [ + 'title' => 'ContentSlot', + 'description' => 'array', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/PaasSlotConfigDTO', + ], + ], + ], + ], + 'PaasSwitchCaseDTO' => [ + 'title' => 'A short description of struct', + 'description' => 'PaasSwitchCaseDTO', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Id', + 'description' => '分支条件ID', + 'type' => 'string', + 'example' => '257', + ], + 'Label' => [ + 'title' => 'Label', + 'description' => '分支条件Label', + 'type' => 'string', + 'example' => '分支1', + ], + 'Type' => [ + 'title' => 'Type', + 'description' => '分支类型', + 'type' => 'string', + 'example' => 'test', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => '期望属性值。', + 'type' => 'string', + 'example' => 'D01001', + ], + 'VariableName' => [ + 'title' => 'VariableName', + 'description' => '变量名，区分大小写', + 'type' => 'string', + 'example' => 'host', + ], + ], + ], + 'RuleMtopDTO' => [ + 'title' => 'RuleMtopDTO', + 'description' => 'RuleMtopDTO', + 'type' => 'object', + 'properties' => [ + 'Strict' => [ + 'title' => 'Strict', + 'description' => '是否严格校验', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Text' => [ + 'title' => 'Text', + 'description' => '文本内容', + 'type' => 'string', + 'example' => 'test', + ], + 'Warning' => [ + 'title' => 'Warning', + 'description' => 'array', + 'type' => 'array', + 'items' => [ + 'description' => '警告信息', + 'type' => 'string', + 'example' => '字段过长', + ], + ], + 'Error' => [ + 'title' => 'Error', + 'description' => '错误信息。说明 仅当操作出错时存在。', + 'type' => 'array', + 'items' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '字段必填', + ], + ], + ], + ], + 'SectionMtopDTO' => [ + 'title' => 'SectionMtopDTO', + 'description' => 'SectionMtopDTO', + 'type' => 'object', + 'properties' => [ + 'SlotId' => [ + 'title' => 'SlotId', + 'description' => '槽位ID', + 'type' => 'string', + 'example' => 'b4d06b5740bb', + ], + 'Text' => [ + 'title' => 'Text', + 'description' => '槽位名称', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'SlotrecordMtopDTO' => [ + 'title' => 'SlotrecordMtopDTO', + 'description' => 'SlotrecordMtopDTO', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Id', + 'description' => 'ID', + 'type' => 'string', + 'example' => '6000000000243567', + ], + 'Question' => [ + 'title' => 'Question', + 'description' => '问题。', + 'type' => 'array', + 'items' => [ + 'description' => '问题', + 'type' => 'string', + 'example' => '你不是', + ], + ], + 'LifeSpan' => [ + 'title' => 'LifeSpan', + 'description' => '有效对话轮数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '槽位名称', + 'type' => 'string', + 'example' => 'test', + ], + 'IsArray' => [ + 'title' => 'IsArray', + 'description' => '是否数组', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => '参数值。', + 'type' => 'string', + 'example' => 'customized', + ], + 'IsNecessary' => [ + 'title' => 'IsNecessary', + 'description' => '是否必填', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Tags' => [ + 'title' => 'Tags', + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/TagMtopDTO', + ], + ], + ], + ], + 'TagMtopDTO' => [ + 'title' => 'TagMtopDTO', + 'description' => 'TagMtopDTO', + 'type' => 'object', + 'properties' => [ + 'UserSayId' => [ + 'title' => 'UserSayId', + 'description' => '用户说ID', + 'type' => 'string', + 'example' => 'b4d06b5740bb', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => '用户说内容', + 'type' => 'string', + 'example' => '你是谁', + ], + ], + ], + 'UpdateDialogFlowModuleDefinition' => [ + 'title' => 'ModuleDefinition', + 'description' => 'UpdateDialogFlowModuleDefinition', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'title' => 'Nodes', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/PaasNodeDTO', + ], + ], + 'Edges' => [ + 'title' => 'Edges', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/PaasEdgeDTO', + ], + ], + ], + ], + 'UsersayMtopDTO' => [ + 'title' => 'UsersayMtopDTO', + 'description' => 'UsersayMtopDTO', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Id', + 'description' => 'id', + 'type' => 'string', + 'example' => 'b4d06b5740bb', + ], + 'Data' => [ + 'title' => 'Data', + 'description' => '数据', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/SectionMtopDTO', + ], + ], + 'Strict' => [ + 'title' => 'Strict', + 'description' => '是否严格匹配', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'apis' => [ + 'GetAsyncResult' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '异步任务ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100000000', + 'minimum' => '0', + 'example' => '从Chat接口Ext结构获取', + ], + ], + [ + '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' => [ + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'task execute success', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'F79E7305-5314-5069-A701-9591AD051902', + ], + 'Data' => [ + 'description' => '数据', + 'type' => 'string', + 'example' => '客户接口返回，此处不提供示例', + ], + 'Code' => [ + 'description' => '调用失败时，返回的错误码。错误码详情，请参见错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'The service is not available.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"task execute success\\",\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\",\\n \\"Data\\": \\"客户接口返回，此处不提供示例\\",\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取异步任务结果', + 'summary' => '获取异步服务执行结果，配合Chat接口使用。', + ], + 'Associate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-eEf', + ], + ], + [ + 'name' => 'Utterance', + 'in' => 'query', + 'schema' => [ + 'description' => '用户表述', + 'type' => 'string', + 'required' => true, + 'example' => '干货', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。', + 'type' => 'string', + 'required' => false, + 'example' => '25670484f2ab4b42ba90acbfbf86d4cd', + ], + ], + [ + 'name' => 'RecommendNum', + 'in' => 'query', + 'schema' => [ + 'description' => '推荐问题数量，1-10，当出推荐的时候才生效，返回不大于RecommendN', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'exclusiveMaximum' => false, + 'exclusiveMinimum' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Perspective', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '视角', + 'type' => 'array', + 'items' => [ + 'description' => '视角编码，用于调用同一知识标题下不同视角的答案。在拼装请求参数时，需要以Perspective={视角编码}的格式传递参数。如：&Perspective="FZJBY3raWr"。使用SDK时以SDK中定义的参数为准。目前仅支持一个视角答案的调用。 （公有云）', + 'type' => 'string', + 'required' => false, + 'example' => 'FZJBY3raWr', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '402FCD5F-518E-4C8E-8A6B-EFEADA69D757', + ], + 'Associate' => [ + 'description' => '联想推荐的列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '关联问题的标题', + 'type' => 'string', + 'example' => '初级干货', + ], + ], + ], + ], + 'SessionId' => [ + 'description' => '本次会话的ID', + 'type' => 'string', + 'example' => '25670484f2ab4b42ba90acbfbf86d4cd', + ], + 'MessageId' => [ + 'description' => '本条会话应答消息的ID', + 'type' => 'string', + 'example' => '11bab7a2e34c4e02bcf0ebcb76bb812d', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"402FCD5F-518E-4C8E-8A6B-EFEADA69D757\\",\\n \\"Associate\\": [\\n {\\n \\"Title\\": \\"初级干货\\"\\n }\\n ],\\n \\"SessionId\\": \\"25670484f2ab4b42ba90acbfbf86d4cd\\",\\n \\"MessageId\\": \\"11bab7a2e34c4e02bcf0ebcb76bb812d\\"\\n}","errorExample":""},{"type":"xml","example":"<AssociateResponse>\\n <RequestId>402FCD5F-518E-4C8E-8A6B-EFEADA69D757</RequestId>\\n <Associate>\\n <Title>初级干货</Title>\\n </Associate>\\n <Associate>\\n <Title>中级干货</Title>\\n </Associate>\\n <Associate>\\n <Title>注会干货</Title>\\n </Associate>\\n <SessionId>25670484f2ab4b42ba90acbfbf86d4cd</SessionId>\\n <MessageId>11bab7a2e34c4e02bcf0ebcb76bb812d</MessageId>\\n</AssociateResponse>","errorExample":""}]', + 'title' => '给出推荐', + 'summary' => '给出推荐。', + ], + 'Chat' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID，⽤于标识⼀个访问者的会话和保持上下⽂信息。对于⼀个新的访问者，⾸次调⽤ Chat接⼝时⽆需传递此字段，机器⼈会开启⼀个会话，并在Chat接⼝的响应中返回该会话的 SessionId。对于该访问者的后续轮次的会 话，调⽤Chat接⼝时传递当前会话的 SessionId，机器⼈即可基于SessionId继续该轮次会话。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2e00330f2a7e47cd8ca56d12ed51c62d', + ], + ], + [ + 'name' => 'KnowledgeId', + 'in' => 'query', + 'schema' => [ + 'description' => '知识id', + 'type' => 'string', + 'required' => false, + 'example' => '1002994742', + ], + ], + [ + 'name' => 'SenderId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问者ID。⽤于识别当前会话中的⽤户', + 'type' => 'string', + 'required' => false, + 'example' => '83325', + ], + ], + [ + 'name' => 'SenderNick', + 'in' => 'query', + 'schema' => [ + 'description' => '当前会话中访问的昵称', + 'type' => 'string', + 'required' => false, + 'example' => '一个试验者', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => '可以传递任何内容参数，该参数将会直接在返回结果中透传回来。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"bizId\\":\\"110000100098985\\",\\"bizType\\":\\"ITEM\\"}', + ], + ], + [ + 'name' => 'Utterance', + 'in' => 'query', + 'schema' => [ + 'description' => '用户表述', + 'type' => 'string', + 'required' => true, + 'example' => '商品是正品吗？', + ], + ], + [ + 'name' => 'IntentName', + 'in' => 'query', + 'schema' => [ + 'description' => '意图名称，当不需要理解用户话术而直接开启某一个意图时，可以指定意图名称', + 'type' => 'string', + 'required' => false, + 'example' => 'TIMEOUT', + ], + ], + [ + 'name' => 'VendorParam', + 'in' => 'query', + 'schema' => [ + 'description' => '业务自定义扩展参数，可以在对话工厂中直接引用到，通常为一个JSON格式字符串。例如，{"var1":"value1"}，在对话工厂中即可以通过${VENDOR_PARAM.var1}获取到value1', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"requestId\\":\\"7DD7849A-0117-5BD8-A411-994FDE07CFBC\\",\\"conversationId\\":\\"1637460236.155930\\"}', + ], + ], + [ + 'name' => 'Perspective', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '视⻆编码，⽤于调⽤同⼀知识标题下不同视⻆的答案。在拼装请求参数时，需要以 Perspective.1={视⻆编码}的格式传递参数。 如： &Perspective.1=FZJBY3raWr。使⽤SDK时 以SDK中定义的参数为 准。⽬前仅⽀持⼀个视⻆答案的调⽤（公有云）。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '视角code', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'd4f70cf7cc5e4a3ba6c82c8ae1e1d99d_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Messages' => [ + 'description' => '会话消息的列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '已废弃，使用AnswerType', + 'type' => 'string', + 'example' => '已废弃，使用AnswerType', + ], + 'Knowledge' => [ + 'type' => 'object', + 'properties' => [ + 'HitStatement' => [ + 'description' => '命中语句', + 'type' => 'string', + ], + 'Summary' => [ + 'description' => '命中问题的简介', + 'type' => 'string', + ], + 'RelatedKnowledges' => [ + 'description' => '关联知识列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeId' => [ + 'description' => '关联问题id', + 'type' => 'string', + 'example' => '82318', + ], + 'Title' => [ + 'description' => '关联问题标题', + 'type' => 'string', + 'example' => '公积金如何查询？', + ], + ], + ], + ], + 'Category' => [ + 'description' => '知识类目路径', + 'type' => 'string', + 'example' => '公积金', + ], + 'Title' => [ + 'description' => '知识标题', + 'type' => 'string', + 'example' => '公积金贷款', + ], + 'Content' => [ + 'description' => '知识答案', + 'type' => 'string', + 'example' => '公积金贷款有指定条件', + ], + 'AnswerSource' => [ + 'description' => '答案来源', + 'type' => 'string', + 'example' => 'KnowledgeBase', + ], + 'Id' => [ + 'description' => '知识id', + 'type' => 'string', + 'example' => '834322', + ], + 'Score' => [ + 'description' => '命中阈值', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.998', + ], + 'ContentType' => [ + 'description' => '答案类型', + 'type' => 'string', + 'example' => 'PLAIN_TEXT', + ], + ], + ], + 'Text' => [ + 'description' => '文本内容', + 'type' => 'object', + 'properties' => [ + 'HitStatement' => [ + 'description' => '命中语句', + 'type' => 'string', + 'example' => '公积金贷款', + ], + 'DialogName' => [ + 'description' => '对话流名称', + 'type' => 'string', + 'example' => '公积金贷款', + ], + 'ArticleTitle' => [ + 'description' => '文章标题', + 'type' => 'string', + 'example' => '公积金查询', + ], + 'AnswerSource' => [ + 'description' => '答案来源', + 'type' => 'string', + ], + 'Slots' => [ + 'description' => '槽位信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '具体值', + 'type' => 'string', + 'example' => '北京', + ], + 'Origin' => [ + 'description' => '原始值', + 'type' => 'string', + 'example' => '北京', + ], + 'Name' => [ + 'description' => '槽位名称', + 'type' => 'string', + 'example' => '查天气意图.city', + ], + 'IsHit' => [ + 'description' => '是否命中', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'IntentName' => [ + 'description' => '意图名称', + 'type' => 'string', + 'example' => '查天气', + ], + 'MetaData' => [ + 'description' => '附加信息', + 'type' => 'string', + 'example' => '{}', + ], + 'NodeName' => [ + 'description' => '节点名称', + 'type' => 'string', + 'example' => '示例_查天气.查天气填槽.__city', + ], + 'ExternalFlags' => [ + 'description' => '扩展信息', + 'type' => 'object', + ], + 'Ext' => [ + 'type' => 'object', + ], + 'UserDefinedChatTitle' => [ + 'description' => '自定义语聊标题', + 'type' => 'string', + 'example' => '感谢', + ], + 'Content' => [ + 'description' => '答案内容', + 'type' => 'string', + 'example' => '北京的天气是晴朗', + ], + 'NodeId' => [ + 'description' => '节点id', + 'type' => 'string', + 'example' => '1410-c7a72a78.__city', + ], + 'Score' => [ + 'description' => '命中阈值', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.988', + ], + 'ContentType' => [ + 'description' => '答案类型', + 'type' => 'string', + 'example' => 'RICH_TEXT', + ], + 'Commands' => [ + 'type' => 'object', + ], + ], + ], + 'Recommends' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeId' => [ + 'description' => '知识Id', + 'type' => 'string', + 'example' => '11111', + ], + 'Title' => [ + 'description' => '澄清标题', + 'type' => 'string', + 'example' => '查公积金', + ], + 'AnswerSource' => [ + 'description' => '答案来源', + 'type' => 'string', + 'example' => 'KNOWLEDGE', + ], + 'Score' => [ + 'description' => '命中阈值', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.88', + ], + ], + ], + ], + 'AnswerType' => [ + 'description' => '问答消息类型', + 'type' => 'string', + 'example' => 'Text', + ], + 'AnswerSource' => [ + 'description' => '问答消息来源', + 'type' => 'string', + 'example' => 'BotFramework', + ], + 'VoiceTitle' => [ + 'title' => '语音场景，澄清内容', + 'description' => '语音场景，澄清内容', + 'type' => 'string', + 'example' => '你是想要查天气，还是查公积金？', + ], + 'Title' => [ + 'title' => '在线场景，反问标题', + 'description' => '在线场景，反问标题', + 'type' => 'string', + 'example' => '你是要咨询如下信息？', + ], + 'VoiceStrategy' => [ + 'type' => 'object', + 'properties' => [ + 'Interruptible' => [ + 'type' => 'boolean', + ], + 'Terminator' => [ + 'type' => 'string', + ], + 'AsrMaxEndSilence' => [ + 'type' => 'string', + ], + 'CollectNumber' => [ + 'type' => 'boolean', + ], + 'ReplyTimeout' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'HangUp' => [ + 'type' => 'boolean', + ], + 'MaxDigits' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC', + ], + 'SessionId' => [ + 'description' => '会话ID，⽤于标识⼀个访问者的会话和保持上下⽂信息。对于⼀个新的访问者，⾸次调⽤ Chat接⼝时⽆需传递此字段，机器⼈会开启⼀个会话，并在Chat接⼝的响应中返回该会话的 SessionId。对于该访问者的后续轮次的会 话，调⽤Chat接⼝时传递当前会话的 SessionId，机器⼈即可基于SessionId继续该轮次会话。'."\n", + 'type' => 'string', + 'example' => '2e00330f2a7e47cd8ca56d12ed51c62d', + ], + 'MessageId' => [ + 'description' => '本条会话应答消息的ID', + 'type' => 'string', + 'example' => '396E74B3-D84B-46CE-9E51-91C06AD22E31', + ], + 'Tag' => [ + 'description' => '可以传递任何内容参数，该参数将会直接在返回结果中透传回来。'."\n", + 'type' => 'string', + 'example' => '{\\"bizId\\":\\"110000100098985\\",\\"bizType\\":\\"ITEM\\"}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Messages\\": [\\n {\\n \\"Type\\": \\"已废弃，使用AnswerType\\",\\n \\"Knowledge\\": {\\n \\"HitStatement\\": \\"\\",\\n \\"Summary\\": \\"\\",\\n \\"RelatedKnowledges\\": [\\n {\\n \\"KnowledgeId\\": \\"82318\\",\\n \\"Title\\": \\"公积金如何查询？\\"\\n }\\n ],\\n \\"Category\\": \\"公积金\\",\\n \\"Title\\": \\"公积金贷款\\",\\n \\"Content\\": \\"公积金贷款有指定条件\\",\\n \\"AnswerSource\\": \\"KnowledgeBase\\",\\n \\"Id\\": \\"834322\\",\\n \\"Score\\": 0.998,\\n \\"ContentType\\": \\"PLAIN_TEXT\\"\\n },\\n \\"Text\\": {\\n \\"HitStatement\\": \\"公积金贷款\\",\\n \\"DialogName\\": \\"公积金贷款\\",\\n \\"ArticleTitle\\": \\"公积金查询\\",\\n \\"AnswerSource\\": \\"\\",\\n \\"Slots\\": [\\n {\\n \\"Value\\": \\"北京\\",\\n \\"Origin\\": \\"北京\\",\\n \\"Name\\": \\"查天气意图.city\\",\\n \\"IsHit\\": true\\n }\\n ],\\n \\"IntentName\\": \\"查天气\\",\\n \\"MetaData\\": \\"{}\\",\\n \\"NodeName\\": \\"示例_查天气.查天气填槽.__city\\",\\n \\"ExternalFlags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Ext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"UserDefinedChatTitle\\": \\"感谢\\",\\n \\"Content\\": \\"北京的天气是晴朗\\",\\n \\"NodeId\\": \\"1410-c7a72a78.__city\\",\\n \\"Score\\": 0.988,\\n \\"ContentType\\": \\"RICH_TEXT\\",\\n \\"Commands\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Recommends\\": [\\n {\\n \\"KnowledgeId\\": \\"11111\\",\\n \\"Title\\": \\"查公积金\\",\\n \\"AnswerSource\\": \\"KNOWLEDGE\\",\\n \\"Score\\": 0.88\\n }\\n ],\\n \\"AnswerType\\": \\"Text\\",\\n \\"AnswerSource\\": \\"BotFramework\\",\\n \\"VoiceTitle\\": \\"你是想要查天气，还是查公积金？\\",\\n \\"Title\\": \\"你是要咨询如下信息？\\",\\n \\"VoiceStrategy\\": {\\n \\"Interruptible\\": true,\\n \\"Terminator\\": \\"\\",\\n \\"AsrMaxEndSilence\\": \\"\\",\\n \\"CollectNumber\\": true,\\n \\"ReplyTimeout\\": 0,\\n \\"HangUp\\": true,\\n \\"MaxDigits\\": 0\\n }\\n }\\n ],\\n \\"RequestId\\": \\"A2315C4B-A872-5DEE-9DAD-D73B194A4AEC\\",\\n \\"SessionId\\": \\"2e00330f2a7e47cd8ca56d12ed51c62d\\",\\n \\"MessageId\\": \\"396E74B3-D84B-46CE-9E51-91C06AD22E31\\",\\n \\"Tag\\": \\"{\\\\\\\\\\\\\\"bizId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"110000100098985\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bizType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ITEM\\\\\\\\\\\\\\"}\\"\\n}","type":"json"}]', + 'title' => '进行问答', + 'summary' => '进行问答。', + 'extraInfo' => '## 常见问答错误'."\n" + ."\n" + .'### 第三方服务错误'."\n" + .'第三方服务错误是由于在FAQ或对话工厂中配置了第三方服务的接口，在问答命中配置的条件或话术时，会调用对应的第三方服务。如果该服务调用错误，则会提示"Third party interface error"，具体协议如下。'."\n" + ."\n" + .'**响应参数说明**'."\n" + ."\n" + .'| 字段名称 | 字段含义 |'."\n" + .'| --------- | ------------------------------------------------------------ |'."\n" + .'| RequestId | 请求ID |'."\n" + .'| HostId | 云小蜜主机ID |'."\n" + .'| Code | 错误码，第三方服务错误的错误码为"Third party interface error" |'."\n" + .'| Message | 错误说明 |'."\n" + ."\n\n" + .'**响应参数示例**'."\n" + .'```json'."\n" + .'{'."\n" + .' "RequestId": "A805905D-B20C-57C9-8793-EAF98FBD8F84",'."\n" + .' "HostId": "chatbot.cn-shanghai.aliyuncs.com",'."\n" + .' "Code": "Third party interface error",'."\n" + .' "Message": "第三方接口错误. HTTP 请求出现 IOException 异常，可能由网络链接超时，服务端未响应或其他配置问题导致, Url 信息: https://xxx.com/order/create",'."\n" + .' "Recommend": "https://next.api.aliyun.com/troubleshoot?q=Third party interface error&product=Chatbot"'."\n" + .'}'."\n" + .'```', + ], + 'Feedback' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'chatbot-cn-UfERQYZnra', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID，⽤于标识⼀个访问者 的会话和保持上下⽂信息。对'."\n" + .'于⼀个新的访问者，⾸次调⽤ Chat接⼝时⽆需传递此字段， 机器⼈会开启⼀个会话，并在 Chat接⼝的响应中返回该会话 的SessionId。对于该访问者的 后续轮次的会话，调⽤Chat接'."\n" + .'⼝时传递当前会话的 SessionId，机器⼈即可基于 SessionId继续该轮次会话。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0054b7d5187d40baba845427f8723', + ], + ], + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'description' => '本条会话应答消息的ID', + 'type' => 'string', + 'required' => true, + 'example' => '8869745c-3b30-44ab-a1ef-20ad4191bfad', + ], + ], + [ + 'name' => 'Feedback', + 'in' => 'query', + 'schema' => [ + 'description' => 'good-点赞、bad-点踩', + 'type' => 'string', + 'required' => true, + 'example' => 'good', + ], + ], + [ + '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' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '16D4BC6D-FF53-5EB0-A6A2-CA0F32B6FF7E', + ], + 'Feedback' => [ + 'description' => 'good-点赞、bad-点踩', + 'type' => 'string', + 'example' => 'good', + ], + 'HttpStatus' => [ + 'description' => 'http状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否操作成功：false：否；true：是', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MessageId' => [ + 'description' => '会话消息id', + 'type' => 'string', + 'example' => '8869745c-3b30-44ab-a1ef-20ad4191bfad', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16D4BC6D-FF53-5EB0-A6A2-CA0F32B6FF7E\\",\\n \\"Feedback\\": \\"good\\",\\n \\"HttpStatus\\": 200,\\n \\"Success\\": true,\\n \\"MessageId\\": \\"8869745c-3b30-44ab-a1ef-20ad4191bfad\\"\\n}","type":"json"}]', + 'title' => '信息反馈', + 'summary' => '调用Feedback接口进行问答点赞、点踩。', + ], + 'CreatePerspective' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '视⻆名称，不超过50个字符', + 'type' => 'string', + 'required' => 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' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A', + ], + 'PerspectiveId' => [ + 'description' => '视⻆主键（code_id）'."\n", + 'type' => 'string', + 'example' => '7488', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A\\",\\n \\"PerspectiveId\\": \\"7488\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A</RequestId>\\n<PerspectiveId>7488</PerspectiveId>","errorExample":""}]', + 'title' => 'CreatePerspective', + 'summary' => '调用CreatePerspective创建机器⼈视⻆。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePerspective' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'PerspectiveId', + 'in' => 'query', + 'schema' => [ + 'description' => '视角id', + 'type' => 'string', + 'required' => 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' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', + ], + 'Result' => [ + 'description' => '是否删除成功：true：是；false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC384CE1-8D42-1900-84E1-F33F990F2B5E\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'DeletePerspective', + 'summary' => '调用DeletePerspective删除视角。', + ], + 'UpdatePerspective' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PerspectiveId', + 'in' => 'query', + 'schema' => [ + 'description' => '视⻆主键', + 'type' => 'string', + 'required' => true, + 'example' => '7488', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '视⻆新名称，不超过50个字符', + 'type' => 'string', + 'required' => true, + 'example' => '测试2', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A8CA5217-4B7A-40F9-8985-416C2DCD5D4A', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CA5217-4B7A-40F9-8985-416C2DCD5D4A\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>A8CA5217-4B7A-40F9-8985-416C2DCD5D4A</RequestId>","errorExample":""}]', + 'title' => 'UpdatePerspective', + 'summary' => '调用UpdatePerspective更新机器⼈视⻆名称。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ActivatePerspective' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PerspectiveId', + 'in' => 'query', + 'schema' => [ + 'description' => '视⻆主键'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '7487', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C5F8186-2D22-433E-9545-606D344F30B5', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9C5F8186-2D22-433E-9545-606D344F30B5\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>9C5F8186-2D22-433E-9545-606D344F30B5</RequestId>","errorExample":""}]', + 'title' => 'ActivatePerspective', + 'summary' => '调用ActivatePerspective启⽤视⻆。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePerspective' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PerspectiveId', + 'in' => 'query', + 'schema' => [ + 'description' => '视角id', + 'type' => 'string', + 'required' => true, + 'example' => '7487', + ], + ], + [ + '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' => [ + 'Status' => [ + 'description' => '数据状态：3：启用；1：未启用'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PerspectiveCode' => [ + 'description' => '视⻆编码（⽤于问答api）'."\n", + 'type' => 'string', + 'example' => '6IReUnbyzb', + ], + 'ModifyTime' => [ + 'description' => '修改时间 UTC时间', + 'type' => 'string', + 'example' => '2020-11-25T08:56:55Z', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910', + ], + 'SelfDefine' => [ + 'description' => '是否自定义：false：否；true：是'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => '创建时间 UTC时间', + 'type' => 'string', + 'example' => '2020-11-25T08:26:06Z', + ], + 'ModifyUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'test', + ], + 'PerspectiveId' => [ + 'description' => '视⻆主键（code_id）'."\n", + 'type' => 'string', + 'example' => '7487', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'test', + ], + 'Name' => [ + 'description' => '视⻆名称', + 'type' => 'string', + 'example' => '12', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": 3,\\n \\"PerspectiveCode\\": \\"6IReUnbyzb\\",\\n \\"ModifyTime\\": \\"2020-11-25T08:56:55Z\\",\\n \\"RequestId\\": \\"DFB71B34-4188-4EA2-9988-EF3014E75910\\",\\n \\"SelfDefine\\": true,\\n \\"CreateTime\\": \\"2020-11-25T08:26:06Z\\",\\n \\"ModifyUserName\\": \\"test\\",\\n \\"PerspectiveId\\": \\"7487\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"Name\\": \\"12\\"\\n}","errorExample":""},{"type":"xml","example":"<Status>3</Status>\\n<ModifyTime>2020-11-25T08:56:55Z</ModifyTime>\\n<PerspectiveCode>6IReUnbyzb</PerspectiveCode>\\n<RequestId>DFB71B34-4188-4EA2-9988-EF3014E75910</RequestId>\\n<SelfDefine>true</SelfDefine>\\n<CreateTime>2020-11-25T08:26:06Z</CreateTime>\\n<PerspectiveId>7487</PerspectiveId>\\n<Name>12</Name>","errorExample":""}]', + 'title' => 'DescribePerspective', + 'summary' => '调用DescribePerspective查询视⻆详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPerspectives' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'DBBF6308-C267-45EE-A0DF-14E401E25272', + ], + 'Perspectives' => [ + 'description' => '视角列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '数据状态：3：启用；1：未启用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ModifyUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-11-12T04:17:31Z', + ], + 'PerspectiveId' => [ + 'description' => '视角主键', + 'type' => 'string', + 'example' => '1001', + ], + 'SelfDefine' => [ + 'description' => '是否自定义：false：否；true：是', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Name' => [ + 'description' => '视角名称', + 'type' => 'string', + 'example' => '默认', + ], + 'PerspectiveCode' => [ + 'description' => '视角编码', + 'type' => 'string', + 'example' => 'default', + ], + 'ModifyTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-11-12T04:17:31Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DBBF6308-C267-45EE-A0DF-14E401E25272\\",\\n \\"Perspectives\\": [\\n {\\n \\"Status\\": 3,\\n \\"ModifyUserName\\": \\"test\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"CreateTime\\": \\"2020-11-12T04:17:31Z\\",\\n \\"PerspectiveId\\": \\"1001\\",\\n \\"SelfDefine\\": false,\\n \\"Name\\": \\"默认\\",\\n \\"PerspectiveCode\\": \\"default\\",\\n \\"ModifyTime\\": \\"2020-11-12T04:17:31Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>DBBF6308-C267-45EE-A0DF-14E401E25272</RequestId>\\n<Perspectives>\\n <Status>3</Status>\\n <ModifyTime>2020-11-12T04:17:31Z</ModifyTime>\\n <PerspectiveCode>default</PerspectiveCode>\\n <SelfDefine>false</SelfDefine>\\n <CreateTime>2020-11-12T04:17:31Z</CreateTime>\\n <PerspectiveId>1001</PerspectiveId>\\n <Name>默认</Name>\\n</Perspectives>\\n<Perspectives>\\n <Status>1</Status>\\n <ModifyTime>2020-11-25T08:26:06Z</ModifyTime>\\n <PerspectiveCode>6IReUnbyzb</PerspectiveCode>\\n <SelfDefine>true</SelfDefine>\\n <CreateTime>2020-11-25T08:26:06Z</CreateTime>\\n <PerspectiveId>7487</PerspectiveId>\\n <Name>12</Name>\\n</Perspectives>","errorExample":""}]', + 'title' => 'QueryPerspectives', + 'summary' => '调用QueryPerspectives查看视角列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCategory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ParentCategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '上级类⽬Id，不填是默认为⼀级类⽬', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '类⽬名称'."\n", + 'type' => 'string', + 'required' => 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' => [ + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '类⽬ID，由系统⽣成，全局唯 ⼀。是访问类⽬数据的唯⼀标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2100073759', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '17204B98-7734-4F9A-8464-2446A84821CA', + ], + 'Success' => [ + 'description' => '是否操作成功，成功：true，失败：false', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CategoryId\\": 2100073759,\\n \\"RequestId\\": \\"17204B98-7734-4F9A-8464-2446A84821CA\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateCategoryResponse>\\n <CategoryId>2100073759</CategoryId>\\n <RequestId>17204B98-7734-4F9A-8464-2446A84821CA</RequestId>\\n <Success>true</Success>\\n</CreateCategoryResponse>","errorExample":""}]', + 'title' => 'CreateCategory', + 'summary' => '调用CreateCategory新增类⽬。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCategory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '类⽬id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30000049006', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55', + ], + 'Success' => [ + 'description' => '是否操作成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteCategoryResponse>\\n <RequestId>4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55</RequestId>\\n <Success>true</Success>\\n</DeleteCategoryResponse>","errorExample":""}]', + 'title' => '删除类⽬', + 'summary' => '调用DeleteCategory删除类⽬。', + ], + 'UpdateCategory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的类⽬名称'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '测试11', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '类⽬id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2100073759', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F79E7305-5314-5069-A701-9591AD051902', + ], + 'Success' => [ + 'description' => '是否操作成功：false：否；true：是', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateCategoryResponse>\\n <RequestId>F79E7305-5314-5069-A701-9591AD051902</RequestId>\\n <Success>true</Success>\\n</UpdateCategoryResponse>","errorExample":""}]', + 'title' => '修改类⽬', + 'summary' => '修改类目。', + ], + 'DescribeCategory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30000049006', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30000049006', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '2B0304FD-3804-5C06-9A83-77F5523664AF', + ], + 'ParentCategoryId' => [ + 'description' => '⽗类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'Name' => [ + 'description' => '类⽬名称', + 'type' => 'string', + 'example' => '类目名称', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CategoryId\\": 30000049006,\\n \\"RequestId\\": \\"2B0304FD-3804-5C06-9A83-77F5523664AF\\",\\n \\"ParentCategoryId\\": -1,\\n \\"Name\\": \\"类目名称\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCategoryResponse>\\n <CategoryId>30000049006</CategoryId>\\n <RequestId>2B0304FD-3804-5C06-9A83-77F5523664AF</RequestId>\\n <ParentCategoryId>-1</ParentCategoryId>\\n <Name>类目名称</Name>\\n</DescribeCategoryResponse>","errorExample":""}]', + 'title' => '获取类⽬详情', + 'summary' => '获取类目详情。', + ], + 'QueryCategories' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ParentCategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '⽗类⽬id，默认-1，对'."\n" + .'应根⽬录'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'ShowChildrens', + 'in' => 'query', + 'schema' => [ + 'description' => '是否包含子节点：false：否；true：是', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'KnowledgeType', + 'in' => 'query', + 'schema' => [ + 'description' => '知识类型:1:普通知识 3:⽂档知识', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + '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' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '17204B98-7734-4F9A-8464-2446A84821CA', + ], + 'Categories' => [ + 'description' => '类⽬列表'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '类目信息', + 'example' => 'Children对象', + '$ref' => '#/components/schemas/Children', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17204B98-7734-4F9A-8464-2446A84821CA\\",\\n \\"Categories\\": [\\n {\\n \\"CategoryId\\": 0,\\n \\"ParentCategoryId\\": 0,\\n \\"AreaCode\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Childrens\\": [\\n {\\n \\"CategoryId\\": 0,\\n \\"ParentCategoryId\\": 0,\\n \\"AreaCode\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Childrens\\": [\\n {\\n \\"CategoryId\\": 0,\\n \\"ParentCategoryId\\": 0,\\n \\"AreaCode\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Childrens\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryCategoriesResponse>\\n <RequestId>17204B98-7734-4F9A-8464-2446A84821CA</RequestId>\\n <Categories>\\n <CategoryId>2100073048</CategoryId>\\n <Childrens>\\n <CategoryId>2100073049</CategoryId>\\n <Childrens>\\n <CategoryId>2100073050</CategoryId>\\n <AreaCode/>\\n <ParentCategoryId>2100073049</ParentCategoryId>\\n <Name>test2</Name>\\n </Childrens>\\n <AreaCode/>\\n <ParentCategoryId>2100073048</ParentCategoryId>\\n <Name>test1</Name>\\n </Childrens>\\n <ParentCategoryId>-1</ParentCategoryId>\\n <Name>test</Name>\\n </Categories>\\n <Categories>\\n <CategoryId>2100073605</CategoryId>\\n <ParentCategoryId>-1</ParentCategoryId>\\n <Name>测试</Name>\\n </Categories>\\n</QueryCategoriesResponse>","errorExample":""}]', + 'title' => 'QueryCategories', + 'summary' => '调用QueryCategories获取类⽬列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateKnowledge' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Knowledge', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '知识数据，⻅ Knowledge，格式： JSON字符串', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => 'FAQ类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30000049006', + ], + 'KnowledgeTitle' => [ + 'description' => 'FAQ标题', + 'type' => 'string', + 'required' => true, + 'example' => '知识标题', + ], + 'KnowledgeType' => [ + 'description' => 'FAQ类型:1：普通知识', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Solutions' => [ + 'description' => '答案列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '富⽂本内容', + 'type' => 'string', + 'required' => true, + 'example' => '富文本答案内容', + ], + 'PlainText' => [ + 'description' => '纯⽂本内容', + 'type' => 'string', + 'required' => true, + 'example' => '纯文本答案内容', + ], + 'PerspectiveIds' => [ + 'description' => '视⻆ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '视⻆ID', + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'StartDate' => [ + 'description' => '⽣效时间（UTC时间）', + 'type' => 'string', + 'required' => false, + 'example' => '1979-12-31T16:00:00Z', + ], + 'EndDate' => [ + 'description' => '失效时间（UTC时间）', + 'type' => 'string', + 'required' => false, + 'example' => '2099-12-31T16:00:00Z', + ], + 'Outlines' => [ + 'description' => '关联知识', + 'type' => 'array', + 'items' => [ + 'description' => '关联知识信息', + 'type' => 'object', + 'properties' => [ + 'KnowledgeId' => [ + 'description' => 'FAQ ID（废弃）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30001905617', + ], + 'OutlineId' => [ + 'description' => '关联FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30001979424', + ], + 'Title' => [ + 'description' => '关联FAQ标题', + 'type' => 'string', + 'required' => false, + 'example' => '关联问知识标题', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SimQuestions' => [ + 'description' => '相似问列表', + 'type' => 'array', + 'items' => [ + 'description' => '相似问信息', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '相似问法标题', + 'type' => 'string', + 'required' => true, + 'example' => '相似问标题', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + 'example' => ' JSON字符串', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '8334b404-3124-47a4-92df-5c7648158b6f', + ], + 'KnowledgeId' => [ + 'description' => '知识ID，由系统⽣成，全局唯 ⼀。是访问知识数据的唯⼀标识'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001905617', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8334b404-3124-47a4-92df-5c7648158b6f\\",\\n \\"KnowledgeId\\": 30001905617\\n}","errorExample":""},{"type":"xml","example":"<RequestId>8334b404-3124-47a4-92df-5c7648158b6f</RequestId>\\n<KnowledgeId>1000002788</KnowledgeId>","errorExample":""}]', + 'title' => 'CreateKnowledge', + 'summary' => '调用CreateKnowledge新增FAQ并发布。', + 'requestParamsDescription' => '**Knowledge**'."\n" + .'| 参数名称 | 参数类型 |是否必填 |参数说明 |'."\n" + .'| ---- | ---- |'."\n" + .'| CategoryId | Long | 是 | 类⽬ID |'."\n" + .'| KnowledgeTitle | String | 是 | 标题 |'."\n" + .'|StartDate | String | 否 | ⽣效时间（UTC时间） |'."\n" + .'| EndDate | String | 否 |失效时间（UTC时间） |'."\n" + .'|Solutions | Array of Solution | 是 | ⽂本型知识答案 |'."\n" + .'| Outlines | Array of Outline | 否 | 关联知识（私有云） |'."\n" + .'| SimQuestions | Array of SimQuestion | 否 | 相似问题 |'."\n" + ."\n" + .'**SimQuestion**'."\n" + .'| 参数名称 | 参数类型 |是否必填 |参数说明 |'."\n" + .'| ---- | ---- |'."\n" + .'| Title | String | 是 | 相似问法标题 |'."\n" + ."\n" + .'**Solution**'."\n" + .'| 参数名称 | 参数类型 |是否必填 |参数说明 |'."\n" + .'| ---- | ---- |'."\n" + .'| Content | String | 是 | 富⽂本内容 |'."\n" + .'| PlainText | String | 是 | 纯⽂本内容 |'."\n" + .'| PerspectiveIds | Array of String | 是 | 视⻆id列表|'."\n" + ."\n" + .'**Outline**'."\n" + .'| 参数名称 | 参数类型 |是否必填 |参数说明 |'."\n" + .'| ---- | ---- |'."\n" + .'| KnowledgeId | Long | 是 | 知识id |'."\n" + .'| Title | String | 是 | 知识题⽬ |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteKnowledge' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'KnowledgeId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30001979424', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A629A28F-F25E-5572-A679-FA46FB0151D6', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A629A28F-F25E-5572-A679-FA46FB0151D6\\"\\n}","type":"json"}]', + 'title' => '删除FAQ', + 'summary' => '知识库-删除知识。', + ], + 'UpdateKnowledge' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Knowledge', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数信息', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30000049006', + ], + 'KnowledgeTitle' => [ + 'description' => 'FAQ标题', + 'type' => 'string', + 'required' => true, + 'example' => '知识标题', + ], + 'KnowledgeType' => [ + 'description' => '知识类型(1,基础知识)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Solutions' => [ + 'description' => '答案列表', + 'type' => 'array', + 'items' => [ + 'description' => '答案信息', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '富⽂本内容', + 'type' => 'string', + 'required' => true, + 'example' => '答案内容', + ], + 'PlainText' => [ + 'description' => '纯⽂本内容', + 'type' => 'string', + 'required' => true, + 'example' => '答案内容', + ], + 'SolutionId' => [ + 'description' => '答案ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30001905617', + ], + 'PerspectiveIds' => [ + 'description' => '视⻆ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '视⻆ID列表', + 'type' => 'string', + 'required' => false, + 'example' => '1003', + ], + 'required' => true, + ], + 'Action' => [ + 'description' => '操作类型，追加：ADD，修改：UPD，移除：DEL', + 'type' => 'string', + 'required' => true, + 'example' => 'ADD', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'StartDate' => [ + 'description' => '⽣效时间（UTC时间）', + 'type' => 'string', + 'required' => false, + 'example' => '1979-12-31T16:00:00Z', + ], + 'EndDate' => [ + 'description' => '失效时间（UTC时间）', + 'type' => 'string', + 'required' => false, + 'example' => '2099-12-31T16:00:00Z', + ], + 'Outlines' => [ + 'description' => '关联知识', + 'type' => 'array', + 'items' => [ + 'description' => '关联问信息', + 'type' => 'object', + 'properties' => [ + 'KnowledgeId' => [ + 'description' => 'FAQ ID（废弃）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30001905617', + ], + 'Title' => [ + 'description' => '关联FAQ标题', + 'type' => 'string', + 'required' => true, + 'example' => '关联问标题', + ], + 'OutlineId' => [ + 'description' => '关联FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30001979424', + ], + 'Action' => [ + 'description' => '操作类型，追加：ADD，移除：DEL', + 'type' => 'string', + 'required' => true, + 'example' => 'ADD', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SimQuestions' => [ + 'description' => '相似问列表', + 'type' => 'array', + 'items' => [ + 'description' => '相似问信息', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '相似问法标题', + 'type' => 'string', + 'required' => true, + 'example' => '相似问标题', + ], + 'SimQuestionId' => [ + 'description' => '相似问法ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30003759180', + ], + 'Action' => [ + 'description' => '操作类型，追加：ADD，修改：UPD，移除：DEL', + 'type' => 'string', + 'required' => true, + 'example' => 'ADD', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'KnowledgeId' => [ + 'description' => 'FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30001905617', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '27C1B103-7A35-532B-8886-B5A91C86CFA4', + ], + 'KnowledgeId' => [ + 'description' => '知识id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001905617', + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27C1B103-7A35-532B-8886-B5A91C86CFA4\\",\\n \\"KnowledgeId\\": 30001905617\\n}","type":"json"}]', + 'title' => '修改知识库并发布', + 'summary' => '进行知识库的修改并发布（⼊参必须全量包含当前知识所有信息）。', + ], + 'DisableKnowledge' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'KnowledgeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30001979424', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '54A18EB2-4633-5848-B309-EE551DF62002', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54A18EB2-4633-5848-B309-EE551DF62002\\"\\n}","type":"json"}]', + 'title' => '使得FAQ失效', + 'summary' => '知识库-失效FAQ。', + ], + 'DescribeKnowledge' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'KnowledgeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1002994358', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'KnowledgeTitle' => [ + 'description' => 'FAQ标题', + 'type' => 'string', + 'example' => 'FAQ标题', + ], + 'CategoryId' => [ + 'description' => '类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000053274', + ], + 'ModifyTime' => [ + 'description' => '修改时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-26T06:36:14Z', + ], + 'CoreWords' => [ + 'description' => '核⼼词列表', + 'type' => 'array', + 'items' => [ + 'description' => '核心词', + 'type' => 'string', + 'example' => '核心词'."\n", + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F7F60925-E0ED-50DA-9E0B-ED4B3ECFBA4F', + ], + 'CreateTime' => [ + 'description' => '创建时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-25T11:44:09Z', + ], + 'KnowledgeId' => [ + 'description' => 'FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001979424', + ], + 'KeyWords' => [ + 'description' => '关键字列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关键字', + 'type' => 'string', + 'example' => '关键词', + ], + ], + 'EndDate' => [ + 'description' => '失效时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-26T11:56:40Z', + ], + 'CreateUserName' => [ + 'description' => '创建人名称', + 'type' => 'string', + 'example' => '创建人', + ], + 'StartDate' => [ + 'description' => '⽣效时间（UTC时间）', + 'type' => 'string', + 'example' => '1979-12-31T16:00:00Z', + ], + 'SimQuestions' => [ + 'description' => '相似问法列表'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '相似问信息', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '创建时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-25T11:44:09Z', + ], + 'SimQuestionId' => [ + 'description' => '相似问法id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001979424', + ], + 'Title' => [ + 'description' => '相似问法标题', + 'type' => 'string', + 'example' => '相似问', + ], + 'ModifyTime' => [ + 'description' => '修改时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-26T06:36:14Z', + ], + ], + ], + ], + 'Solutions' => [ + 'description' => '答案列表', + 'type' => 'array', + 'items' => [ + 'description' => '答案信息', + 'type' => 'object', + 'properties' => [ + 'PerspectiveIds' => [ + 'description' => '视⻆id列表', + 'type' => 'array', + 'items' => [ + 'description' => '视⻆id', + 'type' => 'string', + 'example' => '1001'."\n", + ], + ], + 'Summary' => [ + 'description' => '摘要', + 'type' => 'string', + 'example' => '答案摘要', + ], + 'CreateTime' => [ + 'description' => '创建时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-25T11:44:09Z', + ], + 'PlainText' => [ + 'description' => '纯⽂本内容', + 'type' => 'string', + 'example' => '答案内容', + ], + 'SolutionId' => [ + 'description' => '答案id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001979424', + ], + 'Content' => [ + 'description' => '富⽂本内容', + 'type' => 'string', + 'example' => '答案内容', + ], + 'ModifyTime' => [ + 'description' => '修改时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-26T06:36:14Z', + ], + ], + ], + ], + 'Version' => [ + 'description' => '版本号（最新）'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ModifyUserName' => [ + 'description' => '修改人名称', + 'type' => 'string', + 'example' => '修改人'."\n", + ], + 'KnowledgeStatus' => [ + 'description' => '知识状态：3：已发布，-1：全部，14：草稿，17：已失效，15：待发布(发布中)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Outlines' => [ + 'description' => '关联知识', + 'type' => 'array', + 'items' => [ + 'description' => '关联问信息', + 'type' => 'object', + 'properties' => [ + 'KnowledgeId' => [ + 'description' => 'FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001979425', + ], + 'OutlineId' => [ + 'description' => '关联关系id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001979424', + ], + 'Title' => [ + 'description' => '关联问题的标题', + 'type' => 'string', + 'example' => '关联问', + ], + ], + ], + ], + 'KnowledgeType' => [ + 'description' => '知识库类型，1：普通知识库', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeTitle\\": \\"FAQ标题\\",\\n \\"CategoryId\\": 1000053274,\\n \\"ModifyTime\\": \\"2020-11-26T06:36:14Z\\",\\n \\"CoreWords\\": [\\n \\"核心词\\\\n\\"\\n ],\\n \\"RequestId\\": \\"F7F60925-E0ED-50DA-9E0B-ED4B3ECFBA4F\\",\\n \\"CreateTime\\": \\"2020-11-25T11:44:09Z\\",\\n \\"KnowledgeId\\": 30001979424,\\n \\"KeyWords\\": [\\n \\"关键词\\"\\n ],\\n \\"EndDate\\": \\"2020-11-26T11:56:40Z\\",\\n \\"CreateUserName\\": \\"创建人\\",\\n \\"StartDate\\": \\"1979-12-31T16:00:00Z\\",\\n \\"SimQuestions\\": [\\n {\\n \\"CreateTime\\": \\"2020-11-25T11:44:09Z\\",\\n \\"SimQuestionId\\": 30001979424,\\n \\"Title\\": \\"相似问\\",\\n \\"ModifyTime\\": \\"2020-11-26T06:36:14Z\\"\\n }\\n ],\\n \\"Solutions\\": [\\n {\\n \\"PerspectiveIds\\": [\\n \\"1001\\\\n\\"\\n ],\\n \\"Summary\\": \\"答案摘要\\",\\n \\"CreateTime\\": \\"2020-11-25T11:44:09Z\\",\\n \\"PlainText\\": \\"答案内容\\",\\n \\"SolutionId\\": 30001979424,\\n \\"Content\\": \\"答案内容\\",\\n \\"ModifyTime\\": \\"2020-11-26T06:36:14Z\\"\\n }\\n ],\\n \\"Version\\": 1,\\n \\"ModifyUserName\\": \\"修改人\\\\n\\",\\n \\"KnowledgeStatus\\": 3,\\n \\"Outlines\\": [\\n {\\n \\"KnowledgeId\\": 30001979425,\\n \\"OutlineId\\": 30001979424,\\n \\"Title\\": \\"关联问\\"\\n }\\n ],\\n \\"KnowledgeType\\": 1\\n}","type":"json"}]', + 'title' => '查看知识详情', + 'summary' => '知识库-详情。', + ], + 'GetBotKnowledgeStatData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '77', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '907AA5F2-0521-49AB-80AB-1ADEFAB2B901', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"77\\",\\n \\"RequestId\\": \\"907AA5F2-0521-49AB-80AB-1ADEFAB2B901\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>77</CostTime>\\n<RequestId>907AA5F2-0521-49AB-80AB-1ADEFAB2B901</RequestId>\\n<Datas>\\n <KnowledgeCnt>2.4444444444444446</KnowledgeCnt>\\n <EffectiveKnowledgeRate>0.13636363636363635</EffectiveKnowledgeRate>\\n <HitKnowledgeRate>0.07920792079207921</HitKnowledgeRate>\\n</Datas>","errorExample":""}]', + 'title' => 'GetBotKnowledgeStatData', + 'summary' => '调用GetBotKnowledgeStatData接口获取数据api-知识概览API。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**KnowledgeStatDTO**'."\n" + .'| 字段名 | 类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| KnowledgeCnt | int | 知识总数 |'."\n" + .'| EffectiveKnowledgeRate | double | 有效知识占⽐ |'."\n" + .'| HitKnowledgeRate | double | 知识命中占⽐ |', + 'extraInfo' => ' ', + ], + 'QueryKnowledges' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'KnowledgeTitle', + 'in' => 'query', + 'schema' => [ + 'description' => 'faq标题', + 'type' => 'string', + 'required' => false, + 'example' => '知识标题', + ], + ], + [ + 'name' => 'CoreWordName', + 'in' => 'query', + 'schema' => [ + 'description' => '核心词', + 'type' => 'string', + 'required' => false, + 'example' => '核心词', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前⻚，默认1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '⻚⾯⼤⼩，默认10，最大值500， 值超过500将返回最大值500', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'FAQ类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000053274', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '分⻚-总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '84', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D2605A09-827E-5C50-87A5-547498B93E8F', + ], + 'PageSize' => [ + 'description' => '分⻚-⻚⾯⼤⼩，默认 10，最大值为500， 超过500将返回最大值500', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '分⻚-第⼏⻚', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Knowledges' => [ + 'description' => '知识列表'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '知识信息', + 'type' => 'object', + 'properties' => [ + 'KnowledgeStatus' => [ + 'description' => '知识状态：3：已发布，-1：全部，14：草稿，17：已失效，15：待发布(发布中)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'EndDate' => [ + 'description' => '失效时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-26T11:56:40Z', + ], + 'KnowledgeId' => [ + 'description' => 'FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001979424', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => '创建者', + ], + 'CreateTime' => [ + 'description' => '创建时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-25T11:44:09Z', + ], + 'StartDate' => [ + 'description' => '⽣效时间（UTC时间）', + 'type' => 'string', + 'example' => '2020-11-25T11:56:23Z', + ], + 'KnowledgeTitle' => [ + 'description' => 'FAQ标题', + 'type' => 'string', + 'example' => '知识标题', + ], + 'ModifyUserName' => [ + 'description' => '修改人名称', + 'type' => 'string', + 'example' => '修改人', + ], + 'CoreWords' => [ + 'description' => '核⼼词列表', + 'type' => 'array', + 'items' => [ + 'description' => '核⼼词', + 'type' => 'string', + 'example' => '核心词', + ], + ], + 'Version' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '2', + ], + 'CategoryId' => [ + 'description' => '类⽬ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000053274', + ], + 'ModifyTime' => [ + 'description' => '修改时间（UTC时间）', + 'type' => 'string', + 'example' => '2022-01-24T06:02:37Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 84,\\n \\"RequestId\\": \\"D2605A09-827E-5C50-87A5-547498B93E8F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Knowledges\\": [\\n {\\n \\"KnowledgeStatus\\": 3,\\n \\"EndDate\\": \\"2020-11-26T11:56:40Z\\",\\n \\"KnowledgeId\\": 30001979424,\\n \\"CreateUserName\\": \\"创建者\\",\\n \\"CreateTime\\": \\"2020-11-25T11:44:09Z\\",\\n \\"StartDate\\": \\"2020-11-25T11:56:23Z\\",\\n \\"KnowledgeTitle\\": \\"知识标题\\",\\n \\"ModifyUserName\\": \\"修改人\\",\\n \\"CoreWords\\": [\\n \\"核心词\\"\\n ],\\n \\"Version\\": \\"2\\",\\n \\"CategoryId\\": 1000053274,\\n \\"ModifyTime\\": \\"2022-01-24T06:02:37Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryKnowledges', + 'summary' => '查询类目的知识列表。', + ], + 'PublishKnowledge' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'KnowledgeId', + 'in' => 'query', + 'schema' => [ + 'description' => '要发布的FAQ ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30001905617', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '是否发起异步作业。取值：'."\n" + ."\n" + .'- **true**：发起异步作业'."\n" + .'- **false**：不发起异步作业。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '74D1B5C6-BACE-5F5A-9A24-898F74696627', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D1B5C6-BACE-5F5A-9A24-898F74696627\\"\\n}","type":"json"}]', + 'title' => '发布FAQ', + 'summary' => '发布知识。', + ], + 'MoveKnowledgeCategory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'KnowledgeId', + 'in' => 'query', + 'schema' => [ + 'description' => '待转移的faqid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30001979424', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '转入的类目id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000053274', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结果信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'ABC61B71-9F9D-52FD-9E0C-71C4E4B5D097', + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABC61B71-9F9D-52FD-9E0C-71C4E4B5D097\\"\\n}","type":"json"}]', + 'title' => '来进行FAQ类目间的转移', + 'summary' => '移动知识。', + ], + 'AddSynonym' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CoreWordName', + 'in' => 'query', + 'schema' => [ + 'description' => '核⼼词名称', + 'type' => 'string', + 'required' => true, + 'example' => '异地', + ], + ], + [ + 'name' => 'Synonym', + 'in' => 'query', + 'schema' => [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '47D26156-D4C3-4E48-B0D6-25BBF7A3BC1D', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"47D26156-D4C3-4E48-B0D6-25BBF7A3BC1D\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>47D26156-D4C3-4E48-B0D6-25BBF7A3BC1D</RequestId>","errorExample":""}]', + 'title' => 'AddSynonym', + 'summary' => '调用AddSynonym增加核⼼词同义词。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCoreWord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CoreWordName', + 'in' => 'query', + 'schema' => [ + 'description' => '核⼼词名称，不能为空字符串，不超过120个字符', + 'type' => 'string', + 'required' => true, + 'example' => '测试3', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', + ], + 'CoreWordCode' => [ + 'description' => '核⼼词编码，由系统⽣成，全局 唯⼀。是访问核⼼词数据的唯⼀'."\n" + .'标识', + 'type' => 'string', + 'example' => 'ceb9d68c-dbb5-32c9-a02c-eca56b782ff7', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E3E5C779-A630-45AC-B0F2-A4506A4212F1\\",\\n \\"CoreWordCode\\": \\"ceb9d68c-dbb5-32c9-a02c-eca56b782ff7\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E3E5C779-A630-45AC-B0F2-A4506A4212F1</RequestId>\\n<CoreWordCode>ceb9d68c-dbb5-32c9-a02c-eca56b782ff7</CoreWordCode>","errorExample":""}]', + 'title' => 'CreateCoreWord', + 'summary' => '调用CreateCoreWord新增核⼼词。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCoreWord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CoreWordName', + 'in' => 'query', + 'schema' => [ + 'description' => '删除的核心词名称', + 'type' => 'string', + 'required' => true, + 'example' => '测试4', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'E45491D5-7E0A-42C6-9B21-91D1066B1475', + ], + 'Success' => [ + 'description' => '是否操作成功：false：否；true：是', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E45491D5-7E0A-42C6-9B21-91D1066B1475\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E45491D5-7E0A-42C6-9B21-91D1066B1475</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'DeleteCoreWord', + 'summary' => '调用DeleteCoreWord删除核⼼词。', + ], + 'UpdateCoreWord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CoreWordName', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的核⼼词名称', + 'type' => 'string', + 'required' => true, + 'example' => '测试4', + ], + ], + [ + 'name' => 'CoreWordCode', + 'in' => 'query', + 'schema' => [ + 'description' => '被修改的核心词的唯⼀编码', + 'type' => 'string', + 'required' => true, + 'example' => 'ceb9d68c-dbb5-32c9-a02c-eca56b782ff7', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'D0DDFC4C-D66D-4787-9AE4-4D757481EDEE', + ], + 'Success' => [ + 'description' => '是否操作成功：false：否；true：是', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0DDFC4C-D66D-4787-9AE4-4D757481EDEE\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D0DDFC4C-D66D-4787-9AE4-4D757481EDEE</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'UpdateCoreWord', + 'summary' => '调用UpdateCoreWord修改核⼼词。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCoreWord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CoreWordName', + 'in' => 'query', + 'schema' => [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CoreWordName' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => '本地', + ], + 'Synonyms' => [ + 'description' => '同义词列表', + 'type' => 'array', + 'items' => [ + 'description' => '同义词列表', + 'type' => 'string', + 'example' => '所在地', + ], + ], + 'ModifyTime' => [ + 'description' => '修改时间 (UTC 时间)', + 'type' => 'string', + 'example' => '2020-11-25T10:31:10Z', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419', + ], + 'CreateTime' => [ + 'description' => '创建时间 (UTC 时间)', + 'type' => 'string', + 'example' => '2020-11-24T03:49:18Z', + ], + 'CoreWordCode' => [ + 'description' => '唯⼀编码', + 'type' => 'string', + 'example' => '5be359c7-c18b-353a-bfe5-659b229e272e', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CoreWordName\\": \\"本地\\",\\n \\"Synonyms\\": [\\n \\"所在地\\"\\n ],\\n \\"ModifyTime\\": \\"2020-11-25T10:31:10Z\\",\\n \\"RequestId\\": \\"F55D90C1-31BE-4B2A-AA3F-25EFC36F9419\\",\\n \\"CreateTime\\": \\"2020-11-24T03:49:18Z\\",\\n \\"CoreWordCode\\": \\"5be359c7-c18b-353a-bfe5-659b229e272e\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCoreWordResponse>\\n <CoreWordName>本地</CoreWordName>\\n <Synonyms>所在地</Synonyms>\\n <ModifyTime>2020-11-25T10:31:10Z</ModifyTime>\\n <RequestId>F55D90C1-31BE-4B2A-AA3F-25EFC36F9419</RequestId>\\n <CreateTime>2020-11-24T03:49:18Z</CreateTime>\\n <CoreWordCode>5be359c7-c18b-353a-bfe5-659b229e272e</CoreWordCode>\\n</escribeCoreWordResponse>","errorExample":""}]', + 'title' => 'DescribeCoreWord', + 'summary' => '调用DescribeCoreWord获取核⼼词详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCoreWords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CoreWordName', + 'in' => 'query', + 'schema' => [ + 'description' => '核⼼词名称', + 'type' => 'string', + 'required' => false, + 'example' => '本地', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Synonym', + 'in' => 'query', + 'schema' => [ + 'description' => '核⼼词的同义词', + 'type' => 'string', + 'required' => false, + 'example' => '当地，所在地', + ], + ], + [ + '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' => [ + 'TotalCount' => [ + 'description' => '分⻚-总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CoreWords' => [ + 'description' => '核⼼词列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CoreWordCode' => [ + 'description' => '唯⼀编码', + 'type' => 'string', + 'example' => '405d73a6-ac3c-37fd-96a6-94ae2a882c1e', + ], + 'CoreWordName' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => '本地', + ], + 'Synonyms' => [ + 'type' => 'array', + 'items' => [ + 'description' => '同义词列表', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + 'CreateTime' => [ + 'description' => '创建时间 (UTC 时间)', + 'type' => 'string', + 'example' => '2020-11-24T03:49:18Z', + ], + 'ModifyTime' => [ + 'description' => '修改时间 (UTC 时间)', + 'type' => 'string', + 'example' => '2020-11-25T10:31:10Z', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B', + ], + 'PageSize' => [ + 'description' => '分⻚-⻚⾯⼤⼩', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '分⻚-第⼏⻚', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 3,\\n \\"CoreWords\\": [\\n {\\n \\"CoreWordCode\\": \\"405d73a6-ac3c-37fd-96a6-94ae2a882c1e\\",\\n \\"CoreWordName\\": \\"本地\\",\\n \\"Synonyms\\": [\\n \\"参考JSON示例\\"\\n ],\\n \\"CreateTime\\": \\"2020-11-24T03:49:18Z\\",\\n \\"ModifyTime\\": \\"2020-11-25T10:31:10Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"92B81548-42B9-4B34-924B-4E778AEB412B\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>3</TotalCount>\\n<CoreWords>\\n <CoreWordName>本地</CoreWordName>\\n <Synonyms>本地</Synonyms>\\n <ModifyTime>2020-11-25T10:31:10Z</ModifyTime>\\n <CreateTime>2020-11-24T03:49:18Z</CreateTime>\\n <CoreWordCode>5be359c7-c18b-353a-bfe5-659b229e272e</CoreWordCode>\\n</CoreWords>\\n<CoreWords>\\n <CoreWordName>本地</CoreWordName>\\n <Synonyms>当地</Synonyms>\\n <ModifyTime>2020-11-25T10:31:10Z</ModifyTime>\\n <CreateTime>2020-11-25T10:31:04Z</CreateTime>\\n <CoreWordCode>d8558390-f758-33da-8666-dfbb46f173b3</CoreWordCode>\\n</CoreWords>\\n<CoreWords>\\n <CoreWordName>本地</CoreWordName>\\n <Synonyms>所在地</Synonyms>\\n <ModifyTime>2020-11-25T10:31:10Z</ModifyTime>\\n <CreateTime>2020-11-25T10:31:10Z</CreateTime>\\n <CoreWordCode>405d73a6-ac3c-37fd-96a6-94ae2a882c1e</CoreWordCode>\\n</CoreWords>\\n<PageSize>10</PageSize>\\n<RequestId>92B81548-42B9-4B34-924B-4E778AEB412B</RequestId>\\n<PageNumber>1</PageNumber>","errorExample":""}]', + 'title' => 'QueryCoreWords', + 'summary' => '调用QueryCoreWords获取核⼼词列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveSynonym' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CoreWordName', + 'in' => 'query', + 'schema' => [ + 'description' => '核⼼词名称', + 'type' => 'string', + 'required' => true, + 'example' => '本地', + ], + ], + [ + 'name' => 'Synonym', + 'in' => 'query', + 'schema' => [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'C191B48B-9268-4FB1-A3C2-5143B4A91D0C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C191B48B-9268-4FB1-A3C2-5143B4A91D0C\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C191B48B-9268-4FB1-A3C2-5143B4A91D0C</RequestId>","errorExample":""}]', + 'title' => 'RemoveSynonym', + 'summary' => '调用RemoveSynonym删除核⼼词同义词。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateEntity' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '103610', + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '实体名称', + 'type' => 'string', + 'required' => true, + 'example' => '地点实体', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => [ + 'description' => '实体类型：regex：正则名词；synonyms：标准名词', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'regex' => 'regex', + 'synonyms' => 'synonyms', + ], + 'example' => 'synonyms', + ], + ], + [ + 'name' => 'Regex', + 'in' => 'query', + 'schema' => [ + 'description' => '正则表达式', + 'type' => 'string', + 'required' => false, + 'example' => '\\d{5,8}', + ], + ], + [ + 'name' => 'Members', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '实体成员列表'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MemberName' => [ + 'description' => '实体值归一化值'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '北京', + ], + 'Synonyms' => [ + 'description' => '同义词列表'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '单个同义词', + 'type' => 'string', + 'required' => false, + 'example' => '首都', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'enumValueTitles' => [ + '[{\\"MemberName\\":\\"1413\\",\\"Synonyms\\":[\\"天鹅座D座\\"]},{\\"MemberName\\":\\"1416\\",\\"Synonyms\\":[\\"无锡功能区\\"]}]' => '[{\\"MemberName\\":\\"1413\\",\\"Synonyms\\":[\\"天鹅座D座\\"]},{\\"MemberName\\":\\"1416\\",\\"Synonyms\\":[\\"无锡功能区\\"]}]', + ], + ], + ], + [ + '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' => [ + 'EntityId' => [ + 'description' => '实体 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72121', + ], + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EntityId\\": 72121,\\n \\"RequestId\\": \\"28805A7C-D695-548C-A31B-67E52C2C274F\\"\\n}","type":"json"}]', + 'title' => '创建专有名词', + 'summary' => '调用CreateEntity接口创建专有名词。', + ], + 'DeleteEntity' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体 ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '42212', + ], + ], + [ + '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' => [ + 'EntityId' => [ + 'description' => '实体 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42212', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '851BCF73-08DB-4738-AC23-302C591C1C86', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EntityId\\": 42212,\\n \\"RequestId\\": \\"851BCF73-08DB-4738-AC23-302C591C1C86\\"\\n}","errorExample":""},{"type":"xml","example":"<EntityId>42212</EntityId>\\n<RequestId>851BCF73-08DB-4738-AC23-302C591C1C86</RequestId>","errorExample":""}]', + 'title' => 'DeleteEntity', + 'summary' => '调用DeleteEntity接口删除专有名词。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateEntity' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体 ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '13866', + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '实体名称', + 'type' => 'string', + 'required' => true, + 'example' => '地点实体', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型：regex：正则名词；synonyms：标准名词', + 'type' => 'string', + 'required' => true, + 'example' => 'synonyms ', + ], + ], + [ + 'name' => 'Regex', + 'in' => 'query', + 'schema' => [ + 'description' => '该实体具体的正则表达式', + 'type' => 'string', + 'required' => false, + 'example' => '(\\\\d+-\\\\d+-\\\\d+\\\\s\\\\S+)\\\\s\\\\[(\\\\S+)\\\\s([^:]+):(\\\\d+)\\\\s(\\\\w+)]\\\\s\\\\[(\\\\d+)\\\\s(\\\\d+)]\\\\s\\\\[([^]]+)]\\\\s(\\\\w+)\\\\s(.*)', + ], + ], + [ + 'name' => 'Members', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '实体成员列表', + 'type' => 'array', + 'items' => [ + 'description' => '实体成员', + 'type' => 'object', + 'properties' => [ + 'MemberName' => [ + 'description' => '实体值归一化值', + 'type' => 'string', + 'required' => false, + 'example' => '北京', + ], + 'Synonyms' => [ + 'description' => '同义词列表', + 'type' => 'array', + 'items' => [ + 'description' => '同义词', + 'type' => 'string', + 'required' => false, + 'example' => '首都', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + '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' => [ + 'EntityId' => [ + 'description' => '实体 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63405', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EntityId\\": 63405,\\n \\"RequestId\\": \\"4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55\\"\\n}","type":"json"}]', + 'title' => '修改专有名词', + 'summary' => '调用UpdateEntity接口修改专有名词。', + ], + 'DescribeEntities' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有名词id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '42212', + ], + ], + [ + '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' => [ + 'EntityId' => [ + 'description' => '专有名词id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42212', + ], + 'EntityType' => [ + 'description' => '类型：regex：正则名词； synonyms：标准名词', + 'type' => 'string', + 'example' => 'regex', + ], + 'ModifyTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-12-02T06:35:50Z', + ], + 'ModifyUserId' => [ + 'description' => '修改者id', + 'type' => 'string', + 'example' => '83225', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '3F95508F-8635-4786-A959-E21F6FED4CD1', + ], + 'Regex' => [ + 'description' => '正则', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + 'EntityName' => [ + 'description' => '专有名词名称', + 'type' => 'string', + 'example' => '价格', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-12-02T06:35:50Z', + ], + 'ModifyUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'CreateUserId' => [ + 'description' => '创建者id', + 'type' => 'string', + 'example' => '83225', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'Members' => [ + 'description' => '专有名词成员', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Synonyms' => [ + 'type' => 'array', + 'items' => [ + 'description' => '成员同义词列表', + 'type' => 'string', + 'example' => '参考专有名词列表的JSON示例', + ], + ], + 'MemberName' => [ + 'description' => '成员名称', + 'type' => 'string', + 'example' => '参考专有名词列表的JSON示例', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EntityId\\": 42212,\\n \\"EntityType\\": \\"regex\\",\\n \\"ModifyTime\\": \\"2020-12-02T06:35:50Z\\",\\n \\"ModifyUserId\\": \\"83225\\",\\n \\"RequestId\\": \\"3F95508F-8635-4786-A959-E21F6FED4CD1\\",\\n \\"Regex\\": \\"参考JSON示例\\",\\n \\"EntityName\\": \\"价格\\",\\n \\"CreateTime\\": \\"2020-12-02T06:35:50Z\\",\\n \\"ModifyUserName\\": \\"null\\",\\n \\"CreateUserId\\": \\"83225\\",\\n \\"CreateUserName\\": \\"null\\",\\n \\"Members\\": [\\n {\\n \\"Synonyms\\": [\\n \\"参考专有名词列表的JSON示例\\"\\n ],\\n \\"MemberName\\": \\"参考专有名词列表的JSON示例\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<EntityType>regex</EntityType>\\n<EntityId>42212</EntityId>\\n<ModifyTime>2020-12-02T06:35:50Z</ModifyTime>\\n<ModifyUserId>83225</ModifyUserId>\\n<RequestId>3F95508F-8635-4786-A959-E21F6FED4CD1</RequestId>\\n<EntityName>价格</EntityName>\\n<Regex>^([0-9])\\\\d{1}</Regex>\\n<CreateTime>2020-12-02T06:35:50Z</CreateTime>\\n<ModifyUserName>null</ModifyUserName>\\n<CreateUserId>83225</CreateUserId>\\n<CreateUserName>null</CreateUserName>","errorExample":""}]', + 'title' => 'DescribeEntities', + 'summary' => '调用DescribeEntities接口查看专有名词详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySystemEntities' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索系统专有名词关键字'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '城市', + ], + ], + [ + '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' => [ + 'SystemEntities' => [ + 'description' => '系统内置专有名词', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DefaultQuestion' => [ + 'description' => '默认反问', + 'type' => 'string', + 'example' => '请问您的城市是哪里呢?', + ], + 'EntityCode' => [ + 'description' => '实体编码', + 'type' => 'string', + 'example' => '@sys.geo-city', + ], + 'EntityName' => [ + 'description' => '专有名词名称', + 'type' => 'string', + 'example' => '系统.城市实体', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F6E5D7FE-6165-4478-BC52-9E0D1DAD5C84', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SystemEntities\\": [\\n {\\n \\"DefaultQuestion\\": \\"请问您的城市是哪里呢?\\",\\n \\"EntityCode\\": \\"@sys.geo-city\\",\\n \\"EntityName\\": \\"系统.城市实体\\"\\n }\\n ],\\n \\"RequestId\\": \\"F6E5D7FE-6165-4478-BC52-9E0D1DAD5C84\\"\\n}","errorExample":""},{"type":"xml","example":"<SystemEntities>\\n <EntityName>系统.城市实体</EntityName>\\n <EntityCode>@sys.geo-city</EntityCode>\\n <DefaultQuestion>请问您的城市是哪里呢?</DefaultQuestion>\\n</SystemEntities>\\n<SystemEntities>\\n <EntityName>系统.飞机场城市实体</EntityName>\\n <EntityCode>@sys.airport</EntityCode>\\n <DefaultQuestion>请问是哪个城市?</DefaultQuestion>\\n</SystemEntities>\\n<SystemEntities>\\n <EntityName>系统.全球城市实体</EntityName>\\n <EntityCode>@sys.global-city</EntityCode>\\n <DefaultQuestion>请问您说的是哪座城市？</DefaultQuestion>\\n</SystemEntities>\\n<RequestId>F6E5D7FE-6165-4478-BC52-9E0D1DAD5C84</RequestId>","errorExample":""}]', + 'title' => 'QuerySystemEntities', + 'summary' => '调用QuerySystemEntities接口获取系统专有名词列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryEntities' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '专有名词名称', + 'type' => 'string', + 'required' => false, + 'example' => '业务条件，牌子', + ], + ], + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话单元Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50405', + ], + ], + [ + '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', + ], + ], + [ + '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' => [ + 'TotalCount' => [ + 'description' => '查询结果总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '206FCA00-9802-492E-86B3-5BCABDB6EF71', + ], + 'PageSize' => [ + 'description' => '⻚⾯⼤⼩，默认10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前⻚，默认1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Entities' => [ + 'description' => '专有名词列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Members' => [ + 'description' => '专有名词成员', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Synonyms' => [ + 'type' => 'array', + 'items' => [ + 'description' => '成员同义词列表', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + 'MemberName' => [ + 'description' => '成员名称', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + ], + ], + 'ModifyUserId' => [ + 'description' => '修改者id', + 'type' => 'string', + 'example' => '83225', + ], + 'ModifyUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'EntityId' => [ + 'description' => '专有名词id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42212', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-12-02T06:35:50Z', + ], + 'Regex' => [ + 'description' => '正则', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + 'EntityType' => [ + 'description' => '类型：regex：正则名词； synonyms：标准名词', + 'type' => 'string', + 'example' => 'regex', + ], + 'CreateUserId' => [ + 'description' => '创建者id', + 'type' => 'string', + 'example' => '83225', + ], + 'EntityName' => [ + 'description' => '专有名词名称', + 'type' => 'string', + 'example' => '价格', + ], + 'ModifyTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-12-02T06:35:50Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"206FCA00-9802-492E-86B3-5BCABDB6EF71\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Entities\\": [\\n {\\n \\"Members\\": [\\n {\\n \\"Synonyms\\": [\\n \\"参考JSON示例\\"\\n ],\\n \\"MemberName\\": \\"参考JSON示例\\"\\n }\\n ],\\n \\"ModifyUserId\\": \\"83225\\",\\n \\"ModifyUserName\\": \\"null\\",\\n \\"EntityId\\": 42212,\\n \\"CreateUserName\\": \\"null\\",\\n \\"CreateTime\\": \\"2020-12-02T06:35:50Z\\",\\n \\"Regex\\": \\"参考JSON示例\\",\\n \\"EntityType\\": \\"regex\\",\\n \\"CreateUserId\\": \\"83225\\",\\n \\"EntityName\\": \\"价格\\",\\n \\"ModifyTime\\": \\"2020-12-02T06:35:50Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>206FCA00-9802-492E-86B3-5BCABDB6EF71</RequestId>\\n<PageNumber>1</PageNumber>\\n<Entities>\\n <EntityId>42212</EntityId>\\n <EntityType>regex</EntityType>\\n <ModifyTime>2020-12-02T06:35:50Z</ModifyTime>\\n <ModifyUserId>83225</ModifyUserId>\\n <EntityName>价格</EntityName>\\n <Regex>^([0-9])\\\\d{1}</Regex>\\n <CreateTime>2020-12-02T06:35:50Z</CreateTime>\\n <ModifyUserName>null</ModifyUserName>\\n <CreateUserId>83225</CreateUserId>\\n <CreateUserName>null</CreateUserName>\\n</Entities>","errorExample":""}]', + 'title' => 'QueryEntities', + 'summary' => '调用QueryEntities接口查询专有名词列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AppendEntityMember' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体 ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '62899', + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'description' => '追加类型：memberName-专有名词-成员、synonyms-专有名词相似问'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'memberName', + ], + ], + [ + 'name' => 'Member', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标准名词的成员以及同义词（相似问）'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'MemberName' => [ + 'description' => '标准名词的成员以及同义词（相似问）名称'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '北京', + ], + 'Synonyms' => [ + 'description' => '成员同义词列表'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '单个同义词', + 'type' => 'string', + 'required' => false, + 'example' => '首都', + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + [ + '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' => [ + 'EntityId' => [ + 'description' => '实体 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13853', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '07B270A4-61D8-57F6-A609-A3C216CFB872', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EntityId\\": 13853,\\n \\"RequestId\\": \\"07B270A4-61D8-57F6-A609-A3C216CFB872\\"\\n}","type":"json"}]', + 'title' => '追加专有名词或相似问', + 'summary' => '调用AppendEntityMember接口追加专有名词或相似问。', + ], + 'RemoveEntityMember' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体 ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '13853', + ], + ], + [ + 'name' => 'RemoveType', + 'in' => 'query', + 'schema' => [ + 'description' => '移除内容：memberName-专有名词-成员、synonyms-专有名词相似问', + 'type' => 'string', + 'required' => true, + 'example' => 'memberName', + ], + ], + [ + 'name' => 'Member', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标准名词的成员以及同义词（相似问）', + 'type' => 'object', + 'properties' => [ + 'MemberName' => [ + 'description' => '标准名词的成员以及同义词（相似问）名称'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '北京', + ], + 'Synonyms' => [ + 'description' => '同义词列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个同义词'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '首都', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + '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' => [ + 'EntityId' => [ + 'description' => '移除成员或相似问的专有名词标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13853', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'E42C928F-202A-4896-8F4A-DA718720BC98', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EntityId\\": 13853,\\n \\"RequestId\\": \\"E42C928F-202A-4896-8F4A-DA718720BC98\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E42C928F-202A-4896-8F4A-DA718720BC98</RequestId>\\n<EntityId>13853</EntityId>","errorExample":""}]', + 'title' => 'RemoveEntityMember', + 'summary' => '调用RemoveEntityMember接口移除专有名词。', + 'requestParamsDescription' => ' **Member**'."\n" + .'| 字段名 |类型 |是否必填 |描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| Synonyms | Array Of String |否 |成员同义词列表 |'."\n" + .'| MemberName | String |是 |对话流名称 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDialog' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'DialogName', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流名称，长度限制64个字符', + 'type' => 'string', + 'required' => true, + 'example' => '测试002', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流描述，长度限制120个字。', + 'type' => 'string', + 'required' => false, + 'example' => '002测试示例', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '16AC1B3C-66E0-438B-BB7C-71B692407B67', + ], + 'DialogId' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50120', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16AC1B3C-66E0-438B-BB7C-71B692407B67\\",\\n \\"DialogId\\": 50120\\n}","errorExample":""},{"type":"xml","example":"<RequestId>16AC1B3C-66E0-438B-BB7C-71B692407B67</RequestId>\\n<DialogId>50120</DialogId>","errorExample":""}]', + 'title' => 'CreateDialog', + 'summary' => '调用CreateDialog接口新增对话单元。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDialog' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '被删除的对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50127', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'C6C17866-D5BF-4B90-8224-FC38F069F4C0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C6C17866-D5BF-4B90-8224-FC38F069F4C0\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C6C17866-D5BF-4B90-8224-FC38F069F4C0</RequestId>","errorExample":""}]', + 'title' => 'DeleteDialog', + 'summary' => '调用DeleteDialog接口删除对话流。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateDialog' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '被修改对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50120', + ], + ], + [ + 'name' => 'DialogName', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的对话流名称', + 'type' => 'string', + 'required' => true, + 'example' => '测试003', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的对话流描述', + 'type' => 'string', + 'required' => false, + 'example' => '003测试示例', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'FF157949-D464-4563-99C0-AC1C889729B6', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF157949-D464-4563-99C0-AC1C889729B6\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FF157949-D464-4563-99C0-AC1C889729B6</RequestId>","errorExample":""}]', + 'title' => 'UpdateDialog', + 'summary' => '调用UpdateDialog接口修改对话流名称和对话流描述。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDialog' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50099', + ], + ], + [ + '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' => [ + 'Status' => [ + 'description' => '状态：3：草稿；6：已发布；8：下线', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'ModifyTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-11-30T06:05:11Z', + ], + 'Description' => [ + 'description' => '对话流描述', + 'type' => 'string', + 'example' => '这是一个测试示例', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F178F903-AFCF-4F1F-81A1-69A8D99B1D7E', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-11-30T03:00:54Z', + ], + 'CreateUserId' => [ + 'description' => '创建者Id', + 'type' => 'string', + 'example' => '83225', + ], + 'DialogId' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50099', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'IsOnline' => [ + 'description' => '是否上线：true：上线，false： 未上线', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DialogName' => [ + 'description' => '对话流名称', + 'type' => 'string', + 'example' => '测试', + ], + 'ModifyUserId' => [ + 'description' => '修改者Id', + 'type' => 'string', + 'example' => '83225', + ], + 'ModifyUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'IsSampleDialog' => [ + 'description' => '标识内置样例对话流：true： 是，false：否', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": 6,\\n \\"ModifyTime\\": \\"2020-11-30T06:05:11Z\\",\\n \\"Description\\": \\"这是一个测试示例\\",\\n \\"RequestId\\": \\"F178F903-AFCF-4F1F-81A1-69A8D99B1D7E\\",\\n \\"CreateTime\\": \\"2020-11-30T03:00:54Z\\",\\n \\"CreateUserId\\": \\"83225\\",\\n \\"DialogId\\": 50099,\\n \\"CreateUserName\\": \\"null\\",\\n \\"IsOnline\\": true,\\n \\"DialogName\\": \\"测试\\",\\n \\"ModifyUserId\\": \\"83225\\",\\n \\"ModifyUserName\\": \\"null\\",\\n \\"IsSampleDialog\\": false\\n}","errorExample":""},{"type":"xml","example":"<Status>6</Status>\\n<ModifyTime>2020-11-30T06:05:11Z</ModifyTime>\\n<Description>这是一个测试示例</Description>\\n<RequestId>F178F903-AFCF-4F1F-81A1-69A8D99B1D7E</RequestId>\\n<CreateTime>2020-11-30T03:00:54Z</CreateTime>\\n<CreateUserId>83225</CreateUserId>\\n<DialogId>50099</DialogId>\\n<CreateUserName>null</CreateUserName>\\n<IsOnline>true</IsOnline>\\n<ModifyUserId>83225</ModifyUserId>\\n<DialogName>测试</DialogName>\\n<ModifyUserName>null</ModifyUserName>","errorExample":""}]', + 'title' => 'DescribeDialog', + 'summary' => '调用DescribeDialog接口获取对话单元详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDialogs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈ ID', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'DialogName', + 'in' => 'query', + 'schema' => [ + 'description' => '对话单元名称', + 'type' => 'string', + 'required' => false, + 'example' => '测试，测试001，查天气', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分⻚-第⼏⻚', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分⻚-⻚⾯⼤⼩', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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' => [ + 'TotalCount' => [ + 'description' => '分⻚-总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '7F132693-212A-40A9-8A81-11E7694E478B', + ], + 'PageSize' => [ + 'description' => '分⻚-⻚⾯⼤⼩', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '分⻚-第⼏⻚', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Dialogs' => [ + 'description' => '对话流列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '对话流状态：0-未激活状态；1-沙盒状态；3-草稿状态；4-发布中状态；5-审核中；6-已发布；7-审核失败；8-已下线', + 'description' => '状态：3：草稿；6：已发布；8：下线', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'DialogName' => [ + 'description' => '对话流名称', + 'type' => 'string', + 'example' => '测试001', + ], + 'ModifyUserId' => [ + 'description' => '修改者Id', + 'type' => 'string', + 'example' => '83225', + ], + 'IsOnline' => [ + 'description' => '是否上线：true：上线，false： 未上线', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-11-30T03:00:54Z', + ], + 'CreateUserId' => [ + 'description' => '创建者Id', + 'type' => 'string', + 'example' => '83225', + ], + 'ModifyUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'Description' => [ + 'description' => '对话流描述', + 'type' => 'string', + 'example' => '这是一个测试示例', + ], + 'DialogId' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50099', + ], + 'IsSampleDialog' => [ + 'description' => '标识内置样例对话流：true： 是，false：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ModifyTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-11-30T06:12:47Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"7F132693-212A-40A9-8A81-11E7694E478B\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Dialogs\\": [\\n {\\n \\"Status\\": 3,\\n \\"DialogName\\": \\"测试001\\",\\n \\"ModifyUserId\\": \\"83225\\",\\n \\"IsOnline\\": true,\\n \\"CreateUserName\\": \\"null\\",\\n \\"CreateTime\\": \\"2020-11-30T03:00:54Z\\",\\n \\"CreateUserId\\": \\"83225\\",\\n \\"ModifyUserName\\": \\"null\\",\\n \\"Description\\": \\"这是一个测试示例\\",\\n \\"DialogId\\": 50099,\\n \\"IsSampleDialog\\": false,\\n \\"ModifyTime\\": \\"2020-11-30T06:12:47Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>3</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>7F132693-212A-40A9-8A81-11E7694E478B</RequestId>\\n<PageNumber>1</PageNumber>\\n<Dialogs>\\n <Status>8</Status>\\n <ModifyTime>2020-11-30T06:12:47Z</ModifyTime>\\n <DialogName>测试001</DialogName>\\n <Description>001的测试流</Description>\\n <ModifyUserId>83225</ModifyUserId>\\n <CreateTime>2020-11-30T06:10:11Z</CreateTime>\\n <ModifyUserName>null</ModifyUserName>\\n <DialogId>50110</DialogId>\\n <CreateUserId>83225</CreateUserId>\\n <CreateUserName>null</CreateUserName>\\n <IsOnline>false</IsOnline>\\n</Dialogs>\\n<Dialogs>\\n <Status>6</Status>\\n <ModifyTime>2020-11-30T06:05:11Z</ModifyTime>\\n <DialogName>测试</DialogName>\\n <Description>这是一个测试示例</Description>\\n <ModifyUserId>83225</ModifyUserId>\\n <CreateTime>2020-11-30T03:00:54Z</CreateTime>\\n <ModifyUserName>null</ModifyUserName>\\n <DialogId>50099</DialogId>\\n <CreateUserId>83225</CreateUserId>\\n <CreateUserName>null</CreateUserName>\\n <IsOnline>true</IsOnline>\\n</Dialogs>\\n<Dialogs>\\n <Status>3</Status>\\n <ModifyTime>2020-11-29T06:50:46Z</ModifyTime>\\n <DialogName>示例_查天气</DialogName>\\n <Description>示例_查天气</Description>\\n <ModifyUserId>83225</ModifyUserId>\\n <CreateTime>2020-11-29T06:50:46Z</CreateTime>\\n <ModifyUserName>83225</ModifyUserName>\\n <DialogId>49966</DialogId>\\n <CreateUserId>83225</CreateUserId>\\n <CreateUserName>83225</CreateUserName>\\n <IsSampleDialog>true</IsSampleDialog>\\n <IsOnline>false</IsOnline>\\n</Dialogs>","errorExample":""}]', + 'title' => 'QueryDialogs', + 'summary' => '调用QueryDialogs接口获取对话单元列表。', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableDialogFlow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '49966', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F0809B63-5DDF-4BB8-AA86-92CE99543922', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F0809B63-5DDF-4BB8-AA86-92CE99543922\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F0809B63-5DDF-4BB8-AA86-92CE99543922</RequestId>","errorExample":""}]', + 'title' => 'DisableDialogFlow', + 'summary' => '调用DisableDialogFlow接口把对话流下线。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateDialogFlow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '93130', + ], + ], + [ + 'name' => 'ModuleDefinition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '对话流描述信息(Json字符串)', + 'type' => 'object', + 'properties' => [ + 'GlobalVars' => [ + 'description' => '对话流级别变量', + 'type' => 'object', + 'required' => false, + 'example' => '{"name":"", "uid":""}', + ], + 'ModuleDefinition' => [ + 'description' => '画布详情定义（json）', + 'required' => false, + '$ref' => '#/components/schemas/PaasProcessData', + ], + ], + 'required' => true, + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F561E093-43D8-563E-8B96-34CC654BA2CB', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F561E093-43D8-563E-8B96-34CC654BA2CB\\"\\n}","type":"json"}]', + 'title' => '进行对话流-保存草稿的操作', + 'summary' => '调用UpdateDialogFlow接口进行对话流-保存草稿的操作。', + ], + 'DescribeDialogFlow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '49966', + ], + ], + [ + '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' => [ + 'Status' => [ + 'description' => '0 for deleted, 1 for inSandbox, 2 for draft，3 for online', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ModifyTime' => [ + 'description' => '修改时间戳', + 'type' => 'string', + 'example' => '1641953931', + ], + 'AccountId' => [ + 'description' => '租户ID', + 'type' => 'string', + 'example' => '133208', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6419BA93-D111-5225-8998-13E63E6D3940', + ], + 'InstanceId' => [ + 'description' => '机器⼈唯⼀标识', + 'type' => 'string', + 'example' => 'chatbot-cn-Yvy7uEn7mb', + ], + 'ModuleName' => [ + 'description' => '对话流名称', + 'type' => 'string', + 'example' => '示例_查天气', + ], + 'CreateTime' => [ + 'description' => '创建时间戳', + 'type' => 'string', + 'example' => '1641953931', + ], + 'CreateUserId' => [ + 'description' => '创建人账号ID', + 'type' => 'string', + 'example' => '1760998', + ], + 'Templates' => [ + 'description' => '对话流引用的模板', + 'type' => 'string', + 'example' => '模板信息', + ], + 'DialogId' => [ + 'description' => '对话流ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '49966', + ], + 'GlobalVars' => [ + 'description' => '对话流变量', + 'type' => 'object', + 'example' => '{"name": "", "age": ""}', + ], + 'CreateUserName' => [ + 'description' => '创建人账号名称', + 'type' => 'string', + 'example' => 'user001', + ], + 'ModuleId' => [ + 'description' => '对话流画布ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '49162', + ], + 'ModuleDefinition' => [ + 'description' => '画布详细定义JSON', + 'example' => 'json字符串', + '$ref' => '#/components/schemas/PaasProcessData', + ], + 'DialogName' => [ + 'description' => '对话流名称', + 'type' => 'string', + 'example' => '示例_查天气', + ], + 'ModifyUserId' => [ + 'description' => '修改人账号ID', + 'type' => 'string', + 'example' => '1760998', + ], + 'ModifyUserName' => [ + 'description' => '修改人账号名称', + 'type' => 'string', + 'example' => 'user001', + ], + 'Tags' => [ + 'description' => 'null', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": 1,\\n \\"ModifyTime\\": \\"1641953931\\",\\n \\"AccountId\\": \\"133208\\",\\n \\"RequestId\\": \\"6419BA93-D111-5225-8998-13E63E6D3940\\",\\n \\"InstanceId\\": \\"chatbot-cn-Yvy7uEn7mb\\",\\n \\"ModuleName\\": \\"示例_查天气\\",\\n \\"CreateTime\\": \\"1641953931\\",\\n \\"CreateUserId\\": \\"1760998\\",\\n \\"Templates\\": \\"模板信息\\",\\n \\"DialogId\\": 49966,\\n \\"GlobalVars\\": {\\n \\"name\\": \\"\\",\\n \\"age\\": \\"\\"\\n },\\n \\"CreateUserName\\": \\"user001\\",\\n \\"ModuleId\\": 49162,\\n \\"ModuleDefinition\\": {\\n \\"Nodes\\": [\\n {\\n \\"Code\\": \\"\\",\\n \\"Id\\": \\"\\",\\n \\"Label\\": \\"\\",\\n \\"Xx\\": 0,\\n \\"Yy\\": 0,\\n \\"PluginData\\": {\\n \\"Entry\\": {\\n \\"PluginFieldDataEntry\\": {\\n \\"ContentEntry\\": [\\n {\\n \\"ConditionEntries\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Term\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"LifeSpan\\": 0,\\n \\"Name\\": \\"\\"\\n }\\n },\\n \\"Slot\\": {\\n \\"PluginFieldDataSlot\\": {\\n \\"IntentName\\": \\"\\",\\n \\"IntentId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"IsSysIntent\\": true,\\n \\"ContentSlot\\": [\\n {\\n \\"IsArray\\": true,\\n \\"IsNecessary\\": true,\\n \\"Value\\": \\"\\",\\n \\"LifeSpan\\": 0,\\n \\"Name\\": \\"\\",\\n \\"Question\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n },\\n \\"Response\\": {\\n \\"PluginFieldDataResponse\\": {\\n \\"Name\\": \\"\\",\\n \\"ContentResponse\\": {\\n \\"Type\\": \\"\\",\\n \\"Text\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"ButtonList\\": {\\n \\"Button\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Text\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Intro\\": \\"\\"\\n }\\n }\\n }\\n },\\n \\"Function\\": {\\n \\"PluginFieldDataFunction\\": {\\n \\"Function\\": \\"\\",\\n \\"AliyunFunction\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"EndPoint\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"AliyunService\\": \\"\\",\\n \\"Switch\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Label\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Value\\": \\"\\",\\n \\"VariableName\\": \\"\\"\\n }\\n ],\\n \\"Params\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n }\\n }\\n }\\n ],\\n \\"Edges\\": [\\n {\\n \\"Target\\": \\"\\",\\n \\"Id\\": \\"\\",\\n \\"Source\\": \\"\\",\\n \\"Label\\": \\"\\"\\n }\\n ]\\n },\\n \\"DialogName\\": \\"示例_查天气\\",\\n \\"ModifyUserId\\": \\"1760998\\",\\n \\"ModifyUserName\\": \\"user001\\",\\n \\"Tags\\": \\"default\\"\\n}","type":"json"}]', + 'title' => '获得会话流详情', + 'summary' => '调用DescribeDialogFlow接口获得会话流详情。', + ], + 'PublishDialogFlow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '49966', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'B58AD5AF-21C8-4DB9-82E8-D445ED579EDC', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B58AD5AF-21C8-4DB9-82E8-D445ED579EDC\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B58AD5AF-21C8-4DB9-82E8-D445ED579EDC</RequestId>","errorExample":""}]', + 'title' => 'PublishDialogFlow', + 'summary' => '调用PublishDialogFlow接口发布对话流。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TestDialogFlow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1111', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '1891FFA2-8F35-4F9A-BF16-D4A6E1F58EC0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1891FFA2-8F35-4F9A-BF16-D4A6E1F58EC0\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1891FFA2-8F35-4F9A-BF16-D4A6E1F58EC0</RequestId>","errorExample":""}]', + 'title' => 'TestDialogFlow', + 'summary' => '调用TestDialogFlow接口测试对话流。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateIntent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IntentDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '单个意图的详细定义数据，包括：意图名称、意图话术及划词、LGF、槽位列表', + 'required' => true, + '$ref' => '#/components/schemas/IntentCreateDTO', + ], + ], + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50099', + ], + ], + [ + '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' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32', + ], + 'IntentId' => [ + 'description' => '意图 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '58985', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8AD9FA10-7780-5E12-B701-13C928524F32\\",\\n \\"IntentId\\": 58985\\n}","type":"json"}]', + 'title' => '创建意图', + 'summary' => '调用CreateIntent接口创建意图。', + ], + 'DeleteIntent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => '意图ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '126558', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '6658EB01-A68C-4041-93ED-CD3F9C887A19', + ], + 'IntentId' => [ + 'description' => '意图ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '126558', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6658EB01-A68C-4041-93ED-CD3F9C887A19\\",\\n \\"IntentId\\": 126558\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6658EB01-A68C-4041-93ED-CD3F9C887A19</RequestId>\\n<IntentId>126558</IntentId>","errorExample":""}]', + 'title' => 'DeleteIntent', + 'summary' => '调用DeleteIntent接口删除意图。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateIntent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IntentDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '单个意图的详细定义数据，包括：意图名称、意图话术及划词、LGF、槽位列表', + 'required' => true, + '$ref' => '#/components/schemas/IntentCreateDTO', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => '意图ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '59055', + ], + ], + [ + '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' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D641EA5C-0638-53A2-A1E4-67A9B5C92100', + ], + 'IntentId' => [ + 'description' => '意图 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '59055', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D641EA5C-0638-53A2-A1E4-67A9B5C92100\\",\\n \\"IntentId\\": 59055\\n}","type":"json"}]', + 'title' => '进行意图修改', + 'summary' => '调用UpdateIntent接口进行意图修改。', + ], + 'QueryIntents' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IntentName', + 'in' => 'query', + 'schema' => [ + 'description' => '意图名称', + 'type' => 'string', + 'required' => false, + 'example' => '汽车贴膜', + ], + ], + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50099', + ], + ], + [ + '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', + ], + ], + [ + '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' => false, + 'example' => 'chatbot-cn-v0h17ngxu00016', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A1C54450-F19B-4883-90E3-FDB686BF0381', + ], + 'PageSize' => [ + 'description' => '分⻚-⻚⾯⼤⼩', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '分⻚-第⼏⻚', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Intents' => [ + 'description' => '意图信息列表（JSON字符串）', + 'type' => 'array', + 'items' => [ + 'description' => '意图信息列表（json格式）', + 'type' => 'object', + 'properties' => [ + 'ModifyUserId' => [ + 'description' => '修改者id', + 'type' => 'string', + 'example' => '83325', + ], + 'ModifyUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-11-30T03:03:37Z', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'Slot' => [ + 'description' => '意图槽位信息', + 'type' => 'array', + 'items' => [ + 'description' => '意图槽位信息', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '槽位划词结果', + 'type' => 'string', + 'example' => '@喜欢的颜色', + ], + 'LifeSpan' => [ + 'description' => '槽位⽣命周期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SlotId' => [ + 'description' => '槽位唯⼀标识', + 'type' => 'string', + 'example' => '9ec31b50-32b8-11eb-9478-19d2d885afdb', + ], + 'IsNecessary' => [ + 'description' => '是否必填槽：true：是；false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsArray' => [ + 'description' => '是否数组：true：是；false：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Tags' => [ + 'description' => '槽位划词标签', + 'type' => 'array', + 'items' => [ + 'description' => '槽位划词标签', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签对应意图表述划词结果', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + 'UserSayId' => [ + 'description' => '标签对应意图表述唯⼀标识', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + ], + ], + 'Question' => [ + 'description' => '槽位反问话术', + 'type' => 'array', + 'items' => [ + 'description' => '槽位反问话术', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + 'Name' => [ + 'description' => '槽位名称', + 'type' => 'string', + 'example' => '颜色', + ], + ], + ], + ], + 'UserSay' => [ + 'description' => '意图表述', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '意图表述(被划词切分后结果)', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SlotId' => [ + 'description' => '槽位唯⼀标识', + 'type' => 'string', + 'example' => '9ec31b50-32b8-11eb-9478-19d2d885afdb', + ], + 'Text' => [ + 'description' => '表述', + 'type' => 'string', + 'example' => '我想给汽车贴膜', + ], + ], + ], + ], + 'UserSayId' => [ + 'description' => '表述唯⼀标识', + 'type' => 'string', + 'example' => '853d7220-32b8-11eb-9478-19d2d885afdb', + ], + 'Strict' => [ + 'description' => '是否严格匹配：true：是；false：否', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'Name' => [ + 'description' => '意图名称', + 'type' => 'string', + 'example' => '汽车贴膜', + ], + 'RuleCheck' => [ + 'description' => 'LGF意图表述表达式', + 'type' => 'array', + 'items' => [ + 'description' => 'lgf意图表述表达式', + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'description' => 'job失败信息', + 'type' => 'array', + 'items' => [ + 'description' => '错误提示', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + 'Warning' => [ + 'description' => '异常提示', + 'type' => 'array', + 'items' => [ + 'description' => '异常提示', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + 'Text' => [ + 'description' => '表达式值', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + 'Strict' => [ + 'description' => '是否严格匹配：true：是；false：否', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'CreateUserId' => [ + 'description' => '创建者id', + 'type' => 'string', + 'example' => '83225', + ], + 'IntentId' => [ + 'description' => '意图Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '126558', + ], + 'ModifyTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-11-30T03:03:37Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"A1C54450-F19B-4883-90E3-FDB686BF0381\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Intents\\": [\\n {\\n \\"ModifyUserId\\": \\"83325\\",\\n \\"ModifyUserName\\": \\"null\\",\\n \\"CreateTime\\": \\"2020-11-30T03:03:37Z\\",\\n \\"CreateUserName\\": \\"null\\",\\n \\"Slot\\": [\\n {\\n \\"Value\\": \\"@喜欢的颜色\\",\\n \\"LifeSpan\\": 0,\\n \\"SlotId\\": \\"9ec31b50-32b8-11eb-9478-19d2d885afdb\\",\\n \\"IsNecessary\\": true,\\n \\"IsArray\\": false,\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"参考JSON示例\\",\\n \\"UserSayId\\": \\"参考JSON示例\\"\\n }\\n ],\\n \\"Question\\": [\\n \\"参考JSON示例\\"\\n ],\\n \\"Name\\": \\"颜色\\"\\n }\\n ],\\n \\"UserSay\\": [\\n {\\n \\"Data\\": [\\n {\\n \\"SlotId\\": \\"9ec31b50-32b8-11eb-9478-19d2d885afdb\\",\\n \\"Text\\": \\"我想给汽车贴膜\\"\\n }\\n ],\\n \\"UserSayId\\": \\"853d7220-32b8-11eb-9478-19d2d885afdb\\",\\n \\"Strict\\": false\\n }\\n ],\\n \\"Name\\": \\"汽车贴膜\\",\\n \\"RuleCheck\\": [\\n {\\n \\"Error\\": [\\n \\"参考JSON示例\\"\\n ],\\n \\"Warning\\": [\\n \\"参考JSON示例\\"\\n ],\\n \\"Text\\": \\"参考JSON示例\\",\\n \\"Strict\\": false\\n }\\n ],\\n \\"CreateUserId\\": \\"83225\\",\\n \\"IntentId\\": 126558,\\n \\"ModifyTime\\": \\"2020-11-30T03:03:37Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>2</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>A1C54450-F19B-4883-90E3-FDB686BF0381</RequestId>\\n<PageNumber>1</PageNumber>\\n<Intents>\\n <ModifyTime>2020-11-30T03:03:37Z</ModifyTime>\\n <ModifyUserId>83225</ModifyUserId>\\n <UserSay>\\n <Strict>false</Strict>\\n <UserSayId>853d7220-32b8-11eb-9478-19d2d885afdb</UserSayId>\\n <Data>\\n <Text>我想给汽车贴膜</Text>\\n </Data>\\n </UserSay>\\n <CreateTime>2020-11-30T03:03:37Z</CreateTime>\\n <ModifyUserName>null</ModifyUserName>\\n <CreateUserId>83225</CreateUserId>\\n <Slot>\\n <SlotId>9ec31b50-32b8-11eb-9478-19d2d885afdb</SlotId>\\n <IsArray>false</IsArray>\\n <IsNecessary>true</IsNecessary>\\n <Value>@喜欢的颜色</Value>\\n <LifeSpan>0</LifeSpan>\\n <Name>颜色</Name>\\n </Slot>\\n <Slot>\\n <SlotId>c57c48c0-32b8-11eb-9478-19d2d885afdb</SlotId>\\n <IsArray>false</IsArray>\\n <IsNecessary>true</IsNecessary>\\n <Value>@产地</Value>\\n <LifeSpan>0</LifeSpan>\\n <Name>产地</Name>\\n </Slot>\\n <CreateUserName>null</CreateUserName>\\n <IntentId>126558</IntentId>\\n <Name>汽车贴膜</Name>\\n</Intents>\\n<Intents>\\n <UserSay>\\n <Strict>false</Strict>\\n <UserSayId>-1</UserSayId>\\n <Data>\\n <Text>未知意图</Text>\\n </Data>\\n </UserSay>\\n <IntentId>-1</IntentId>\\n <Name>UNKNOWN</Name>\\n</Intents>","errorExample":""}]', + 'title' => 'QueryIntents', + 'summary' => '调用QueryIntents接口查询意图列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeIntent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => '意图 ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '126558', + ], + ], + [ + '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' => [ + 'ModifyTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-11-30T06:04:37Z', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '473F6889-1DE6-44A5-BA62-BD3CC7600DBF', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-11-30T03:03:37Z', + ], + 'DialogId' => [ + 'description' => '对话流id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50099', + ], + 'CreateUserId' => [ + 'description' => '创建者id', + 'type' => 'string', + 'example' => '83225', + ], + 'CreateUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'Name' => [ + 'description' => '意图名称', + 'type' => 'string', + 'example' => '汽车贴膜', + ], + 'IntentId' => [ + 'description' => '意图Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '126558', + ], + 'Type' => [ + 'description' => '类型', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + 'ModifyUserId' => [ + 'description' => '修改者id', + 'type' => 'string', + 'example' => '83225', + ], + 'UserSay' => [ + 'description' => '意图表述', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '意图表述(被划词切分后结果)', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SlotId' => [ + 'description' => '槽位唯⼀标识', + 'type' => 'string', + 'example' => '9ec31b50-32b8-11eb-9478-19d2d885afdb', + ], + 'Text' => [ + 'description' => '表达式值', + 'type' => 'string', + 'example' => '我想给汽车贴膜', + ], + ], + ], + ], + 'UserSayId' => [ + 'description' => '标签对应意图表述唯⼀标识', + 'type' => 'string', + 'example' => '853d7220-32b8-11eb-9478-19d2d885afdb', + ], + 'Strict' => [ + 'description' => '是否严格匹配：true：是；false：否', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'ModifyUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'null', + ], + 'Slot' => [ + 'description' => '意图槽位信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '槽位划词结果', + 'type' => 'string', + 'example' => '@喜欢的颜色', + ], + 'LifeSpan' => [ + 'description' => '槽位⽣命周期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SlotId' => [ + 'description' => '槽位唯⼀标识', + 'type' => 'string', + 'example' => '9ec31b50-32b8-11eb-9478-19d2d885afdb', + ], + 'IsNecessary' => [ + 'description' => '是否必填槽', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsArray' => [ + 'description' => '是否数组', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Tags' => [ + 'description' => '槽位划词标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签对应意图表述划词结果', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + 'UserSayId' => [ + 'description' => '标签对应意图表述唯⼀标识', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + ], + ], + 'Question' => [ + 'type' => 'array', + 'items' => [ + 'description' => '槽位反问话术', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + 'Name' => [ + 'description' => '槽位名称', + 'type' => 'string', + 'example' => '颜色', + ], + ], + ], + ], + 'RuleCheck' => [ + 'description' => 'LGF意图表述表达式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'type' => 'array', + 'items' => [ + 'description' => '错误提示，为空//TODO', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + 'Warning' => [ + 'type' => 'array', + 'items' => [ + 'description' => '异常提示，为空//TODO', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + ], + 'Text' => [ + 'description' => '表达式值', + 'type' => 'string', + 'example' => '参考JSON示例', + ], + 'Strict' => [ + 'description' => '是否严格匹配：true：是；false：否', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2020-11-30T06:04:37Z\\",\\n \\"RequestId\\": \\"473F6889-1DE6-44A5-BA62-BD3CC7600DBF\\",\\n \\"CreateTime\\": \\"2020-11-30T03:03:37Z\\",\\n \\"DialogId\\": 50099,\\n \\"CreateUserId\\": \\"83225\\",\\n \\"CreateUserName\\": \\"null\\",\\n \\"Name\\": \\"汽车贴膜\\",\\n \\"IntentId\\": 126558,\\n \\"Type\\": \\"参考JSON示例\\",\\n \\"ModifyUserId\\": \\"83225\\",\\n \\"UserSay\\": [\\n {\\n \\"Data\\": [\\n {\\n \\"SlotId\\": \\"9ec31b50-32b8-11eb-9478-19d2d885afdb\\",\\n \\"Text\\": \\"我想给汽车贴膜\\"\\n }\\n ],\\n \\"UserSayId\\": \\"853d7220-32b8-11eb-9478-19d2d885afdb\\",\\n \\"Strict\\": false\\n }\\n ],\\n \\"ModifyUserName\\": \\"null\\",\\n \\"Slot\\": [\\n {\\n \\"Value\\": \\"@喜欢的颜色\\",\\n \\"LifeSpan\\": 0,\\n \\"SlotId\\": \\"9ec31b50-32b8-11eb-9478-19d2d885afdb\\",\\n \\"IsNecessary\\": true,\\n \\"IsArray\\": false,\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"参考JSON示例\\",\\n \\"UserSayId\\": \\"参考JSON示例\\"\\n }\\n ],\\n \\"Question\\": [\\n \\"参考JSON示例\\"\\n ],\\n \\"Name\\": \\"颜色\\"\\n }\\n ],\\n \\"RuleCheck\\": [\\n {\\n \\"Error\\": [\\n \\"参考JSON示例\\"\\n ],\\n \\"Warning\\": [\\n \\"参考JSON示例\\"\\n ],\\n \\"Text\\": \\"参考JSON示例\\",\\n \\"Strict\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-30T06:04:37Z</ModifyTime>\\n<RequestId>473F6889-1DE6-44A5-BA62-BD3CC7600DBF</RequestId>\\n<CreateTime>2020-11-30T03:03:37Z</CreateTime>\\n<CreateUserId>83225</CreateUserId>\\n<DialogId>50099</DialogId>\\n<CreateUserName>null</CreateUserName>\\n<Name>汽车贴膜</Name>\\n<IntentId>126558</IntentId>\\n<ModifyUserId>83225</ModifyUserId>\\n<UserSay>\\n <Strict>false</Strict>\\n <UserSayId>853d7220-32b8-11eb-9478-19d2d885afdb</UserSayId>\\n <Data>\\n <Text>我想给汽车贴膜</Text>\\n </Data>\\n</UserSay>\\n<ModifyUserName>null</ModifyUserName>\\n<Slot>\\n <SlotId>9ec31b50-32b8-11eb-9478-19d2d885afdb</SlotId>\\n <IsArray>false</IsArray>\\n <IsNecessary>true</IsNecessary>\\n <Value>@喜欢的颜色</Value>\\n <LifeSpan>0</LifeSpan>\\n <Name>颜色</Name>\\n</Slot>\\n<Slot>\\n <SlotId>c57c48c0-32b8-11eb-9478-19d2d885afdb</SlotId>\\n <IsArray>false</IsArray>\\n <IsNecessary>true</IsNecessary>\\n <Value>@产地</Value>\\n <LifeSpan>0</LifeSpan>\\n <Name>产地</Name>\\n</Slot>","errorExample":""}]', + 'title' => 'DescribeIntent', + 'summary' => '调用DescribeIntent接口查询意图详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateBot' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'LanguageCode', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈服务的语⾔，如 zh-cn、en-us', + 'type' => 'string', + 'required' => true, + 'example' => 'zh-cn', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈名称，不超过50个字符', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Avatar', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人头像URL，公网可用，比如OSS资源URL，长度不超过1024个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'http://test.oss-cn-beijing.aliyuncs.com/test.jpg', + ], + ], + [ + 'name' => 'Introduction', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈备注，不超过50个字符', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'RobotType', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈类型，默认为：scenario_im', + 'type' => 'string', + 'required' => false, + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'CDFB7CDF-CCBF-4388-AC7D-9484DB457FFF', + ], + 'InstanceId' => [ + 'description' => '机器⼈唯⼀标识', + 'type' => 'string', + 'example' => 'chatbot-cn-7QuUfaqM', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CDFB7CDF-CCBF-4388-AC7D-9484DB457FFF\\",\\n \\"InstanceId\\": \\"chatbot-cn-7QuUfaqM\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>CDFB7CDF-CCBF-4388-AC7D-9484DB457FFF</RequestId>\\n<InstanceId>chatbot-cn-7QuUfaqMQe</InstanceId>","errorExample":""}]', + 'title' => 'CreateBot', + 'summary' => '调用CreateBot创建机器⼈。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteBot' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人ID', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-xxxxxxx', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A</RequestId>","errorExample":""}]', + 'title' => 'DeleteBot', + 'summary' => '调用DeleteBot接口删除机器人。', + ], + 'DescribeBot' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈ID', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqM', + ], + ], + [ + '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' => [ + 'LanguageCode' => [ + 'description' => '机器⼈服务的语⾔，如zh-cn、 en-us', + 'type' => 'string', + 'example' => 'zh-cn', + ], + 'TimeZone' => [ + 'description' => '机器⼈的时区，参考《公共-时区码》', + 'type' => 'string', + 'example' => 'Asia/Beijing', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'BF736BAB-5AC0-4092-82A9-85475D39D1', + ], + 'Introduction' => [ + 'description' => '机器⼈备注', + 'type' => 'string', + 'example' => '测试用的', + ], + 'InstanceId' => [ + 'description' => '公有云问答API，机器⼈唯⼀标识', + 'type' => 'string', + 'example' => 'chatbot-cn-7QuUfaqM', + ], + 'Categories' => [ + 'description' => '类⽬列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '类⽬id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2100073048', + ], + 'Name' => [ + 'description' => '类⽬名称', + 'type' => 'string', + 'example' => 'test', + ], + 'ParentCategoryId' => [ + 'description' => '父类目id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '机器⼈创建的 UTC 时间', + 'type' => 'string', + 'example' => '2020-11-29T06:50:46Z', + ], + 'Avatar' => [ + 'description' => '机器⼈头像的URL', + 'type' => 'string', + 'example' => 'http://test.oss-cn-beijing.aliyuncs.com/test.jpg', + ], + 'Logo' => [ + 'description' => '返回值已下线，保持接口兼容因此字段保留', + 'type' => 'string', + 'example' => '返回值已下线，保持接口兼容因此字段保留', + ], + 'Name' => [ + 'description' => '机器⼈名称', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"TimeZone\\": \\"Asia/Beijing\\",\\n \\"RequestId\\": \\"BF736BAB-5AC0-4092-82A9-85475D39D1\\",\\n \\"Introduction\\": \\"测试用的\\",\\n \\"InstanceId\\": \\"chatbot-cn-7QuUfaqM\\",\\n \\"Categories\\": [\\n {\\n \\"CategoryId\\": 2100073048,\\n \\"Name\\": \\"test\\",\\n \\"ParentCategoryId\\": -1\\n }\\n ],\\n \\"CreateTime\\": \\"2020-11-29T06:50:46Z\\",\\n \\"Avatar\\": \\"http://test.oss-cn-beijing.aliyuncs.com/test.jpg\\",\\n \\"Logo\\": \\"返回值已下线，保持接口兼容因此字段保留\\",\\n \\"Name\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"<LanguageCode>zh-cn</LanguageCode>\\n<TimeZone>Asia/Beijing</TimeZone>\\n<RequestId>BF736BAB-5AC0-4092-82A9-85475D6F39D1</RequestId>\\n<InstanceId>chatbot-cn-7QuUfaqMQe</InstanceId>\\n<Introduction>测试用的</Introduction>\\n<Categories>\\n <CategoryId>2100073048</CategoryId>\\n <ParentCategoryId>-1</ParentCategoryId>\\n <Name>test</Name>\\n</Categories>\\n<CreateTime>2020-11-29T06:50:46Z</CreateTime>\\n<Avatar>C:\\\\Users\\\\ypfyu\\\\Pictures</Avatar>\\n<Name>test</Name>","errorExample":""}]', + 'title' => 'DescribeBot', + 'summary' => '调用DescribeBot获取机器⼈详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryBots' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + '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' => [ + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Bots' => [ + 'description' => '机器⼈列表信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Introduction' => [ + 'description' => '机器⼈备注', + 'type' => 'string', + 'example' => '测试用的', + ], + 'Avatar' => [ + 'description' => '机器⼈头像的URL', + 'type' => 'string', + 'example' => 'C:\\\\Users\\\\ypfyu\\\\Pictures', + ], + 'TimeZone' => [ + 'description' => '机器⼈的时区，参考《公共-时区码》', + 'type' => 'string', + 'example' => 'Asia/Beijing', + ], + 'CreateTime' => [ + 'description' => '机器⼈创建的 UTC 时间', + 'type' => 'string', + 'example' => '2020-11-29T06:50:46Z', + ], + 'LanguageCode' => [ + 'description' => '机器⼈服务的语⾔，如zh-cn、 en-us', + 'type' => 'string', + 'example' => 'zh-cn', + ], + 'InstanceId' => [ + 'description' => '公有云问答API，机器⼈唯⼀标识', + 'type' => 'string', + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + 'Name' => [ + 'description' => '机器⼈名称', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '6FAC33F5-F76A-476C-9FEF-5838F869BD4B', + ], + 'PageSize' => [ + 'description' => '分⻚-⻚⾯⼤⼩', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '分⻚-第⼏⻚', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"Bots\\": [\\n {\\n \\"Introduction\\": \\"测试用的\\",\\n \\"Avatar\\": \\"C:\\\\\\\\\\\\\\\\Users\\\\\\\\\\\\\\\\ypfyu\\\\\\\\\\\\\\\\Pictures\\",\\n \\"TimeZone\\": \\"Asia/Beijing\\",\\n \\"CreateTime\\": \\"2020-11-29T06:50:46Z\\",\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"InstanceId\\": \\"chatbot-cn-7QuUfaqMQe\\",\\n \\"Name\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"6FAC33F5-F76A-476C-9FEF-5838F869BD4B\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<Bots>\\n <LanguageCode>zh-cn</LanguageCode>\\n <TimeZone>Asia/Beijing</TimeZone>\\n <Introduction>测试用的</Introduction>\\n <InstanceId>chatbot-cn-7QuUfaqMQe</InstanceId>\\n <CreateTime>2020-11-29T06:50:46Z</CreateTime>\\n <Avatar>C:\\\\Users\\\\ypfyu\\\\Pictures</Avatar>\\n <Name>test</Name>\\n</Bots>\\n<RequestId>6FAC33F5-F76A-476C-9FEF-5838F869BD4B</RequestId>\\n<PageSize>10</PageSize>\\n<PageNumber>1</PageNumber>","errorExample":""}]', + 'title' => 'QueryBots', + 'summary' => '调用QueryBots获取机器⼈列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListConversationLogs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID，⽤于标识⼀个访问者 的会话和保持上下⽂信息。对'."\n" + .'于⼀个新的访问者，⾸次调⽤ Chat接⼝时⽆需传递此字段， 机器⼈会开启⼀个会话，并在 Chat接⼝的响应中返回该会话 的SessionId。对于该访问者的 后续轮次的会话，调⽤Chat接'."\n" + .'⼝时传递当前会话的 SessionId，机器⼈即可基于 SessionId继续该轮次会话。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c1187530338311ebade7cf3eaeb3668a', + ], + ], + [ + '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' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'B6082275-D0E3-4030-9478-FFC35BA90312', + ], + 'ChatLogs' => [ + 'description' => '详细对话列表', + 'type' => 'array', + 'items' => [ + 'description' => '详细对话列表', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + 'Rounds' => [ + 'description' => '对话交互轮数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B6082275-D0E3-4030-9478-FFC35BA90312\\",\\n \\"ChatLogs\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"Rounds\\": 1\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B6082275-D0E3-4030-9478-FFC35BA90312</RequestId>\\n<ChatLogs>\\n <Type>NO_ANSWER</Type>\\n <UserQuery>查天气</UserQuery>\\n <Date>2020-12-01 11:17:38</Date>\\n <ChatId>16dd397889424c089cfe648e34b3981f</ChatId>\\n</ChatLogs>\\n<Rounds>1</Rounds>","errorExample":""}]', + 'title' => 'ListConversationLogs ', + 'summary' => '调用ListConversationLogs获取会话详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Log**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| Date | String | 对话时间 |'."\n" + .'| UserQuery | String | ⽤户原始问题 |'."\n" + .'| Response | String | 机器⼈回复 |'."\n" + .'| Type | String | 五种：Knowledge / Recommend / DialogStudio / NoAnswer |'."\n" + .'| Knowledge | Knowledge | 具体知识 |'."\n" + .'| Recommends | Array of Knowledge | 推荐知识列表 |'."\n" + .'| DialogStudio | DialogStudio | 对话⼯⼚ |'."\n" + ."\n" + .'**Knowledge**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| KnowledgeId | String | 知识id |'."\n" + .'| KnowledgeName | String | 知识名称 |'."\n" + ."\n" + .'**DialogStudio**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| DialogName | String | 对话流名称 |'."\n" + .'| DialogNodeName | String | 对话流节点名称 |'."\n" + .'| IntentName | String | 意图名称 |', + 'extraInfo' => ' ', + ], + 'ListBotChatHistorys' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，时间格式为yyyyMMdd或yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => true, + 'example' => '20201108，2023-10-01 12:30:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，时间格式为yyyyMMdd或yyyy-MM-dd HH:mm:ss，格式需要和StartTime保持一致', + 'type' => 'string', + 'required' => true, + 'example' => '20201207，2023-10-01 12:35:00', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '数据条数,默认30条', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + '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' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '146', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '897F3CD0-99CA-4879-BA1D-989C817FDF9E', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"146\\",\\n \\"RequestId\\": \\"897F3CD0-99CA-4879-BA1D-989C817FDF9E\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>146</CostTime>\\n<RequestId>897F3CD0-99CA-4879-BA1D-989C817FDF9E</RequestId>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeTitle>\\n <SessionUuid>62d934c0383b11eb879e4f3e4091cf78</SessionUuid>\\n <ChatUuid>c911f526942c4a85973e13288ddacbcc</ChatUuid>\\n <AnswerSource>知识</AnswerSource>\\n <QueryTime>2020-12-07 11:22:45</QueryTime>\\n <Question>本地测试结果不好怎么办</Question>\\n <KnowledgeContent>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeContent>\\n <KnowledgeId>1002994742#1002994742</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeTitle>\\n <SessionUuid>4948b620383b11eb879e4f3e4091cf78</SessionUuid>\\n <ChatUuid>ba275f89d8644625a9f715b7f5372cf9</ChatUuid>\\n <AnswerSource>知识</AnswerSource>\\n <QueryTime>2020-12-07 11:21:50</QueryTime>\\n <Question>本地测试结果不好怎么办</Question>\\n <KnowledgeContent>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeContent>\\n <KnowledgeId>1002994742#1002994742</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeTitle>\\n <SessionUuid>280c1b00383b11eb879e4f3e4091cf78</SessionUuid>\\n <ChatUuid>07445104ce3c42d59e78c98b6c219a3d</ChatUuid>\\n <AnswerSource>知识</AnswerSource>\\n <QueryTime>2020-12-07 11:21:16</QueryTime>\\n <Question>本地测试结果不好怎么办</Question>\\n <KnowledgeContent>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeContent>\\n <KnowledgeId>1002994742#1002994742</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeTitle>\\n <SessionUuid>280c1b00383b11eb879e4f3e4091cf78</SessionUuid>\\n <ChatUuid>d9517aa8965c42d3a2242aaf9091bcc3</ChatUuid>\\n <AnswerSource>知识</AnswerSource>\\n <QueryTime>2020-12-07 11:20:57</QueryTime>\\n <Question>本地测试结果不好怎么办</Question>\\n <KnowledgeContent>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeContent>\\n <KnowledgeId>1002994742#1002994742</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeTitle>\\n <SessionUuid>280c1b00383b11eb879e4f3e4091cf78</SessionUuid>\\n <ChatUuid>0687096612c14de3b7d07bb7736d5cbd</ChatUuid>\\n <AnswerSource>知识</AnswerSource>\\n <QueryTime>2020-12-07 11:20:34</QueryTime>\\n <Question>本地测试结果不好怎么办</Question>\\n <KnowledgeContent>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeContent>\\n <KnowledgeId>1002994742#1002994742</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeTitle>\\n <SessionUuid>0f95bef0383b11eb879e4f3e4091cf78</SessionUuid>\\n <ChatUuid>98b9ff25dd214a7e806069ab584bb45d</ChatUuid>\\n <AnswerSource>知识</AnswerSource>\\n <QueryTime>2020-12-07 11:20:06</QueryTime>\\n <Question>本地测试结果不好怎么办</Question>\\n <KnowledgeContent>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeContent>\\n <KnowledgeId>1002994742#1002994742</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeTitle>\\n <SessionUuid>6ee5c630383011eb879e4f3e4091cf78</SessionUuid>\\n <ChatUuid>afe3464a860e432db5a7821fe18a5cd0</ChatUuid>\\n <AnswerSource>知识</AnswerSource>\\n <QueryTime>2020-12-07 11:17:12</QueryTime>\\n <Question>本地测试结果不好怎么办</Question>\\n <KnowledgeContent>本地测试结果不好怎么办#本地测试结果不好怎么办</KnowledgeContent>\\n <KnowledgeId>1002994742#1002994742</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>给宝宝喝哦</KnowledgeTitle>\\n <SessionUuid>52730730361711eb8c708599d06a6268</SessionUuid>\\n <ChatUuid>9effd7b80fad49d39cc0cee0670ce3e1</ChatUuid>\\n <AnswerSource>系统语聊</AnswerSource>\\n <QueryTime>2020-12-04 18:02:08</QueryTime>\\n <Question>娃哈哈</Question>\\n <KnowledgeContent>给宝宝喝哦</KnowledgeContent>\\n <KnowledgeId>null</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>好的，我已收集到您这边期望购车信息：您想购买的汽车是的宝马,您的期望报价是万元</KnowledgeTitle>\\n <SessionUuid>52730730361711eb8c708599d06a6268</SessionUuid>\\n <ChatUuid>1d6b472eb34d40be918f259042e3ad2e</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 18:02:01</QueryTime>\\n <Question>宝马</Question>\\n <KnowledgeContent>好的，我已收集到您这边期望购车信息：您想购买的汽车是的宝马,您的期望报价是万元</KnowledgeContent>\\n <KnowledgeId>127953</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请问您喜欢什么牌子的车</KnowledgeTitle>\\n <SessionUuid>52730730361711eb8c708599d06a6268</SessionUuid>\\n <ChatUuid>b85aa4abc87c49c1ba769c36ae2b3070</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 18:01:58</QueryTime>\\n <Question>4</Question>\\n <KnowledgeContent>请问您喜欢什么牌子的车</KnowledgeContent>\\n <KnowledgeId>127953</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>抱歉，没有查询到天津相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeTitle>\\n <SessionUuid>bc484620360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>efd6bb32a73546cda2f9e121fafd1b27</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:51:32</QueryTime>\\n <Question>天津</Question>\\n <KnowledgeContent>抱歉，没有查询到天津相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeContent>\\n <KnowledgeId>128746</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>抱歉，没有查询到上海相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeTitle>\\n <SessionUuid>bc484620360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>71f586e888ff41ac82f585202aebcffd</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:51:25</QueryTime>\\n <Question>上海</Question>\\n <KnowledgeContent>抱歉，没有查询到上海相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeContent>\\n <KnowledgeId>128746</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>抱歉，没有查询到北京西站相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeTitle>\\n <SessionUuid>bc484620360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>a76fa45e95844c1b94802adcefa2bc17</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:51:17</QueryTime>\\n <Question>北京西站</Question>\\n <KnowledgeContent>抱歉，没有查询到北京西站相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeContent>\\n <KnowledgeId>128746</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入需要查询的路况地址，如：南昌绕城高速</KnowledgeTitle>\\n <SessionUuid>bc484620360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>a1e83bb552a84fea8cc27c92a22281d4</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:51:13</QueryTime>\\n <Question>北京</Question>\\n <KnowledgeContent>请输入需要查询的路况地址，如：南昌绕城高速</KnowledgeContent>\\n <KnowledgeId>128747</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入需要查询的城市，如：南昌</KnowledgeTitle>\\n <SessionUuid>bc484620360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>2dda21a37b514ebfabc45c4eb1ce3aea</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:51:10</QueryTime>\\n <Question>查路况</Question>\\n <KnowledgeContent>请输入需要查询的城市，如：南昌</KnowledgeContent>\\n <KnowledgeId>128748</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>天津晴，西风2级，气温3℃，体感温度3℃，相对湿度22%。</KnowledgeTitle>\\n <SessionUuid>7b38b200360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>32e67c38c152488da3fa0cfe592310e0</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:49:24</QueryTime>\\n <Question>天津</Question>\\n <KnowledgeContent>天津晴，西风2级，气温3℃，体感温度3℃，相对湿度22%。</KnowledgeContent>\\n <KnowledgeId>128681</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>抱歉，没有查询到北京西站相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeTitle>\\n <SessionUuid>7b38b200360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>5b008d906b6445278f96f48a474ef20d</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:49:15</QueryTime>\\n <Question>北京西站</Question>\\n <KnowledgeContent>抱歉，没有查询到北京西站相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeContent>\\n <KnowledgeId>128746</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入需要查询的路况地址，如：南昌绕城高速</KnowledgeTitle>\\n <SessionUuid>7b38b200360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>c05c9baaaedc47478c33c7011efdb3ff</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:49:11</QueryTime>\\n <Question>北京</Question>\\n <KnowledgeContent>请输入需要查询的路况地址，如：南昌绕城高速</KnowledgeContent>\\n <KnowledgeId>128747</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入需要查询的城市，如：南昌</KnowledgeTitle>\\n <SessionUuid>7b38b200360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>0a86f7592da248fca3250afa4bdfb256</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:49:06</QueryTime>\\n <Question>查路况</Question>\\n <KnowledgeContent>请输入需要查询的城市，如：南昌</KnowledgeContent>\\n <KnowledgeId>128748</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>北京晴，西北风2级，气温3℃，体感温度2℃，相对湿度21%。</KnowledgeTitle>\\n <SessionUuid>031da000360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>60a2170831224ca390568d5d11d31086</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:47:56</QueryTime>\\n <Question>北京</Question>\\n <KnowledgeContent>北京晴，西北风2级，气温3℃，体感温度2℃，相对湿度21%。</KnowledgeContent>\\n <KnowledgeId>128681</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入要查询的城市，如：北京</KnowledgeTitle>\\n <SessionUuid>031da000360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>12fed48053d846398323c5c879918b79</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:47:44</QueryTime>\\n <Question>查天气</Question>\\n <KnowledgeContent>请输入要查询的城市，如：北京</KnowledgeContent>\\n <KnowledgeId>128681</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>抱歉，没有查询到北京西站相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeTitle>\\n <SessionUuid>031da000360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>c9ca92bf721c41689c67919dacf95907</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:47:35</QueryTime>\\n <Question>北京西站</Question>\\n <KnowledgeContent>抱歉，没有查询到北京西站相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeContent>\\n <KnowledgeId>128746</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入需要查询的路况地址，如：南昌绕城高速</KnowledgeTitle>\\n <SessionUuid>031da000360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>16db2a778f8943849580c6a2cd821f6b</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:47:31</QueryTime>\\n <Question>北京</Question>\\n <KnowledgeContent>请输入需要查询的路况地址，如：南昌绕城高速</KnowledgeContent>\\n <KnowledgeId>128747</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入需要查询的城市，如：南昌</KnowledgeTitle>\\n <SessionUuid>031da000360d11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>9692f2298fb5454ab3cb2be680a14c58</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:47:28</QueryTime>\\n <Question>查路况</Question>\\n <KnowledgeContent>请输入需要查询的城市，如：南昌</KnowledgeContent>\\n <KnowledgeId>128748</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>抱歉，没有查询到查天气相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeTitle>\\n <SessionUuid>07dc40e0360a11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>bcdff13ce54a4efd9ee2c943feeb077e</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:44:37</QueryTime>\\n <Question>查天气</Question>\\n <KnowledgeContent>抱歉，没有查询到查天气相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeContent>\\n <KnowledgeId>128746</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>抱歉，没有查询到北京西站相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeTitle>\\n <SessionUuid>07dc40e0360a11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>921f7ac4059d4f95be4729510a403038</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:44:32</QueryTime>\\n <Question>北京西站</Question>\\n <KnowledgeContent>抱歉，没有查询到北京西站相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeContent>\\n <KnowledgeId>128746</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入需要查询的路况地址，如：南昌绕城高速</KnowledgeTitle>\\n <SessionUuid>07dc40e0360a11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>eb702e44b9ef4996a577fdd3cf4636e3</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:44:28</QueryTime>\\n <Question>北京</Question>\\n <KnowledgeContent>请输入需要查询的路况地址，如：南昌绕城高速</KnowledgeContent>\\n <KnowledgeId>128747</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入需要查询的城市，如：南昌</KnowledgeTitle>\\n <SessionUuid>07dc40e0360a11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>ae9b95b125024ad49bf5b1c829146bf4</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:44:24</QueryTime>\\n <Question>查路况</Question>\\n <KnowledgeContent>请输入需要查询的城市，如：南昌</KnowledgeContent>\\n <KnowledgeId>128748</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>抱歉，没有查询到北京相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeTitle>\\n <SessionUuid>07dc40e0360a11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>6ab72ae7d09a409796caaa0c84fbe608</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:40:52</QueryTime>\\n <Question>北京</Question>\\n <KnowledgeContent>抱歉，没有查询到北京相关路况信息。如需查询其他路况信息，请输入【查路况】</KnowledgeContent>\\n <KnowledgeId>128746</KnowledgeId>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>请输入要查询的城市，如：北京</KnowledgeTitle>\\n <SessionUuid>07dc40e0360a11eb992f1908405f44bc</SessionUuid>\\n <ChatUuid>9341f273905b422b81f77e68d0f377c6</ChatUuid>\\n <AnswerSource>对话工厂</AnswerSource>\\n <QueryTime>2020-12-04 16:40:44</QueryTime>\\n <Question>查天气</Question>\\n <KnowledgeContent>请输入要查询的城市，如：北京</KnowledgeContent>\\n <KnowledgeId>128681</KnowledgeId>\\n</Datas>","errorExample":""}]', + 'title' => 'ListBotChatHistorys', + 'summary' => '调用ListBotChatHistorys接口获取数据api-会话历史明细的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**ChatHistoryDTO**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| QueryTime | String | 创建时间 |'."\n" + .'| Question | String | 问题 |'."\n" + .'| AnswerSource | String | 答案来源 |'."\n" + .'| SessionUuid | String | sessionUuid |'."\n" + .'| ChatUuid | String | ChatUuid |'."\n" + .'| KnowledgeId | String | 知识id |'."\n" + .'| KnowledgeTitle | String | 知识标题 |'."\n" + .'| KnowledgeContent | String | 知识内容 |'."\n" + ."\n", + 'extraInfo' => ' ', + ], + 'GetConversationList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例ID。登录云⼩蜜控 制台，左侧⾯板选择开发者-> 基本配置，查看机器⼈示例信 息，可获得该实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID，⽤于标识⼀个访问者 的会话和保持上下⽂信息。对'."\n" + .'于⼀个新的访问者，⾸次调⽤ Chat接⼝时⽆需传递此字段， 机器⼈会开启⼀个会话，并在 Chat接⼝的响应中返回该会话 的SessionId。对于该访问者的 后续轮次的会话，调⽤Chat接'."\n" + .'⼝时传递当前会话的 SessionId，机器⼈即可基于 SessionId继续该轮次会话', + 'type' => 'string', + 'required' => false, + 'example' => 'c1187530338311ebade7cf3eaeb3668a', + ], + ], + [ + 'name' => 'SenderId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问者ID。⽤于识别当前会话'."\n" + .'中的⽤户。', + 'type' => 'string', + 'required' => false, + 'example' => '83325', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-12-01 11:17:38', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-12-01 11:17:38', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前⻚码(默认1)。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每⻚条数(默认10),最⼤50。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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' => [ + 'Messages' => [ + 'type' => 'array', + 'items' => [ + 'description' => '会话消息的列表', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + 'example' => '参考JSON示例', + ], + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'C83D94BB-D371-4DE9-AEE2-14FE7B9CEBA9', + ], + 'PageSize' => [ + 'description' => '当前⻚⾯条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前⻚码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalCounts' => [ + 'description' => '搜索范围内总条⽬', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Messages\\": [\\n {\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"C83D94BB-D371-4DE9-AEE2-14FE7B9CEBA9\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCounts\\": 1\\n}","errorExample":""},{"type":"xml","example":"<Messages>\\n <StartDate>2020-12-01 11:17:38</StartDate>\\n <Rounds>1</Rounds>\\n <SenderId>83225</SenderId>\\n <EndDate>2020-12-01 11:17:38</EndDate>\\n <SessionId>c1187530338311ebade7cf3eaeb3668a</SessionId>\\n</Messages>\\n<PageSize>10</PageSize>\\n<RequestId>C83D94BB-D371-4DE9-AEE2-14FE7B9CEBA9</RequestId>\\n<PageNumber>1</PageNumber>\\n<TotalCounts>1</TotalCounts>","errorExample":""}]', + 'title' => 'GetConversationList', + 'summary' => '调用GetConversationList接口获取会话列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' **Message**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| SessionId| String | 会话ID |'."\n" + .'| SenderId| String | 访问者ID |'."\n" + .'| StartDate| String | 会话开始时间 |'."\n" + .'| EndDate| String | 会话结束时间 |'."\n" + .'| Rounds| Integer | 交互轮数 |', + 'extraInfo' => ' ', + ], + 'GetBotDsStatData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '70', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'C7EDACCF-0268-4C4F-B529-317F98CA9EF9', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"70\\",\\n \\"RequestId\\": \\"C7EDACCF-0268-4C4F-B529-317F98CA9EF9\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>70</CostTime>\\n<RequestId>C7EDACCF-0268-4C4F-B529-317F98CA9EF9</RequestId>\\n<Datas>\\n <HitDsRate>0.8514851485148515</HitDsRate>\\n <DsCnt>14</DsCnt>\\n <ValidDsRate>0.35714285714285715</ValidDsRate>\\n</Datas>","errorExample":""}]', + 'title' => 'GetBotDsStatData', + 'summary' => '调用GetBotDsStatData接口获取数据api-对话⼯⼚概览API。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' **DsStatDTO**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| DsCnt | int | 对话流总数 |'."\n" + .'| ValidDsRate | double| 有效对话流占⽐ |'."\n" + .'| HitDsRate | double| DS命中占⽐ |', + 'extraInfo' => ' ', + ], + 'ListBotColdDsDatas' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '数据条数,默认30条', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + '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' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '94', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A270DBA1-694D-447D-9EF9-160EADDB115E', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"94\\",\\n \\"RequestId\\": \\"A270DBA1-694D-447D-9EF9-160EADDB115E\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>94</CostTime>\\n<RequestId>A270DBA1-694D-447D-9EF9-160EADDB115E</RequestId>\\n<Datas>\\n <DialogName>测试004</DialogName>\\n</Datas>","errorExample":""}]', + 'title' => 'ListBotColdDsDatas', + 'summary' => '调用ListBotColdDsDatas接口获取数据api-对话流冷⻔榜的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**DialogDataDTO**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| DialogName | String | 对话流名称 |'."\n", + 'extraInfo' => ' ', + ], + 'ListBotDsDetails' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '数据条数,默认30条', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + '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' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '72', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '078144CD-7C10-4019-9831-09BC388AAF8C', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"72\\",\\n \\"RequestId\\": \\"078144CD-7C10-4019-9831-09BC388AAF8C\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>72</CostTime>\\n<RequestId>078144CD-7C10-4019-9831-09BC388AAF8C</RequestId>\\n<Datas>\\n <DialogChatCnt>62</DialogChatCnt>\\n <CaseCrtCnt>20</CaseCrtCnt>\\n <CaseEndCnt>17</CaseEndCnt>\\n <DialogName>查路况</DialogName>\\n <CaseEndRate>0.85</CaseEndRate>\\n <FeedbackGoodCaseRate>0.0</FeedbackGoodCaseRate>\\n <FeedbackBadCaseRate>0.0</FeedbackBadCaseRate>\\n <CaseTSRate>0.15</CaseTSRate>\\n</Datas>\\n<Datas>\\n <DialogChatCnt>6</DialogChatCnt>\\n <CaseCrtCnt>5</CaseCrtCnt>\\n <CaseEndCnt>5</CaseEndCnt>\\n <DialogName>查天气</DialogName>\\n <CaseEndRate>1.0</CaseEndRate>\\n <FeedbackGoodCaseRate>0.0</FeedbackGoodCaseRate>\\n <FeedbackBadCaseRate>0.0</FeedbackBadCaseRate>\\n <CaseTSRate>0.0</CaseTSRate>\\n</Datas>\\n<Datas>\\n <DialogChatCnt>3</DialogChatCnt>\\n <CaseCrtCnt>2</CaseCrtCnt>\\n <CaseEndCnt>1</CaseEndCnt>\\n <DialogName>测试004</DialogName>\\n <CaseEndRate>0.5</CaseEndRate>\\n <FeedbackGoodCaseRate>0.0</FeedbackGoodCaseRate>\\n <FeedbackBadCaseRate>0.0</FeedbackBadCaseRate>\\n <CaseTSRate>0.5</CaseTSRate>\\n</Datas>","errorExample":""}]', + 'title' => 'ListBotDsDetails', + 'summary' => '调用ListBotDsDetails接口获取数据api-对话流明细的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**DialogDataDTO**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| DialogName | String | 对话流名称 |'."\n" + .'| DialogChatCnt | int | 对话轮次 |'."\n" + .'| CaseCrtCnt | int | case触发量 |'."\n" + .'| CaseEndCnt | int | case完结量 |'."\n" + .'| CaseEndRate | double | 完结率 |'."\n" + .'| CaseTSRate | double | 跳失率 |'."\n" + .'| FeedbackGoodCaseRate | double | 点赞率 |'."\n" + .'| FeedbackBadCaseRate | double |点踩率 |', + 'extraInfo' => ' ', + ], + 'ListBotHotDsDatas' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + 'default' => '30', + ], + ], + [ + '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' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '171', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '736994BD-AA35-4742-88C9-E64BE4BAA14B', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"171\\",\\n \\"RequestId\\": \\"736994BD-AA35-4742-88C9-E64BE4BAA14B\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>171</CostTime>\\n<RequestId>736994BD-AA35-4742-88C9-E64BE4BAA14B</RequestId>\\n<Datas>\\n <CaseCrtCnt>20</CaseCrtCnt>\\n <DialogName>查路况</DialogName>\\n</Datas>\\n<Datas>\\n <CaseCrtCnt>5</CaseCrtCnt>\\n <DialogName>查天气</DialogName>\\n</Datas>\\n<Datas>\\n <CaseCrtCnt>2</CaseCrtCnt>\\n <DialogName>测试004</DialogName>\\n</Datas>","errorExample":""}]', + 'title' => 'ListBotHotDsDatas', + 'summary' => '调用ListBotHotDsDatas接口获取数据api-对话流热⻔榜的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' **DialogDTO**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| DialogName | String | 对话流名称 |'."\n" + .'| CaseCrtCnt | int | 触发次数 |', + 'extraInfo' => ' ', + ], + 'GetBotChatData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '66', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'AD38E52B-B64E-435D-8627-ABB374046CCC', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"66\\",\\n \\"RequestId\\": \\"AD38E52B-B64E-435D-8627-ABB374046CCC\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>66</CostTime>\\n<RequestId>AD38E52B-B64E-435D-8627-ABB374046CCC</RequestId>\\n<Datas>\\n <TextChatCnt>3</TextChatCnt>\\n <DsHitCnt>86</DsHitCnt>\\n <NoAnswerChatCnt>3</NoAnswerChatCnt>\\n <RecommendCnt>1</RecommendCnt>\\n <KnldgHitCnt>8</KnldgHitCnt>\\n</Datas>","errorExample":""}]', + 'title' => 'GetBotChatData', + 'summary' => '调用GetBotChatData接口获取数据api-机器⼈对话轮次详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**ChatStatCnt**'."\n" + .'| 字段名 | 类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| KnldgHitCnt | int | 命中知识对话量|'."\n" + .'|DsHitCnt | int | DS对话量|'."\n" + .'| TextChatCnt | int | 语聊对话量|'."\n" + .'| RecommendCnt| int | 知识推荐对话量|'."\n" + .'| NoAnswerChatCnt | int | ⽆答案对话量|', + 'extraInfo' => ' ', + ], + 'GetBotSessionData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'CostTime' => [ + 'description' => '请求消耗时间（毫秒）', + 'type' => 'string', + 'example' => '116', + ], + 'RequestId' => [ + 'description' => '请求 id', + 'type' => 'string', + 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"116\\",\\n \\"RequestId\\": \\"15CD94CC-CBEB-4189-806C-A132D1F45D51\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetBotSessionDataResponse>\\n <CostTime>106</CostTime>\\n <RequestId>81EF7283-56D9-5C3B-B999-FFD303981545</RequestId>\\n <Datas>\\n <SidCnt>6</SidCnt>\\n <SolutionSidCnt>3</SolutionSidCnt>\\n <NoAnswerRate>0.5</NoAnswerRate>\\n <ChatCnt>8</ChatCnt>\\n <NoSolutionRate>0.5</NoSolutionRate>\\n <FeedbackBadChatCnt>0</FeedbackBadChatCnt>\\n <FeedbackGoodChatCnt>0</FeedbackGoodChatCnt>\\n <FeedbackChatCnt>0</FeedbackChatCnt>\\n <AvgChatCnt>1.3333333333333333</AvgChatCnt>\\n </Datas>\\n</GetBotSessionDataResponse>","errorExample":""}]', + 'title' => 'GetBotSessionData', + 'summary' => '调用GetBotSessionData接口获取数据api-机器⼈指标数据。', + 'requestParamsDescription' => ' ', + '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类型返回的，如需转换为数字类型请按需解析', + 'extraInfo' => ' ', + ], + 'ListBotColdKnowledges' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '数据条数,默认30条', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + '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' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '83', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '1B5B71F0-FE39-466A-BC5E-187A7B6F4632', + ], + 'Datas' => [ + 'description' => '数据详情列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"83\\",\\n \\"RequestId\\": \\"1B5B71F0-FE39-466A-BC5E-187A7B6F4632\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>83</CostTime>\\n<RequestId>1B5B71F0-FE39-466A-BC5E-187A7B6F4632</RequestId>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办</KnowledgeTitle>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>电池亏电？</KnowledgeTitle>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>熬夜</KnowledgeTitle>\\n</Datas>","errorExample":""}]', + 'title' => 'ListBotColdKnowledges', + 'summary' => '调用ListBotColdKnowledges接口获取数据api-机器⼈冷⻔知识。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**KnowledgeDTO**'."\n" + .'| 字段名 | 类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| KnowledgeTitle | String | 知识名称 |', + 'extraInfo' => ' ', + ], + 'ListBotHotKnowledges' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqM', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + 'default' => '30', + ], + ], + [ + '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' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '13', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '9394952D-44A6-4AE2-8018-9E3423AAF3B7', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"13\\",\\n \\"RequestId\\": \\"9394952D-44A6-4AE2-8018-9E3423AAF3B7\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>13</CostTime>\\n<RequestId>9394952D-44A6-4AE2-8018-9E3423AAF3B7</RequestId>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办</KnowledgeTitle>\\n <KnowledgeHitNum>14</KnowledgeHitNum>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>亏电？这些保养重点要牢记！</KnowledgeTitle>\\n <KnowledgeHitNum>2</KnowledgeHitNum>\\n</Datas>","errorExample":""}]', + 'title' => 'ListBotHotKnowledges', + 'summary' => '调用ListBotHotKnowledges接口获取数据api-机器⼈热⻔知识。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**KnowledgeDTO**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| KnowledgeTitle | String | 知识名称 |'."\n" + .'| KnowledgeHitNum | int | 命中次数 |', + 'extraInfo' => ' ', + ], + 'ListBotKnowledgeDetails' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '数据条数,默认30条', + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'default' => '100', + ], + ], + [ + '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' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '78', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '1A0F7108-16AF-480C-AF54-45C11A97EAB4', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"78\\",\\n \\"RequestId\\": \\"1A0F7108-16AF-480C-AF54-45C11A97EAB4\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>78</CostTime>\\n<RequestId>1A0F7108-16AF-480C-AF54-45C11A97EAB4</RequestId>\\n<Datas>\\n <KnowledgeTitle>本地测试结果不好怎么办</KnowledgeTitle>\\n <KnowledgeHitNum>14</KnowledgeHitNum>\\n <RecommendClickRate>0.0</RecommendClickRate>\\n <KeywordsName>本地</KeywordsName>\\n <RecommendShowCnt>2</RecommendShowCnt>\\n <KnowledgeId>1002994742</KnowledgeId>\\n <CatName>测试</CatName>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>蓄电池亏电？这些保养重点要牢记！</KnowledgeTitle>\\n <KnowledgeHitNum>2</KnowledgeHitNum>\\n <RecommendClickRate>0.0</RecommendClickRate>\\n <KeywordsName>蓄电池</KeywordsName>\\n <RecommendShowCnt>0</RecommendShowCnt>\\n <KnowledgeId>1002982291</KnowledgeId>\\n <CatName>test2</CatName>\\n</Datas>\\n<Datas>\\n <KnowledgeTitle>熬夜</KnowledgeTitle>\\n <KnowledgeHitNum>0</KnowledgeHitNum>\\n <RecommendClickRate>0.0</RecommendClickRate>\\n <KeywordsName>null</KeywordsName>\\n <RecommendShowCnt>0</RecommendShowCnt>\\n <KnowledgeId>1003006429</KnowledgeId>\\n <CatName>测试2</CatName>\\n</Datas>","errorExample":""}]', + 'title' => 'ListBotKnowledgeDetails', + 'summary' => '调用ListBotKnowledgeDetails接口获取数据api-机器⼈知识明细API。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' **KnowledgeDTO**'."\n" + .'| 字段名 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| KeywordsName | String | 核⼼词 |'."\n" + .'| KnowledgeId | String | 知识ID |'."\n" + .'| KnowledgeTitle | String | 知识标题|'."\n" + .'| CatName | String | 知识类⽬ |'."\n" + .'| KnowledgeHitNum | int | 对话轮次 |'."\n" + .'| RecommendShowCnt | int | 推荐次数 |'."\n" + .'| RecommendClickRate | int | 推荐点击率 |', + 'extraInfo' => ' ', + ], + 'ListBotReceptionDetailDatas' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201108', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间,时间格式 为yyyyMMdd,⽐如 20190401', + 'type' => 'string', + 'required' => true, + 'example' => '20201207', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'CostTime' => [ + 'description' => '请求消耗时间', + 'type' => 'string', + 'example' => '77', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '1CCB889E-9837-42C9-BAEC-641169D8DF2A', + ], + 'Datas' => [ + 'type' => 'array', + 'items' => [ + 'description' => '数据详情', + 'type' => 'object', + 'example' => '参考JSON示例', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CostTime\\": \\"77\\",\\n \\"RequestId\\": \\"1CCB889E-9837-42C9-BAEC-641169D8DF2A\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CostTime>77</CostTime>\\n<RequestId>1CCB889E-9837-42C9-BAEC-641169D8DF2A</RequestId>\\n<Datas>\\n <TextChatCnt>0</TextChatCnt>\\n <SidCnt>3</SidCnt>\\n <DsHitCnt>0</DsHitCnt>\\n <SolutionSidCnt>0</SolutionSidCnt>\\n <ChatCnt>3</ChatCnt>\\n <NoAnswerChatCnt>2</NoAnswerChatCnt>\\n <RecommendCnt>1</RecommendCnt>\\n <KnldgHitCnt>0</KnldgHitCnt>\\n <Date>20201201</Date>\\n <AvgChatCnt>1.0</AvgChatCnt>\\n</Datas>\\n<Datas>\\n <TextChatCnt>0</TextChatCnt>\\n <SidCnt>0</SidCnt>\\n <DsHitCnt>0</DsHitCnt>\\n <SolutionSidCnt>0</SolutionSidCnt>\\n <ChatCnt>0</ChatCnt>\\n <NoAnswerChatCnt>0</NoAnswerChatCnt>\\n <RecommendCnt>0</RecommendCnt>\\n <KnldgHitCnt>0</KnldgHitCnt>\\n <Date>20201206</Date>\\n <AvgChatCnt>0.0</AvgChatCnt>\\n</Datas>\\n<Datas>\\n <TextChatCnt>0</TextChatCnt>\\n <SidCnt>0</SidCnt>\\n <DsHitCnt>0</DsHitCnt>\\n <SolutionSidCnt>0</SolutionSidCnt>\\n <ChatCnt>0</ChatCnt>\\n <NoAnswerChatCnt>0</NoAnswerChatCnt>\\n <RecommendCnt>0</RecommendCnt>\\n <KnldgHitCnt>0</KnldgHitCnt>\\n <Date>20201130</Date>\\n <AvgChatCnt>0.0</AvgChatCnt>\\n</Datas>\\n<Datas>\\n <TextChatCnt>0</TextChatCnt>\\n <SidCnt>5</SidCnt>\\n <DsHitCnt>0</DsHitCnt>\\n <SolutionSidCnt>5</SolutionSidCnt>\\n <ChatCnt>7</ChatCnt>\\n <NoAnswerChatCnt>0</NoAnswerChatCnt>\\n <RecommendCnt>0</RecommendCnt>\\n <KnldgHitCnt>7</KnldgHitCnt>\\n <Date>20201207</Date>\\n <AvgChatCnt>1.4</AvgChatCnt>\\n</Datas>\\n<Datas>\\n <TextChatCnt>0</TextChatCnt>\\n <SidCnt>0</SidCnt>\\n <DsHitCnt>0</DsHitCnt>\\n <SolutionSidCnt>0</SolutionSidCnt>\\n <ChatCnt>0</ChatCnt>\\n <NoAnswerChatCnt>0</NoAnswerChatCnt>\\n <RecommendCnt>0</RecommendCnt>\\n <KnldgHitCnt>0</KnldgHitCnt>\\n <Date>20201129</Date>\\n <AvgChatCnt>0.0</AvgChatCnt>\\n</Datas>\\n<Datas>\\n <TextChatCnt>3</TextChatCnt>\\n <SidCnt>11</SidCnt>\\n <DsHitCnt>67</DsHitCnt>\\n <SolutionSidCnt>11</SolutionSidCnt>\\n <ChatCnt>71</ChatCnt>\\n <NoAnswerChatCnt>0</NoAnswerChatCnt>\\n <RecommendCnt>0</RecommendCnt>\\n <KnldgHitCnt>1</KnldgHitCnt>\\n <Date>20201204</Date>\\n <AvgChatCnt>6.454545454545454</AvgChatCnt>\\n</Datas>\\n<Datas>\\n <TextChatCnt>0</TextChatCnt>\\n <SidCnt>0</SidCnt>\\n <DsHitCnt>0</DsHitCnt>\\n <SolutionSidCnt>0</SolutionSidCnt>\\n <ChatCnt>0</ChatCnt>\\n <NoAnswerChatCnt>0</NoAnswerChatCnt>\\n <RecommendCnt>0</RecommendCnt>\\n <KnldgHitCnt>0</KnldgHitCnt>\\n <Date>20201205</Date>\\n <AvgChatCnt>0.0</AvgChatCnt>\\n</Datas>\\n<Datas>\\n <TextChatCnt>0</TextChatCnt>\\n <SidCnt>6</SidCnt>\\n <DsHitCnt>18</DsHitCnt>\\n <SolutionSidCnt>5</SolutionSidCnt>\\n <ChatCnt>19</ChatCnt>\\n <NoAnswerChatCnt>1</NoAnswerChatCnt>\\n <RecommendCnt>0</RecommendCnt>\\n <KnldgHitCnt>0</KnldgHitCnt>\\n <Date>20201203</Date>\\n <AvgChatCnt>3.1666666666666665</AvgChatCnt>\\n</Datas>\\n<Datas>\\n <TextChatCnt>0</TextChatCnt>\\n <SidCnt>1</SidCnt>\\n <DsHitCnt>1</DsHitCnt>\\n <SolutionSidCnt>1</SolutionSidCnt>\\n <ChatCnt>1</ChatCnt>\\n <NoAnswerChatCnt>0</NoAnswerChatCnt>\\n <RecommendCnt>0</RecommendCnt>\\n <KnldgHitCnt>0</KnldgHitCnt>\\n <Date>20201202</Date>\\n <AvgChatCnt>1.0</AvgChatCnt>\\n</Datas>","errorExample":""}]', + 'title' => 'ListBotReceptionDetailDatas', + 'summary' => '调用ListBotReceptionDetailDatas接口获取数据api-机器⼈接待明细的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' **Knowledge**'."\n" + .'| 字段名 | 类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| Date | string |⽇期 |'."\n" + .'| SidCnt | int |接待⼈次 |'."\n" + .'| ChatCnt | int |对话请求量 |'."\n" + .'| AvgChatCnt | int |平均对话轮次|'."\n" + .'| SolutionSidCnt | int |解决接待量 |'."\n" + .'| KnldgHitCnt | int |命中知识对话量 |'."\n" + .'| DsHitCnt | int |DS对话量 |'."\n" + .'|TextChatCnt | int |语聊对话量 |'."\n" + .'| RecommendCnt | int |知识推荐对话量 |'."\n" + .'| NoAnswerChatCnt | int |⽆答案对话量 |', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'chatbot.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'chatbot.cn-hongkong.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/chatbot/2022-04-08/api-docs.php b/data/zh_cn/chatbot/2022-04-08/api-docs.php new file mode 100644 index 0000000..d2b8c9c --- /dev/null +++ b/data/zh_cn/chatbot/2022-04-08/api-docs.php @@ -0,0 +1,13420 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Chatbot', + 'version' => '2022-04-08', + ], + 'directories' => [ + [ + 'id' => 189601, + 'title' => '文档管理', + 'type' => 'directory', + 'children' => [ + 'CreateDoc', + 'DeleteDoc', + 'UpdateDoc', + 'RetryDoc', + 'SearchDoc', + 'DescribeDoc', + ], + ], + [ + 'id' => 189608, + 'title' => '类目管理', + 'type' => 'directory', + 'children' => [ + 'CreateCategory', + 'DeleteCategory', + 'UpdateCategory', + 'DescribeCategory', + 'ListCategory', + ], + ], + [ + 'id' => 167775, + 'title' => '会话管理', + 'type' => 'directory', + 'children' => [ + 'TongyiChatDebugInfo', + 'ApplyForStreamAccessToken', + 'Feedback', + 'Chat', + 'Associate', + 'BeginSession', + 'Nlu', + ], + ], + [ + 'id' => 168180, + 'title' => '全局服务', + 'type' => 'directory', + 'children' => [ + 'GetAsyncResult', + ], + ], + [ + 'id' => 168037, + 'title' => '机器人管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 168069, + 'title' => '机器人管理', + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'DeleteInstance', + 'UpdateInstance', + 'LinkInstanceCategory', + 'DescribeInstance', + 'ListInstance', + ], + ], + [ + 'id' => 168038, + 'title' => '机器人发布', + 'type' => 'directory', + 'children' => [ + 'CreateInstancePublishTask', + 'CancelInstancePublishTask', + 'ContinueInstancePublishTask', + 'GetInstancePublishTaskState', + ], + ], + ], + ], + [ + 'id' => 167654, + 'title' => 'FAQ管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 168042, + 'title' => 'FAQ答案', + 'type' => 'directory', + 'children' => [ + 'CreateSolution', + 'DeleteSolution', + 'UpdateSolution', + 'ListSolution', + ], + ], + [ + 'id' => 168043, + 'title' => 'FAQ关联问', + 'type' => 'directory', + 'children' => [ + 'CreateConnQuestion', + 'DeleteConnQuestion', + 'UpdateConnQuestion', + 'ListConnQuestion', + ], + ], + [ + 'id' => 168045, + 'title' => 'FAQ相似问', + 'type' => 'directory', + 'children' => [ + 'CreateSimQuestion', + 'DeleteSimQuestion', + 'UpdateSimQuestion', + 'ListSimQuestion', + ], + ], + [ + 'id' => 168046, + 'title' => 'FAQ', + 'type' => 'directory', + 'children' => [ + 'CreateFaq', + 'DeleteFaq', + 'UpdateFaq', + 'DescribeFaq', + 'SearchFaq', + ], + ], + ], + ], + [ + 'id' => 168050, + 'title' => '对话工厂', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 168103, + 'title' => '实体管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 168104, + 'title' => '实体', + 'type' => 'directory', + 'children' => [ + 'CreateDSEntity', + 'DeleteDSEntity', + 'UpdateDSEntity', + 'DescribeDSEntity', + 'ListDSEntity', + ], + ], + [ + 'id' => 168105, + 'title' => '实体成员', + 'type' => 'directory', + 'children' => [ + 'CreateDSEntityValue', + 'DeleteDSEntityValue', + 'UpdateDSEntityValue', + 'ListDSEntityValue', + ], + ], + ], + ], + [ + 'id' => 168106, + 'title' => '意图管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 168107, + 'title' => '意图', + 'type' => 'directory', + 'children' => [ + 'CreateIntent', + 'DeleteIntent', + 'UpdateIntent', + 'DescribeIntent', + 'ListIntent', + ], + ], + [ + 'id' => 168108, + 'title' => '意图话术', + 'type' => 'directory', + 'children' => [ + 'CreateUserSay', + 'DeleteUserSay', + 'UpdateUserSay', + 'ListUserSay', + ], + ], + [ + 'id' => 168109, + 'title' => '高级语义配置（LGF）', + 'type' => 'directory', + 'children' => [ + 'CreateLgf', + 'DeleteLgf', + 'UpdateLgf', + 'ListLgf', + ], + ], + ], + ], + ], + ], + [ + 'id' => 168068, + 'title' => '视角管理', + 'type' => 'directory', + 'children' => [ + 'CreatePerspective', + 'DeletePerspective', + 'UpdatePerspective', + 'DescribePerspective', + 'QueryPerspectives', + ], + ], + [ + 'id' => 168054, + 'title' => '发布管理', + 'type' => 'directory', + 'children' => [ + 'CreatePublishTask', + 'CancelPublishTask', + 'GetPublishTaskState', + ], + ], + [ + 'id' => 168056, + 'title' => '业务空间', + 'type' => 'directory', + 'children' => [ + 'GetAgentInfo', + 'ListAgent', + ], + ], + [ + 'id' => 169501, + 'title' => '渠道聊天窗', + 'type' => 'directory', + 'children' => [ + 'GenerateUserAccessToken', + ], + ], + [ + 'id' => 192374, + 'title' => '数据看板', + 'type' => 'directory', + 'children' => [ + 'ListTongyiConversationLogs', + 'ListTongyiChatHistorys', + 'GetBotSessionData', + ], + ], + [ + 'id' => 187838, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'InitIMConnect', + 'ListSaasInfo', + 'ListSaasPermissionGroupInfos', + 'CancelChat', + ], + ], + ], + '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', + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '删除文档', + ], + 'UpdateDoc' => [ + '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' => '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, + ], + ], + ], + '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' => '0F9F136A-1BF6-5CC1-9D57-9717761F03B8', + ], + 'KnowledgeId' => [ + 'description' => '知识ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30002406051', + ], + ], + ], + ], + ], + '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' => '', + 'title' => '文档重试', + ], + 'SearchDoc' => [ + 'summary' => '搜索文档。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + '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', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字', + 'type' => 'string', + 'required' => false, + 'example' => '搜索关键字', + ], + ], + [ + 'name' => 'CategoryIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '类目ID列表', + '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', + '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' => '分⻚-第⼏⻚', + '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' => [ + 'title' => '标签ID列表', + 'description' => '标签ID列表，多个标签时，采用“并集”逻辑进行筛选', + 'type' => 'array', + 'items' => [ + 'description' => '标签ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1201', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '搜索文档', + ], + 'DescribeDoc' => [ + 'summary' => '文档详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + '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', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '文档详情', + ], + 'CreateCategory' => [ + 'summary' => '新建类目。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '类目名称', + 'description' => '类目名称', + 'type' => 'string', + 'required' => true, + 'example' => '测试1', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '业务代码', + 'description' => '业务代码', + 'type' => 'string', + 'required' => false, + 'example' => 'bizcode123', + ], + ], + [ + 'name' => 'KnowledgeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '知识类型，FAQ类目：1，文档类目：3', + 'description' => '知识类型，FAQ类目：1，文档类目：3，默认1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ParentCategoryId', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => '返回值', + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '类目-删除', + ], + 'UpdateCategory' => [ + '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' => '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', + ], + ], + ], + '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', + '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', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '类目-详情', + ], + 'ListCategory' => [ + 'summary' => '获取类目列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'KnowledgeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '知识类型,FAQ类目:1,文档类目:3', + 'description' => '知识类型,FAQ类目:1,文档类目:3,默认1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + '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' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '获取类目列表', + ], + 'TongyiChatDebugInfo' => [ + 'summary' => '大模型问答调试信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264606', + 'abilityTreeNodes' => [ + 'FEATUREbeebotUKQQ1L', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '需要提供有效期内的MessageId', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人ID', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'description' => '本条会话应答消息的ID', + 'type' => 'string', + 'required' => true, + 'example' => '396E74B3-D84B-46CE-9E51-91C06AD22E31', + ], + ], + ], + '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' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', + ], + 'MessageId' => [ + 'description' => '本条会话应答消息的ID', + 'type' => 'string', + 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661', + ], + 'Pipeline' => [ + '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:正在为您转接人工客服', + ], + ], + ], + ], + ], + ], + ], + ], + '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" + ."\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" + .'```', + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '获取流式调用的连接信息', + ], + 'Feedback' => [ + 'summary' => '保存用户对于问答结果的评价。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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', + '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' => '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' => '', + 'title' => '问答点赞、点踩', + ], + 'Chat' => [ + 'summary' => '根据机器人唯一标识（机器人ID）与其进行会话，仅适用于智能对话机器人（旧版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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', + ], + ], + [ + 'name' => 'Utterance', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'KnowledgeId', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'SenderNick', + 'in' => 'query', + 'schema' => [ + 'title' => '当前会话中访问的昵称', + 'description' => '当前会话中访问的昵称', + 'type' => 'string', + 'required' => false, + 'example' => '用户123456', + ], + ], + [ + 'name' => 'IntentName', + 'in' => 'query', + 'schema' => [ + 'title' => '对话流中意图名称。 若指定此名称，机器人会直接进入此意图做问答', + 'description' => '对话流中意图名称。 若指定此名称，机器人会直接进入此意图做问答', + 'type' => 'string', + 'required' => false, + 'example' => '查天气意图', + ], + ], + [ + 'name' => 'Perspective', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '视角编码，用于调用同一知识标题下不同视角的答案。如：Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准', + 'description' => '视角编码数组，用于调用同一知识标题下不同视角的答案。如：Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准', + 'type' => 'array', + 'items' => [ + 'description' => '视角编码', + 'type' => 'string', + 'required' => false, + 'example' => 'FZJBY3raWr', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'VendorParam', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'QuerySegList' => [ + 'title' => 'query的分词结果，可能为空', + 'description' => 'query的分词结果，可能为空', + 'type' => 'array', + 'items' => [ + 'description' => '问题的分词数组，如'."\n" + .'['."\n" + .' "查",'."\n" + .' "天气"'."\n" + .' ]', + 'type' => 'string', + 'example' => '天气', + ], + ], + 'Messages' => [ + 'title' => '消息的列表', + 'description' => '消息的列表', + 'type' => 'array', + 'items' => [ + 'description' => '消息', + 'type' => 'object', + 'properties' => [ + 'Knowledge' => [ + 'title' => '当AnswerType为Knowledge时，此字段包含机器人返回的Knowledge对象', + 'description' => '当AnswerType为Knowledge时，此字段包含机器人返回的Knowledge对象', + 'type' => 'object', + 'properties' => [ + 'HitStatement' => [ + 'title' => '命中语句', + 'description' => '命中语句', + 'type' => 'string', + 'example' => '公积金', + ], + 'Summary' => [ + 'title' => '命中问题的简介', + 'description' => '命中问题的简介', + 'type' => 'string', + 'example' => '公积金提取', + ], + 'RelatedKnowledges' => [ + 'title' => '关联知识列表', + 'description' => '关联知识列表', + 'type' => 'array', + 'items' => [ + 'description' => '关联知识', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'ContentType' => [ + 'title' => '纯文本/富文本答案的标示', + 'description' => '纯文本或富文本答案的标识', + 'type' => 'string', + 'enumValueTitles' => [ + 'PLAIN_TEXT' => '纯本文', + 'RICH_TEXT' => '富文本', + ], + 'example' => 'PLAIN_TEXT', + 'enum' => [ + 'PLAIN_TEXT：纯本文', + 'RICH_TEXT: 富文本', + 'CARD_TEMPLATE：卡片模版', + ], + ], + ], + ], + 'Text' => [ + 'title' => '当AnswerType为Text时，此字段包含机器人返回的Text对象', + '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' => '备案十一', + ], + 'AnswerSource' => [ + 'title' => '区分答案类型', + 'description' => '区分答案类型', + 'type' => 'string', + '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：表格问答', + ], + ], + 'Slots' => [ + 'title' => '当AnswerSource为BotFramework时，此字段返回专有名词列表', + 'description' => '当AnswerSource为BotFramework时，此字段返回专有名词列表', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + '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' => '富文本', + ], + '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', + ], + ], + ], + 'Recommends' => [ + 'title' => '当AnswerType为Recommend时，此字段包含机器人返回的Recommend的列表', + 'description' => '当AnswerType为Recommend时，此字段包含机器人返回的Recommend的列表', + 'type' => 'array', + 'items' => [ + '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' => '测试纯文本', + ], + 'AnswerSource' => [ + 'title' => '澄清来源的标识', + 'description' => '澄清来源的标识', + 'type' => 'string', + 'enumValueTitles' => [ + 'BotFramework' => '对话工厂', + 'Knowledge' => 'FAQ', + ], + 'example' => 'KNOWLEDGE', + 'enum' => [ + 'Knowledge：FAQ标题', + 'BotFramework：对话工厂', + ], + ], + 'Score' => [ + 'title' => '推荐内容的分数，当AnswerSource为KNOWLEDGE时，此字段有值', + 'description' => '推荐内容的分数，当AnswerSource为KNOWLEDGE时，此字段有值', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.46', + ], + ], + ], + ], + 'AnswerType' => [ + 'title' => '本条消息的类型', + 'description' => '本条消息的类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Recommend' => '澄清或者反问', + 'Text' => '文本', + 'Knowledge' => '知识库知识直出', + ], + 'example' => 'Text', + 'enum' => [ + 'Text：文本', + 'Recommend：澄清或者反问', + 'Knowledge：知识库知识直出', + 'cardAnswer：卡片工坊的卡片答案', + ], + ], + 'AnswerSource' => [ + 'title' => '当AnswerType为Recommend时，此字段表示推荐的答案来源', + 'description' => '当AnswerType为Recommend时，此字段表示推荐的答案来源', + 'type' => 'string', + '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' => '请问您想咨询的是哪个投保年龄区间呢？', + ], + ], + ], + ], + '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", + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '会话', + 'responseParamsDescription' => '#### Ext字段说明'."\n" + .'**AnswerSource=BotFramework时：**'."\n" + ."\n" + .'| 字段名 | 类型 | 描述 |'."\n" + .'| --- | --- | --- |'."\n" + .'| MATCHED\\_ENTRY_NAME | String | 命中的触发节点名称 |'."\n" + .'| MATCHED\\_INTENT_SOURCE | String | 命中的触发节点意图来源 |'."\n" + .'| INTENT_ID | Long | 命中的意图ID |'."\n" + .'| IntentName | String | 与INTENT_NAME相同 |'."\n" + .'| INTENT_DETAIL | String | 意图命中的方式细节，主要在INTENT_SOURCE=Similarity或者Lgf的时候有用，当为Similarity时，这个字段的值就是匹配的意图话术，当为Lgf时，这个字段的值就是匹配的Lgf语法 |'."\n" + .'| IS\\_SESSION_FINISHED | Boolean | 会话是否完结标志 |'."\n" + .'| DsScore | String | 命中对话流的分数 |'."\n" + .'| DIALOG_ID | String | 对话流ID |'."\n" + .'| FINISH_LABEL | Boolean | 回复节点是否被标记为完结节点，由业务定义，常用于业务统计 |'."\n" + .'| MODULE_START | Boolean | 是否为对话流开启意图节点 |'."\n" + .'| INTENT_NAME | String | 命中的意图名称 |'."\n" + .'| INTENT_SOURCE | String | 意图识别命中的来源方法，包括：`Simialrity` - 相似度匹配方法，`Lgf` - LGF语法匹配方法，`Classify` - 有监督模型方法 |'."\n" + .'| DIALOG_NAME | String | 对话流名称 |'."\n" + .'| DS_REPORT | Map | 对话流变量配置中，勾选为“输出至报表”的变量key value数据 |'."\n" + .'| TASK_ID | String | 异步服务返回的任务ID |'."\n" + ."\n" + .'#### 响应报文：'."\n" + .'##### FAQ问答-直出'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "测试",'."\n" + .' "富文",'."\n" + .' "本"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "Knowledge": {'."\n" + .' "Score": 100.0,'."\n" + .' "Category": "第一个类目",'."\n" + .' "ContentType": "RICH_TEXT",'."\n" + .' "AnswerSource": "KnowledgeBase",'."\n" + .' "Content": "<p>富文本答案啊</p>",'."\n" + .' "Summary": "富文本答案啊",'."\n" + .' "Title": "测试富文本",'."\n" + .' "Id": "4549"'."\n" + .' },'."\n" + .' "AnswerType": "Knowledge"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "1b8b19de-7e6d-4e45-b7f1-9daca21af8b0",'."\n" + .' "SessionId": "1234",'."\n" + .' "MessageId": "1b8b19de-7e6d-4e45-b7f1-9daca21af8b0"'."\n" + .'}'."\n" + .'```'."\n" + ."\n\n" + .'##### FAQ问答-澄清'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "文本"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "AnswerSource": "KNOWLEDGE",'."\n" + .' "Recommends": ['."\n" + .' {'."\n" + .' "Score": 46.0,'."\n" + .' "Title": "测试纯文本",'."\n" + .' "KnowledgeId": "4548"'."\n" + .' }'."\n" + .' ],'."\n" + .' "AnswerType": "Recommend"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "5af5d5f9-76b1-45e9-8003-fcd07ab9a5e4",'."\n" + .' "SessionId": "1234",'."\n" + .' "MessageId": "5af5d5f9-76b1-45e9-8003-fcd07ab9a5e4"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'##### 对话工厂直出'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "查",'."\n" + .' "天气"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "Text": {'."\n" + .' "Ext": {'."\n" + .' "MATCHED_ENTRY_NAME": "intentWithout_city",'."\n" + .' "MATCHED_INTENT_SOURCE": "",'."\n" + .' "INTENT_ID": 724414,'."\n" + .' "BOT_ANSWER_SOURCE": "Lgf",'."\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" + .' },'."\n" + .' "ContentType": "PLAIN_TEXT",'."\n" + .' "NodeName": "示例_查天气.查天气填槽.__city",'."\n" + .' "AnswerSource": "BotFramework",'."\n" + .' "Slots": ['."\n" + .' {'."\n" + .' "Origin": "",'."\n" + .' "Hit": false,'."\n" + .' "Value": "",'."\n" + .' "Name": "查天气意图.city"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Score": 100.0,'."\n" + .' "DialogName": "示例_查天气",'."\n" + .' "IntentName": "查天气意图",'."\n" + .' "Content": "请问您要查哪里的天气？",'."\n" + .' "NodeId": "1410-c7a72a78.__city",'."\n" + .' "ExternalFlags": {'."\n" + .' '."\n" + .' }'."\n" + .' },'."\n" + .' "AnswerType": "Text"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "dc6757ef-9d03-4255-92ec-d262752a88ed",'."\n" + .' "SessionId": "1234",'."\n" + .' "MessageId": "dc6757ef-9d03-4255-92ec-d262752a88ed"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'##### 对话工厂澄清'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "公积金"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "VoiceTitle": "请问你说的是公积金查询，还是公积金提取",'."\n" + .' "AnswerSource": "BotFramework",'."\n" + .' "Recommends": ['."\n" + .' {'."\n" + .' "Score": 0.656,'."\n" + .' "AnswerSource": "BotFramework",'."\n" + .' "Title": "公积金查询",'."\n" + .' "KnowledgeId": "735899"'."\n" + .' },'."\n" + .' {'."\n" + .' "Score": 0.634,'."\n" + .' "AnswerSource": "BotFramework",'."\n" + .' "Title": "公积金提取",'."\n" + .' "KnowledgeId": "735900"'."\n" + .' }'."\n" + .' ],'."\n" + .' "AnswerType": "Recommend"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98",'."\n" + .' "SessionId": "123",'."\n" + .' "MessageId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'##### 意图、FAQ混合澄清'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "公积金"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "VoiceTitle": "请问你说的是公积金查询，还是住房公积金在个人所得税税前扣除的具体规定是什么？",'."\n" + .' "AnswerSource": "INTENT_FAQ_CLARIFY",'."\n" + .' "Recommends": ['."\n" + .' {'."\n" + .' "Score": 0.656,'."\n" + .' "AnswerSource": "BotFramework",'."\n" + .' "Title": "公积金查询",'."\n" + .' "KnowledgeId": "735899"'."\n" + .' },'."\n" + .' {'."\n" + .' "Score": 0.47410887479782104,'."\n" + .' "Category": "税务-12366&680条-税款计算-居民个人取得综合所得-个人所得税专项扣除",'."\n" + .' "AnswerSource": "KNOWLEDGE",'."\n" + .' "Title": "住房公积金在个人所得税税前扣除的具体规定是什么？",'."\n" + .' "KnowledgeId": "7049"'."\n" + .' }'."\n" + .' ],'."\n" + .' "AnswerType": "Recommend"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "08d6bb1c-5394-4836-8e4a-86c07e7729b1",'."\n" + .' "SessionId": "123",'."\n" + .' "MessageId": "08d6bb1c-5394-4836-8e4a-86c07e7729b1"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'##### 闲聊'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "你好"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "Text": {'."\n" + .' "ContentType": "PLAIN_TEXT",'."\n" + .' "AnswerSource": "ChitChat",'."\n" + .' "HitStatement": "你好",'."\n" + .' "Content": "哔~哔~哔~，我来了"'."\n" + .' },'."\n" + .' "AnswerType": "Text"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "8f267d8c-c118-4d6a-9ba1-2a5bdc720fed",'."\n" + .' "SessionId": "1234",'."\n" + .' "MessageId": "8f267d8c-c118-4d6a-9ba1-2a5bdc720fed"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'##### 全局敏感词'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "查",'."\n" + .' "天气"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "Text": {'."\n" + .' "ContentType": "PLAIN_TEXT",'."\n" + .' "AnswerSource": "SENSITIVE_WORD",'."\n" + .' "Content": "您说的这个问题我不能回答您，您可以尝试询问其他问题"'."\n" + .' },'."\n" + .' "AnswerType": "Text"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "961d4187-e2e7-4463-8063-a4c79c912227",'."\n" + .' "SessionId": "1234",'."\n" + .' "MessageId": "961d4187-e2e7-4463-8063-a4c79c912227"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'##### 转人工'."\n" + ."\n" + .'###### 全局转人工'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "人工"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "Text": {'."\n" + .' "ContentType": "PLAIN_TEXT",'."\n" + .' "AnswerSource": "COMMANDS",'."\n" + .' "Content": "正在为您转接人工客服",'."\n" + .' "Commands": {'."\n" + .' "sysToAgent": "{\\"skillGroup\\":\\"12\\"}"'."\n" + .' }'."\n" + .' },'."\n" + .' "Knowledge": {'."\n" + .' '."\n" + .' },'."\n" + .' "Type": "Text",'."\n" + .' "AnswerType": "Text"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",'."\n" + .' "SessionId": "123",'."\n" + .' "MessageId": "fbbe0230-af14-4850-8f59-2ff60dfbf773"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'###### 触发对话工厂意图转人工'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "转",'."\n" + .' "人工"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "Text": {'."\n" + .' "Ext": {'."\n" + .' "MATCHED_ENTRY_NAME": "转人工",'."\n" + .' "MATCHED_INTENT_SOURCE": "",'."\n" + .' "INTENT_ID": 8454,'."\n" + .' "BOT_ANSWER_SOURCE": "Similarity",'."\n" + .' "intentName": "转人工",'."\n" + .' "DsScore": 100.0,'."\n" + .' "INTENT_DETAIL": "转人工",'."\n" + .' "LGF_EXPRESSION": "转人工",'."\n" + .' "IS_SESSION_FINISHED": true,'."\n" + .' "dsScore": 100.0,'."\n" + .' "DIALOG_ID": "2529",'."\n" + .' "FINISH_LABEL": false,'."\n" + .' "IntentName": "转人工",'."\n" + .' "MODULE_START": true,'."\n" + .' "INTENT_NAME": "转人工",'."\n" + .' "INTENT_SOURCE": "Similarity",'."\n" + .' "DIALOG_NAME": "公积金转人工"'."\n" + .' },'."\n" + .' "ContentType": "PLAIN_TEXT",'."\n" + .' "NodeName": "公积金转人工.回复信息",'."\n" + .' "AnswerSource": "BotFramework",'."\n" + .' "Score": 100.0,'."\n" + .' "DialogName": "公积金转人工",'."\n" + .' "IntentName": "转人工",'."\n" + .' "Content": "这是转人工的回复",'."\n" + .' "Commands": {'."\n" + .' "sysToAgent": "{\\"skillGroup\\":\\"8\\",\\"ext\\":\\"123\\"}"'."\n" + .' },'."\n" + .' "NodeId": "i073y198",'."\n" + .' "ExternalFlags": {'."\n" + .' '."\n" + .' }'."\n" + .' },'."\n" + .' "Type": "Text",'."\n" + .' "AnswerType": "Text"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",'."\n" + .' "SessionId": "123",'."\n" + .' "MessageId": "590f0434-030a-4de2-8212-bf1a96e0c687"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'##### 无答案'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "公积金",'."\n" + .' "贷款"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "Text": {'."\n" + .' "ContentType": "PLAIN_TEXT",'."\n" + .' "AnswerSource": "NO_ANSWER",'."\n" + .' "Content": "我还没有学会这个问题，已经记录会尽快学习为您解答，请尝试询问我其他问题"'."\n" + .' },'."\n" + .' "AnswerType": "Text"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",'."\n" + .' "SessionId": "1234",'."\n" + .' "MessageId": "1ad8733a-7180-4e3b-a969-96f47d774256"'."\n" + .'}'."\n" + .'```'."\n" + .' '."\n" + .'##### 机器阅读 [非标，依赖开启文档问答能力]'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList":['."\n" + .' "项目",'."\n" + .' "备案"'."\n" + .' ],'."\n" + .' "Messages":['."\n" + .' {'."\n" + .' "Type":"Text",'."\n" + .' "AnswerType": "Text",'."\n" + .' "Text":{'."\n" + .' "AnswerSource":"MACHINE_READ",'."\n" + .' "ArticleTitle":"备案十一",'."\n" + .' "Content":"四、申请接收:'."\n" + .'申请方式:网上申请'."\n" + .'联系电话:0571-87052724、87052837'."\n" + .'办公地址:无'."\n" + .'五、办理基本流程:'."\n" + .'1、项目单位登录浙江政务服务网(http://www.zjzwfw.gov.cn)进行法人用户'."\n" + .'注册。'."\n" + .'2、项目单位使用法人用户账号登录浙江政务服务网投资项目在线审批监'."\n" + .'管平台(http://tzxm.zjzwfw.gov.cn)(以下简称在线平台)。'."\n" + .'3、项目单位选择在线平台“项目登记”中的“备案类登记”栏目,进入'."\n" + .'备案系统。'."\n" + .'4、填报项目备案信息'."\n" + .'5、提交项目备案信息表,完成项目赋码'."\n" + .'6、提交声明,完成项目备案'."\n" + .'流程图:http://zjqlk.oss-cn-hangzhou.aliyuncs.com/c/5/53"'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId":"089abc58-e9ab-4aa8-86a8-70fc9d8cf0fb",'."\n" + .' "SessionId":"123",'."\n" + .' "MessageId":"089abc58-e9ab-4aa8-86a8-70fc9d8cf0fb"'."\n" + .'}'."\n" + .'``` '."\n" + ."\n" + .'##### 表格问答直出[非标，依赖开启Tableqa能力]'."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "王珊珊",'."\n" + .' "的",'."\n" + .' "成绩"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "Text": {'."\n" + .' "ContentType": "PLAIN_TEXT",'."\n" + .' "AnswerSource": "TABLEQA",'."\n" + .' "Content": "姓名是王珊珊的成绩是不及格"'."\n" + .' },'."\n" + .' "AnswerType": "Text"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "c09d1913-dd8d-4a45-b8bd-e45e4fcf872b",'."\n" + .' "SessionId": "123",'."\n" + .' "MessageId": "c09d1913-dd8d-4a45-b8bd-e45e4fcf872b"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'##### 表格问答反问[非标，依赖开启Tableqa能力]'."\n" + .'```json'."\n" + .'{'."\n" + .' "QuerySegList": ['."\n" + .' "收益率",'."\n" + .' "大于",'."\n" + .' "4",'."\n" + .' "的",'."\n" + .' "产品"'."\n" + .' ],'."\n" + .' "Messages": ['."\n" + .' {'."\n" + .' "AnswerSource": "TABLEQA",'."\n" + .' "Title": "请选择投资时间：",'."\n" + .' "Recommends": ['."\n" + .' {'."\n" + .' "Title": "1907"'."\n" + .' },'."\n" + .' {'."\n" + .' "Title": "31"'."\n" + .' },'."\n" + .' {'."\n" + .' "Title": "365"'."\n" + .' }'."\n" + .' ],'."\n" + .' "AnswerType": "Recommend"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "abef84e0-8d08-4d80-9dfb-2e958e0833ad",'."\n" + .' "SessionId": "1234",'."\n" + .' "MessageId": "abef84e0-8d08-4d80-9dfb-2e958e0833ad"'."\n" + .'}'."\n" + .'```', + 'extraInfo' => '## 常见问答错误'."\n" + ."\n" + .'### 第三方服务错误'."\n" + .'第三方服务错误是由于在FAQ或对话工厂中配置了第三方服务的接口，在问答命中配置的条件或话术时，会调用对应的第三方服务。如果该服务调用错误，则会提示“Third party interface error”，具体协议如下。'."\n" + ."\n" + .'**响应参数说明**'."\n" + ."\n" + .'| 字段名称 | 字段含义 |'."\n" + .'| --------- | ------------------------------------------------------------ |'."\n" + .'| RequestId | 请求ID |'."\n" + .'| HostId | 云小蜜主机ID |'."\n" + .'| Code | 错误码，第三方服务错误的错误码为“Third party interface error” |'."\n" + .'| Message | 错误说明 |'."\n" + ."\n\n" + .'**响应参数示例**'."\n" + .'```json'."\n" + .'{'."\n" + .' "RequestId": "A805905D-B20C-57C9-8793-EAF98FBD8F84",'."\n" + .' "HostId": "chatbot.cn-shanghai.aliyuncs.com",'."\n" + .' "Code": "Third party interface error",'."\n" + .' "Message": "第三方接口错误. HTTP 请求出现 IOException 异常，可能由网络链接超时，服务端未响应或其他配置问题导致, Url 信息: https://example.com/order/create",'."\n" + .' "Recommend": "https://next.api.aliyun.com/troubleshoot?q=Third party interface error&product=Chatbot"'."\n" + .'}'."\n" + .'```', + ], + 'Associate' => [ + 'summary' => '根据用户query联想知识库中的FAQ。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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', + ], + ], + [ + 'name' => 'RecommendNum', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐问题数量，1-10，当出推荐的时候才生效，返回不大于RecommendN', + 'description' => '推荐问题数量，1-10，当出推荐的时候才生效，返回小于等于RecommendNum的推荐问题', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8', + ], + ], + [ + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5C20F0D4-9721-178A-8236-3BF990634962', + ], + 'Associate' => [ + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + '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" + .'```', + ], + 'BeginSession' => [ + 'summary' => '获取欢迎语接口。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebotUKQQ1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SandBox', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'VendorParam', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '获取欢迎语', + ], + 'Nlu' => [ + 'summary' => '针对用户query，返回机器人有关这个query的语言理解（nlu）结果。当前只支持对话工厂、中控的NLU信息透出，其他引擎后续按需支持。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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' => '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' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '从Chat接口返回参数中获取TASK_ID', + 'description' => '异步服务的任务ID', + 'type' => 'string', + 'required' => true, + 'example' => '从Chat接口中获取TASK_ID', + ], + ], + [ + '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', + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '获取异步函数执行结果', + 'description' => '获取异步服务执行结果', + ], + 'CreateInstance' => [ + 'summary' => '创建沙箱环境机器人。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人名称，不超过50字', + 'description' => '机器人名称，不超过50个字符', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '小蜜机器人', + ], + ], + [ + 'name' => 'LanguageCode', + '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', + ], + ], + [ + 'name' => 'Introduction', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人备注，不超过50字', + 'description' => '机器人备注，不超过50字', + 'type' => 'string', + 'required' => false, + 'example' => '用于手机app的小蜜机器人', + ], + ], + [ + 'name' => 'RobotType', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人类型', + 'description' => '机器人类型，默认为scenario_im', + 'type' => 'string', + 'required' => false, + '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', + ], + ], + ], + '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' => 'F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A', + ], + 'InstanceId' => [ + 'title' => '机器人唯一标识', + 'description' => '机器人唯一标识', + 'type' => 'string', + 'example' => 'chatbot-cn-mp90s2lrk00050', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '机器人-创建', + ], + 'DeleteInstance' => [ + 'summary' => '删除沙箱和线上的机器人。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + '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' => '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '机器人-删除', + ], + 'UpdateInstance' => [ + 'summary' => '更新机器人名称，描述。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人ID', + 'description' => '机器人唯一标识', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'chatbot-cn-mp90s2lrk00050', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '要修改的机器人名称', + 'description' => '要修改的机器人名称，最多50个字符', + 'type' => 'string', + 'required' => false, + 'example' => '智能客服-小C', + ], + ], + [ + 'name' => 'Introduction', + 'in' => 'query', + 'schema' => [ + 'title' => '要修改的机器人备注', + 'description' => '要修改的机器人备注', + 'type' => 'string', + 'required' => false, + 'example' => '用于C端问答的机器人', + ], + ], + [ + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C45BFEE4-F657-1332-8B47-2C757B94C972', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '机器人-更新', + ], + 'LinkInstanceCategory' => [ + 'summary' => '机器人绑定知识类目。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebotW5WL9W', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人唯一标识', + 'description' => '机器人唯一标识', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'chatbot-cn-mp90s2lrk00050', + ], + ], + [ + 'name' => 'CategoryIds', + 'in' => 'formData', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '知识类目Id', + 'description' => '绑定到机器人的FAQ类目ID数组', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '[\\"30000065789\\"]', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '业务空间key,不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '机器人-绑定类目', + ], + 'DescribeInstance' => [ + 'summary' => '查询机器人详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebotW5WL9W', + ], + ], + 'parameters' => [ + [ + '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' => '按机器人类型筛选', + 'description' => '按机器人类型筛选', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'scenario_callout' => '外呼机器人', + 'scenario_im' => '在线文本机器人', + 'scenario_ivr' => '导航机器人', + ], + 'example' => 'scenario_im', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '按机器人名称模糊搜索', + 'description' => '按机器人名称模糊搜索', + 'type' => 'string', + 'required' => false, + 'example' => '售前客服', + ], + ], + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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" + .'```', + ], + 'CreateInstancePublishTask' => [ + 'summary' => '将沙箱机器人发布到线上。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '创建机器人发布任务', + 'responseParamsDescription' => "\n" + .'### 示例'."\n" + .'#### 响应报文：'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "ModifyTime": "2022-04-12T06:30:17Z",'."\n" + .' "BizTypeList": ['."\n" + .' "robot"'."\n" + .' ],'."\n" + .' "CreateTime": "2022-04-12T06:30:17Z",'."\n" + .' "RequestId": "edba56e5-aac2-49b4-a406-3e4d7e7952dd",'."\n" + .' "Response": "4930",'."\n" + .' "Id": 4930,'."\n" + .' "Status": "FE_RUNNING"'."\n" + .'}'."\n" + ."\n" + .'```', + ], + 'CancelInstancePublishTask' => [ + 'summary' => '在发布机器人的过程中，取消机器人发布任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人ID', + 'description' => '机器人唯一标识', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'chatbot-cn-mp90s2lrk00050', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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" + .'```', + ], + 'ContinueInstancePublishTask' => [ + 'summary' => '机器人发布告警时，忽略告警并继续发布。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人ID', + 'description' => '机器人唯一标识', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'chatbot-cn-mp90s2lrk00050', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + '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', + ], + ], + ], + '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', + ], + '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' => '发布警告', + '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' => '{}', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人ID', + 'description' => '机器人唯一标识', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'chatbot-cn-mp90s2lrk00050', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + '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', + ], + ], + ], + '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', + ], + '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\\":[\\"[email protected]@请发布对话流所引用服务后重试！\\"],\\"needRefresh\\":false,\\"success\\":false}"'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + ], + ], + '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" + .'```', + ], + 'CreateSolution' => [ + 'summary' => '创建知识答案。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + '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', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'PerspectiveCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '视角code列表', + 'description' => '视角code列表', + 'type' => 'array', + 'items' => [ + 'description' => '视角code', + 'type' => 'string', + 'required' => false, + 'example' => 'm8qAIvUUAIf', + ], + '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, + ], + ], + [ + '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' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419', + ], + 'SolutionId' => [ + 'title' => '答案ID', + 'description' => '答案ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001089003', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '创建FAQ答案', + ], + 'DeleteSolution' => [ + 'summary' => '删除答案。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => 'F79E7305-5314-5069-A701-9591AD051902', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '删除FAQ答案', + ], + 'UpdateSolution' => [ + 'summary' => '更新答案。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebotVKU6KE', + ], + ], + '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', + '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, + ], + ], + [ + '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' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8B8F098D-A338-54DD-B19C-24BBBCBD8498', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '更新FAQ答案', + ], + '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' => [ + 'title' => 'result', + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '获取FAQ答案列表', + ], + 'CreateConnQuestion' => [ + 'summary' => '为知识添加关联知识。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '创建关联问', + ], + 'DeleteConnQuestion' => [ + 'summary' => '删除知识的关联知识。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'FC323352-3AD7-59A1-9088-A64470BAFC9D', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '删除FAQ关联问', + ], + 'UpdateConnQuestion' => [ + 'summary' => '更新关联关系。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '004EB5C0-9DEB-53BF-A57A-0407A6D6B3C9', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '更新FAQ关联问', + ], + 'ListConnQuestion' => [ + 'summary' => '查询知识的关联问题列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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' => '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '获取关联问列表', + ], + 'CreateSimQuestion' => [ + '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', + ], + ], + [ + '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' => 'Title', + 'in' => 'formData', + 'schema' => [ + 'title' => '相似问标题，字数上限-120', + 'description' => '相似问标题，字数上限：120字', + 'type' => 'string', + 'required' => true, + 'example' => '测试相似问标题', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '创建相似问', + ], + 'DeleteSimQuestion' => [ + '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', + ], + ], + [ + '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' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6419BA93-D111-5225-8998-13E63E6D3940', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '删除FAQ相似问', + ], + 'UpdateSimQuestion' => [ + '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', + ], + ], + [ + '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' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '更新FAQ相似问', + ], + 'ListSimQuestion' => [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + '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' => '相似问', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '获取FAQ相似问列表', + ], + 'CreateFaq' => [ + 'summary' => '创建一条知识。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebot2KMN8Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + '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' => 'Title', + 'in' => 'formData', + 'schema' => [ + 'title' => '知识标题', + 'description' => '知识标题，字数上限：120字', + 'type' => 'string', + 'required' => true, + 'example' => '测试标题', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => [ + 'title' => '生效时间', + 'description' => '生效时间', + 'type' => 'string', + 'required' => false, + 'example' => '2022-05-25T16:28:36Z', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => [ + 'title' => '失效时间', + 'description' => '失效时间', + 'type' => 'string', + 'required' => false, + 'example' => '2030-12-31T16:00:00Z', + ], + ], + [ + 'name' => 'SolutionContent', + 'in' => 'formData', + 'schema' => [ + 'title' => '默认答案内容', + 'description' => '默认答案内容（如果兜底视角开启，则此项必填）', + 'type' => 'string', + 'required' => false, + 'example' => '测试答案', + ], + ], + [ + 'name' => 'SolutionType', + 'in' => 'formData', + 'schema' => [ + 'title' => '默认答案类型', + 'description' => '默认答案类型：0-纯文本，1-富文本', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '创建FAQ', + ], + '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', + ], + ], + [ + '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' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F79E7305-5314-5069-A701-9591AD051902', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '删除FAQ', + ], + 'UpdateFaq' => [ + 'summary' => '编辑一条知识。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebot2KMN8Y', + ], + ], + 'parameters' => [ + [ + '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' => [ + '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', + ], + ], + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '736994BD-AA35-4742-88C9-E64BE4BAA14B', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '修改FAQ', + ], + 'DescribeFaq' => [ + 'summary' => '查询知识详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebot2KMN8Y', + ], + ], + 'parameters' => [ + [ + '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' => [ + 'title' => '知识ID', + 'description' => '知识ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9223372036854775807', + 'exclusiveMaximum' => true, + 'minimum' => '-9223372036854775808', + 'exclusiveMinimum' => true, + 'example' => '30001979424', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'KnowledgeResponse', + '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', + ], + 'SimQuestions' => [ + 'title' => '相似问列表', + 'description' => '相似问列表', + 'type' => 'array', + 'items' => [ + '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' => '测试相似问标题', + ], + ], + ], + ], + 'Solutions' => [ + 'title' => '答案列表', + 'description' => '答案列表', + 'type' => 'array', + 'items' => [ + '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' => '测试答案内容', + ], + 'PerspectiveCodes' => [ + 'title' => '视角code列表', + 'description' => '视角code列表', + 'type' => 'array', + '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', + ], + 'required' => false, + ], + ], + ], + ], + 'Outlines' => [ + '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' => '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', + ], + 'TagIdList' => [ + 'title' => '标签ID列表', + 'description' => '标签ID列表', + 'type' => 'array', + 'items' => [ + 'title' => '标签ID', + 'description' => '标签ID', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '获取FAQ详情', + ], + 'SearchFaq' => [ + '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', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'title' => '关键字', + 'description' => '关键字', + 'type' => 'string', + 'required' => false, + 'example' => '搜索标题', + ], + ], + [ + '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' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', + 'description' => '知识状态：-1-已删除未发布，1-未发布，2-已发布，3-已更新未发布', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '未发布', + '已发布', + '已更新未发布', + -1 => '已删除未发布', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'SearchScope', + 'in' => 'formData', + 'schema' => [ + 'title' => '搜索范围： 1-搜索标题相似问, 2-搜索答案, 3-搜索全部', + 'description' => '搜索范围：1-搜索标题相似问，2-搜索答案，3-搜索全部', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '搜索标题和相似问', + '搜索答案', + '搜索全部', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'CreateUserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建人', + 'description' => '创建人', + 'type' => 'string', + 'required' => false, + 'example' => 'test01', + ], + ], + [ + 'name' => 'ModifyUserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改人', + 'description' => '修改人', + 'type' => 'string', + 'required' => false, + 'example' => 'test01', + ], + ], + [ + 'name' => 'CreateTimeBegin', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建开始时间', + 'description' => '创建开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-02T03:09:30Z', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建结束时间', + 'description' => '创建结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2022-05-02T03:09:30Z', + ], + ], + [ + 'name' => 'ModifyTimeBegin', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改开始时间', + 'description' => '修改开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-02T03:09:30Z', + ], + ], + [ + 'name' => 'ModifyTimeEnd', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改结束时间', + 'description' => '修改结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-02T03:09:30Z', + ], + ], + [ + 'name' => 'StartTimeBegin', + 'in' => 'formData', + 'schema' => [ + 'title' => '生效开始时间', + 'description' => '生效开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-02T03:09:30Z', + ], + ], + [ + 'name' => 'StartTimeEnd', + 'in' => 'formData', + 'schema' => [ + 'title' => '生效结束时间', + 'description' => '生效结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-03T03:09:30Z', + ], + ], + [ + 'name' => 'EndTimeBegin', + 'in' => 'formData', + 'schema' => [ + 'title' => '失效开始时间', + 'description' => '失效开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-02T03:09:30Z', + ], + ], + [ + 'name' => 'EndTimeEnd', + 'in' => 'formData', + 'schema' => [ + 'title' => '失效结束时间', + 'description' => '失效结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-02T03:09:30Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '页码 默认1', + 'description' => '页码默认1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + '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' => [ + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => 'FAQ搜索', + ], + 'CreateDSEntity' => [ + 'summary' => '创建实体，特指实体的Meta信息，如：实体名称、实体类型。', + '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' => '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' => 'BaseResponse<EntityIdResponse>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'adfad2343f1f2r', + ], + 'EntityId' => [ + 'description' => '实体ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23436345', + ], + ], + ], + ], + ], + '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' => '', + 'title' => '实体-创建', + ], + 'DeleteDSEntity' => [ + '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', + ], + ], + [ + '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 => [ + 'schema' => [ + 'title' => 'BaseResponse<EntityIdResponse>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4dfghf56235asdf452', + ], + 'EntityId' => [ + 'description' => '实体ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BusinessErrorEntityId.NotExists', + 'errorMessage' => 'The business error EntityId is not exists.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '实体-删除', + ], + 'UpdateDSEntity' => [ + 'summary' => '实体meta信息修改，仅支持修改实体名称；实体类型不支持修改。', + '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' => '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' => 'BaseResponse<EntityIdResponse>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'df23fgh4hyj67hn56', + ], + 'EntityId' => [ + 'description' => '实体ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + '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' => '', + 'title' => '实体-修改', + ], + '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', + ], + ], + [ + '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 => [ + 'schema' => [ + 'description' => '返回参数说明', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BusinessErrorEntityId.NotExists', + 'errorMessage' => 'The business error EntityId is not exists.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '实体-详情', + 'responseParamsDescription' => '如果是系统实体，SysEntityCode返回系统实体key，例如：@sys.date', + ], + 'ListDSEntity' => [ + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人ID', + 'description' => '机器人ID', + 'type' => 'string', + 'required' => true, + 'example' => ' chatbot-cn-yjzbyrEvqd', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '筛选项，contains匹配，范围：实体名称（未来扩展：实体成员、同义词）', + 'description' => '筛选项，contains匹配，范围：实体名称（未来扩展：实体成员、同义词）', + 'type' => 'string', + 'required' => false, + 'example' => '实体', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => [ + 'title' => '为空：全量自定义实体（默认）', + 'description' => '为空：全量自定义实体（默认）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'regex' => 'regex', + 'system' => 'system', + 'synonyms' => 'synonyms', + ], + 'example' => 'synonyms'."\n" + .'regex'."\n" + .'system', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页，默认1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页数量，默认10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息说明', + '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' => '实体列表信息', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Ds.IllegalAccess.BotIdNotExists', + ], + ], + ], + 'responseDemo' => '', + 'title' => '实体-列表', + ], + 'CreateDSEntityValue' => [ + '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', + ], + ], + [ + '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' => '12', + ], + ], + [ + 'name' => 'Content', + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BusinessErrorEntityId.NotExists', + 'errorMessage' => 'The business error EntityId is not exists.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '实体成员-创建', + ], + 'DeleteDSEntityValue' => [ + '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', + ], + ], + [ + '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' => '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 => [ + 'schema' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'dfdf2t3rfvb45y', + ], + 'EntityValueId' => [ + 'description' => '实体成员ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3453453452', + ], + ], + ], + ], + ], + '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' => '', + 'title' => '实体-实体成员-删除', + ], + 'UpdateDSEntityValue' => [ + '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', + ], + ], + [ + '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' => '223423423', + ], + ], + [ + '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' => [ + 'title' => '实体同义词', + 'description' => '同义词列表', + 'type' => 'array', + 'items' => [ + 'description' => '实体同义词', + 'type' => 'string', + 'required' => false, + 'example' => '小说', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<EntityValueIdResponse>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'sDag3g43wesf2', + ], + 'EntityValueId' => [ + 'description' => '实体成员ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2342377423', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BusinessErrorEntityId.NotExists', + 'errorMessage' => 'The business error EntityId is not exists.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '实体成员-修改', + ], + 'ListDSEntityValue' => [ + 'summary' => '查询指定实体的实体成员列表及详情数据，同时支持关键词筛选（contains），筛选范围：实体值、同义词。', + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求唯一标识', + 'type' => 'string', + 'example' => 'n3fg34gbfj8adf2gj923', + ], + 'EntityValues' => [ + 'description' => '实体列表', + 'type' => 'array', + 'items' => [ + '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' => '书类型', + ], + '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', + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '实体成员-列表', + ], + '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' => '机器人ID', + 'type' => 'string', + 'required' => true, + 'example' => ' chatbot-cn-yjzbyrEvqd', + ], + ], + [ + 'name' => 'IntentDefinition', + 'in' => 'query', + 'style' => 'json', + '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' => '槽位信息', + '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, + ], + ], + ], + '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.', + ], + [ + '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.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '意图-创建', + ], + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '机器人ID', + 'description' => '机器人ID', + 'type' => 'string', + 'required' => true, + 'example' => ' chatbot-cn-yjzbyrEvqd', + ], + ], + [ + '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 => [ + 'schema' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'IntentId' => [ + 'description' => '意图ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '3464dfg3qwr34tf34', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BusinessErrorIntentId.NotExists', + 'errorMessage' => 'The business error Intent is not exists.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '意图-删除', + ], + 'UpdateIntent' => [ + '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' => '机器人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', + ], + ], + [ + 'name' => 'IntentDefinition', + 'in' => 'query', + 'style' => 'json', + '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' => '槽位信息', + 'type' => 'array', + 'items' => [ + 'description' => '槽位信息', + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + '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' => '', + 'title' => '意图-修改', + ], + 'DescribeIntent' => [ + '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', + ], + ], + [ + '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' => '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BusinessErrorIntentId.NotExists', + 'errorMessage' => 'The business error IntentId is not exists.', + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '', + 'title' => '意图-详情', + ], + 'ListIntent' => [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<DsIntentPageData>', + 'description' => '返回值', + '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' => '意图列表', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter InstanceId is not valid!', + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '', + 'title' => '意图-列表', + ], + 'CreateUserSay' => [ + 'summary' => '为指定意图添加话术的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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' => 'UserSayDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'UserSayId' => [ + 'description' => '意图-话术唯一ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '46456176856', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8g4n8bnd236fg79', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BusinessErrorIntentId.NotExists', + 'errorMessage' => 'The business error Intent is not exists.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '意图-话术创建', + ], + 'DeleteUserSay' => [ + 'summary' => '修改意图话术信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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' => [ + 'description' => '机器人ID', + 'type' => 'string', + 'required' => true, + 'example' => '343df2sdf23', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => '意图ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9223372036854775807', + 'exclusiveMaximum' => true, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '5564564546', + ], + ], + [ + 'name' => 'UserSayId', + 'in' => 'query', + 'schema' => [ + 'description' => '话术ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9223372036854775807', + 'exclusiveMaximum' => true, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '4562121234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'UserSayId' => [ + 'description' => '话术ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4562121234', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'dfgdg324gf34t34g34g3', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '意图-话术-删除', + ], + 'UpdateUserSay' => [ + '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', + ], + ], + [ + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'UserSayId' => [ + 'description' => '话术ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34512323', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '2356fg3wf34634vdt23wef2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BusinessErrorIntentId.NotExists', + 'errorMessage' => 'The business error Intent is not exists.', + ], + ], + ], + 'responseDemo' => '', + 'title' => '意图-话术-修改', + ], + 'ListUserSay' => [ + 'summary' => '查询指定意图的话术内容及关联槽位信息，支持关键话术筛选（contains）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'title' => '筛选用户话术', + 'description' => '筛选用户话术', + 'type' => 'string', + 'required' => false, + 'example' => '您做核酸了嘛', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<DsUserSayPageData>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'fs1fg4512v43572v23', + ], + 'UserSays' => [ + 'description' => '话术列表', + 'type' => 'array', + 'items' => [ + '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' => '您做核酸了嘛', + ], + 'SlotInfos' => [ + 'description' => '关联槽位信息', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '意图-话术-列表', + ], + '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' => [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'LgfId' => [ + 'description' => 'LGF ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123453433453', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'af5fg3sdf457j5', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '意图-LGF-创建', + ], + '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', + ], + ], + [ + '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 => [ + 'schema' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'LgfId' => [ + 'description' => 'LGF ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2342424', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'dgw2342424qw42', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '意图-LGF-删除', + ], + 'UpdateLgf' => [ + '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' => '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' => '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' => [ + 'description' => '返回信息说明', + 'type' => 'object', + 'properties' => [ + 'LgfId' => [ + 'description' => 'LGF唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2342556223532', + ], + 'RequestId' => [ + 'description' => '请求唯一标识', + 'type' => 'string', + 'example' => '289dfa131adf23wqe2r', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '', + 'title' => 'LGF-修改', + ], + 'ListLgf' => [ + 'summary' => '查询指定意图的高级语义配置（LGF）。', + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + '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' => '123', + ], + ], + [ + 'name' => 'LgfText', + 'in' => 'query', + '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' => 'BaseResponse<DsLgfPageData>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '34fg57h2gh5783', + ], + 'Lgfs' => [ + 'description' => 'LGF列表', + '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', + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '视角-创建', + ], + 'DeletePerspective' => [ + 'summary' => '删除视角。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + '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' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', + ], + 'Result' => [ + 'title' => '删除视角的结果', + 'description' => '删除视角的结果', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '视角-删除', + ], + 'UpdatePerspective' => [ + 'summary' => '更新视角名称和描述。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '视角名称', + 'description' => '视角名称，长度不超过50字', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '客户端视角', + ], + ], + [ + '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' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '视角-更新', + ], + 'DescribePerspective' => [ + 'summary' => '查询视角详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + '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' => [ + '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' => '移动端视角', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '视角-详情', + ], + 'QueryPerspectives' => [ + 'summary' => '查询视角列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '视角-列表', + ], + 'CreatePublishTask' => [ + 'summary' => '创建发布中心的发布任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'BizType', + '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' => [], + ], + ], + [ + 'name' => 'DataIdList', + '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"]', + ], + ], + [ + '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', + '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' => '业务类型列表', + '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' => '创建发布任务', + ], + 'CancelPublishTask' => [ + 'summary' => '取消正在发布中的任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '取消发布任务', + ], + 'GetPublishTaskState' => [ + 'summary' => '查询发布进度。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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", + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '查询发布进度', + ], + 'GetAgentInfo' => [ + 'summary' => '获取业务空间ID。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'beebot_bot_public_cn-ca36x8v3n1x', + ], + ], + ], + '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' => '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' => '', + 'title' => '根据实例ID获取业务空间信息', + ], + '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', + ], + ], + [ + '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' => '商品code，可按照商品code进行过滤，查询实例信息', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'G_cloudBeeBot_public' => 'G_cloudBeeBot_public', + ], + 'example' => 'G_cloudBeeBot_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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + 'title' => '获取业务空间列表', + 'responseParamsDescription' => 'InstanceInfos示例。'."\n" + .'"InstanceInfos": {'."\n" + .' "GoodsCode": {'."\n" + .' "InstanceId": "xxxxxx"'."\n" + .' }'."\n" + .' }'."\n" + .'//GoodsCode参考枚举值', + ], + 'GenerateUserAccessToken' => [ + 'summary' => '用于聊天窗用户免登时，获取Token，通过该Token可将用户的企业身份带入。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + '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' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '3600', + 'minimum' => '0', + 'example' => '1000', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'title' => '坐席密钥', + 'description' => '业务空间key，不设置则访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + [ + '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' => 'Email', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Telephone', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ForeignId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户外部的userid', + 'description' => '用户外部的userid', + 'type' => 'string', + 'required' => true, + 'example' => '8882022040000000171', + ], + ], + [ + 'name' => 'Nick', + 'in' => 'formData', + 'schema' => [ + 'title' => '访问者昵称', + 'description' => '访问者昵称', + 'type' => 'string', + 'required' => true, + 'example' => '张三', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '获取用户免登Token', + 'description' => '由于安全问题，生成的Token仅第一次使用有效（过期时间内），如同一个用户多浏览器登录，需要多次调用。', + ], + 'ListTongyiConversationLogs' => [ + 'summary' => '查询对话机器人通义版的单个会话对话记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebot2KBZDS', + ], + ], + 'parameters' => [ + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID', + 'type' => 'string', + 'required' => true, + 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', + ], + ], + [ + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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 |', + ], + 'ListTongyiChatHistorys' => [ + 'summary' => '获取会话历史明细。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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', + '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', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '机器⼈实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'chatbot-cn-7QuUfaqMQe', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + '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' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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 | 用户反馈说明 |', + ], + 'GetBotSessionData' => [ + 'summary' => '查询机器⼈问答概览指标。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，时间格式为yyyyMMdd，⽐如20240505', + 'type' => 'string', + 'required' => true, + 'example' => '20240505', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，时间格式为yyyyMMdd，⽐如20240605', + 'type' => 'string', + 'required' => true, + 'example' => '20240605', + ], + ], + [ + 'name' => 'RobotInstanceId', + 'in' => 'query', + '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' => [ + 'type' => 'object', + 'properties' => [ + '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示例', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbeebotJ8IS68', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'UserAccessToken', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + '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' => '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==" }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '初始化im连接', + 'responseParamsDescription' => 'imDomain: im连接域名，'."\n" + .'appKey: im认证key，'."\n" + .'token: im连接token。', + ], + 'ListSaasInfo' => [ + 'summary' => '获取SaaS被集成信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + [ + 'name' => 'SaasName', + 'in' => 'query', + 'schema' => [ + 'description' => '业务方用户名', + 'type' => 'string', + 'required' => true, + 'example' => 'userTest', + ], + ], + [ + 'name' => 'SaasGroupCodes', + 'in' => 'query', + 'schema' => [ + 'description' => '用户所拥有的saas权限组code，多个用英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => 'DS,FAQ', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '获取SaaS被集成信息列表', + ], + 'ListSaasPermissionGroupInfos' => [ + 'summary' => '获取权限被集成信息列表，可通过该列表返回的权限组，给用户授权。', + 'methods' => [ + 'post', + 'get', + ], + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '获取权限被集成信息列表', + ], + 'CancelChat' => [ + 'summary' => '取消或打断对应对话。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254397', + 'abilityTreeNodes' => [ + 'FEATUREbeebotUKQQ1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务空间key，不传时访问默认业务空间，key值在主账号业务管理页面获取', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '会话ID，用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。长度限制是64个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'c1187530338311ebade7cf3eaeb3668a', + ], + ], + [ + 'name' => 'ChatId', + 'in' => 'formData', + 'schema' => [ + 'description' => '标识单次对话的id', + 'type' => 'string', + 'required' => false, + 'example' => '7105a351-b2e7-4c9e-8437-c43a043c0a4e', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '机器人ID', + 'type' => 'string', + 'required' => false, + 'example' => ' chatbot-cn-yjzbyrEvqd', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '打断类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Canceled', + ], + ], + [ + 'name' => 'Answer', + 'in' => 'formData', + 'schema' => [ + 'description' => '答案正文', + 'type' => 'string', + 'required' => false, + 'example' => '<这个答案被打>', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求本接口的请求ID', + 'type' => 'string', + 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', + ], + 'CancelResult' => [ + 'description' => '调用本接口的结果', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + 'title' => '取消或打断给定对话', + 'description' => '仅支持新版机器人，只能查询到90天内的数据', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'chatbot.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'chatbot.cn-hongkong.aliyuncs.com', + ], + ], +]; |