'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":"\\n 402FCD5F-518E-4C8E-8A6B-EFEADA69D757\\n \\n 初级干货\\n \\n \\n 中级干货\\n \\n \\n 注会干货\\n \\n 25670484f2ab4b42ba90acbfbf86d4cd\\n 11bab7a2e34c4e02bcf0ebcb76bb812d\\n","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":"F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A\\n7488","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":"A8CA5217-4B7A-40F9-8985-416C2DCD5D4A","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":"9C5F8186-2D22-433E-9545-606D344F30B5","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":"3\\n2020-11-25T08:56:55Z\\n6IReUnbyzb\\nDFB71B34-4188-4EA2-9988-EF3014E75910\\ntrue\\n2020-11-25T08:26:06Z\\n7487\\n12","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":"DBBF6308-C267-45EE-A0DF-14E401E25272\\n\\n 3\\n 2020-11-12T04:17:31Z\\n default\\n false\\n 2020-11-12T04:17:31Z\\n 1001\\n 默认\\n\\n\\n 1\\n 2020-11-25T08:26:06Z\\n 6IReUnbyzb\\n true\\n 2020-11-25T08:26:06Z\\n 7487\\n 12\\n","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":"\\n 2100073759\\n 17204B98-7734-4F9A-8464-2446A84821CA\\n true\\n","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":"\\n 4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55\\n true\\n","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":"\\n F79E7305-5314-5069-A701-9591AD051902\\n true\\n","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":"\\n 30000049006\\n 2B0304FD-3804-5C06-9A83-77F5523664AF\\n -1\\n 类目名称\\n","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":"\\n 17204B98-7734-4F9A-8464-2446A84821CA\\n \\n 2100073048\\n \\n 2100073049\\n \\n 2100073050\\n \\n 2100073049\\n test2\\n \\n \\n 2100073048\\n test1\\n \\n -1\\n test\\n \\n \\n 2100073605\\n -1\\n 测试\\n \\n","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":"8334b404-3124-47a4-92df-5c7648158b6f\\n1000002788","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":"77\\n907AA5F2-0521-49AB-80AB-1ADEFAB2B901\\n\\n 2.4444444444444446\\n 0.13636363636363635\\n 0.07920792079207921\\n","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":"47D26156-D4C3-4E48-B0D6-25BBF7A3BC1D","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":"E3E5C779-A630-45AC-B0F2-A4506A4212F1\\nceb9d68c-dbb5-32c9-a02c-eca56b782ff7","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":"E45491D5-7E0A-42C6-9B21-91D1066B1475\\ntrue","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":"D0DDFC4C-D66D-4787-9AE4-4D757481EDEE\\ntrue","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":"\\n 本地\\n 所在地\\n 2020-11-25T10:31:10Z\\n F55D90C1-31BE-4B2A-AA3F-25EFC36F9419\\n 2020-11-24T03:49:18Z\\n 5be359c7-c18b-353a-bfe5-659b229e272e\\n","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":"3\\n\\n 本地\\n 本地\\n 2020-11-25T10:31:10Z\\n 2020-11-24T03:49:18Z\\n 5be359c7-c18b-353a-bfe5-659b229e272e\\n\\n\\n 本地\\n 当地\\n 2020-11-25T10:31:10Z\\n 2020-11-25T10:31:04Z\\n d8558390-f758-33da-8666-dfbb46f173b3\\n\\n\\n 本地\\n 所在地\\n 2020-11-25T10:31:10Z\\n 2020-11-25T10:31:10Z\\n 405d73a6-ac3c-37fd-96a6-94ae2a882c1e\\n\\n10\\n92B81548-42B9-4B34-924B-4E778AEB412B\\n1","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":"C191B48B-9268-4FB1-A3C2-5143B4A91D0C","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":"42212\\n851BCF73-08DB-4738-AC23-302C591C1C86","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":"regex\\n42212\\n2020-12-02T06:35:50Z\\n83225\\n3F95508F-8635-4786-A959-E21F6FED4CD1\\n价格\\n^([0-9])\\\\d{1}\\n2020-12-02T06:35:50Z\\nnull\\n83225\\nnull","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":"\\n 系统.城市实体\\n @sys.geo-city\\n 请问您的城市是哪里呢?\\n\\n\\n 系统.飞机场城市实体\\n @sys.airport\\n 请问是哪个城市?\\n\\n\\n 系统.全球城市实体\\n @sys.global-city\\n 请问您说的是哪座城市?\\n\\nF6E5D7FE-6165-4478-BC52-9E0D1DAD5C84","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":"1\\n10\\n206FCA00-9802-492E-86B3-5BCABDB6EF71\\n1\\n\\n 42212\\n regex\\n 2020-12-02T06:35:50Z\\n 83225\\n 价格\\n ^([0-9])\\\\d{1}\\n 2020-12-02T06:35:50Z\\n null\\n 83225\\n null\\n","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":"E42C928F-202A-4896-8F4A-DA718720BC98\\n13853","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":"16AC1B3C-66E0-438B-BB7C-71B692407B67\\n50120","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":"C6C17866-D5BF-4B90-8224-FC38F069F4C0","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":"FF157949-D464-4563-99C0-AC1C889729B6","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":"6\\n2020-11-30T06:05:11Z\\n这是一个测试示例\\nF178F903-AFCF-4F1F-81A1-69A8D99B1D7E\\n2020-11-30T03:00:54Z\\n83225\\n50099\\nnull\\ntrue\\n83225\\n测试\\nnull","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":"3\\n10\\n7F132693-212A-40A9-8A81-11E7694E478B\\n1\\n\\n 8\\n 2020-11-30T06:12:47Z\\n 测试001\\n 001的测试流\\n 83225\\n 2020-11-30T06:10:11Z\\n null\\n 50110\\n 83225\\n null\\n false\\n\\n\\n 6\\n 2020-11-30T06:05:11Z\\n 测试\\n 这是一个测试示例\\n 83225\\n 2020-11-30T03:00:54Z\\n null\\n 50099\\n 83225\\n null\\n true\\n\\n\\n 3\\n 2020-11-29T06:50:46Z\\n 示例_查天气\\n 示例_查天气\\n 83225\\n 2020-11-29T06:50:46Z\\n 83225\\n 49966\\n 83225\\n 83225\\n true\\n false\\n","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":"F0809B63-5DDF-4BB8-AA86-92CE99543922","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":"B58AD5AF-21C8-4DB9-82E8-D445ED579EDC","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":"1891FFA2-8F35-4F9A-BF16-D4A6E1F58EC0","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":"6658EB01-A68C-4041-93ED-CD3F9C887A19\\n126558","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":"2\\n10\\nA1C54450-F19B-4883-90E3-FDB686BF0381\\n1\\n\\n 2020-11-30T03:03:37Z\\n 83225\\n \\n false\\n 853d7220-32b8-11eb-9478-19d2d885afdb\\n \\n 我想给汽车贴膜\\n \\n \\n 2020-11-30T03:03:37Z\\n null\\n 83225\\n \\n 9ec31b50-32b8-11eb-9478-19d2d885afdb\\n false\\n true\\n @喜欢的颜色\\n 0\\n 颜色\\n \\n \\n c57c48c0-32b8-11eb-9478-19d2d885afdb\\n false\\n true\\n @产地\\n 0\\n 产地\\n \\n null\\n 126558\\n 汽车贴膜\\n\\n\\n \\n false\\n -1\\n \\n 未知意图\\n \\n \\n -1\\n UNKNOWN\\n","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":"2020-11-30T06:04:37Z\\n473F6889-1DE6-44A5-BA62-BD3CC7600DBF\\n2020-11-30T03:03:37Z\\n83225\\n50099\\nnull\\n汽车贴膜\\n126558\\n83225\\n\\n false\\n 853d7220-32b8-11eb-9478-19d2d885afdb\\n \\n 我想给汽车贴膜\\n \\n\\nnull\\n\\n 9ec31b50-32b8-11eb-9478-19d2d885afdb\\n false\\n true\\n @喜欢的颜色\\n 0\\n 颜色\\n\\n\\n c57c48c0-32b8-11eb-9478-19d2d885afdb\\n false\\n true\\n @产地\\n 0\\n 产地\\n","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":"CDFB7CDF-CCBF-4388-AC7D-9484DB457FFF\\nchatbot-cn-7QuUfaqMQe","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":"F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A","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":"zh-cn\\nAsia/Beijing\\nBF736BAB-5AC0-4092-82A9-85475D6F39D1\\nchatbot-cn-7QuUfaqMQe\\n测试用的\\n\\n 2100073048\\n -1\\n test\\n\\n2020-11-29T06:50:46Z\\nC:\\\\Users\\\\ypfyu\\\\Pictures\\ntest","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":"1\\n\\n zh-cn\\n Asia/Beijing\\n 测试用的\\n chatbot-cn-7QuUfaqMQe\\n 2020-11-29T06:50:46Z\\n C:\\\\Users\\\\ypfyu\\\\Pictures\\n test\\n\\n6FAC33F5-F76A-476C-9FEF-5838F869BD4B\\n10\\n1","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":"B6082275-D0E3-4030-9478-FFC35BA90312\\n\\n NO_ANSWER\\n 查天气\\n 2020-12-01 11:17:38\\n 16dd397889424c089cfe648e34b3981f\\n\\n1","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":"146\\n897F3CD0-99CA-4879-BA1D-989C817FDF9E\\n\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 62d934c0383b11eb879e4f3e4091cf78\\n c911f526942c4a85973e13288ddacbcc\\n 知识\\n 2020-12-07 11:22:45\\n 本地测试结果不好怎么办\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 1002994742#1002994742\\n\\n\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 4948b620383b11eb879e4f3e4091cf78\\n ba275f89d8644625a9f715b7f5372cf9\\n 知识\\n 2020-12-07 11:21:50\\n 本地测试结果不好怎么办\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 1002994742#1002994742\\n\\n\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 280c1b00383b11eb879e4f3e4091cf78\\n 07445104ce3c42d59e78c98b6c219a3d\\n 知识\\n 2020-12-07 11:21:16\\n 本地测试结果不好怎么办\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 1002994742#1002994742\\n\\n\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 280c1b00383b11eb879e4f3e4091cf78\\n d9517aa8965c42d3a2242aaf9091bcc3\\n 知识\\n 2020-12-07 11:20:57\\n 本地测试结果不好怎么办\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 1002994742#1002994742\\n\\n\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 280c1b00383b11eb879e4f3e4091cf78\\n 0687096612c14de3b7d07bb7736d5cbd\\n 知识\\n 2020-12-07 11:20:34\\n 本地测试结果不好怎么办\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 1002994742#1002994742\\n\\n\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 0f95bef0383b11eb879e4f3e4091cf78\\n 98b9ff25dd214a7e806069ab584bb45d\\n 知识\\n 2020-12-07 11:20:06\\n 本地测试结果不好怎么办\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 1002994742#1002994742\\n\\n\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 6ee5c630383011eb879e4f3e4091cf78\\n afe3464a860e432db5a7821fe18a5cd0\\n 知识\\n 2020-12-07 11:17:12\\n 本地测试结果不好怎么办\\n 本地测试结果不好怎么办#本地测试结果不好怎么办\\n 1002994742#1002994742\\n\\n\\n 给宝宝喝哦\\n 52730730361711eb8c708599d06a6268\\n 9effd7b80fad49d39cc0cee0670ce3e1\\n 系统语聊\\n 2020-12-04 18:02:08\\n 娃哈哈\\n 给宝宝喝哦\\n null\\n\\n\\n 好的,我已收集到您这边期望购车信息:您想购买的汽车是的宝马,您的期望报价是万元\\n 52730730361711eb8c708599d06a6268\\n 1d6b472eb34d40be918f259042e3ad2e\\n 对话工厂\\n 2020-12-04 18:02:01\\n 宝马\\n 好的,我已收集到您这边期望购车信息:您想购买的汽车是的宝马,您的期望报价是万元\\n 127953\\n\\n\\n 请问您喜欢什么牌子的车\\n 52730730361711eb8c708599d06a6268\\n b85aa4abc87c49c1ba769c36ae2b3070\\n 对话工厂\\n 2020-12-04 18:01:58\\n 4\\n 请问您喜欢什么牌子的车\\n 127953\\n\\n\\n 抱歉,没有查询到天津相关路况信息。如需查询其他路况信息,请输入【查路况】\\n bc484620360d11eb992f1908405f44bc\\n efd6bb32a73546cda2f9e121fafd1b27\\n 对话工厂\\n 2020-12-04 16:51:32\\n 天津\\n 抱歉,没有查询到天津相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 128746\\n\\n\\n 抱歉,没有查询到上海相关路况信息。如需查询其他路况信息,请输入【查路况】\\n bc484620360d11eb992f1908405f44bc\\n 71f586e888ff41ac82f585202aebcffd\\n 对话工厂\\n 2020-12-04 16:51:25\\n 上海\\n 抱歉,没有查询到上海相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 128746\\n\\n\\n 抱歉,没有查询到北京西站相关路况信息。如需查询其他路况信息,请输入【查路况】\\n bc484620360d11eb992f1908405f44bc\\n a76fa45e95844c1b94802adcefa2bc17\\n 对话工厂\\n 2020-12-04 16:51:17\\n 北京西站\\n 抱歉,没有查询到北京西站相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 128746\\n\\n\\n 请输入需要查询的路况地址,如:南昌绕城高速\\n bc484620360d11eb992f1908405f44bc\\n a1e83bb552a84fea8cc27c92a22281d4\\n 对话工厂\\n 2020-12-04 16:51:13\\n 北京\\n 请输入需要查询的路况地址,如:南昌绕城高速\\n 128747\\n\\n\\n 请输入需要查询的城市,如:南昌\\n bc484620360d11eb992f1908405f44bc\\n 2dda21a37b514ebfabc45c4eb1ce3aea\\n 对话工厂\\n 2020-12-04 16:51:10\\n 查路况\\n 请输入需要查询的城市,如:南昌\\n 128748\\n\\n\\n 天津晴,西风2级,气温3℃,体感温度3℃,相对湿度22%。\\n 7b38b200360d11eb992f1908405f44bc\\n 32e67c38c152488da3fa0cfe592310e0\\n 对话工厂\\n 2020-12-04 16:49:24\\n 天津\\n 天津晴,西风2级,气温3℃,体感温度3℃,相对湿度22%。\\n 128681\\n\\n\\n 抱歉,没有查询到北京西站相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 7b38b200360d11eb992f1908405f44bc\\n 5b008d906b6445278f96f48a474ef20d\\n 对话工厂\\n 2020-12-04 16:49:15\\n 北京西站\\n 抱歉,没有查询到北京西站相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 128746\\n\\n\\n 请输入需要查询的路况地址,如:南昌绕城高速\\n 7b38b200360d11eb992f1908405f44bc\\n c05c9baaaedc47478c33c7011efdb3ff\\n 对话工厂\\n 2020-12-04 16:49:11\\n 北京\\n 请输入需要查询的路况地址,如:南昌绕城高速\\n 128747\\n\\n\\n 请输入需要查询的城市,如:南昌\\n 7b38b200360d11eb992f1908405f44bc\\n 0a86f7592da248fca3250afa4bdfb256\\n 对话工厂\\n 2020-12-04 16:49:06\\n 查路况\\n 请输入需要查询的城市,如:南昌\\n 128748\\n\\n\\n 北京晴,西北风2级,气温3℃,体感温度2℃,相对湿度21%。\\n 031da000360d11eb992f1908405f44bc\\n 60a2170831224ca390568d5d11d31086\\n 对话工厂\\n 2020-12-04 16:47:56\\n 北京\\n 北京晴,西北风2级,气温3℃,体感温度2℃,相对湿度21%。\\n 128681\\n\\n\\n 请输入要查询的城市,如:北京\\n 031da000360d11eb992f1908405f44bc\\n 12fed48053d846398323c5c879918b79\\n 对话工厂\\n 2020-12-04 16:47:44\\n 查天气\\n 请输入要查询的城市,如:北京\\n 128681\\n\\n\\n 抱歉,没有查询到北京西站相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 031da000360d11eb992f1908405f44bc\\n c9ca92bf721c41689c67919dacf95907\\n 对话工厂\\n 2020-12-04 16:47:35\\n 北京西站\\n 抱歉,没有查询到北京西站相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 128746\\n\\n\\n 请输入需要查询的路况地址,如:南昌绕城高速\\n 031da000360d11eb992f1908405f44bc\\n 16db2a778f8943849580c6a2cd821f6b\\n 对话工厂\\n 2020-12-04 16:47:31\\n 北京\\n 请输入需要查询的路况地址,如:南昌绕城高速\\n 128747\\n\\n\\n 请输入需要查询的城市,如:南昌\\n 031da000360d11eb992f1908405f44bc\\n 9692f2298fb5454ab3cb2be680a14c58\\n 对话工厂\\n 2020-12-04 16:47:28\\n 查路况\\n 请输入需要查询的城市,如:南昌\\n 128748\\n\\n\\n 抱歉,没有查询到查天气相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 07dc40e0360a11eb992f1908405f44bc\\n bcdff13ce54a4efd9ee2c943feeb077e\\n 对话工厂\\n 2020-12-04 16:44:37\\n 查天气\\n 抱歉,没有查询到查天气相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 128746\\n\\n\\n 抱歉,没有查询到北京西站相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 07dc40e0360a11eb992f1908405f44bc\\n 921f7ac4059d4f95be4729510a403038\\n 对话工厂\\n 2020-12-04 16:44:32\\n 北京西站\\n 抱歉,没有查询到北京西站相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 128746\\n\\n\\n 请输入需要查询的路况地址,如:南昌绕城高速\\n 07dc40e0360a11eb992f1908405f44bc\\n eb702e44b9ef4996a577fdd3cf4636e3\\n 对话工厂\\n 2020-12-04 16:44:28\\n 北京\\n 请输入需要查询的路况地址,如:南昌绕城高速\\n 128747\\n\\n\\n 请输入需要查询的城市,如:南昌\\n 07dc40e0360a11eb992f1908405f44bc\\n ae9b95b125024ad49bf5b1c829146bf4\\n 对话工厂\\n 2020-12-04 16:44:24\\n 查路况\\n 请输入需要查询的城市,如:南昌\\n 128748\\n\\n\\n 抱歉,没有查询到北京相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 07dc40e0360a11eb992f1908405f44bc\\n 6ab72ae7d09a409796caaa0c84fbe608\\n 对话工厂\\n 2020-12-04 16:40:52\\n 北京\\n 抱歉,没有查询到北京相关路况信息。如需查询其他路况信息,请输入【查路况】\\n 128746\\n\\n\\n 请输入要查询的城市,如:北京\\n 07dc40e0360a11eb992f1908405f44bc\\n 9341f273905b422b81f77e68d0f377c6\\n 对话工厂\\n 2020-12-04 16:40:44\\n 查天气\\n 请输入要查询的城市,如:北京\\n 128681\\n","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":"\\n 2020-12-01 11:17:38\\n 1\\n 83225\\n 2020-12-01 11:17:38\\n c1187530338311ebade7cf3eaeb3668a\\n\\n10\\nC83D94BB-D371-4DE9-AEE2-14FE7B9CEBA9\\n1\\n1","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":"70\\nC7EDACCF-0268-4C4F-B529-317F98CA9EF9\\n\\n 0.8514851485148515\\n 14\\n 0.35714285714285715\\n","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":"94\\nA270DBA1-694D-447D-9EF9-160EADDB115E\\n\\n 测试004\\n","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":"72\\n078144CD-7C10-4019-9831-09BC388AAF8C\\n\\n 62\\n 20\\n 17\\n 查路况\\n 0.85\\n 0.0\\n 0.0\\n 0.15\\n\\n\\n 6\\n 5\\n 5\\n 查天气\\n 1.0\\n 0.0\\n 0.0\\n 0.0\\n\\n\\n 3\\n 2\\n 1\\n 测试004\\n 0.5\\n 0.0\\n 0.0\\n 0.5\\n","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":"171\\n736994BD-AA35-4742-88C9-E64BE4BAA14B\\n\\n 20\\n 查路况\\n\\n\\n 5\\n 查天气\\n\\n\\n 2\\n 测试004\\n","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":"66\\nAD38E52B-B64E-435D-8627-ABB374046CCC\\n\\n 3\\n 86\\n 3\\n 1\\n 8\\n","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":"\\n 106\\n 81EF7283-56D9-5C3B-B999-FFD303981545\\n \\n 6\\n 3\\n 0.5\\n 8\\n 0.5\\n 0\\n 0\\n 0\\n 1.3333333333333333\\n \\n","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":"83\\n1B5B71F0-FE39-466A-BC5E-187A7B6F4632\\n\\n 本地测试结果不好怎么办\\n\\n\\n 电池亏电?\\n\\n\\n 熬夜\\n","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":"13\\n9394952D-44A6-4AE2-8018-9E3423AAF3B7\\n\\n 本地测试结果不好怎么办\\n 14\\n\\n\\n 亏电?这些保养重点要牢记!\\n 2\\n","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":"78\\n1A0F7108-16AF-480C-AF54-45C11A97EAB4\\n\\n 本地测试结果不好怎么办\\n 14\\n 0.0\\n 本地\\n 2\\n 1002994742\\n 测试\\n\\n\\n 蓄电池亏电?这些保养重点要牢记!\\n 2\\n 0.0\\n 蓄电池\\n 0\\n 1002982291\\n test2\\n\\n\\n 熬夜\\n 0\\n 0.0\\n null\\n 0\\n 1003006429\\n 测试2\\n","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":"77\\n1CCB889E-9837-42C9-BAEC-641169D8DF2A\\n\\n 0\\n 3\\n 0\\n 0\\n 3\\n 2\\n 1\\n 0\\n 20201201\\n 1.0\\n\\n\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 20201206\\n 0.0\\n\\n\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 20201130\\n 0.0\\n\\n\\n 0\\n 5\\n 0\\n 5\\n 7\\n 0\\n 0\\n 7\\n 20201207\\n 1.4\\n\\n\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 20201129\\n 0.0\\n\\n\\n 3\\n 11\\n 67\\n 11\\n 71\\n 0\\n 0\\n 1\\n 20201204\\n 6.454545454545454\\n\\n\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 20201205\\n 0.0\\n\\n\\n 0\\n 6\\n 18\\n 5\\n 19\\n 1\\n 0\\n 0\\n 20201203\\n 3.1666666666666665\\n\\n\\n 0\\n 1\\n 1\\n 1\\n 1\\n 0\\n 0\\n 0\\n 20201202\\n 1.0\\n","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',
],
],
];