'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Chatbot', 'version' => '2022-04-08', ], 'directories' => [ [ 'id' => 189601, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateDoc', 'DeleteDoc', 'UpdateDoc', 'RetryDoc', 'SearchDoc', 'DescribeDoc', ], ], [ 'id' => 189608, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateCategory', 'DeleteCategory', 'UpdateCategory', 'DescribeCategory', 'ListCategory', ], ], [ 'id' => 167775, 'title' => null, 'type' => 'directory', 'children' => [ 'TongyiChatDebugInfo', 'ApplyForStreamAccessToken', 'Feedback', 'Chat', 'Associate', 'BeginSession', 'Nlu', ], ], [ 'id' => 168180, 'title' => null, 'type' => 'directory', 'children' => [ 'GetAsyncResult', ], ], [ 'id' => 168037, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 168069, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateInstance', 'DeleteInstance', 'UpdateInstance', 'LinkInstanceCategory', 'DescribeInstance', 'ListInstance', ], ], [ 'id' => 168038, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateInstancePublishTask', 'CancelInstancePublishTask', 'ContinueInstancePublishTask', 'GetInstancePublishTaskState', ], ], ], ], [ 'id' => 167654, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 168042, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateSolution', 'DeleteSolution', 'UpdateSolution', 'ListSolution', ], ], [ 'id' => 168043, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateConnQuestion', 'DeleteConnQuestion', 'UpdateConnQuestion', 'ListConnQuestion', ], ], [ 'id' => 168045, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateSimQuestion', 'DeleteSimQuestion', 'UpdateSimQuestion', 'ListSimQuestion', ], ], [ 'id' => 168046, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateFaq', 'DeleteFaq', 'UpdateFaq', 'DescribeFaq', 'SearchFaq', ], ], ], ], [ 'id' => 168050, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 168103, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 168104, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateDSEntity', 'DeleteDSEntity', 'UpdateDSEntity', 'DescribeDSEntity', 'ListDSEntity', ], ], [ 'id' => 168105, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateDSEntityValue', 'DeleteDSEntityValue', 'UpdateDSEntityValue', 'ListDSEntityValue', ], ], ], ], [ 'id' => 168106, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 168107, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateIntent', 'DeleteIntent', 'UpdateIntent', 'DescribeIntent', 'ListIntent', ], ], [ 'id' => 168108, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateUserSay', 'DeleteUserSay', 'UpdateUserSay', 'ListUserSay', ], ], [ 'id' => 168109, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateLgf', 'DeleteLgf', 'UpdateLgf', 'ListLgf', ], ], ], ], ], ], [ 'id' => 168068, 'title' => null, 'type' => 'directory', 'children' => [ 'CreatePerspective', 'DeletePerspective', 'UpdatePerspective', 'DescribePerspective', 'QueryPerspectives', ], ], [ 'id' => 168054, 'title' => null, 'type' => 'directory', 'children' => [ 'CreatePublishTask', 'CancelPublishTask', 'GetPublishTaskState', ], ], [ 'id' => 168056, 'title' => null, 'type' => 'directory', 'children' => [ 'GetAgentInfo', 'ListAgent', ], ], [ 'id' => 169501, 'title' => null, 'type' => 'directory', 'children' => [ 'GenerateUserAccessToken', ], ], [ 'id' => 192374, 'title' => null, 'type' => 'directory', 'children' => [ 'ListTongyiConversationLogs', 'ListTongyiChatHistorys', 'GetBotSessionData', ], ], [ 'id' => 187838, 'title' => null, 'type' => 'directory', 'children' => [ 'InitIMConnect', 'ListSaasInfo', 'ListSaasPermissionGroupInfos', 'CancelChat', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateDoc' => [ 'summary' => 'Create Document', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => [ 'title' => '文档类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30000049006', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', 'maxLength' => 128, 'minLength' => 1, ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => [ 'title' => '文档内容', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'title' => '文档解析/切分配置'."\n" .'配置项:切分器'."\n" .'KEY:Splitter'."\n" .'值选项:ParagraphSplitter-识别层级'."\n" .'值选项:TreeSplitter-规则层级'."\n" ."\n" .'配置项:文档切块大小'."\n" .'KEY:ChunkSize'."\n" .'VALUE:默认500;范围[200,800]'."\n" ."\n" .'配置项:规则层级'."\n" .'KEY:TreePatterns'."\n" .'VALUE:默认[]'."\n" ."\n" .'配置项:文档标题来源'."\n" .'KEY:TitleSource'."\n" .'值选项:ocrTitle - OCR识别标题【默认】'."\n" .'值选项:docName - 文档名即标题', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":""}', ], ], [ 'name' => 'Meta', 'in' => 'query', 'schema' => [ 'title' => '文档随路数据', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{"code":"xxx"}', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '生效开始时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-05-25T16:28:36Z'."\n", ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '生效结束时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2032-05-25T16:28:36Z'."\n", ], ], [ 'name' => 'Url', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '文档链接URL路径 ', 'type' => 'string', 'example' => 'https://example.com/example.pdf', ], ], [ 'name' => 'TagIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], [ 'name' => 'DocMetadata', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BusinessViewId' => [ 'type' => 'string', ], 'BusinessViewName' => [ 'type' => 'string', ], 'MetaCellInfoDTOList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FieldCode' => [ 'type' => 'string', ], 'FieldName' => [ 'type' => 'string', ], 'Value' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '07B270A4-61D8-57F6-A609-A3C216CFB872', ], 'KnowledgeId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30001905617', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', 'title' => 'Document Creation', ], 'DeleteDoc' => [ 'summary' => 'Document Deletion', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910', ], 'KnowledgeId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30002406051', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', 'title' => 'Delete Document', ], 'UpdateDoc' => [ 'summary' => 'Document Update', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => [ 'title' => '文档ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => [ 'title' => '文档类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '231001028593', ], ], [ 'name' => 'DocName', 'in' => 'query', 'schema' => [ 'title' => '文档名称', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', 'maxLength' => 128, 'minLength' => 1, ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', 'maxLength' => 128, 'minLength' => 1, ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => [ 'title' => '文档内容', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', 'maxLength' => 40000, ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'title' => '文档解析/切分配置'."\n" .'配置项:切分器'."\n" .'KEY:Splitter'."\n" .'值选项:ParagraphSplitter-识别层级【默认】'."\n" .'值选项:TreeSplitter-规则层级'."\n" ."\n" .'配置项:文档切块大小'."\n" .'KEY:ChunkSize'."\n" .'VALUE:默认500;范围[200,800]'."\n" ."\n" .'配置项:规则层级'."\n" .'KEY:TreePatterns'."\n" .'VALUE:默认[]'."\n" ."\n" .'配置项:文档标题来源'."\n" .'KEY:TitleSource'."\n" .'值选项:ocrTitle - OCR识别标题【默认】'."\n" .'值选项:docName - 文档名即标题', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":""}', ], ], [ 'name' => 'Meta', 'in' => 'query', 'schema' => [ 'title' => '文档随路数据', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{"code":"xxx"}', 'maxLength' => 1000, ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-05-25T16:28:36Z', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-03-11T23:59:59Z', ], ], [ 'name' => 'TagIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], [ 'name' => 'DocMetadata', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BusinessViewId' => [ 'type' => 'string', ], 'BusinessViewName' => [ 'type' => 'string', ], 'MetaCellInfoDTOList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FieldCode' => [ 'type' => 'string', ], 'FieldName' => [ 'type' => 'string', ], 'Value' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0F9F136A-1BF6-5CC1-9D57-9717761F03B8', ], 'KnowledgeId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30002406051', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', 'title' => 'Update Document', ], 'RetryDoc' => [ 'summary' => 'Document Retry', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'e2a20f74cd9042558002c0f7dc873739_p_outbound_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6419BA93-D111-5225-8998-13E63E6D3940', ], 'KnowledgeId' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '30001905617', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', 'title' => 'Document Retry', ], 'SearchDoc' => [ 'summary' => 'Document Search', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'CategoryIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000065594', ], 'required' => false, ], ], [ 'name' => 'ProcessStatus', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'SearchScope', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CreateUserName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'ModifyUserName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'CreateTimeBegin', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z', ], ], [ 'name' => 'CreateTimeEnd', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-05-02T03:09:30Z', ], ], [ 'name' => 'ModifyTimeBegin', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z', ], ], [ 'name' => 'ModifyTimeEnd', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z', ], ], [ 'name' => 'StartTimeBegin', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z', ], ], [ 'name' => 'StartTimeEnd', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-04-03T03:09:30Z', ], ], [ 'name' => 'EndTimeBegin', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z', ], ], [ 'name' => 'EndTimeEnd', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'TagIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '标签ID列表', 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', ], 'PageNumber' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '141', ], 'DocHits' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'KnowledgeId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30002692007', ], 'DocName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'BizCode' => [ 'description' => '', 'type' => 'string', 'example' => 'cn_dytns', ], 'Meta' => [ 'description' => '', 'type' => 'string', 'example' => '{"code":"xxx"}', ], 'Config' => [ 'description' => '', 'type' => 'string', 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}', ], 'Url' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'ModifyTime' => [ 'description' => '', 'type' => 'string', 'example' => '2023-06-25T02:27:42Z', ], 'ModifyUserName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'description' => '', 'type' => 'string', 'example' => '2023-06-22T03:53:41Z', ], 'CreateUserName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateUserId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111', ], 'ModifyUserId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '222222222', ], 'CategoryId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30000135654', ], 'ProcessStatus' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ProcessMessage' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'ProcessCanRetry' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Status' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EffectStatus' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'StartDate' => [ 'description' => '', 'type' => 'string', 'example' => '2023-02-28T11:40:18Z', ], 'EndDate' => [ 'description' => '', 'type' => 'string', 'example' => '2099-12-31T16:00:00Z', ], 'DocTags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TagId' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', ], 'TagName' => [ 'title' => '标签名称', 'type' => 'string', ], 'GroupId' => [ 'title' => '标签组ID', 'type' => 'integer', 'format' => 'int64', ], 'GroupName' => [ 'title' => '标签组名称', 'type' => 'string', ], 'DefaultTag' => [ 'title' => '是否默认全部标签', 'type' => 'boolean', ], ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', 'title' => 'Document Search', ], 'DescribeDoc' => [ 'summary' => 'Document Details', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001979424', ], ], [ 'name' => 'ShowDetail', 'in' => 'query', 'schema' => [ 'title' => '是否展示文档段落详细信息'."\n" .'true:展示'."\n" .'false:忽略(默认)', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7F132693-212A-40A9-8A81-11E7694E478B', ], 'KnowledgeId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424', ], 'DocName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Title' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'BizCode' => [ 'description' => '', 'type' => 'string', 'example' => 'bizcode123', ], 'Meta' => [ 'description' => '', 'type' => 'string', 'example' => '{"code":"xxx"}', ], 'Config' => [ 'description' => '', 'type' => 'string', 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}', ], 'Url' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'ModifyTime' => [ 'description' => '', 'type' => 'string', 'example' => '2020-11-25T08:56:55Z', ], 'ModifyUserName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'CreateUserName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateUserId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111', ], 'ModifyUserId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2222222222', ], 'CategoryId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30000049006', ], 'ProcessStatus' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ProcessMessage' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'ProcessCanRetry' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Status' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EffectStatus' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'StartDate' => [ 'description' => '', 'type' => 'string', 'example' => '1979-12-31T16:00:00Z', ], 'EndDate' => [ 'description' => '', 'type' => 'string', 'example' => '2023-04-27T06:08:54Z', ], 'DocInfo' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DocParas' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ParaNo' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ParaLevel' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ParaType' => [ 'description' => '', 'type' => 'string', 'example' => 'text', ], 'ParaText' => [ 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], ], ], 'DocTags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TagId' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', ], 'TagName' => [ 'title' => '标签名称', 'type' => 'string', ], 'GroupId' => [ 'title' => '标签分组ID', 'type' => 'integer', 'format' => 'int64', ], 'GroupName' => [ 'title' => '标签分组名称', 'type' => 'string', ], 'DefaultTag' => [ 'title' => '是否默认为全部标签', 'type' => 'boolean', ], ], ], ], 'DocMetadata' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BusinessViewId' => [ 'type' => 'string', ], 'BusinessViewName' => [ 'title' => '标签名称', 'type' => 'string', ], 'MetaCellInfoDTOList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FieldCode' => [ 'type' => 'string', ], 'FieldName' => [ 'type' => 'string', ], 'Value' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', 'title' => 'Document Details', ], 'CreateCategory' => [ 'summary' => 'Create Category', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => [ 'title' => '类目名称', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'BizCode', 'in' => 'formData', 'schema' => [ 'title' => '业务代码', 'type' => 'string', 'required' => false, ], ], [ 'name' => 'KnowledgeType', 'in' => 'formData', 'schema' => [ 'title' => '知识类型,FAQ类目:1,文档类目:3', 'type' => 'integer', 'format' => 'int32', 'required' => false, ], ], [ 'name' => 'ParentCategoryId', 'in' => 'formData', 'schema' => [ 'title' => '父类目ID,默认-1,对应根目录', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '-1', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'A629A28F-F25E-5572-A679-FA46FB0151D6', ], 'Category' => [ 'title' => '类目信息', 'description' => '', 'type' => 'object', 'properties' => [ 'CategoryId' => [ 'title' => '类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30000049006', ], 'BizCode' => [ 'type' => 'string', ], 'Name' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'ParentCategoryId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', ], 'Status' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], ], ], ], 'responseDemo' => '', 'title' => 'Categories - Create', ], 'DeleteCategory' => [ 'summary' => 'Delete Category', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ 'title' => '类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30000049006', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Category - Delete', ], 'UpdateCategory' => [ 'summary' => 'Edit Category', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ 'title' => '类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '231001028593', ], ], [ 'name' => 'BizCode', 'in' => 'formData', 'schema' => [ 'title' => '业务代码', 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => [ 'title' => '类目名称', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Categories - Update', ], 'DescribeCategory' => [ 'summary' => 'View Single Category Information', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ 'title' => '类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30000049006', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '2B0304FD-3804-5C06-9A83-77F5523664AF', ], 'Category' => [ 'title' => '类目信息', 'description' => '', 'type' => 'object', 'properties' => [ 'CategoryId' => [ 'title' => '类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30000049006', ], 'Name' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'ParentCategoryId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', ], 'Status' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'BizCode' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '', 'title' => 'Category Details', ], 'ListCategory' => [ 'summary' => 'Category List', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'KnowledgeType', 'in' => 'formData', 'schema' => [ 'title' => '知识类型,FAQ类目:1,文档类目:3', 'type' => 'integer', 'format' => 'int32', 'required' => false, ], ], [ 'name' => 'ParentCategoryId', 'in' => 'formData', 'schema' => [ 'title' => '父类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '-1', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Categories' => [ 'title' => 'list结果', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CategoryId' => [ 'title' => '类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '231001028593', ], 'BizCode' => [ 'type' => 'string', ], 'Name' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'ParentCategoryId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', ], 'Status' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '9C5F8186-2D22-433E-9545-606D344F30B5', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Get Category List', ], 'TongyiChatDebugInfo' => [ 'summary' => '大模型问答调试信息', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '264606', 'abilityTreeNodes' => [ 'FEATUREbeebotUKQQ1L', ], 'autoTest' => false, 'notSupportAutoTestReason' => '需要提供有效期内的MessageId', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe', ], ], [ 'name' => 'MessageId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '396E74B3-D84B-46CE-9E51-91C06AD22E31', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', ], 'MessageId' => [ 'description' => '', 'type' => 'string', 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661', ], 'Pipeline' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'NodeType' => [ 'description' => '', 'type' => 'string', 'example' => 'system_strategy', ], 'Name' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Input' => [ 'description' => '', 'type' => 'any', 'example' => '', ], 'Output' => [ 'description' => '', 'type' => 'any', 'example' => '', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => true, 'eventNames' => [], ], 'responseDemo' => null, ], 'ApplyForStreamAccessToken' => [ 'summary' => 'Apply for Streaming Gateway AccessToken', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '736994BD-AA35-4742-88C9-E64BE4BAA14B', ], 'AccessToken' => [ 'description' => '', 'type' => 'string', 'example' => '63ba97b4f18a4a04f715c81e8e643938', ], 'ChannelId' => [ 'description' => '', 'type' => 'string', 'example' => 'cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d', ], 'StreamSecret' => [ 'description' => '', 'type' => 'string', 'example' => 'cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', 'title' => 'Get Connection Information for Streaming Invocation', ], 'Feedback' => [ 'summary' => '问答点赞、点踩API', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'MessageId', 'in' => 'query', 'schema' => [ 'title' => '会话窗单次会话标识', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5ca40988-4f99-47ad-ac96-9060d0f81db9', ], ], [ 'name' => 'Feedback', 'in' => 'query', 'schema' => [ 'title' => 'good-点赞、bad-点踩', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'enumValueTitles' => [ 'bad' => 'bad', 'good' => 'good', ], 'example' => 'good', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => [ 'title' => '会话Session标识,标识:IM唯一标识会话', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', ], ], [ 'name' => 'FeedbackContent', 'in' => 'query', 'schema' => [ 'title' => '点赞、点踩的内容', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '这个回答很棒', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '4e5eea71-f326-450c-8849-49515473ef64', ], 'Feedback' => [ 'title' => 'good-点赞、bad-点踩', 'description' => '', 'type' => 'string', 'example' => 'good', ], 'MessageId' => [ 'title' => '会话窗单次会话标识', 'description' => '', 'type' => 'string', 'example' => '5ca40988-4f99-47ad-ac96-9060d0f81db9', ], ], ], ], ], 'responseDemo' => null, ], 'Chat' => [ 'summary' => '会话API', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人实例ID。登录云小蜜控制台,机器人详情->会话接口,查看机器人实例信息,可获得该实例ID。', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'Utterance', 'in' => 'query', 'schema' => [ 'title' => '机器人访问者的输入', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => [ 'title' => '会话ID,用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者,首次调用Chat接口时无需传递此字段,机器人会开启一个会话,并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话,调用Chat接口时传递当前会话的SessionId,机器人即可基于SessionId继续该轮次会话。长度限制是64个字符', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '9c6ebdc6e66f46ecadab3434314f6959', ], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => [ 'title' => '知识库中知识标题的ID。若指定此ID,那么机器人会直接返回指定知识标题的答案', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '30002406051', ], ], [ 'name' => 'SenderId', 'in' => 'query', 'schema' => [ 'title' => '访问者ID。用于识别当前会话中的用户', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'custumer_123456', ], ], [ 'name' => 'SenderNick', 'in' => 'query', 'schema' => [ 'title' => '当前会话中访问的昵称', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'IntentName', 'in' => 'query', 'schema' => [ 'title' => '对话流中意图名称。 若指定此名称,机器人会直接进入此意图做问答', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'Perspective', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '视角编码,用于调用同一知识标题下不同视角的答案。如:Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'FZJBY3raWr', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'VendorParam', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{"phone":123456789}', ], ], [ 'name' => 'SandBox', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'QuerySegList' => [ 'title' => 'query的分词结果,可能为空', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '', ], ], 'Messages' => [ 'title' => '消息的列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Knowledge' => [ 'title' => '当AnswerType为Knowledge时,此字段包含机器人返回的Knowledge对象', 'description' => '', 'type' => 'object', 'properties' => [ 'HitStatement' => [ 'title' => '命中语句', 'description' => '', 'type' => 'string', 'example' => '', ], 'Summary' => [ 'title' => '命中问题的简介', 'description' => '', 'type' => 'string', 'example' => '', ], 'RelatedKnowledges' => [ 'title' => '关联知识列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'KnowledgeId' => [ 'title' => '知识关联知识的ID', 'description' => '', 'type' => 'string', 'example' => '735899', ], 'Title' => [ 'title' => '知识的关联知识的标题', 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], 'Category' => [ 'title' => '知识类目', 'description' => '', 'type' => 'string', 'example' => '', ], 'Title' => [ 'title' => '命中问题的标题', 'description' => '', 'type' => 'string', 'example' => '', ], 'Content' => [ 'title' => '命中问题的内容', 'description' => '', 'type' => 'string', 'example' => '', ], 'AnswerSource' => [ 'title' => '区分答案类型。'."\n" .'KnowledgeBase:知识库条;', 'description' => '', 'type' => 'string', 'example' => 'KnowledgeBase', ], 'Id' => [ 'title' => '命中问题在知识库中的ID', 'description' => '', 'type' => 'string', 'example' => '735898', ], 'Score' => [ 'title' => '分数', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '0.998', ], 'ContentType' => [ 'title' => '纯文本/富文本答案的标示', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'PLAIN_TEXT' => '', 'RICH_TEXT' => '', ], 'example' => 'PLAIN_TEXT', 'enum' => [ 'PLAIN_TEXT:纯本文', 'RICH_TEXT: 富文本', 'CARD_TEMPLATE:卡片模版', ], ], ], ], 'Text' => [ 'title' => '当AnswerType为Text时,此字段包含机器人返回的Text对象', 'description' => '', 'type' => 'object', 'properties' => [ 'HitStatement' => [ 'title' => '命中语句', 'description' => '', 'type' => 'string', 'example' => '', ], 'DialogName' => [ 'title' => '当AnswerSource为BotFramework时,此字段返回对话单元名称', 'description' => '', 'type' => 'string', 'example' => '', ], 'ArticleTitle' => [ 'title' => '当AnswerSource为MACHINE_READ时,此字段返回命中文章标题', 'description' => '', 'type' => 'string', 'example' => '', ], 'AnswerSource' => [ 'title' => '区分答案类型', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'TABLEQA' => '', 'COMMANDS' => '', 'SENSITIVE_WORD' => '', 'BotFramework' => '', 'MACHINE_READ' => '', 'ChitChat' => '', 'NO_ANSWER' => '', ], 'example' => 'BotFramework', 'enum' => [ 'ChitChat:闲聊', 'BotFramework:对话工厂', 'NO_ANSWER:无答案', 'MACHINE_READ:机器阅读', 'CardAnswer:卡片答案', 'SENSITIVE_WORD: 全局敏感词', 'COMMANDS:系统指令', 'TABLEQA:表格问答', ], ], 'Slots' => [ 'title' => '当AnswerSource为BotFramework时,此字段返回专有名词列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Origin' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Name' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Hit' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], ], ], ], 'NodeName' => [ 'title' => '当AnswerSource为BotFramework时,此字段返回节点名称', 'description' => '', 'type' => 'string', 'example' => '', ], 'IntentName' => [ 'title' => '当AnswerSource为BotFramework时,此字段返回意图名称', 'description' => '', 'type' => 'string', 'example' => '', ], 'MetaData' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'ExternalFlags' => [ 'title' => '当AnswerSource为BotFramework时,此字段返回透传参数', 'description' => '', 'type' => 'object', ], 'Ext' => [ 'title' => '此字段返回透传参数', 'description' => '', 'type' => 'object', 'example' => '', ], 'UserDefinedChatTitle' => [ 'title' => '自定义闲聊主题title', 'description' => '', 'type' => 'string', 'example' => '', ], 'Content' => [ 'title' => '文本消息的内容', 'description' => '', 'type' => 'string', 'example' => '', ], 'NodeId' => [ 'title' => '当AnswerSource为BotFramework时,此字段返回节点Id', 'description' => '', 'type' => 'string', 'example' => '1410-c7a72a78.__city', ], 'Score' => [ 'title' => '分数', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '100.0', ], 'ContentType' => [ 'title' => '纯文本/富文本答案的标示', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'PLAIN_TEXT' => '', 'RICH_TEXT' => '', ], 'example' => 'PLAIN_TEXT', 'enum' => [ 'PLAIN_TEXT:纯本文', 'RICH_TEXT: 富文本', 'CARD_TEMPLATE:卡片模版', ], ], 'Commands' => [ 'title' => '指令参数,如转人工指令的转人工技能组', 'description' => '', 'type' => 'object', 'example' => '{'."\n" .' "sysToAgent": "{\\"skillGroup\\":\\"12\\"}"'."\n" .'}', ], 'ResponseType' => [ 'title' => '当AnswerSource=BotFramework,ResponseType=SSML时,表示命中对话工厂交互式填槽;否则字段不存在', 'description' => '', 'type' => 'string', 'example' => 'SSML', ], ], ], 'Recommends' => [ 'title' => '当AnswerType为Recommend时,此字段包含机器人返回的Recommend的列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'KnowledgeId' => [ 'title' => '澄清的知识id', 'description' => '', 'type' => 'string', 'example' => '4548', ], 'Title' => [ 'title' => '澄清内容,可能是'."\n" .'图谱问答的实体、'."\n" .'知识问答的知识标题、'."\n" .'表格问答的列值', 'description' => '', 'type' => 'string', 'example' => '', ], 'AnswerSource' => [ 'title' => '澄清来源的标识', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'BotFramework' => '', 'Knowledge' => 'FAQ', ], 'example' => 'KNOWLEDGE', 'enum' => [ 'Knowledge:FAQ标题', 'BotFramework:对话工厂', ], ], 'Score' => [ 'title' => '推荐内容的分数,当AnswerSource为KNOWLEDGE时,此字段有值', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '0.46', ], ], ], ], 'AnswerType' => [ 'title' => '本条消息的类型', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'Recommend' => '', 'Text' => '', 'Knowledge' => '', ], 'example' => 'Text', 'enum' => [ 'Text:文本', 'Recommend:澄清或者反问', 'Knowledge:知识库知识直出', 'cardAnswer:卡片工坊的卡片答案', ], ], 'AnswerSource' => [ 'title' => '当AnswerType为Recommend时,此字段表示推荐的答案来源', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ ' INTENT_FAQ_CLARIFY' => '', 'TABLEQA' => '', 'KNOWLEDGE' => 'FAQ', 'BotFramework' => '', ], 'example' => 'KNOWLEDGE', 'enum' => [ 'KNOWLEDGE:知识问答', 'INTENT_FAQ_CLARIFY:FAQ和对话工厂混合澄清', 'BotFramework:对话工厂澄清', 'TABLEQA:表格问答', ], ], 'VoiceTitle' => [ 'title' => '当AnswerType为Recommend时,并且问答的机器人为语音机器人,此字段表示列表型答案在语音场景渲染之后的答案内容', 'description' => '', 'type' => 'string', 'example' => '', ], 'Title' => [ 'title' => '当AnswerType为Recommend时,此字段表示推荐或者反问的标题话术', 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], 'RequestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC', ], 'SessionId' => [ 'title' => '本次会话的ID', 'description' => '', 'type' => 'string', 'example' => 'a6f216a0685c4c8baa0e8beb6d5ec6db', ], 'MessageId' => [ 'title' => '本条会话应答消息的ID', 'description' => '', 'type' => 'string', 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC'."\n", ], ], ], ], ], 'responseDemo' => null, ], 'Associate' => [ 'summary' => '会话-联想API', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'Utterance', 'in' => 'query', 'schema' => [ 'title' => '用户表述', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '公积金提取', ], ], [ 'name' => 'Perspective', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '视角编码,用于调用同一知识标题下不同视角的答案。在拼装请求参数时,需要以Perspective={视角编码}的格式传递参数。如:&Perspective=["FZJBY3raWr"]。使用SDK时以SDK中定义的参数为准。目前仅支持一个视角答案的调用。 (公有云)', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'FZJBY3raWr', ], 'required' => false, 'example' => '["qyzzVfyFfa"]', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => [ 'title' => '会话ID,用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者,首次调用Chat接口时无需传递此字段,机器人会开启一个会话,并在Chat接口的响应中返回该会话的SessionId。对于该访问者的后续轮次的会话,调用Chat接口时传递当前会话的SessionId,机器人即可基于SessionId继续该轮次会话。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', ], ], [ 'name' => 'RecommendNum', 'in' => 'query', 'schema' => [ 'title' => '推荐问题数量,1-10,当出推荐的时候才生效,返回不大于RecommendN', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '5C20F0D4-9721-178A-8236-3BF990634962', ], 'Associate' => [ 'title' => '联想的列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Meta' => [ 'title' => '附带信息', 'description' => '', 'type' => 'string', 'example' => '{}', ], 'Title' => [ 'title' => '关联问题的标题', 'description' => '', 'type' => 'string', 'example' => '公积金提取的政策', ], ], ], ], 'SessionId' => [ 'title' => '本次会话的ID', 'description' => '', 'type' => 'string', 'example' => '1531ded6b3df4afca4be63943f708bb7', ], 'MessageId' => [ 'title' => '本条会话应答消息的ID', 'description' => '', 'type' => 'string', 'example' => '5ADF0EBD-7C50-1922-A28B-43215B47CC1A', ], ], ], ], ], 'responseDemo' => null, ], 'BeginSession' => [ 'summary' => '获取欢迎语', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotUKQQ1L', ], ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'SandBox', 'in' => 'formData', 'schema' => [ 'type' => 'boolean', ], ], [ 'name' => 'VendorParam', 'in' => 'formData', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '149C7528-C104-1B50-A4F9-0C5907A8AD9D', ], 'WelcomeMessage' => [ 'title' => '欢迎语', 'description' => '', 'type' => 'string', 'example' => '智能对话机器人为您服务,请问有什么可以帮您?', ], 'SilenceReplyTimeout' => [ 'description' => '静默超时时间', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Interruptible' => [ 'type' => 'boolean', ], 'AsrMaxEndSilence' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => null, ], 'Nlu' => [ 'summary' => '统一NLU接口', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'Utterance', 'in' => 'query', 'schema' => [ 'title' => '用户表述', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '北京的天气怎么样', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Messages' => [ 'title' => '消息的列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DialogHubNluInfo' => [ 'title' => '对话中控的nlu信息', 'description' => '', 'type' => 'object', 'properties' => [ 'GlobalDictList' => [ 'title' => '全局名词列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StandardWord' => [ 'title' => '名词', 'description' => '', 'type' => 'string', 'example' => '天气', ], 'Word' => [ 'title' => '同义词', 'description' => '', 'type' => 'string', 'example' => '天气', ], ], ], ], 'GlobalSensitiveWordList' => [ 'title' => '全局敏感词列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StandardWord' => [ 'title' => '名词', 'description' => '', 'type' => 'string', 'example' => '天气', ], 'Word' => [ 'title' => '同义词', 'description' => '', 'type' => 'string', 'example' => '天气', ], ], ], ], ], ], 'DsNluInfo' => [ 'title' => '对话工厂的nlu信息', 'description' => '', 'type' => 'object', 'properties' => [ 'EntityList' => [ 'title' => '实体列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '实体名称', 'description' => '', 'type' => 'string', 'example' => '@城市', ], 'Origin' => [ 'title' => '实体原词(实体成员)', 'description' => '', 'type' => 'string', 'example' => '北京', ], 'Type' => [ 'title' => '实体类型,当前只有text类型', 'description' => '', 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'title' => '实体同义词', 'description' => '', 'type' => 'string', 'example' => '首都', ], ], ], ], 'IntentList' => [ 'title' => '意图列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IntentId' => [ 'title' => '意图id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '724387', ], 'MatchDetail' => [ 'title' => '匹配详情(匹配过程)', 'description' => '', 'type' => 'string', 'example' => 'classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]', ], 'MatchType' => [ 'title' => '匹配类型,其枚举值含义如下: Similarity:query与意图通过意图话术相似度匹配 Lgf:query与意图通过LGF匹配 Classify:query与意图通过模型训练匹配 FewShotLearning:query与意图通过系统内置fewshot模型匹配 BuildIn: query与系统内置意图匹配', 'description' => '', 'type' => 'string', 'example' => 'FewShotLearning', ], 'Name' => [ 'title' => '意图名称', 'description' => '', 'type' => 'string', 'example' => '查天气意图', ], 'Score' => [ 'title' => '分数', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '0.995', ], 'SlotList' => [ 'title' => '命中意图的槽位列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '实体名称', 'description' => '', 'type' => 'string', 'example' => '@城市', ], 'Origin' => [ 'title' => '实体原词(实体成员)', 'description' => '', 'type' => 'string', 'example' => '北京', ], 'Type' => [ 'title' => '实体类型,当前只有text类型', 'description' => '', 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'title' => '实体同义词', 'description' => '', 'type' => 'string', 'example' => '首都', ], ], ], ], ], ], ], ], ], ], ], ], 'RequestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'A6357C1B-1D79-1382-B259-BD9E80751B42', ], 'MessageId' => [ 'title' => '本条语言理解应答消息的ID', 'description' => '', 'type' => 'string', 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661', ], ], ], ], ], 'responseDemo' => null, ], 'GetAsyncResult' => [ 'summary' => '获取异步函数执行结果接口', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '从Chat接口返回参数中获取TASK_ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902', ], ], ], ], ], 'responseDemo' => null, ], 'CreateInstance' => [ 'summary' => '机器人-创建', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '机器人名称,不超过50字', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '小蜜机器人', ], ], [ 'name' => 'LanguageCode', 'in' => 'query', 'schema' => [ 'title' => '机器人服务的语言,如zh-cn、en-us,参考 http://www.lingoes.net/zh/translator/langcode.htm 入参全小写,当前只支持 zh-cn、en-us', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'zh-cn', ], ], [ 'name' => 'Introduction', 'in' => 'query', 'schema' => [ 'title' => '机器人备注,不超过50字', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '用于手机app的小蜜机器人', ], ], [ 'name' => 'RobotType', 'in' => 'query', 'schema' => [ 'title' => '机器人类型', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'scenario_callout' => '', 'scenario_im' => '', 'scenario_ivr' => '', ], 'example' => 'scenario_im', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A', ], 'InstanceId' => [ 'title' => '机器人唯一标识', 'description' => '', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], ], ], ], 'responseDemo' => null, ], 'DeleteInstance' => [ 'summary' => '机器人-删除', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', ], 'Status' => [ 'title' => '任务状态,可以在GetInstancePublishTaskState API 了解更多的状态', 'description' => '', 'type' => 'string', 'example' => 'FE_RUNNING', ], 'Response' => [ 'title' => '任务id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8521', ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'robot', ], ], 'CreateTime' => [ 'title' => '任务创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2021-09-11T09:26:14Z', ], 'CreateUserId' => [ 'title' => '任务创建人Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '9052', ], 'Error' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'Id' => [ 'title' => '任务id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8521', ], 'CreateUserName' => [ 'title' => '任务创建人', 'description' => '', 'type' => 'string', 'example' => 'xuqiang_test', ], ], ], ], ], 'responseDemo' => null, ], 'UpdateInstance' => [ 'summary' => '机器人-修改', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '要修改的机器人名称', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '智能客服-小C', ], ], [ 'name' => 'Introduction', 'in' => 'query', 'schema' => [ 'title' => '要修改的机器人备注', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '用于C端问答的机器人', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'C45BFEE4-F657-1332-8B47-2C757B94C972', ], ], ], ], ], 'responseDemo' => null, ], 'LinkInstanceCategory' => [ 'summary' => '机器人-绑定类目', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotW5WL9W', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人唯一标识', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'CategoryIds', 'in' => 'formData', 'allowEmptyValue' => true, 'schema' => [ 'title' => '知识类目Id', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[\\"30000065789\\"]', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'AbilityType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'example' => 'FAQ,MRC', 'default' => 'FAQ', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => 'D8C96601-E645-1BD7-99F3-04EADAB84E29', ], ], ], ], ], 'responseDemo' => null, ], 'DescribeInstance' => [ 'summary' => '机器人-详情', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotW5WL9W', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '907AA5F2-0521-49AB-80AB-1ADEFAB2B901', ], 'InstanceId' => [ 'title' => '机器人唯一标识', 'description' => '', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050', ], 'Name' => [ 'title' => '机器人名称', 'description' => '', 'type' => 'string', 'example' => '智能客服-小C', ], 'TimeZone' => [ 'title' => '机器人的时区,参考《公共-时区码》', 'description' => '', 'type' => 'string', 'example' => 'Asia/Chongqing', ], 'Introduction' => [ 'title' => '机器人备注', 'description' => '', 'type' => 'string', 'example' => '用于C端问答的机器人', ], 'LanguageCode' => [ 'title' => '机器人服务的语言,如zh-cn、en-us', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'en-us' => '', 'zh-cn' => '', ], 'example' => 'zh-cn', ], 'RobotType' => [ 'title' => '机器人类型', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'scenario_callout' => '', 'scenario_im' => '', 'scenario_ivr' => '', ], 'example' => 'scenario_im', ], 'Avatar' => [ 'title' => '机器人头像的URL', 'description' => '', 'type' => 'string', 'example' => '/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png', ], 'EditStatus' => [ 'title' => '机器人状态: EDITING(编辑中)、 PUBLISHED(已发布)', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'PUBLISHED' => '', 'EDITING' => '', ], 'example' => 'PUBLISHED', ], 'CreateTime' => [ 'title' => '机器人创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'Categories' => [ 'title' => '类目列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CategoryId' => [ 'title' => '类目id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30000066832', ], 'Name' => [ 'title' => '类目名称', 'description' => '', 'type' => 'string', 'example' => '杭州市防疫政策', ], 'ParentCategoryId' => [ 'title' => '父类目id,-1表示根目录', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', ], 'AbilityType' => [ 'type' => 'string', ], ], ], ], ], ], ], ], 'responseDemo' => null, ], 'ListInstance' => [ 'summary' => '机器人-修改', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotW5WL9W', ], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '分页-第几页,默认1', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页-页面大小,默认10', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], ], [ 'name' => 'RobotType', 'in' => 'query', 'schema' => [ 'title' => '按机器人类型筛选', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'scenario_callout' => '', 'scenario_im' => '', 'scenario_ivr' => '', ], 'example' => 'scenario_im', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '按机器人名称模糊搜索', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'scenario_im', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'Sandbox', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Instances' => [ 'title' => '机器人列表信息', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'title' => '机器人唯一标识', 'description' => '', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050', ], 'Name' => [ 'title' => '机器人名称', 'description' => '', 'type' => 'string', 'example' => '智能客服-小C', ], 'Introduction' => [ 'title' => '机器人备注', 'description' => '', 'type' => 'string', 'example' => '用于C端问答的机器人', ], 'LanguageCode' => [ 'title' => '机器人服务的语言', 'description' => '', 'type' => 'string', 'example' => 'zh-cn', ], 'RobotType' => [ 'title' => '机器人类型', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'scenario_callout' => '', 'scenario_im' => '', 'scenario_ivr' => '', ], 'example' => 'scenario_im', ], 'Avatar' => [ 'title' => '机器人头像的URL', 'description' => '', 'type' => 'string', 'example' => '/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png', ], 'CreateTime' => [ 'title' => '机器人创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], ], ], ], 'TotalCount' => [ 'title' => '总条数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '23', ], 'PageSize' => [ 'title' => '分页-页面大小', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'PageNumber' => [ 'title' => '分页-第几页', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B', ], ], ], ], ], 'responseDemo' => null, ], 'CreateInstancePublishTask' => [ 'summary' => '创建机器人发布任务', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人唯一标识', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', ], 'Id' => [ 'title' => '任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', ], 'Response' => [ 'title' => '任务Id', 'description' => '', 'type' => 'string', 'example' => '8522', ], 'Status' => [ 'title' => '任务状态', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'FE_SUCCESS' => '', 'FE_ABORTED' => '', 'FE_WARNING' => '', 'FE_FAILED' => '', 'FE_RUNNING' => '', ], 'example' => 'FE_RUNNING', 'enum' => [ 'FE_RUNNING:正在发布中', 'FE_WARNING:有警告,若需继续,请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS:发布成功', 'FE_FAILED:发布失败', 'FE_ABORTED:发布取消', ], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'robot', ], ], 'Error' => [ 'title' => 'job失败信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'title' => '任务创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'ModifyTime' => [ 'title' => '任务修改的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', ], ], ], ], ], 'responseDemo' => null, ], 'CancelInstancePublishTask' => [ 'summary' => '取消机器人发布', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '任务ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', ], 'Id' => [ 'title' => '任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', ], 'Response' => [ 'title' => '任务Id', 'description' => '', 'type' => 'string', 'example' => '8522', ], 'Status' => [ 'title' => '任务状态', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'FE_SUCCESS' => '', 'FE_ABORTED' => '', 'FE_FAILED' => '', 'FE_RUNNING' => '', ], 'example' => 'FE_ABORTED', 'enum' => [ 'FE_RUNNING:正在发布中', 'FE_WARNING:有警告,若需继续,请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS:发布成功', 'FE_FAILED:发布失败', 'FE_ABORTED:发布取消', ], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'robot', ], ], 'Error' => [ 'title' => 'job失败信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'title' => '任务创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'ModifyTime' => [ 'title' => '任务修改的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', ], ], ], ], ], 'responseDemo' => null, ], 'ContinueInstancePublishTask' => [ 'summary' => '继续机器人发布', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '任务ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', ], 'Id' => [ 'title' => '任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', ], 'Response' => [ 'title' => '任务Id', 'description' => '', 'type' => 'string', 'example' => '8522', ], 'Status' => [ 'title' => '任务状态', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'FE_SUCCESS' => '', 'FE_ABORTED' => '', 'FE_WARNING' => '', 'FE_FAILED' => '', 'FE_RUNNING' => '', ], 'example' => 'FE_RUNNING', 'enum' => [ 'FE_RUNNING:正在发布中', 'FE_WARNING:有警告,若需继续,请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS:发布成功', 'FE_FAILED:发布失败', 'FE_ABORTED:发布取消', ], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'robot', ], ], 'Error' => [ 'title' => 'job失败信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'title' => '任务创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'ModifyTime' => [ 'title' => '任务修改的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', ], 'Warnings' => [ 'title' => '各子发布模块的警告信息,key是子发布模块,value是警告信息', 'description' => '', 'type' => 'object', 'example' => '{ "category_bind_faq": [ "以下类目没有发布到正式环境: 项目交付信息汇总" ] }', ], 'Errors' => [ 'title' => '各子发布模块的错误信息,key是子发布模块,value是错误信息', 'description' => '', 'type' => 'object', 'example' => '{}', ], ], ], ], ], 'responseDemo' => null, ], 'GetInstancePublishTaskState' => [ 'summary' => '查询机器人发布进度', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '任务ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', ], 'Id' => [ 'title' => '任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', ], 'Response' => [ 'title' => '任务Id', 'description' => '', 'type' => 'string', 'example' => '8522', ], 'Status' => [ 'title' => '任务状态', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'FE_SUCCESS' => '', 'FE_ABORTED' => '', 'FE_WARNING' => '', 'FE_FAILED' => '', 'FE_RUNNING' => '', ], 'example' => 'FE_RUNNING', 'enum' => [ 'FE_RUNNING:正在发布中', 'FE_WARNING:有警告,若需继续,请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS:发布成功', 'FE_FAILED:发布失败', 'FE_ABORTED:发布取消', ], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'robot', ], ], 'Error' => [ 'title' => 'job失败信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'title' => '任务创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'ModifyTime' => [ 'title' => '任务修改的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', ], 'Warnings' => [ 'title' => '各子发布模块的警告信息,key是子发布模块,value是警告信息', 'description' => '', 'type' => 'object', 'example' => '', ], 'Errors' => [ 'title' => '各子发布模块的错误信息,key是子发布模块,value是错误信息', 'description' => '', 'type' => 'object', 'example' => '', ], ], ], ], ], 'responseDemo' => null, ], 'CreateSolution' => [ 'summary' => 'Create New FAQ Answer', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotVKU6KE', ], ], 'parameters' => [ [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => [ 'title' => '答案内容', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'ContentType', 'in' => 'query', 'schema' => [ 'title' => '答案类型', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PerspectiveCodes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '视角code列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'm8qAIvUUAIf', ], 'required' => true, 'maxItems' => 10, ], ], [ 'name' => 'TagIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '标签ID列表', 'type' => 'array', 'items' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '25645645', ], ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419', ], 'SolutionId' => [ 'title' => '答案ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100001089003', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Create FAQ Solution', ], 'DeleteSolution' => [ 'summary' => 'Delete FAQ Solution', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SolutionId', 'in' => 'formData', 'schema' => [ 'title' => '答案ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '100001321580', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Delete FAQ Solution', ], 'UpdateSolution' => [ 'summary' => 'Update FAQ Answer', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotVKU6KE', ], ], 'parameters' => [ [ 'name' => 'SolutionId', 'in' => 'formData', 'schema' => [ 'title' => '答案ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '100001333260', ], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => [ 'title' => '答案内容', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'ContentType', 'in' => 'formData', 'schema' => [ 'title' => '答案类型', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PerspectiveCodes', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '视角code列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'default', ], 'required' => true, 'maxItems' => 10, ], ], [ 'name' => 'TagIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '标签ID列表', 'type' => 'array', 'items' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '25645645', ], ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '8B8F098D-A338-54DD-B19C-24BBBCBD8498', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Update FAQ Answer', ], 'ListSolution' => [ 'summary' => 'FAQ Solution List', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotVKU6KE', ], ], 'parameters' => [ [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'Solutions' => [ 'title' => '答案列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SolutionId' => [ 'title' => '答案ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '496', ], 'ModifyTime' => [ 'title' => '修改时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-03-29T06:23:53Z', ], 'CreateTime' => [ 'title' => '创建时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-03-29T03:55:04Z', ], 'Content' => [ 'title' => '答案内容', 'description' => '', 'type' => 'string', 'example' => '', ], 'ContentType' => [ 'title' => '答案类型(0纯文本,1富文本)', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PlainText' => [ 'title' => '答案纯文本内容', 'description' => '', 'type' => 'string', 'example' => '', ], 'PerspectiveCodes' => [ 'title' => '视角code列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'm8qAIvUUAIf', ], ], 'TagIdList' => [ 'title' => '标签ID列表', 'type' => 'array', 'items' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1232342', ], ], ], ], ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '5B29DB5E-251D-5A73-84B5-A12DF795F231', 'title' => '请求ID', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Get FAQ Solution List', ], 'CreateConnQuestion' => [ 'summary' => 'Create FAQ Connection Question', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ConnQuestionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30002654628', ], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30002174773', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'C191B48B-9268-4FB1-A3C2-5143B4A91D0C', ], 'OutlineId' => [ 'title' => '关联关系ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1000002123', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Create Connection Question', ], 'DeleteConnQuestion' => [ 'summary' => 'Delete FAQ Connection Question', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'OutlineId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '877397683', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'FC323352-3AD7-59A1-9088-A64470BAFC9D', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Delete FAQ Connection Question', ], 'UpdateConnQuestion' => [ 'summary' => 'Update FAQ Connection Question', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ConnQuestionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000000295', ], ], [ 'name' => 'OutlineId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '877397683', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '004EB5C0-9DEB-53BF-A57A-0407A6D6B3C9', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Update FAQ Association Question', ], 'ListConnQuestion' => [ 'summary' => 'Query FAQ Connection Questions List', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B', ], 'Outlines' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'OutlineId' => [ 'title' => '关联关系ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '797', ], 'ConnQuestionId' => [ 'title' => '关联知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424', ], 'Title' => [ 'title' => '关联知识题目', 'description' => '', 'type' => 'string', 'example' => '', ], 'ModifyTime' => [ 'title' => '修改时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-26T10:18:15Z', ], 'CreateTime' => [ 'title' => '创建时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-02-25T02:47:18Z', ], ], ], ], ], ], ], ], 'responseDemo' => '', 'title' => 'Get Associated Questions List', ], 'CreateSimQuestion' => [ 'summary' => 'Create FAQ Similar Question', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '相似问标题,字数上限-120', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'SimQuestionId' => [ 'title' => '相似问ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1000002788', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '16AC1B3C-66E0-438B-BB7C-71B692407B67', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Create Similar Question', ], 'DeleteSimQuestion' => [ 'summary' => 'Delete FAQ Similar Question', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'SimQuestionId', 'in' => 'formData', 'schema' => [ 'title' => '相似问ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000002788', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '6419BA93-D111-5225-8998-13E63E6D3940', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Delete FAQ Similar Question', ], 'UpdateSimQuestion' => [ 'summary' => 'Update FAQ Similar Questions', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '相似问标题,字数上限-120', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'SimQuestionId', 'in' => 'formData', 'schema' => [ 'title' => '相似问ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000002788', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Update FAQ Similar Questions', ], 'ListSimQuestion' => [ 'summary' => 'FAQ Similar Questions List', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30002299537', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51', ], 'SimQuestions' => [ 'title' => '相似问列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SimQuestionId' => [ 'title' => '相似问ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424', ], 'ModifyTime' => [ 'title' => '修改时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-13T03:49:28Z', ], 'CreateTime' => [ 'title' => '创建时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-30T02:08:33Z', ], 'Title' => [ 'title' => '相似问标题', 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], ], ], ], ], 'responseDemo' => '', 'title' => 'Get FAQ Similar Questions List', ], 'CreateFaq' => [ 'summary' => 'New FAQ', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebot2KMN8Y', ], ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ 'title' => '知识的类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000053274', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '知识标题', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'StartDate', 'in' => 'formData', 'schema' => [ 'title' => '生效时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-05-25T16:28:36Z', ], ], [ 'name' => 'EndDate', 'in' => 'formData', 'schema' => [ 'title' => '失效时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2030-12-31T16:00:00Z', ], ], [ 'name' => 'SolutionContent', 'in' => 'formData', 'schema' => [ 'title' => '默认答案内容', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'SolutionType', 'in' => 'formData', 'schema' => [ 'title' => '默认答案类型', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'TagIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '标签ID列表', 'type' => 'array', 'items' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '25645645', ], ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'KnowledgeId' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Create FAQ', ], 'DeleteFaq' => [ 'summary' => 'Delete FAQ. If it is published knowledge, after deletion, it becomes deleted but not published, and requires publishing to be truly deleted.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => [ 'title' => '知识ID,创建知识该值为空', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Delete FAQ', ], 'UpdateFaq' => [ 'summary' => 'Update FAQ', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebot2KMN8Y', ], ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', ], ], [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ 'title' => '知识的类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30000049006', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => [ 'title' => '知识标题', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'StartDate', 'in' => 'formData', 'schema' => [ 'title' => '生效时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-05-27T05:18:20Z', ], ], [ 'name' => 'EndDate', 'in' => 'formData', 'schema' => [ 'title' => '失效时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2030-12-31T16:00:00Z', ], ], [ 'name' => 'TagIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '标签ID列表', 'type' => 'array', 'items' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '25645645', ], ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '736994BD-AA35-4742-88C9-E64BE4BAA14B', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Modify FAQ', ], 'DescribeFaq' => [ 'summary' => 'Knowledge Details', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebot2KMN8Y', ], ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001979424', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'KnowledgeResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'KnowledgeId' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424', ], 'Title' => [ 'title' => '标题', 'description' => '', 'type' => 'string', 'example' => '', ], 'ModifyTime' => [ 'title' => '修改时间(UTC时间)', 'description' => '', 'type' => 'string', 'example' => '2020-12-02T06:35:50Z', ], 'ModifyUserName' => [ 'title' => '修改人', 'description' => '', 'type' => 'string', 'example' => 'test01', ], 'CreateTime' => [ 'title' => '创建时间(UTC时间)', 'description' => '', 'type' => 'string', 'example' => '2020-11-30T03:03:37Z', ], 'CreateUserName' => [ 'title' => '创建人', 'description' => '', 'type' => 'string', 'example' => 'test01', ], 'CategoryId' => [ 'title' => '类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30000055617', ], 'Status' => [ 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'EffectStatus' => [ 'title' => '知识生效状态,根据StartDate, EndDate计算出来: 20-生效中, 21-已失效, 22-待生效', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'StartDate' => [ 'title' => '生效时间(UTC时间)', 'description' => '', 'type' => 'string', 'example' => '2022-04-27T07:04:39Z', ], 'EndDate' => [ 'title' => '失效时间(UTC时间)', 'description' => '', 'type' => 'string', 'example' => '2023-04-27T06:08:54Z', ], 'SimQuestions' => [ 'title' => '相似问列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SimQuestionId' => [ 'title' => '相似问ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000581', ], 'ModifyTime' => [ 'title' => '修改时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-29T03:55:07Z', ], 'CreateTime' => [ 'title' => '创建时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-26T10:24:00Z', ], 'Title' => [ 'title' => '相似问标题', 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], 'Solutions' => [ 'title' => '答案列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SolutionId' => [ 'title' => '答案ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10000003071', ], 'ModifyTime' => [ 'title' => '修改时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-29T07:07:13Z', ], 'CreateTime' => [ 'title' => '创建时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-26T10:24:00Z', ], 'Content' => [ 'title' => '答案内容', 'description' => '', 'type' => 'string', 'example' => '', ], 'ContentType' => [ 'title' => '答案类型(0纯文本,1富文本)', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'PlainText' => [ 'title' => '答案纯文本内容', 'description' => '', 'type' => 'string', 'example' => '', ], 'PerspectiveCodes' => [ 'title' => '视角code列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'default', 'title' => '视角code', ], ], 'TagIdList' => [ 'title' => '标签ID集合', 'type' => 'array', 'items' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', 'example' => '322353453', ], 'required' => false, ], ], ], ], 'Outlines' => [ 'title' => '关联问列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'OutlineId' => [ 'title' => '关联关系ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '797', ], 'ConnQuestionId' => [ 'title' => '关联知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1000098002', ], 'Title' => [ 'title' => '关联知识标题', 'description' => '', 'type' => 'string', 'example' => '', ], 'ModifyTime' => [ 'title' => '修改时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-26T18:12:02Z', ], 'CreateTime' => [ 'title' => '创建时间(UTC 时间)', 'description' => '', 'type' => 'string', 'example' => '2022-05-26T10:24:00Z', ], ], ], ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32', ], 'TagIdList' => [ 'title' => '标签ID列表', 'type' => 'array', 'items' => [ 'title' => '标签ID', 'type' => 'integer', 'format' => 'int64', ], ], ], ], ], ], 'responseDemo' => '', 'title' => 'Get FAQ Details', ], 'SearchFaq' => [ 'summary' => 'Knowledge Search', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => [ 'title' => '关键字', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'CategoryIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '类目唯一标识', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000065594', ], 'required' => false, ], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 1 => '', '', '', -1 => '', ], 'example' => '1', ], ], [ 'name' => 'SearchScope', 'in' => 'formData', 'schema' => [ 'title' => '搜索范围: 1-搜索标题相似问, 2-搜索答案, 3-搜索全部', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 1 => '', '', '', ], 'example' => '1', ], ], [ 'name' => 'CreateUserName', 'in' => 'formData', 'schema' => [ 'title' => '创建人', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test01', ], ], [ 'name' => 'ModifyUserName', 'in' => 'formData', 'schema' => [ 'title' => '修改人', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test01', ], ], [ 'name' => 'CreateTimeBegin', 'in' => 'formData', 'schema' => [ 'title' => '创建开始时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z', ], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => [ 'title' => '创建结束时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-05-02T03:09:30Z', ], ], [ 'name' => 'ModifyTimeBegin', 'in' => 'formData', 'schema' => [ 'title' => '修改开始时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z', ], ], [ 'name' => 'ModifyTimeEnd', 'in' => 'formData', 'schema' => [ 'title' => '修改结束时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z', ], ], [ 'name' => 'StartTimeBegin', 'in' => 'formData', 'schema' => [ 'title' => '生效开始时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z', ], ], [ 'name' => 'StartTimeEnd', 'in' => 'formData', 'schema' => [ 'title' => '生效结束时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-04-03T03:09:30Z', ], ], [ 'name' => 'EndTimeBegin', 'in' => 'formData', 'schema' => [ 'title' => '失效开始时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z', ], ], [ 'name' => 'EndTimeEnd', 'in' => 'formData', 'schema' => [ 'title' => '失效结束时间', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '页码 默认1', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页数量,默认10,最大50', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => '', 'type' => 'object', 'properties' => [ 'FaqHits' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'KnowledgeId' => [ 'title' => '知识ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30002145804', ], 'ModifyTime' => [ 'title' => '修改时间(UTC时间)', 'description' => '', 'type' => 'string', 'example' => '2022-04-02T03:09:30Z', ], 'ModifyUserName' => [ 'title' => '修改人', 'description' => '', 'type' => 'string', 'example' => 'test01', ], 'CreateTime' => [ 'title' => '创建时间(UTC时间)', 'description' => '', 'type' => 'string', 'example' => '2022-04-02T03:09:30Z', ], 'CreateUserName' => [ 'title' => '创建人', 'description' => '', 'type' => 'string', 'example' => 'test01', ], 'CreateUserId' => [ 'title' => '创建人ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '18453', ], 'ModifyUserId' => [ 'title' => '修改人ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '18453', ], 'CategoryId' => [ 'title' => '类目ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30000055639', ], 'Status' => [ 'title' => '知识状态: -1-已删除未发布, 1-未发布, 2-已发布, 3-已更新未发布', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [ 1 => '', '', '', -1 => '', ], 'example' => '3', ], 'EffectStatus' => [ 'title' => '知识生效状态,根据StartDate, EndDate计算出来: 20-生效中, 21-已失效, 22-待生效', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [ 20 => '', '', '', ], 'example' => '20', ], 'Title' => [ 'title' => '标题', 'description' => '', 'type' => 'string', 'example' => '', ], 'HitSimilarTitles' => [ 'title' => '命中的相似问', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '', ], ], 'HitSolutions' => [ 'title' => '命中的答案', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], ], 'PageNumber' => [ 'title' => '页码 默认1', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '每页数量,默认10,最大500', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'title' => '总条数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1075', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'E45491D5-7E0A-42C6-9B21-91D1066B1475', ], ], ], ], ], 'responseDemo' => '', 'title' => 'FAQ Search', ], 'CreateDSEntity' => [ 'summary' => '实体-创建', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'EntityName', 'in' => 'query', 'schema' => [ 'title' => '实体名称,仅支持中文、大小写字母、数字、下划线', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '实体名称', ], ], [ 'name' => 'EntityType', 'in' => 'query', 'schema' => [ 'title' => '实体类型:详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'synonyms', 'default' => 'synonyms', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'adfad2343f1f2r', ], 'EntityId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '23436345', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorEntity.OutRange', 'errorMessage' => 'The business error Entity is out of range.', ], [ 'errorCode' => 'BusinessErrorEntityName.OutRange', 'errorMessage' => 'The business error EntityName is out of range.', ], [ 'errorCode' => 'BusinessErrorEntityName.Repeat', 'errorMessage' => 'BusinessErrorEntityName.Repeat The business error EntityName is repeat.', ], [ 'errorCode' => 'BusinessErrorEntityName.InvalidCharactor', 'errorMessage' => 'The business error EntityName contains invalid charactor.', ], ], ], 'responseDemo' => null, ], 'DeleteDSEntity' => [ 'summary' => '实体-删除', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => [ 'title' => '实体ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '4dfghf56235asdf452', ], 'EntityId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', ], ], ], 'responseDemo' => null, ], 'UpdateDSEntity' => [ 'summary' => '实体-更新', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'required' => false, 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'type' => 'string', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => ' chatbot-cn-yjzbyrEvqd', 'required' => true, 'title' => '机器人ID', 'type' => 'string', ], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => '123', 'exclusiveMaximum' => true, 'exclusiveMinimum' => true, 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'title' => '实体ID', 'type' => 'integer', ], ], [ 'name' => 'EntityName', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => '实体名称', 'required' => true, 'title' => '实体名称,仅支持中文、大小写字母、数字、下划线', 'type' => 'string', ], ], [ 'name' => 'EntityType', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'synonyms', 'required' => false, 'title' => '实体类型:详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'properties' => [ 'RequestId' => [ 'description' => '', 'example' => 'df23fgh4hyj67hn56', 'type' => 'string', ], 'EntityId' => [ 'description' => '', 'example' => '123', 'format' => 'int64', 'type' => 'integer', ], ], 'title' => 'BaseResponse', 'type' => 'object', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', ], [ 'errorCode' => 'BusinessErrorEntityName.OutRange', 'errorMessage' => 'The business error EntityName is out of range.', ], [ 'errorCode' => 'BusinessErrorEntityName.Repeat', 'errorMessage' => 'The business error EntityName is repeat.', ], [ 'errorCode' => 'BusinessErrorEntityName.InvalidCharactor', 'errorMessage' => 'The business error EntityName contains invalid charactor.', ], ], ], 'responseDemo' => null, ], 'DescribeDSEntity' => [ 'summary' => '实体-详情', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => [ 'title' => '实体ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'ad23234dsf234fga', ], 'EntityId' => [ 'title' => '实体ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'EntityName' => [ 'title' => '实体名称,仅支持中文、大小写字母、数字、下划线', 'description' => '', 'type' => 'string', 'example' => '', ], 'SysEntityCode' => [ 'title' => '系统实体code,如@sys.date', 'description' => '', 'type' => 'string', 'example' => '', ], 'EntityType' => [ 'title' => '实体类型:详见:,EntityTypeEnum[synonyms(同义词),regex(正则)]', 'description' => '', 'type' => 'string', 'example' => 'synonyms', ], 'CreateTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'ModifyTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'CreateUserId' => [ 'description' => '', 'type' => 'string', 'example' => '123231', ], 'CreateUserName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'ModifyUserId' => [ 'description' => '', 'type' => 'string', 'example' => '123231', ], 'ModifyUserName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', ], ], ], 'responseDemo' => null, ], 'ListDSEntity' => [ 'summary' => '实体-列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'title' => '筛选项,contains匹配,范围:实体名称(未来扩展:实体成员、同义词)', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '实体', ], ], [ 'name' => 'EntityType', 'in' => 'query', 'schema' => [ 'title' => '为空:全量自定义实体(默认)', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'regex' => 'regex', 'system' => 'system', 'synonyms' => 'synonyms', ], 'example' => 'system', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'ga4h345defgwet2sdf223', ], 'TotalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Entities' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EntityId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '234564567445', ], 'EntityName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'SysEntityCode' => [ 'title' => '系统实体code,如@sys.date', 'description' => '', 'type' => 'string', 'example' => '', ], 'EntityType' => [ 'description' => '', 'type' => 'string', 'example' => 'synonyms', ], 'CreateTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'ModifyTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'CreateUserId' => [ 'description' => '', 'type' => 'string', 'example' => '123231', ], 'CreateUserName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'ModifyUserId' => [ 'description' => '', 'type' => 'string', 'example' => '123231', ], 'ModifyUserName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Ds.IllegalAccess.BotIdNotExists', ], ], ], 'responseDemo' => null, ], 'CreateDSEntityValue' => [ 'summary' => '实体成员-创建', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => [ 'title' => '实体ID,修改实体成员时可为空', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12', ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'ada', ], ], [ 'name' => 'Synonyms', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'g763hg48j3f3', ], 'EntityValueId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2434543453', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', ], ], ], 'responseDemo' => null, ], 'DeleteDSEntityValue' => [ 'summary' => '实体成员-删除', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => [ 'title' => '实体ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '345346223452', ], ], [ 'name' => 'EntityValueId', 'in' => 'query', 'schema' => [ 'title' => '实体成员ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '3453453452', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'dfdf2t3rfvb45y', ], 'EntityValueId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '3453453452', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', ], [ 'errorCode' => 'BusinessErrorEntityValueId.NotExists', 'errorMessage' => 'The business error EntityValueId is not exists.', ], ], ], 'responseDemo' => null, ], 'UpdateDSEntityValue' => [ 'summary' => '实体成员-更新', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => [ 'title' => '实体ID,修改实体成员时可为空', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '223423423', ], ], [ 'name' => 'EntityValueId', 'in' => 'query', 'schema' => [ 'title' => '实体成员ID,创建实体成员时为空', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '2342377423', ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => [ 'title' => '实体类型为synonyms时,表示实体归一化值;当实体类型为regex时,表示正则表达式文本', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'Synonyms', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '实体同义词', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'required' => false, 'maxItems' => 10, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'sDag3g43wesf2', ], 'EntityValueId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2342377423', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', ], ], ], 'responseDemo' => null, ], 'ListDSEntityValue' => [ 'summary' => '实体成员-列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'EntityId', 'in' => 'formData', 'schema' => [ 'title' => '实体ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', ], ], [ 'name' => 'EntityValueId', 'in' => 'formData', 'schema' => [ 'title' => '实体成员ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '234', ], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => [ 'title' => '实体成员名称搜索关键词', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'n3fg34gbfj8adf2gj923', ], 'EntityValues' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EntityId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '34313785463', ], 'EntityValueId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '3467858234534534532', ], 'Content' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Synonyms' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '', ], ], 'CreateTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'ModifyTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], ], ], ], 'TotalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNumber' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', ], ], ], 'responseDemo' => null, ], 'CreateIntent' => [ 'summary' => '意图-创建', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'IntentDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '意图定义结构体', 'description' => '', 'type' => 'object', 'properties' => [ 'IntentName' => [ 'title' => '意图名称', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'AliasName' => [ 'title' => '意图别名', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'SlotInfos' => [ 'title' => '槽位信息', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SlotId' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'fg452dfg3df23', ], 'Name' => [ 'title' => '槽位名', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'Value' => [ 'title' => '关联的实体名', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'Interactive' => [ 'title' => '是否交互式', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'Array' => [ 'title' => '是否数组', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'Encrypt' => [ 'title' => '是否脱敏', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '43546474', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'df56gjh5et34g3g3', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorIntent.OutRange', 'errorMessage' => 'The business error Intent is out of range.', ], [ 'errorCode' => 'BusinessErrorIntentName.OutRange', 'errorMessage' => 'The business error IntentName is out of range.', ], [ 'errorCode' => 'BusinessErrorIntentName.Repeat', 'errorMessage' => 'The business error IntentName is repeat.', ], [ 'errorCode' => 'BusinessErrorIntentName.InvalidCharactor', 'errorMessage' => 'The business error IntentName contains invalid charactor.', ], [ 'errorCode' => 'BusinessErrorIntentEntity.NotExists', 'errorMessage' => 'The business error IntentEntity is not exists.', ], ], ], 'responseDemo' => null, ], 'DeleteIntent' => [ 'summary' => '意图-删除', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'IntentId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12345', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '3464dfg3qwr34tf34', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', ], ], ], 'responseDemo' => null, ], 'UpdateIntent' => [ 'summary' => '意图-更新', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '234234234534', ], ], [ 'name' => 'IntentDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '意图定义结构体', 'description' => '', 'type' => 'object', 'properties' => [ 'IntentName' => [ 'title' => '意图名称', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'AliasName' => [ 'title' => '意图别名', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'SlotInfos' => [ 'title' => '槽位信息', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SlotId' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'dgadf23dfg2f', ], 'Name' => [ 'title' => '槽位名', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'Value' => [ 'title' => '关联的实体名', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'Interactive' => [ 'title' => '是否交互式', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'Array' => [ 'title' => '是否数组', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'Encrypt' => [ 'title' => '是否脱敏', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '234234234534', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'dfaf23dfas234234234534', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', ], [ 'errorCode' => 'BusinessErrorIntent.OutRange', 'errorMessage' => 'The business error Intent is out of range.', ], ], ], 'responseDemo' => null, ], 'DescribeIntent' => [ 'summary' => '意图-详情', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'IntentId', 'in' => 'formData', 'schema' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'a22afaf2adfasf2gr345fga45ada', ], 'IntentId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '84243341', ], 'IntentName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'AliasName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'SlotInfos' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SlotId' => [ 'description' => '', 'type' => 'string', 'example' => 'aa4d2a343a3ad4afad', ], 'Name' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Value' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Interactive' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'Array' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'Encrypt' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], ], ], ], 'CreateTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'ModifyTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'CreateUserId' => [ 'description' => '', 'type' => 'string', 'example' => '123231', ], 'CreateUserName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'ModifyUserId' => [ 'description' => '', 'type' => 'string', 'example' => '123231', ], 'ModifyUserName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error IntentId is not exists.', ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'ListIntent' => [ 'summary' => '意图-列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'IntentName', 'in' => 'query', 'schema' => [ 'title' => '意图名称', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '查天气', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '23dsfa34r2s2s2sd12', ], 'TotalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNumber' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Intents' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '234234234234', ], 'IntentName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'AliasName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'SlotInfos' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SlotId' => [ 'title' => '槽位ID', 'description' => '', 'type' => 'string', 'example' => '12134223', ], 'Name' => [ 'title' => '槽位名', 'description' => '', 'type' => 'string', 'example' => '', ], 'Value' => [ 'title' => '槽位值(实体名)', 'description' => '', 'type' => 'string', 'example' => '', ], 'Interactive' => [ 'title' => '是否交互式收集', 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'Array' => [ 'title' => '是否数组', 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'Encrypt' => [ 'title' => '是否敏感', 'description' => '', 'type' => 'boolean', 'example' => 'false', ], ], ], ], 'CreateTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'ModifyTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'CreateUserId' => [ 'description' => '', 'type' => 'string', 'example' => '123231', ], 'CreateUserName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'ModifyUserId' => [ 'description' => '', 'type' => 'string', 'example' => '123231', ], 'ModifyUserName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter InstanceId is not valid!', ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'CreateUserSay' => [ 'summary' => '意图-话术-创建', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'UserSayDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123232', ], 'Content' => [ 'title' => '用户话术', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'SlotInfos' => [ 'title' => '划槽信息', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SlotId' => [ 'title' => '划槽ID', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'fb34adf2fv43f2', ], 'StartIndex' => [ 'title' => '槽位在意图话术中的起始下标', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', ], 'EndIndex' => [ 'title' => '槽位在意图话术中的结束下标(不含)', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'UserSayId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '46456176856', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '8g4n8bnd236fg79', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', ], ], ], 'responseDemo' => null, ], 'DeleteUserSay' => [ 'summary' => '意图-用户话术-删除', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '343df2sdf23', ], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5564564546', ], ], [ 'name' => 'UserSayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '4562121234', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'UserSayId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '4562121234', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'dfgdg324gf34t34g34g3', ], ], ], ], ], 'responseDemo' => null, ], 'UpdateUserSay' => [ 'summary' => '意图-话术-更新', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'UserSayId', 'in' => 'query', 'schema' => [ 'title' => '用户话术ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '34512323', ], ], [ 'name' => 'UserSayDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', ], 'Content' => [ 'title' => '用户话术', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'SlotInfos' => [ 'title' => '划槽信息', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SlotId' => [ 'title' => '划槽ID', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '346ffg3q23dv', ], 'StartIndex' => [ 'title' => '槽位在意图话术中的起始下标', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'EndIndex' => [ 'title' => '槽位在意图话术中的结束下标(不含)', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'UserSayId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '34512323', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '2356fg3wf34634vdt23wef2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', ], ], ], 'responseDemo' => null, ], 'ListUserSay' => [ 'summary' => '话术-列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '232', ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => [ 'title' => '筛选用户话术', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '您做核酸了嘛', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'fs1fg4512v43572v23', ], 'UserSays' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '235564564', ], 'UserSayId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '3453452138', ], 'Content' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'SlotInfos' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SlotId' => [ 'title' => '意图槽位ID', 'description' => '', 'type' => 'string', 'example' => '3456sdfg3tu', ], 'StartIndex' => [ 'title' => '槽位在意图话术中的下标', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'EndIndex' => [ 'title' => '槽位在意图话术中的下标', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], ], 'CreateTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'ModifyTime' => [ 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], ], ], ], 'TotalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNumber' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], 'responseDemo' => null, ], 'CreateLgf' => [ 'summary' => '意图-LGF-创建', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'LgfDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '4675678567', ], 'RuleText' => [ 'title' => 'LGF配置', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LgfId' => [ 'description' => 'LGF ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123453433453', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'af5fg3sdf457j5', ], ], ], ], ], 'responseDemo' => null, ], 'DeleteLgf' => [ 'summary' => '意图-LGF-删除', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '23242342', ], ], [ 'name' => 'LgfId', 'in' => 'query', 'schema' => [ 'description' => 'lgf Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '2342424', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LgfId' => [ 'description' => 'LGF ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2342424', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'dgw2342424qw42', ], ], ], ], ], 'responseDemo' => null, ], 'UpdateLgf' => [ 'summary' => '意图-LGF-更新', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'LgfId', 'in' => 'query', 'schema' => [ 'title' => 'LGF ID', 'description' => 'LGF ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12121', ], ], [ 'name' => 'LgfDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '23234523522', ], 'RuleText' => [ 'title' => 'LGF配置', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LgfId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2342556223532', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '289dfa131adf23wqe2r', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error IntentId is not exists.', ], [ 'errorCode' => '400 BusinessErrorIntentLgfId.NotExists', 'errorMessage' => 'The business error IntentLgfId is not exists.', ], ], ], 'responseDemo' => null, ], 'ListLgf' => [ 'summary' => '意图-LGF-列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '机器人ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', ], ], [ 'name' => 'LgfText', 'in' => 'query', 'schema' => [ 'title' => '筛选语义配置内容', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '.{0,5}北京天气', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '34fg57h2gh5783', ], 'Lgfs' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IntentId' => [ 'title' => '意图ID', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '256756734345', ], 'LgfId' => [ 'title' => 'LGF ID', 'description' => 'LGF ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'RuleText' => [ 'title' => 'LGF规则', 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', ], ], ], ], 'TotalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNumber' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], 'responseDemo' => null, ], 'CreatePerspective' => [ 'summary' => '视角-创建', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '视角名称,长度不超过50字', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '移动端视角', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '视角描述', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '用于购物APP的移动端视角', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', ], 'PerspectiveId' => [ 'title' => '视角主键(code_id)', 'description' => '', 'type' => 'string', 'example' => '3001', ], ], ], ], ], 'responseDemo' => null, ], 'DeletePerspective' => [ 'summary' => '视角-删除', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'PerspectiveId', 'in' => 'query', 'schema' => [ 'title' => '视角主键(code_id)', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', ], 'Result' => [ 'title' => '删除视角的结果', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'responseDemo' => null, ], 'UpdatePerspective' => [ 'summary' => '视角-修改', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'PerspectiveId', 'in' => 'query', 'schema' => [ 'title' => '视角主键(code_id)', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '视角名称', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '客户端视角', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', ], ], ], ], ], 'responseDemo' => null, ], 'DescribePerspective' => [ 'summary' => '视角-详情', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PerspectiveId', 'in' => 'query', 'schema' => [ 'title' => '视角Id', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', ], 'Status' => [ 'title' => '数据状态:3:选中;1:未选中', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PerspectiveCode' => [ 'title' => '视角编码(用于问答api)', 'description' => '', 'type' => 'string', 'example' => 'FZJBY3raWr', ], 'ModifyTime' => [ 'title' => '修改时间 UTC时间', 'description' => '', 'type' => 'string', 'example' => '2021-07-26T07:05:37Z', ], 'SelfDefine' => [ 'title' => '是否自定义', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'CreateTime' => [ 'title' => '创建时间 UTC时间', 'description' => '', 'type' => 'string', 'example' => '2021-07-27T07:05:37Z', ], 'PerspectiveId' => [ 'title' => '视角主键(code_id)', 'description' => '', 'type' => 'string', 'example' => '3001', ], 'Name' => [ 'title' => '视角名称', 'description' => '', 'type' => 'string', 'example' => '移动端视角', ], ], ], ], ], 'responseDemo' => null, ], 'QueryPerspectives' => [ 'summary' => '视角-列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', ], 'Perspectives' => [ 'title' => '视角列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '数据状态:3:选中;1:未选中', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CreateTime' => [ 'title' => '创建时间 UTC时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'PerspectiveId' => [ 'title' => '视角主键(code_id)', 'description' => '', 'type' => 'string', 'example' => '3001', ], 'SelfDefine' => [ 'title' => '是否自定义', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Name' => [ 'title' => '视角名称', 'description' => '', 'type' => 'string', 'example' => '移动端视角', ], 'PerspectiveCode' => [ 'title' => '视角编码(用于问答api)', 'description' => '', 'type' => 'string', 'example' => 'FZJBY3raWr', ], 'ModifyTime' => [ 'title' => '修改时间 UTC时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-29T03:38:54Z', ], ], ], ], ], ], ], ], 'responseDemo' => null, ], 'CreatePublishTask' => [ 'summary' => 'Create Publishing Task', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'title' => '发布任务的业务类型,若发布机器人请使用 CreateInstancePublishTask API', 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'enumValueTitles' => [ 'chitchat' => '', 'service_center' => '', 'faq' => '', 'dict' => '', 'sensitive' => '', 'command' => '', 'mrc' => '', ], 'example' => 'faq', 'enum' => [], ], ], [ 'name' => 'DataIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '业务类型附加信息,当前仅支持BizType为faq的传参,此字段指定faq类目Id列表,表示只发布指定类目下面的faq知识', 'description' => '', 'type' => 'array', 'items' => [ 'title' => '具体附加发布信息,如faq类目信息'."\n", 'description' => '', 'type' => 'string', 'required' => false, 'example' => '8521', ], 'required' => false, 'enumValueTitles' => [], 'example' => '["8521"]', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,若不指定则请求默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', ], 'Id' => [ 'title' => '发布任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', ], 'Response' => [ 'title' => '发布任务Id,冗余字段,建议使用Id字段获取发布任务Id', 'description' => '', 'type' => 'string', 'example' => '8522', ], 'Status' => [ 'title' => '任务状态( FE_RUNNING:正在发布中 FE_SUCCESS:发布成功 FE_FAILED:发布失败 FE_ABORTED:发布取消)', 'description' => '', 'type' => 'string', 'example' => 'FE_RUNNING', 'enum' => [ 'FE_RUNNING:正在发布中', 'FE_SUCCESS:发布成功', 'FE_FAILED:发布失败', 'FE_ABORTED:发布取消', ], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'faq', ], ], 'Error' => [ 'title' => '发布任务失败信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'title' => '任务创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'ModifyTime' => [ 'title' => '任务修改的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Create Publishing Task', ], 'CancelPublishTask' => [ 'summary' => 'Cancel Publishing Task', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '发布任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', ], 'Id' => [ 'title' => '发布任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', ], 'Response' => [ 'title' => '发布任务Id,冗余字段,建议使用Id字段获取发布任务Id', 'description' => '', 'type' => 'string', 'example' => '8522', ], 'Status' => [ 'title' => '任务状态( FE_RUNNING:正在发布中 FE_SUCCESS:发布成功 FE_FAILED:发布失败 FE_ABORTED:发布取消)', 'description' => '', 'type' => 'string', 'example' => 'FE_ABORTED', 'enum' => [ 'FE_RUNNING:正在发布中', 'FE_SUCCESS:发布成功', 'FE_FAILED:发布失败', 'FE_ABORTED:发布取消', ], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'faq', ], ], 'Error' => [ 'title' => '发布任务失败信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'title' => '任务创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'ModifyTime' => [ 'title' => '任务修改的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Cancel Publishing Task', ], 'GetPublishTaskState' => [ 'summary' => 'Query Publishing Progress', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '发布任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', ], 'Id' => [ 'title' => '发布任务Id', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', ], 'Response' => [ 'title' => '发布任务Id,冗余字段,建议使用Id字段获取发布任务Id', 'description' => '', 'type' => 'string', 'example' => '8522', ], 'Status' => [ 'title' => '任务状态( FE_RUNNING:正在发布中 FE_SUCCESS:发布成功 FE_FAILED:发布失败 FE_ABORTED:发布取消)', 'description' => '', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'FE_RUNNING', 'enum' => [ 'FE_RUNNING:正在发布中', 'FE_SUCCESS:发布成功', 'FE_FAILED:发布失败', 'FE_ABORTED:发布取消', ], ], 'BizTypeList' => [ 'title' => '业务类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'faq', ], ], 'Error' => [ 'title' => '发布任务失败信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'CreateTime' => [ 'title' => '任务创建的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', ], 'ModifyTime' => [ 'title' => '任务修改的 UTC 时间', 'description' => '', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', ], 'Errors' => [ 'title' => '各子发布模块的错误信息,key是子发布模块,value是错误信息', 'description' => '', 'type' => 'object', 'example' => '', ], 'Warnings' => [ 'title' => '各子发布模块的警告信息,key是子发布模块,value是警告信息', 'description' => '', 'type' => 'object', 'example' => '', ], ], ], ], ], 'responseDemo' => '', 'title' => 'Query Publishing Progress', ], 'GetAgentInfo' => [ 'summary' => '获取业务空间信息', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'beebot_bot_public_cn-ca36x8v3n1x', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'Parameter.Invalid', ], 'Data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AgentName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'AgentKey' => [ 'description' => '', 'type' => 'string', 'example' => '4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => null, ], 'ListAgent' => [ 'summary' => '获取业务空间列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotS5PR8Q', ], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'AgentName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'GoodsCodes', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'G_cloudBeeBot_public' => 'G_cloudBeeBot_public', ], 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419', ], 'PageNumber' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'Data' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AgentId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '881', ], 'AgentKey' => [ 'description' => '', 'type' => 'string', 'example' => '4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public', ], 'AgentName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'InstanceInfos' => [ 'description' => '', 'type' => 'object', 'enumValueTitles' => [ 'G_cloudBeeBot_public' => 'G_cloudBeeBot_public', ], ], ], ], ], ], ], ], ], 'responseDemo' => null, ], 'GenerateUserAccessToken' => [ 'summary' => '生成用户免登Token', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotJ8IS68', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ExpireTime', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3600', 'minimum' => '0', 'example' => '1000', 'title' => '保留参数,无需传入', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => '坐席密钥', ], ], [ 'name' => 'ExtraInfo', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "xx": 123,'."\n" .' "yy": 22332,'."\n" .' "customerNameCard": ['."\n" .' {'."\n" .' "key": "姓名",'."\n" .' "value": "张三"'."\n" .' },'."\n" .' {'."\n" .' "key": "等级",'."\n" .' "value": "v2"'."\n" .' },'."\n" .' {'."\n" .' "key": "联系方式",'."\n" .' "value": "123"'."\n" .' }'."\n" .' ]'."\n" .'}', 'title' => '附加信息,json字符串', ], ], [ 'name' => 'Email', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'a***bcx@gmail.com', ], ], [ 'name' => 'Telephone', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1381111****', ], ], [ 'name' => 'ForeignId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8882022040000000171', 'title' => '用户外部的userid', ], ], [ 'name' => 'Nick', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '张三', 'title' => '访问者昵称', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E6988CE6-41CF-1103-9BEC-2B20D26C0B51', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', 'title' => '是否操作成功:false:否;true:是', ], 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', 'title' => '请求消息', ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'Parameter.Invalid', 'title' => '错误信息', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF', 'title' => '请求id', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => null, ], 'ListTongyiConversationLogs' => [ 'summary' => '查询通义晓蜜的单个会话对话记录', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebot2KBZDS', ], ], 'parameters' => [ [ 'name' => 'RobotInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CostTime' => [ 'description' => '', 'type' => 'string', 'example' => '66', 'title' => '请求消耗时间', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F', 'title' => '请求id', ], 'Datas' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'example' => '', 'title' => '数据详情', ], 'title' => '数据详情', ], 'SessionFlowDebugInfo' => [ 'title' => '会话流程调试信息', 'type' => 'object', 'properties' => [ 'ApiParams' => [ 'title' => '会话流程调试信息的API参数', 'type' => 'object', ], 'SlotParams' => [ 'title' => '会话流程调试信息的槽位参数', 'type' => 'object', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'ListTongyiChatHistorys' => [ 'summary' => 'Tongyi对话明细查询接口', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '2024-04-01 00:00:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '2024-04-01 08:00:00', ], ], [ 'name' => 'RobotInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe', ], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'D0DDFC4C-D66D-4787-9AE4-4D757481EDEE', ], 'CostTime' => [ 'description' => '', 'type' => 'string', 'example' => '116', ], 'Datas' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'example' => '', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => null, ], 'GetBotSessionData' => [ 'summary' => '查询机器人接待人次和对话轮次', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '20240505', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '20240605', ], ], [ 'name' => 'RobotInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'title' => '业务空间key,不设置则访问默认业务空间,key值在主账号业务管理页面获取', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CostTime' => [ 'description' => '', 'type' => 'string', 'example' => '116', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51', ], 'Datas' => [ 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'example' => '', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => null, ], 'InitIMConnect' => [ 'summary' => '初始化im连接信息', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbeebotJ8IS68', ], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'From', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '8XNBzDucJv', ], ], [ 'name' => 'UserAccessToken', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E6988CE6-41CF-1103-9BEC-2B20D26C0B52', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'Parameter.Invalid', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => '{ "imDomain": "im.alimebot.com", "appKey": "WDg2VfNv", "token": "QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==" }', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => null, ], 'ListSaasInfo' => [ 'summary' => '获取业务空间下可集成的SaaS信息列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'SaasName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'userTest', ], ], [ 'name' => 'SaasGroupCodes', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'DS,FAQ', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A629A28F-F25E-5572-A679-FA46FB0151D6', ], 'Data' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => 'GLOBAL_SERVICE', ], 'Name' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Url' => [ 'description' => '', 'type' => 'string', 'example' => 'https://alime.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot', ], 'EnName' => [ 'description' => '', 'type' => 'string', 'example' => 'GLOBAL SERVICE', ], 'ServiceUrl' => [ 'description' => '', 'type' => 'string', 'example' => 'https://pre-alime4service.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot', ], ], ], ], 'SaasToken' => [ 'description' => '', 'type' => 'string', 'example' => '06614fdb-c72f-436e-8003-dfe8a2854a15', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => null, ], 'ListSaasPermissionGroupInfos' => [ 'summary' => '获取业务空间下可集成的权限组信息', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32', ], 'Data' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SaasCode' => [ 'description' => '', 'type' => 'string', 'example' => 'FAQ', ], 'Name' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'EnName' => [ 'description' => '', 'type' => 'string', 'example' => 'Release Center', ], 'PgInfos' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'PgCode' => [ 'description' => '', 'type' => 'string', 'example' => 'FAQ', ], 'PgName' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'PgEnName' => [ 'description' => '', 'type' => 'string', 'example' => 'FAQ', ], ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => null, ], 'CancelChat' => [ 'summary' => '取消对应对话', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '254397', 'abilityTreeNodes' => [ 'FEATUREbeebotUKQQ1L', ], ], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', ], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'c1187530338311ebade7cf3eaeb3668a', ], ], [ 'name' => 'ChatId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '7105a351-b2e7-4c9e-8437-c43a043c0a4e', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => ' chatbot-cn-yjzbyrEvqd', ], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Canceled', ], ], [ 'name' => 'Answer', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', ], 'CancelResult' => [ 'description' => '', 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => null, ], ], 'endpoints' => [ [ 'regionId' => 'cn-shanghai', 'endpoint' => 'chatbot.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'chatbot.cn-hongkong.aliyuncs.com', ], ], ];