'1.0', 'info' => ['style' => 'RPC', 'product' => 'Chatbot', 'version' => '2022-04-08'], 'directories' => [ 'ApplyForStreamAccessToken', 'Associate', 'BeginSession', 'CancelChat', 'CancelInstancePublishTask', 'CancelPublishTask', 'Chat', 'ContinueInstancePublishTask', 'CreateCategory', 'CreateConnQuestion', 'CreateDSEntity', 'CreateDSEntityValue', 'CreateDoc', 'CreateFaq', 'CreateInstance', 'CreateInstancePublishTask', 'CreateIntent', 'CreateLgf', 'CreatePerspective', 'CreatePublishTask', 'CreateSimQuestion', 'CreateSolution', 'CreateUserSay', 'DeleteCategory', 'DeleteConnQuestion', 'DeleteDSEntity', 'DeleteDSEntityValue', 'DeleteDoc', 'DeleteFaq', 'DeleteInstance', 'DeleteIntent', 'DeleteLgf', 'DeletePerspective', 'DeleteSimQuestion', 'DeleteSolution', 'DeleteUserSay', 'DescribeCategory', 'DescribeDSEntity', 'DescribeDoc', 'DescribeFaq', 'DescribeInstance', 'DescribeIntent', 'DescribePerspective', 'Feedback', 'GenerateUserAccessToken', 'GetAgentInfo', 'GetAsyncResult', 'GetBotSessionData', 'GetInstancePublishTaskState', 'GetPublishTaskState', 'InitIMConnect', 'LinkInstanceCategory', 'ListAgent', 'ListCategory', 'ListConnQuestion', 'ListDSEntity', 'ListDSEntityValue', 'ListInstance', 'ListIntent', 'ListLgf', 'ListSaasInfo', 'ListSaasPermissionGroupInfos', 'ListSimQuestion', 'ListSolution', 'ListTongyiChatHistorys', 'ListTongyiConversationLogs', 'ListUserSay', 'Nlu', 'QueryPerspectives', 'RetryDoc', 'SearchDoc', 'SearchFaq', 'TongyiChatDebugInfo', 'UpdateCategory', 'UpdateConnQuestion', 'UpdateDSEntity', 'UpdateDSEntityValue', 'UpdateDoc', 'UpdateFaq', 'UpdateInstance', 'UpdateIntent', 'UpdateLgf', 'UpdatePerspective', 'UpdateSimQuestion', 'UpdateSolution', 'UpdateUserSay', ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ApplyForStreamAccessToken' => [ 'summary' => 'Obtain the Connection information for stream invocation.', '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' => 'Workspace key. If not set, the default workspace is accessed. The key value can be obtained from the Alibaba Cloud account workspace Management page.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', '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' => '736994BD-AA35-4742-88C9-E64BE4BAA14B'], 'AccessToken' => ['description' => 'Request token for the service.', 'type' => 'string', 'example' => '63ba97b4f18a4a04f715c81e8e643938', 'title' => ''], 'ChannelId' => ['description' => 'Channel ID', 'type' => 'string', 'example' => 'cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d', 'title' => ''], 'StreamSecret' => ['description' => 'Key of the workspace, used to add signature to stream requests', 'type' => 'string', 'example' => 'cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"736994BD-AA35-4742-88C9-E64BE4BAA14B\\",\\n \\"AccessToken\\": \\"63ba97b4f18a4a04f715c81e8e643938\\",\\n \\"ChannelId\\": \\"cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d\\",\\n \\"StreamSecret\\": \\"cc9e88c0-4f41-4f1d-a1a9-91a72d2aa27d\\"\\n}","type":"json"}]', 'title' => 'Obtain the Connection information for stream invocation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyForStreamAccessToken'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], 'translator' => 'machine', ], 'Associate' => [ 'summary' => 'Suggests FAQs from the knowledge base based on a user\'s utterance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'Utterance', 'in' => 'query', 'schema' => ['description' => 'The user\'s utterance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '公积金提取', 'title' => ''], ], [ 'name' => 'Perspective', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The code for a perspective. Use this to retrieve answers from different perspectives that share the same knowledge title. When constructing the request, pass the value in the "Perspective={perspective\\_code}" format, for example, \\&Perspective=\\["FZJBY3raWr"]. If you use an SDK, pass the parameter as defined by the SDK. You can specify only one perspective in each request.', 'type' => 'array', 'items' => ['description' => 'A perspective code.', 'type' => 'string', 'example' => 'FZJBY3raWr', 'required' => false, 'title' => ''], 'required' => false, 'example' => '["qyzzVfyFfa"]', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The session ID that identifies a conversation and maintains context. For the first request from a new user, you can omit this parameter. The service automatically starts a session and returns a session ID in the response. To continue the conversation, you must include the session ID in subsequent requests.', 'type' => 'string', 'required' => false, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', 'title' => ''], ], [ 'name' => 'RecommendNum', 'in' => 'query', 'schema' => ['description' => 'The number of recommended FAQs to return. The value must be an integer from 1 to 10. This parameter takes effect only when recommendations are generated. The number of FAQs returned is less than or equal to the value you specify.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => '', 'required' => false], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The workspace key. If this parameter is not specified, the service uses the default workspace. You can obtain the key from the workspace management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5C20F0D4-9721-178A-8236-3BF990634962', 'title' => ''], 'Associate' => [ 'title' => '', 'description' => 'A list of suggested FAQs.', 'type' => 'array', 'items' => [ 'description' => 'The details of a suggested FAQ.', 'type' => 'object', 'properties' => [ 'Meta' => ['description' => 'Additional information.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Title' => ['description' => 'The title of the suggested FAQ.', 'type' => 'string', 'example' => '公积金提取的政策', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '1531ded6b3df4afca4be63943f708bb7', 'title' => ''], 'MessageId' => ['description' => 'The response message ID.', 'type' => 'string', 'example' => '5ADF0EBD-7C50-1922-A28B-43215B47CC1A', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C20F0D4-9721-178A-8236-3BF990634962\\",\\n \\"Associate\\": [\\n {\\n \\"Meta\\": \\"{}\\",\\n \\"Title\\": \\"公积金提取的政策\\"\\n }\\n ],\\n \\"SessionId\\": \\"1531ded6b3df4afca4be63943f708bb7\\",\\n \\"MessageId\\": \\"5ADF0EBD-7C50-1922-A28B-43215B47CC1A\\"\\n}","type":"json"}]', 'title' => 'Session - Association API ', 'responseParamsDescription' => '### Examples'."\n" ."\n" .'#### Sample response'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "MessageId":"1eb47d7a1706429081e90c83c62c2f00",'."\n" .' "SessionId":"93f11165a2a24289a6f869760e8cb3f3",'."\n" .' "Associate":['."\n" .' {'."\n" .' "Meta":"{}",'."\n" .' "Title": "What are the career development paths for professional and support roles?"'."\n" .' },'."\n" .' {'."\n" .' "Meta":"{}",'."\n" .' "Title": "What are the career development paths for professional and support roles?"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Associate'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'BeginSession' => [ 'summary' => 'Initiates a session and retrieves a welcome message.', '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' => ['description' => 'The key for the business space. If not specified, the default business space is used. You can find the key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'SandBox', 'in' => 'formData', 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'VendorParam', 'in' => 'formData', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '149C7528-C104-1B50-A4F9-0C5907A8AD9D', 'title' => ''], 'WelcomeMessage' => ['description' => 'The welcome message.', 'type' => 'string', 'example' => '智能对话机器人为您服务，请问有什么可以帮您？', 'title' => ''], 'SilenceReplyTimeout' => ['description' => 'The silence timeout, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'Interruptible' => ['description' => 'Indicates whether voice playback is interruptible.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'AsrMaxEndSilence' => ['description' => 'The ASR end-pointing detection time, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '700', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"149C7528-C104-1B50-A4F9-0C5907A8AD9D\\",\\n \\"WelcomeMessage\\": \\"智能对话机器人为您服务，请问有什么可以帮您？\\",\\n \\"SilenceReplyTimeout\\": 5,\\n \\"Interruptible\\": false,\\n \\"AsrMaxEndSilence\\": 700\\n}","type":"json"}]', 'title' => 'Obtain Welcome Message', 'changeSet' => [ ['createdAt' => '2026-03-24T01:58:43.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-10-16T13:12:58.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-12-28T09:28:13.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2023-04-18T12:39:08.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BeginSession'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CancelChat' => [ 'summary' => 'Cancels or interrupts an ongoing chat.', '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' => 'The agent key. If unspecified, the default agent is used. You can obtain the key on the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'The session ID is used to identify a visitor\'s session and maintain context. For a new visitor, omit this parameter in the first call to the chat operation. The chatbot starts a session and returns the session ID in the response. For subsequent turns, you must pass the session ID to maintain context. The value can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'c1187530338311ebade7cf3eaeb3668a', 'title' => ''], ], [ 'name' => 'ChatId', 'in' => 'formData', 'schema' => ['description' => 'The ID that identifies a single chat turn.', 'type' => 'string', 'required' => false, 'example' => '7105a351-b2e7-4c9e-8437-c43a043c0a4e', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the chatbot instance.', 'type' => 'string', 'required' => false, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => ['description' => 'The cancellation type.', 'type' => 'string', 'required' => false, 'example' => 'Canceled', 'title' => ''], ], [ 'name' => 'Answer', 'in' => 'formData', 'schema' => ['description' => 'The content of the answer.', 'type' => 'string', 'required' => false, 'example' => '<这个答案被打>', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1', 'title' => ''], 'CancelResult' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3E5C779-A630-45AC-B0F2-A4506A4212F1\\",\\n \\"CancelResult\\": false\\n}","type":"json"}]', 'title' => 'Cancel or interrupt the specified conversation. ', 'description' => 'This operation supports only the new version of chatbots. You can query data only from the last 90 days.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CancelInstancePublishTask' => [ 'summary' => 'Cancels a publishing task for a chatbot.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique ID of the chatbot.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. You can obtain the key from the Business Management page of your Alibaba Cloud account. If you omit this parameter, the default business space is used.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', 'title' => ''], 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', 'title' => ''], 'Response' => ['description' => 'The task ID, returned as a string.', 'type' => 'string', 'example' => '8522', 'title' => ''], 'Status' => [ 'description' => 'The task status.', 'enumValueTitles' => ['FE_SUCCESS' => 'Successful', 'FE_ABORTED' => 'Canceled', 'FE_FAILED' => 'Failed', 'FE_RUNNING' => 'Publishing'], 'type' => 'string', 'example' => 'FE_ABORTED', 'enum' => ['FE_RUNNING：正在发布中', 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], 'title' => '', ], 'BizTypeList' => [ 'title' => '', 'description' => 'A list of business types.', 'type' => 'array', 'items' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'robot', 'title' => ''], 'example' => '', ], 'Error' => ['description' => 'The error message if the task fails.', 'type' => 'string', 'title' => '', 'example' => '检查待发布模块是否空闲发生错误，faq'], 'CreateTime' => ['description' => 'The creation time of the task in UTC.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'ModifyTime' => ['description' => 'The last modification time of the task in UTC.', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_ABORTED\\",\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\"\\n}","type":"json"}]', 'title' => 'Cancel robot publishing', 'responseParamsDescription' => '### Examples'."\n" ."\n" .'#### Response body:'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "ModifyTime": "2022-04-14T03:43:55Z",'."\n" .' "BizTypeList": ['."\n" .' "robot"'."\n" .' ],'."\n" .' "CreateTime": "2022-04-14T03:43:54Z",'."\n" .' "RequestId": "c2f542c6-f0e3-464c-9aaf-ad6f6eab8140",'."\n" .' "Response": "5088",'."\n" .' "Warnings": {'."\n" .' "category_bind_chitchat": ['."\n" .' "The following category was not published to the production environment: The first chitchat package"'."\n" .' ]'."\n" .' },'."\n" .' "Id": 5088,'."\n" .' "Status": "FE_ABORTED"'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelInstancePublishTask'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CancelPublishTask' => [ 'summary' => 'Cancels a publish task that is in progress.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => ['description' => 'The ID of the publish task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you do not specify this parameter, the default business space is used. You can find the key on the Business Management page of your master account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', 'title' => ''], 'Id' => ['description' => 'The ID of the publish task.', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', 'title' => ''], 'Response' => ['description' => 'The ID of the publish task. This is a redundant field. We recommend that you use the `Id` field instead.', 'type' => 'string', 'example' => '8522', 'title' => ''], 'Status' => [ 'description' => 'The task status. Valid values:'."\n" ."\n" .'`FE_RUNNING`: in progress, `FE_SUCCESS`: succeeded, `FE_FAILED`: failed, `FE_ABORTED`: aborted.', 'type' => 'string', 'example' => 'FE_ABORTED', 'enum' => ['FE_RUNNING：正在发布中', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], 'title' => '', ], 'BizTypeList' => [ 'title' => '', 'description' => 'A list of business types.', 'type' => 'array', 'items' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'faq', 'title' => ''], 'example' => '', ], 'Error' => ['description' => 'The error message returned if the task fails.', 'type' => 'string', 'title' => '', 'example' => '检查待发布模块是否空闲发生错误，faq'], 'CreateTime' => ['description' => 'The time when the task was created, in UTC.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'ModifyTime' => ['description' => 'The time when the task was last modified, in UTC.', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_ABORTED\\",\\n \\"BizTypeList\\": [\\n \\"faq\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\"\\n}","type":"json"}]', 'title' => 'Cancel Publish Job', 'changeSet' => [ ['createdAt' => '2022-12-26T11:37:56.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelPublishTask'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'Chat' => [ 'summary' => 'Starts a conversation with a bot by specifying its Bot ID. This applies only to Chatbot (Legacy).', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique ID of the chatbot instance. To get this ID, log in to the Alibaba Cloud Chatbot console and go to **Chatbot Details** > **Session API**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'chatbot-cn-mp90s2lrk00050'], ], [ 'name' => 'Utterance', 'in' => 'query', 'schema' => ['description' => 'The user\'s input text.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '今天天气怎么样？'], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The session ID, used to identify a user session and maintain context. For a new user, omit this parameter in the first call to the `Chat` API. The chatbot automatically starts a session and returns the `SessionId` in the response. To continue the conversation, include this `SessionId` in all subsequent requests. The maximum length is 64 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9c6ebdc6e66f46ecadab3434314f6959'], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => ['description' => 'The ID of an entry in the knowledge base. If you specify this ID, the chatbot directly returns the corresponding answer.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '30002406051'], ], [ 'name' => 'SenderId', 'in' => 'query', 'schema' => ['description' => 'The unique ID of the user in the current session.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'custumer_123456'], ], [ 'name' => 'SenderNick', 'in' => 'query', 'schema' => ['description' => 'The nickname of the user in the current session.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '用户123456'], ], [ 'name' => 'IntentName', 'in' => 'query', 'schema' => ['description' => 'The name of an intent within a dialog flow. If specified, the chatbot directly activates this intent to process the user\'s request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '查天气意图'], ], [ 'name' => 'Perspective', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'An array of perspective codes. Use these codes to retrieve answers from different perspectives for the same knowledge entry. Example: `Perspective=["FZJBY3raWr"]`. When using an SDK, refer to its parameter definitions.', 'type' => 'array', 'items' => ['description' => 'The perspective code.', 'type' => 'string', 'example' => 'FZJBY3raWr', 'required' => false, 'title' => ''], 'required' => false, 'maxItems' => 20, 'example' => '', ], ], [ 'name' => 'VendorParam', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted string containing custom parameters to pass to various dialog engines.', 'type' => 'string', 'required' => false, 'example' => '{"phone":123456789}', 'title' => ''], ], [ 'name' => 'SandBox', 'in' => 'query', 'schema' => ['description' => 'Specifies the environment to use. The default value is `false`, which indicates the production environment.'."\n" ."\n" .'- `true`: The test environment. This environment is for testing only. Do not use it in production due to potential instability and QPS limitations.'."\n" ."\n" .'- `false`: The production environment.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If omitted, the request is routed to the default business space. You can get this key from the **Business Management** page of your main account.', 'type' => 'string', 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'QuerySegList' => [ 'title' => '', 'description' => 'The words segmented from the query. This field may be empty.', 'type' => 'array', 'items' => ['description' => 'A word segmented from the query.', 'type' => 'string', 'example' => '天气', 'title' => ''], 'example' => '', ], 'Messages' => [ 'title' => '', 'description' => 'A list of message objects.', 'type' => 'array', 'items' => [ 'description' => 'A message object.', 'type' => 'object', 'properties' => [ 'Knowledge' => [ 'title' => '', 'description' => 'Contains the `Knowledge` object if `AnswerType` is `Knowledge`.', 'type' => 'object', 'properties' => [ 'HitStatement' => ['description' => 'The hit statement matching the query.', 'type' => 'string', 'title' => '', 'example' => '公积金'], 'Summary' => ['description' => 'Summary of the matched knowledge entry.', 'type' => 'string', 'title' => '', 'example' => '公积金提取'], 'RelatedKnowledges' => [ 'title' => '', 'description' => 'A list of related knowledge objects.', 'type' => 'array', 'items' => [ 'description' => 'A related knowledge object.', 'type' => 'object', 'properties' => [ 'KnowledgeId' => ['description' => 'The ID of the related knowledge entry.', 'type' => 'string', 'title' => '', 'example' => '735899'], 'Title' => ['description' => 'The title of the related knowledge entry.', 'type' => 'string', 'title' => '', 'example' => '公积金查询'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Category' => ['description' => 'The category of the knowledge entry.', 'type' => 'string', 'title' => '', 'example' => '公积金'], 'Title' => ['description' => 'The title of the matched knowledge entry.', 'type' => 'string', 'title' => '', 'example' => '公积金提取'], 'Content' => ['description' => 'The content of the matched knowledge entry.', 'type' => 'string', 'title' => '', 'example' => '公积金提取，请在首页搜索公积金提取，提交办事的表单'], 'AnswerSource' => ['description' => 'The source of the answer.'."\n" .'`KnowledgeBase`: The answer is from the knowledge base.', 'type' => 'string', 'title' => '', 'example' => 'KnowledgeBase'], 'Id' => ['description' => 'ID of the matched knowledge entry in the knowledge base.', 'type' => 'string', 'title' => '', 'example' => '735898'], 'Score' => ['description' => 'The confidence score.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.998'], 'ContentType' => [ 'description' => 'Content format of the answer.', 'enumValueTitles' => ['PLAIN_TEXT' => 'plain text', 'RICH_TEXT' => 'rich text'], 'type' => 'string', 'enum' => ['PLAIN_TEXT：纯本文', 'RICH_TEXT: 富文本', 'CARD_TEMPLATE：卡片模版'], 'title' => '', 'example' => 'PLAIN_TEXT', ], ], 'example' => '', ], 'Text' => [ 'title' => '', 'description' => 'Contains the `Text` object if `AnswerType` is `Text`.', 'type' => 'object', 'properties' => [ 'HitStatement' => ['description' => 'The hit statement.', 'type' => 'string', 'title' => '', 'example' => '查天气'], 'DialogName' => ['description' => 'Name of the dialog. Returned only if `AnswerSource` is `BotFramework`.', 'type' => 'string', 'title' => '', 'example' => '示例_查天气'], 'ArticleTitle' => ['description' => 'Title of the matched article. Returned only if `AnswerSource` is `MACHINE_READ`.', 'type' => 'string', 'title' => '', 'example' => '备案十一'], 'AnswerSource' => [ 'description' => 'The source of the answer.', 'enumValueTitles' => ['TABLEQA' => 'table QA', 'COMMANDS' => 'System command', 'SENSITIVE_WORD' => 'Global sensitive word', 'BotFramework' => 'dialog factory', 'MACHINE_READ' => 'machine reading', 'ChitChat' => 'chit-chat', 'NO_ANSWER' => 'No answer found'], 'type' => 'string', 'enum' => ['ChitChat：闲聊', 'BotFramework：对话工厂', 'NO_ANSWER：无答案', 'MACHINE_READ：机器阅读', 'CardAnswer：卡片答案', 'SENSITIVE_WORD： 全局敏感词', 'COMMANDS：系统指令', 'TABLEQA：表格问答'], 'title' => '', 'example' => 'BotFramework', ], 'Slots' => [ 'title' => '', 'description' => 'A list of slot objects. Returned only if `AnswerSource` is `BotFramework`.', 'type' => 'array', 'items' => [ 'description' => 'Information about a slot.', 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'Extracted value of the slot.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Origin' => ['description' => 'The original value from the user\'s input.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Name' => ['description' => 'The name of the slot.', 'type' => 'string', 'example' => '查天气意图.city', 'title' => ''], 'Hit' => ['description' => 'Indicates whether the slot was filled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'NodeName' => ['description' => 'The name of the node. This field is returned when `AnswerSource` is `BotFramework`.', 'type' => 'string', 'title' => '', 'example' => '示例_查天气.查天气填槽.__city'], 'IntentName' => ['description' => 'The name of the intent. This field is returned when `AnswerSource` is `BotFramework`.', 'type' => 'string', 'title' => '', 'example' => '查天气意图'], 'MetaData' => ['description' => 'Metadata.', 'type' => 'string', 'example' => '[[{\\"columnName\\":\\"姓名\\",\\"stringValue\\":\\"王珊珊\\"}]]', 'title' => ''], 'ExternalFlags' => ['description' => 'Passthrough parameters. Returned only if `AnswerSource` is `BotFramework`.', 'type' => 'object', 'title' => '', 'example' => ''], 'Ext' => ['description' => 'Contains passthrough parameters.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" .' "MATCHED_INTENT_SOURCE": "",'."\n" .' "INTENT_ID": 724414,'."\n" .' "IntentName": "查天气意图",'."\n" .' "INTENT_DETAIL": "[我想|我要]查天气",'."\n" .' "LGF_EXPRESSION": "[我想|我要]查天气",'."\n" .' "IS_SESSION_FINISHED": false,'."\n" .' "DsScore": 100.0,'."\n" .' "DIALOG_ID": "299034",'."\n" .' "FINISH_LABEL": false,'."\n" .' "MODULE_START": false,'."\n" .' "INTENT_NAME": "查天气意图",'."\n" .' "INTENT_SOURCE": "Lgf",'."\n" .' "DIALOG_NAME": "示例_查天气"'."\n" .'}'], 'UserDefinedChatTitle' => ['description' => 'The title of a custom chit-chat topic.', 'type' => 'string', 'title' => '', 'example' => '问候'], 'Content' => ['description' => 'The content of the text message.', 'type' => 'string', 'title' => '', 'example' => '请问您要查哪里的天气？'], 'NodeId' => ['description' => 'The node ID. Returned only if `AnswerSource` is `BotFramework`.', 'type' => 'string', 'title' => '', 'example' => '1410-c7a72a78.__city'], 'Score' => ['description' => 'The confidence score.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.0'], 'ContentType' => [ 'description' => 'The content format of the answer.', 'enumValueTitles' => ['PLAIN_TEXT' => 'plain text', 'RICH_TEXT' => 'rich text'], 'type' => 'string', 'enum' => ['PLAIN_TEXT：纯本文', 'RICH_TEXT: 富文本', 'CARD_TEMPLATE：卡片模版'], 'title' => '', 'example' => 'PLAIN_TEXT', ], 'Commands' => ['description' => 'Command parameters, such as the skill group for transferring to a human agent.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" .' "sysToAgent": "{\\"skillGroup\\":\\"12\\"}"'."\n" .'}'], 'ResponseType' => ['description' => 'A value of `SSML` indicates that an interactive slot-filling process has started in the dialog factory. This field is returned only if `AnswerSource` is `BotFramework`.', 'type' => 'string', 'title' => '', 'example' => 'SSML'], ], 'example' => '', ], 'Recommends' => [ 'title' => '', 'description' => 'Contains a list of `Recommend` objects if `AnswerType` is `Recommend`.', 'type' => 'array', 'items' => [ 'description' => 'A `Recommend` object.', 'type' => 'object', 'properties' => [ 'KnowledgeId' => ['description' => 'The knowledge ID for the clarification.', 'type' => 'string', 'title' => '', 'example' => '4548'], 'Title' => ['description' => 'Clarification content. This can be an entity from knowledge graph QA, a knowledge title from FAQ-based QA, or a column value from table QA.', 'type' => 'string', 'title' => '', 'example' => '测试纯文本'], 'AnswerSource' => [ 'description' => 'Source of the clarification.', 'enumValueTitles' => ['BotFramework' => 'dialog factory', 'Knowledge' => 'FAQ'], 'type' => 'string', 'enum' => ['Knowledge：FAQ标题', 'BotFramework：对话工厂'], 'title' => '', 'example' => 'KNOWLEDGE', ], 'Score' => ['description' => 'The score of the recommended content. Returned only if `AnswerSource` is `KNOWLEDGE`.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.46'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'AnswerType' => [ 'description' => 'Type of the message.', 'enumValueTitles' => ['Recommend' => 'A clarification or a clarification question.', 'Text' => 'A text-based response.', 'Knowledge' => 'A direct answer from the knowledge base.'], 'type' => 'string', 'enum' => ['Text：文本', 'Recommend：澄清或者反问', 'Knowledge：知识库知识直出', 'cardAnswer：卡片工坊的卡片答案'], 'title' => '', 'example' => 'Text', ], 'AnswerSource' => [ 'description' => 'Indicates the source of the recommended answer if `AnswerType` is `Recommend`.', 'enumValueTitles' => [' INTENT_FAQ_CLARIFY' => 'A mixed clarification from both the FAQ and the dialog factory.', 'TABLEQA' => 'table QA', 'KNOWLEDGE' => 'FAQ', 'BotFramework' => 'dialog factory'], 'type' => 'string', 'enum' => ['KNOWLEDGE：知识问答', 'INTENT_FAQ_CLARIFY：FAQ和对话工厂混合澄清', 'BotFramework：对话工厂澄清', 'TABLEQA：表格问答'], 'title' => '', 'example' => 'KNOWLEDGE', ], 'VoiceTitle' => ['description' => 'The clarification content for voice-based scenarios.', 'type' => 'string', 'title' => '', 'example' => '请问你说的是公积金查询，还是公积金提取'], 'Title' => ['description' => 'The title of the clarification question for text-based chat scenarios.', 'type' => 'string', 'title' => '', 'example' => '请问您想咨询的是哪个投保年龄区间呢？'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'title' => '', 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC'], 'SessionId' => ['description' => 'The unique session ID.', 'type' => 'string', 'title' => '', 'example' => 'a6f216a0685c4c8baa0e8beb6d5ec6db'], 'MessageId' => ['description' => 'The unique message ID.', 'type' => 'string', 'title' => '', 'example' => 'A2315C4B-A872-5DEE-9DAD-D73B194A4AEC'."\n"], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QuerySegList\\": [\\n \\"天气\\"\\n ],\\n \\"Messages\\": [\\n {\\n \\"Knowledge\\": {\\n \\"HitStatement\\": \\"公积金\\",\\n \\"Summary\\": \\"公积金提取\\",\\n \\"RelatedKnowledges\\": [\\n {\\n \\"KnowledgeId\\": \\"735899\\",\\n \\"Title\\": \\"公积金查询\\"\\n }\\n ],\\n \\"Category\\": \\"公积金\\",\\n \\"Title\\": \\"公积金提取\\",\\n \\"Content\\": \\"公积金提取，请在首页搜索公积金提取，提交办事的表单\\",\\n \\"AnswerSource\\": \\"KnowledgeBase\\",\\n \\"Id\\": \\"735898\\",\\n \\"Score\\": 0.998,\\n \\"ContentType\\": \\"PLAIN_TEXT\\"\\n },\\n \\"Text\\": {\\n \\"HitStatement\\": \\"查天气\\",\\n \\"DialogName\\": \\"示例_查天气\\",\\n \\"ArticleTitle\\": \\"备案十一\\",\\n \\"AnswerSource\\": \\"BotFramework\\",\\n \\"Slots\\": [\\n {\\n \\"Value\\": \\"北京\\",\\n \\"Origin\\": \\"北京\\",\\n \\"Name\\": \\"查天气意图.city\\",\\n \\"Hit\\": false\\n }\\n ],\\n \\"NodeName\\": \\"示例_查天气.查天气填槽.__city\\",\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"MetaData\\": \\"[[{\\\\\\\\\\\\\\"columnName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"姓名\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"stringValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"王珊珊\\\\\\\\\\\\\\"}]]\\",\\n \\"ExternalFlags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Ext\\": {\\n \\"MATCHED_INTENT_SOURCE\\": \\"\\",\\n \\"INTENT_ID\\": 724414,\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"INTENT_DETAIL\\": \\"[我想|我要]查天气\\",\\n \\"LGF_EXPRESSION\\": \\"[我想|我要]查天气\\",\\n \\"IS_SESSION_FINISHED\\": false,\\n \\"DsScore\\": 100,\\n \\"DIALOG_ID\\": \\"299034\\",\\n \\"FINISH_LABEL\\": false,\\n \\"MODULE_START\\": false,\\n \\"INTENT_NAME\\": \\"查天气意图\\",\\n \\"INTENT_SOURCE\\": \\"Lgf\\",\\n \\"DIALOG_NAME\\": \\"示例_查天气\\"\\n },\\n \\"UserDefinedChatTitle\\": \\"问候\\",\\n \\"Content\\": \\"请问您要查哪里的天气？\\",\\n \\"NodeId\\": \\"1410-c7a72a78.__city\\",\\n \\"Score\\": 100,\\n \\"ContentType\\": \\"PLAIN_TEXT\\",\\n \\"Commands\\": {\\n \\"sysToAgent\\": \\"{\\\\\\"skillGroup\\\\\\":\\\\\\"12\\\\\\"}\\"\\n },\\n \\"ResponseType\\": \\"SSML\\"\\n },\\n \\"Recommends\\": [\\n {\\n \\"KnowledgeId\\": \\"4548\\",\\n \\"Title\\": \\"测试纯文本\\",\\n \\"AnswerSource\\": \\"KNOWLEDGE\\",\\n \\"Score\\": 0.46\\n }\\n ],\\n \\"AnswerType\\": \\"Text\\",\\n \\"AnswerSource\\": \\"KNOWLEDGE\\",\\n \\"VoiceTitle\\": \\"请问你说的是公积金查询，还是公积金提取\\",\\n \\"Title\\": \\"请问您想咨询的是哪个投保年龄区间呢？\\"\\n }\\n ],\\n \\"RequestId\\": \\"A2315C4B-A872-5DEE-9DAD-D73B194A4AEC\\",\\n \\"SessionId\\": \\"a6f216a0685c4c8baa0e8beb6d5ec6db\\",\\n \\"MessageId\\": \\"A2315C4B-A872-5DEE-9DAD-D73B194A4AEC\\\\n\\"\\n}","type":"json"}]', 'title' => 'Session', 'responseParamsDescription' => '#### Ext fields'."\n" ."\n" .'**When `AnswerSource` is `BotFramework`:**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| MATCHED_ENTRY_NAME | String | The name of the matched trigger node. |'."\n" .'| MATCHED_INTENT_SOURCE | String | The intent source of the matched trigger node. |'."\n" .'| INTENT_ID | Long | The ID of the matched intent. |'."\n" .'| IntentName | String | Same as `INTENT_NAME`. |'."\n" .'| INTENT_DETAIL | String | Describes how the intent was matched. This field is useful when INTENT_SOURCE is Similarity or Lgf. For Similarity, it contains the matched intent utterance. For Lgf, it contains the matched LGF grammar. |'."\n" .'| IS_SESSION_FINISHED | Boolean | Indicates whether the session has finished. |'."\n" .'| DsScore | String | The confidence score for the matched dialog flow. Also returned as dsScore. |'."\n" .'| DIALOG_ID | String | The ID of the dialog flow. |'."\n" .'| FINISH_LABEL | Boolean | Indicates if the response node is a final node. This is a business-defined value, typically used for analytics. |'."\n" .'| MODULE_START | Boolean | Indicates whether this is the starting intent node of a dialog flow. |'."\n" .'| INTENT_NAME | String | The name of the matched intent. |'."\n" .'| INTENT_SOURCE | String | The method used for intent recognition. Valid values include: `Similarity` for similarity matching, `Lgf` for LGF grammar matching, and `Classify` for supervised model matching. |'."\n" .'| DIALOG_NAME | String | The name of the dialog flow. |'."\n" .'| DS_REPORT | Map | Contains key-value pairs for variables selected for "Output to report" in the dialog flow configuration. |'."\n" .'| TASK_ID | String | The task ID returned by the asynchronous service. |'."\n" ."\n" .'#### Response message'."\n" ."\n" .'##### FAQ: Direct response'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Test",'."\n" .' "Rich",'."\n" .' "Text"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "Knowledge": {'."\n" .' "Score": 100.0,'."\n" .' "Category": "First Category",'."\n" .' "ContentType": "RICH_TEXT",'."\n" .' "AnswerSource": "KnowledgeBase",'."\n" .' "Content": "

This is a rich text answer.

",'."\n" .' "Summary": "This is a rich text answer.",'."\n" .' "Title": "Test Rich Text",'."\n" .' "Id": "4549"'."\n" .' },'."\n" .' "AnswerType": "Knowledge"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "1b8b19de-7e6d-4e45-b7f1-9daca21af8b0",'."\n" .' "SessionId": "1234",'."\n" .' "MessageId": "1b8b19de-7e6d-4e45-b7f1-9daca21af8b0"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### FAQ: Clarification'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Text"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "AnswerSource": "KNOWLEDGE",'."\n" .' "Recommends": ['."\n" .' {'."\n" .' "Score": 46.0,'."\n" .' "Title": "Test Plain Text",'."\n" .' "KnowledgeId": "4548"'."\n" .' }'."\n" .' ],'."\n" .' "AnswerType": "Recommend"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "5af5d5f9-76b1-45e9-8003-fcd07ab9a5e4",'."\n" .' "SessionId": "1234",'."\n" .' "MessageId": "5af5d5f9-76b1-45e9-8003-fcd07ab9a5e4"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Bot Framework: Direct response'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Check",'."\n" .' "Weather"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "Text": {'."\n" .' "Ext": {'."\n" .' "MATCHED_ENTRY_NAME": "intentWithout_city",'."\n" .' "MATCHED_INTENT_SOURCE": "",'."\n" .' "INTENT_ID": 724414,'."\n" .' "BOT_ANSWER_SOURCE": "Lgf",'."\n" .' "IntentName": "Check Weather intent",'."\n" .' "INTENT_DETAIL": "[I want|I\'d like to] check the weather",'."\n" .' "LGF_EXPRESSION": "[I want|I\'d like to] check the weather",'."\n" .' "IS_SESSION_FINISHED": false,'."\n" .' "DsScore": 100.0,'."\n" .' "DIALOG_ID": "299034",'."\n" .' "FINISH_LABEL": false,'."\n" .' "MODULE_START": false,'."\n" .' "INTENT_NAME": "Check Weather intent",'."\n" .' "INTENT_SOURCE": "Lgf",'."\n" .' "DIALOG_NAME": "Sample_CheckWeather"'."\n" .' },'."\n" .' "ContentType": "PLAIN_TEXT",'."\n" .' "NodeName": "Sample_CheckWeather.CheckWeather_FillSlot.__city",'."\n" .' "AnswerSource": "BotFramework",'."\n" .' "Slots": ['."\n" .' {'."\n" .' "Origin": "",'."\n" .' "Hit": false,'."\n" .' "Value": "",'."\n" .' "Name": "CheckWeatherIntent.city"'."\n" .' }'."\n" .' ],'."\n" .' "Score": 100.0,'."\n" .' "DialogName": "Sample_CheckWeather",'."\n" .' "IntentName": "Check Weather intent",'."\n" .' "Content": "Which city\'s weather would you like to check?",'."\n" .' "NodeId": "1410-c7a72a78.__city",'."\n" .' "ExternalFlags": {'."\n" .' '."\n" .' }'."\n" .' },'."\n" .' "AnswerType": "Text"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "dc6757ef-9d03-4255-92ec-d262752a88ed",'."\n" .' "SessionId": "1234",'."\n" .' "MessageId": "dc6757ef-9d03-4255-92ec-d262752a88ed"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Bot Framework: Clarification'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Housing Fund"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "VoiceTitle": "Are you asking about checking your housing fund, or withdrawing from it?",'."\n" .' "AnswerSource": "BotFramework",'."\n" .' "Recommends": ['."\n" .' {'."\n" .' "Score": 0.656,'."\n" .' "AnswerSource": "BotFramework",'."\n" .' "Title": "Housing Fund Inquiry",'."\n" .' "KnowledgeId": "735899"'."\n" .' },'."\n" .' {'."\n" .' "Score": 0.634,'."\n" .' "AnswerSource": "BotFramework",'."\n" .' "Title": "Housing Fund Withdrawal",'."\n" .' "KnowledgeId": "735900"'."\n" .' }'."\n" .' ],'."\n" .' "AnswerType": "Recommend"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98",'."\n" .' "SessionId": "123",'."\n" .' "MessageId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Intent and FAQ: Mixed clarification'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Housing Fund"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "VoiceTitle": "Are you asking about checking your housing fund, or about the specific regulations for pre-tax deduction of housing funds from personal income tax?",'."\n" .' "AnswerSource": "INTENT_FAQ_CLARIFY",'."\n" .' "Recommends": ['."\n" .' {'."\n" .' "Score": 0.656,'."\n" .' "AnswerSource": "BotFramework",'."\n" .' "Title": "Housing Fund Inquiry",'."\n" .' "KnowledgeId": "735899"'."\n" .' },'."\n" .' {'."\n" .' "Score": 0.47410887479782104,'."\n" .' "Category": "Taxation-12366&680 items-Tax Calculation-Comprehensive Income for Resident Individuals-Personal Income Tax Special Deductions",'."\n" .' "AnswerSource": "KNOWLEDGE",'."\n" .' "Title": "What are the specific regulations for pre-tax deduction of housing funds from personal income tax?",'."\n" .' "KnowledgeId": "7049"'."\n" .' }'."\n" .' ],'."\n" .' "AnswerType": "Recommend"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "08d6bb1c-5394-4836-8e4a-86c07e7729b1",'."\n" .' "SessionId": "123",'."\n" .' "MessageId": "08d6bb1c-5394-4836-8e4a-86c07e7729b1"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Chit-chat'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Hello"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "Text": {'."\n" .' "ContentType": "PLAIN_TEXT",'."\n" .' "AnswerSource": "ChitChat",'."\n" .' "HitStatement": "Hello",'."\n" .' "Content": "Beep~beep~beep~, I\'m here."'."\n" .' },'."\n" .' "AnswerType": "Text"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "8f267d8c-c118-4d6a-9ba1-2a5bdc720fed",'."\n" .' "SessionId": "1234",'."\n" .' "MessageId": "8f267d8c-c118-4d6a-9ba1-2a5bdc720fed"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Global sensitive word'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Check",'."\n" .' "Weather"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "Text": {'."\n" .' "ContentType": "PLAIN_TEXT",'."\n" .' "AnswerSource": "SENSITIVE_WORD",'."\n" .' "Content": "I cannot answer this question. Please try asking something else."'."\n" .' },'."\n" .' "AnswerType": "Text"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "961d4187-e2e7-4463-8063-a4c79c912227",'."\n" .' "SessionId": "1234",'."\n" .' "MessageId": "961d4187-e2e7-4463-8063-a4c79c912227"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Transfer to agent'."\n" ."\n" .'###### Global transfer to agent'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Agent"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "Text": {'."\n" .' "ContentType": "PLAIN_TEXT",'."\n" .' "AnswerSource": "COMMANDS",'."\n" .' "Content": "Transferring you to an agent.",'."\n" .' "Commands": {'."\n" .' "sysToAgent": "{\\"skillGroup\\":\\"12\\"}"'."\n" .' }'."\n" .' },'."\n" .' "Knowledge": {'."\n" .' '."\n" .' },'."\n" .' "Type": "Text",'."\n" .' "AnswerType": "Text"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",'."\n" .' "SessionId": "123",'."\n" .' "MessageId": "fbbe0230-af14-4850-8f59-2ff60dfbf773"'."\n" .'}'."\n" .'```'."\n" ."\n" .'###### Transfer to agent via Bot Framework intent'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Transfer",'."\n" .' "to",'."\n" .' "Agent"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "Text": {'."\n" .' "Ext": {'."\n" .' "MATCHED_ENTRY_NAME": "Transfer to agent",'."\n" .' "MATCHED_INTENT_SOURCE": "",'."\n" .' "INTENT_ID": 8454,'."\n" .' "BOT_ANSWER_SOURCE": "Similarity",'."\n" .' "intentName": "Transfer to agent",'."\n" .' "DsScore": 100.0,'."\n" .' "INTENT_DETAIL": "Transfer to agent",'."\n" .' "LGF_EXPRESSION": "Transfer to agent",'."\n" .' "IS_SESSION_FINISHED": true,'."\n" .' "dsScore": 100.0,'."\n" .' "DIALOG_ID": "2529",'."\n" .' "FINISH_LABEL": false,'."\n" .' "IntentName": "Transfer to agent",'."\n" .' "MODULE_START": true,'."\n" .' "INTENT_NAME": "Transfer to agent",'."\n" .' "INTENT_SOURCE": "Similarity",'."\n" .' "DIALOG_NAME": "Housing Fund Transfer to Agent"'."\n" .' },'."\n" .' "ContentType": "PLAIN_TEXT",'."\n" .' "NodeName": "Housing Fund Transfer to Agent.Response Message",'."\n" .' "AnswerSource": "BotFramework",'."\n" .' "Score": 100.0,'."\n" .' "DialogName": "Housing Fund Transfer to Agent",'."\n" .' "IntentName": "Transfer to agent",'."\n" .' "Content": "This is the response for the agent transfer.",'."\n" .' "Commands": {'."\n" .' "sysToAgent": "{\\"skillGroup\\":\\"8\\",\\"ext\\":\\"123\\"}"'."\n" .' },'."\n" .' "NodeId": "i073y198",'."\n" .' "ExternalFlags": {'."\n" .' '."\n" .' }'."\n" .' },'."\n" .' "Type": "Text",'."\n" .' "AnswerType": "Text"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",'."\n" .' "SessionId": "123",'."\n" .' "MessageId": "590f0434-030a-4de2-8212-bf1a96e0c687"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Fallback'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Housing Fund",'."\n" .' "Loan"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "Text": {'."\n" .' "ContentType": "PLAIN_TEXT",'."\n" .' "AnswerSource": "NO_ANSWER",'."\n" .' "Content": "I haven\'t learned how to answer this question yet. I\'ve logged it and will learn soon. Please try asking something else."'."\n" .' },'."\n" .' "AnswerType": "Text"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",'."\n" .' "SessionId": "1234",'."\n" .' "MessageId": "1ad8733a-7180-4e3b-a969-96f47d774256"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Machine reading \\[Non-standard feature. To use this, enable the document QA capability.]'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList":['."\n" .' "Project",'."\n" .' "Filing"'."\n" .' ],'."\n" .' "Messages":['."\n" .' {'."\n" .' "Type":"Text",'."\n" .' "AnswerType": "Text",'."\n" .' "Text":{'."\n" .' "AnswerSource":"MACHINE_READ",'."\n" .' "ArticleTitle":"Filing Eleven",'."\n" .' "Content":"IV. Application Submission:\\nApplication method: Online application\\nContact number: 057******2724, 870*2837\\nOffice address: N/A\\nV. Basic Procedure:\\n1. Log on to the Zhejiang Government Service Network (http://www.zjzwfw.gov.cn) to register a corporate user account.\\n2. Use the corporate account to log on to the Investment Project Online Approval and Supervision Platform (http://tzxm.zjzwfw.gov.cn), also known as the online platform.\\n3. On the online platform, navigate to Project Registration > Filing-based Registration to enter the filing system.\\n4. Fill in the project filing information.\\n5. Submit the project filing information form to receive a project code.\\n6. Submit the declaration to complete the project filing.\\nFlowchart: http://zjqlk.oss-cn-hangzhou.aliyuncs.com/c/5/53"'."\n" .' }'."\n" .' }'."\n" .' ],'."\n" .' "RequestId":"089abc58-e9ab-4aa8-86a8-70fc9d8cf0fb",'."\n" .' "SessionId":"123",'."\n" .' "MessageId":"089abc58-e9ab-4aa8-86a8-70fc9d8cf0fb"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Table QA: Direct response \\[Non-standard feature. To use this, enable the Table QA capability.]'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Wang**\'s",'."\n" .' "grade"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "Text": {'."\n" .' "ContentType": "PLAIN_TEXT",'."\n" .' "AnswerSource": "TABLEQA",'."\n" .' "Content": "The grade for Wang** is \'Fail\'."'."\n" .' },'."\n" .' "AnswerType": "Text"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "c09d1913-dd8d-4a45-b8bd-e45e4fcf872b",'."\n" .' "SessionId": "123",'."\n" .' "MessageId": "c09d1913-dd8d-4a45-b8bd-e45e4fcf872b"'."\n" .'}'."\n" .'```'."\n" ."\n" .'##### Table QA: Clarification \\[Non-standard feature. To use this, enable the Table QA capability.]'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "QuerySegList": ['."\n" .' "Products",'."\n" .' "with",'."\n" .' "yield",'."\n" .' "greater than",'."\n" .' "4"'."\n" .' ],'."\n" .' "Messages": ['."\n" .' {'."\n" .' "AnswerSource": "TABLEQA",'."\n" .' "Title": "Please select the investment period:",'."\n" .' "Recommends": ['."\n" .' {'."\n" .' "Title": "1907"'."\n" .' },'."\n" .' {'."\n" .' "Title": "31"'."\n" .' },'."\n" .' {'."\n" .' "Title": "365"'."\n" .' }'."\n" .' ],'."\n" .' "AnswerType": "Recommend"'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "abef84e0-8d08-4d80-9dfb-2e958e0833ad",'."\n" .' "SessionId": "1234",'."\n" .' "MessageId": "abef84e0-8d08-4d80-9dfb-2e958e0833ad"'."\n" .'}'."\n" .'```', 'extraInfo' => '## Common Q&A Errors'."\n" ."\n" .'### Third-Party Service Errors'."\n" .'A third-party service error occurs when an API of a third-party service is configured in a Q&A pair or Dialog Studio. When a user query matches the configured conditions or utterances, the corresponding third-party service is invoked. If the service invocation fails, the system returns the error message "Third party interface error". The response protocol is as follows.'."\n" ."\n" .'**Response Parameter Description**'."\n" ."\n" .'| Column Name | Description |'."\n" .'| ----------- | ------------------------------------------------------------------- |'."\n" .'| RequestId | Request ID |'."\n" .'| HostId | Alibaba Cloud Chatbot host ID |'."\n" .'| Code | Error code; for third-party service errors, the error code is "Third party interface error" |'."\n" .'| Message | Fault description |'."\n" ."\n" .'**Sample Response Parameters**'."\n" .'```json'."\n" .'{'."\n" .' "RequestId": "A805905D-B20C-57C9-8793-EAF98FBD8F84",'."\n" .' "HostId": "chatbot.cn-shanghai.aliyuncs.com",'."\n" .' "Code": "Third party interface error",'."\n" .' "Message": "Third-party interface error. An IOException occurred during the HTTP request, which may be caused by a network connection timeout, no response from the server-side, or other configuration issues. URL: https://example.com/order/create",'."\n" .' "Recommend": "https://next.api.aliyun.com/troubleshoot?q=Third party interface error&product=Chatbot"'."\n" .'}'."\n" .'```', 'changeSet' => [ ['createdAt' => '2023-04-27T12:46:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-09-01T02:47:10.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-21T13:43:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-17T09:21:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Chat'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ContinueInstancePublishTask' => [ 'summary' => 'Ignores an alarm and continues a chatbot publish task.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the chatbot.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the default business space is used. You can find this key on the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', 'title' => ''], 'Id' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', 'title' => ''], 'Response' => ['description' => 'The ID of the task, returned as a string.', 'type' => 'string', 'example' => '8522', 'title' => ''], 'Status' => [ 'description' => 'The status of the task.', 'enumValueTitles' => ['FE_SUCCESS' => 'Published', 'FE_ABORTED' => 'Publication Canceled', 'FE_WARNING' => 'Publication Warning', 'FE_FAILED' => 'Publication Failed', 'FE_RUNNING' => 'Publishing'], 'type' => 'string', 'example' => 'FE_RUNNING', 'enum' => ['FE_RUNNING：正在发布中', 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], 'title' => '', ], 'BizTypeList' => [ 'title' => '', 'description' => 'The business types associated with the publish task.', 'type' => 'array', 'items' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'robot', 'title' => ''], 'example' => '', ], 'Error' => ['description' => 'The error message if the task fails.', 'type' => 'string', 'title' => '', 'example' => '检查待发布模块是否空闲发生错误，faq'], 'CreateTime' => ['description' => 'The UTC time when the task was created.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'ModifyTime' => ['description' => 'The UTC time when the task was last modified.', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', 'title' => ''], 'Warnings' => ['description' => 'A key-value map of warnings. Keys are the submodule names, and values are arrays of warning messages.', 'type' => 'object', 'example' => '{'."\n" .' "category_bind_faq": ['."\n" .' "以下类目没有发布到正式环境: 项目交付信息汇总"'."\n" .' ]'."\n" .'}', 'title' => ''], 'Errors' => ['description' => 'A key-value map of errors. Keys are the submodule names, and values are arrays of error messages.', 'type' => 'object', 'title' => '', 'example' => '{}'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\",\\n \\"Warnings\\": {\\n \\"category_bind_faq\\": [\\n \\"以下类目没有发布到正式环境: 项目交付信息汇总\\"\\n ]\\n },\\n \\"Errors\\": {}\\n}","type":"json"}]', 'title' => 'Resume robot publishing', 'responseParamsDescription' => '### Submodule keys for warnings and errors'."\n" ."\n" .'| Key | Description |'."\n" .'| ------------------------ | ------------------------- |'."\n" .'| `category_bind_chitchat` | Chitchat bindings. |'."\n" .'| `category_bind_faq` | FAQ bindings. |'."\n" .'| `robot_ds` | Dialog Studio dialog flow |'."\n" .'| `ds_entity` | Dialog Studio entity |'."\n" .'| `ds_intent` | Dialog Studio intent |'."\n" ."\n" .'### Examples'."\n" ."\n" .'#### Sample response'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "ModifyTime": "2022-04-12T06:32:59Z",'."\n" .' "BizTypeList": ['."\n" .' "robot"'."\n" .' ],'."\n" .' "CreateTime": "2022-04-12T06:30:17Z",'."\n" .' "RequestId": "1b6318c2-df76-4117-9c2c-02e22940ff24",'."\n" .' "Response": "4930",'."\n" .' "Warnings": {'."\n" .' "category_bind_faq": ['."\n" .' "The following category is not published to the production environment: Project Delivery Information Summary"'."\n" .' ]'."\n" .' },'."\n" .' "Id": 4930,'."\n" .' "Status": "FE_RUNNING"'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinueInstancePublishTask'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateCategory' => [ 'summary' => 'Creates a category.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The category name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '测试1'], ], [ 'name' => 'BizCode', 'in' => 'formData', 'schema' => ['title' => 'Business code ', 'description' => 'The business code.', 'type' => 'string', 'required' => false, 'example' => 'bizcode123'], ], [ 'name' => 'KnowledgeType', 'in' => 'formData', 'schema' => ['title' => 'Knowledge type: 1 for FAQ category, 3 for document category', 'description' => 'The knowledge type. Valid values are 1 for an FAQ category and 3 for a document category. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'ParentCategoryId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the parent category. Defaults to -1, which indicates the root category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '-1'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If this parameter is not specified, the default business space is used. You can obtain the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A629A28F-F25E-5572-A679-FA46FB0151D6', 'title' => ''], 'Category' => [ 'title' => '', 'description' => 'Details of the created category.', 'type' => 'object', 'properties' => [ 'CategoryId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30000049006'], 'BizCode' => ['description' => 'The business code.', 'type' => 'string', 'example' => 'bizcode123', 'title' => ''], 'Name' => ['description' => 'The category name.', 'type' => 'string', 'example' => '类目名称', 'title' => ''], 'ParentCategoryId' => ['description' => 'The ID of the parent category.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], 'Status' => ['description' => 'The category status. A value of -1 indicates that the category has been deleted, but this change has not been published. A value of 0 indicates Normal.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A629A28F-F25E-5572-A679-FA46FB0151D6\\",\\n \\"Category\\": {\\n \\"CategoryId\\": 30000049006,\\n \\"BizCode\\": \\"bizcode123\\",\\n \\"Name\\": \\"类目名称\\",\\n \\"ParentCategoryId\\": -1,\\n \\"Status\\": 0\\n }\\n}","type":"json"}]', 'title' => 'Category - Create', 'changeSet' => [ ['createdAt' => '2024-02-22T12:10:09.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2022-07-07T11:54:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCategory'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateConnQuestion' => [ 'summary' => 'Creates a connected question for a knowledge item.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ConnQuestionId', 'in' => 'formData', 'schema' => ['description' => 'The connected question ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30002654628', 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30002174773', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The agent key. If you do not specify this parameter, the default agent is used. You can obtain the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C191B48B-9268-4FB1-A3C2-5143B4A91D0C', 'title' => ''], 'OutlineId' => ['description' => 'The outline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000002123'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C191B48B-9268-4FB1-A3C2-5143B4A91D0C\\",\\n \\"OutlineId\\": 1000002123\\n}","type":"json"}]', 'title' => 'Create association', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnQuestion'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateDSEntity' => [ 'summary' => 'Creates an `entity` and its metadata, such as the `entity name` and `entity type`.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the `business space`. If you omit this parameter, the default `business space` is used. You can get the key from the Business Management page of your `main account`.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The `instance ID`.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'EntityName', 'in' => 'query', 'schema' => ['description' => 'The `entity name`. The name can contain Chinese characters, uppercase and lowercase letters, digits, and underscores (\\_).', 'type' => 'string', 'required' => true, 'example' => '实体名称', 'title' => ''], ], [ 'name' => 'EntityType', 'in' => 'query', 'schema' => ['description' => 'The `entity type`. Valid values: `synonyms` and `regex`.', 'type' => 'string', 'required' => false, 'example' => 'synonyms', 'default' => 'synonyms', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The `request ID`.', 'type' => 'string', 'example' => 'adfad2343f1f2r', 'title' => ''], 'EntityId' => ['description' => 'The `entity ID`.', 'type' => 'integer', 'format' => 'int64', 'example' => '23436345', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorEntity.OutRange', 'errorMessage' => 'The business error Entity is out of range.', 'description' => ''], ['errorCode' => 'BusinessErrorEntityName.OutRange', 'errorMessage' => 'The business error EntityName is out of range.', 'description' => ''], ['errorCode' => 'BusinessErrorEntityName.Repeat', 'errorMessage' => 'BusinessErrorEntityName.Repeat The business error EntityName is repeat.', 'description' => ''], ['errorCode' => 'BusinessErrorEntityName.InvalidCharactor', 'errorMessage' => 'The business error EntityName contains invalid charactor.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"adfad2343f1f2r\\",\\n \\"EntityId\\": 23436345\\n}","type":"json"}]', 'title' => 'Entity - Creation ', 'changeSet' => [ ['createdAt' => '2022-07-21T13:43:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDSEntity'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateDSEntityValue' => [ 'summary' => 'Adds an entity member to a specified entity. An entity member includes an entity value and a synonym list. All entity values and synonyms must be unique within the same entity.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The business space key. If omitted, the default business space is used. You can obtain the key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The robot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The entity value (or regular expression).', 'type' => 'string', 'required' => true, 'example' => '书类型', 'title' => ''], ], [ 'name' => 'Synonyms', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of synonyms for the entity value.', 'type' => 'array', 'items' => ['description' => 'A synonym.', 'type' => 'string', 'required' => false, 'example' => '书本', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'g763hg48j3f3', 'title' => ''], 'EntityValueId' => ['description' => 'The entity member ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2434543453', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"g763hg48j3f3\\",\\n \\"EntityValueId\\": 2434543453\\n}","type":"json"}]', 'title' => 'Entity Member - Creation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDSEntityValue'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateDoc' => [ 'summary' => 'Creates a 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' => 'The key for the business space. If this parameter is not specified, the default business space is used. You can obtain the key from the Business Management page of your primary account.', 'type' => 'string', 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'required' => false, 'title' => ''], ], [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'The document category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30000049006'], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The document title.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'title' => '', 'example' => '测试标题'], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The document content. You must specify either this parameter or `Url`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '测试内容'], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The configuration for document splitting. Set the key to `Splitter`. Valid values are `paragraphSplitter` (identifies content hierarchy) and `treeSplitter` (uses a rule-based hierarchy).'."\n" ."\n" .'The document chunk size. Set the key to `ChunkSize`. The default value is 500. The value must be in the range of 200 to 800.'."\n" ."\n" .'The patterns for the rule-based hierarchy. Set the key to `TreePatterns`. The default value is an empty array (`[]`).'."\n" ."\n" .'The document title source. Set the key to `TitleSource`. Valid values are `ocrTitle` (default), which uses the title recognized by Optical Character Recognition (OCR), and `docName`, which uses the document name as the title.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":""}'], ], [ 'name' => 'Meta', 'in' => 'query', 'schema' => ['description' => 'The passthrough data of the document.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"code":"xxx"}'], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => ['description' => 'The time when the document takes effect. The time is in UTC.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-05-25T16:28:36Z'."\n"], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => ['description' => 'The time when the document expires. The time is in UTC.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2032-05-25T16:28:36Z'."\n"], ], [ 'name' => 'Url', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['title' => 'Document URL path', 'description' => 'The URL of the document. You must specify either this parameter or `Content`. Supported formats include .txt, .pdf, .markdown, .doc, and .docx. The following limits apply to a single file: a maximum of 100 pages, less than 200 KB for .txt and .markdown files, and less than 100 MB for .pdf, .doc, and .docx files.', 'type' => 'string', 'example' => 'https://example.com/example.pdf', 'required' => false], ], [ 'name' => 'TagIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of tag IDs.', 'type' => 'array', 'items' => ['description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1201', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'DocMetadata', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BusinessViewId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'BusinessViewName' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'MetaCellInfoDTOList' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'FieldCode' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'FieldName' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'Value' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '07B270A4-61D8-57F6-A609-A3C216CFB872'], 'KnowledgeId' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30001905617', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"07B270A4-61D8-57F6-A609-A3C216CFB872\\",\\n \\"KnowledgeId\\": 30001905617\\n}","type":"json"}]', 'title' => 'Create a document', 'changeSet' => [ ['createdAt' => '2024-09-26T12:39:56.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-17T09:42:04.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDoc'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateFaq' => [ 'summary' => 'Creates a knowledge item.', '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' => ['description' => 'The agent key. If omitted, the default agent is used. Find this key on the Agent Management page.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the knowledge category.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '1000053274'], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['description' => 'The knowledge title. Max length: 120 characters.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '测试标题'], ], [ 'name' => 'StartDate', 'in' => 'formData', 'schema' => ['description' => 'The knowledge start time. The time is in UTC and in ISO 8601 format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-05-25T16:28:36Z'], ], [ 'name' => 'EndDate', 'in' => 'formData', 'schema' => ['description' => 'The knowledge end time. The time is in UTC and in ISO 8601 format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2030-12-31T16:00:00Z'], ], [ 'name' => 'SolutionContent', 'in' => 'formData', 'schema' => ['description' => 'The content of the default solution. Required if the fallback feature is enabled.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '测试答案'], ], [ 'name' => 'SolutionType', 'in' => 'formData', 'schema' => ['description' => 'The type of the default solution. Valid values: `0` (plain text) and `1` (rich text).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], ], [ 'name' => 'TagIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of tag IDs to associate with the knowledge.', 'title' => 'List of tag IDs', 'type' => 'array', 'items' => ['title' => 'Tag ID', 'description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '25645645', 'required' => false], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'KnowledgeId' => ['description' => 'The ID of the newly created knowledge.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30001979424'], 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeId\\": 30001979424,\\n \\"RequestId\\": \\"28805A7C-D695-548C-A31B-67E52C2C274F\\"\\n}","type":"json"}]', 'title' => 'Create FAQ', 'changeSet' => [ ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFaq'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateInstance' => [ 'summary' => 'Creates a robot in the sandbox environment.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the robot. The maximum length is 50 characters.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '小蜜机器人', 'title' => ''], ], [ 'name' => 'LanguageCode', 'in' => 'query', 'schema' => ['description' => 'The language of the robot, such as `zh-cn` or `en-us`. The language must be supported by the agent. If you omit this parameter, the agent\'s default language is used.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'zh-cn', 'title' => ''], ], [ 'name' => 'Introduction', 'in' => 'query', 'schema' => ['description' => 'A description of the robot. The description can be up to 50 characters long.', 'type' => 'string', 'required' => false, 'example' => '用于手机app的小蜜机器人', 'title' => ''], ], [ 'name' => 'RobotType', 'in' => 'query', 'schema' => [ 'description' => 'The robot type. The default value is `scenario_im`.', 'enumValueTitles' => ['scenario_callout' => 'callout robot', 'scenario_im' => 'online text robot', 'scenario_ivr' => 'IVR robot'], 'type' => 'string', 'required' => false, 'example' => 'scenario_im', 'title' => '', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the agent. If you omit this parameter, the default agent is used. You can find the key on the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A'], 'InstanceId' => ['description' => 'The instance ID of the robot.', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A\\",\\n \\"InstanceId\\": \\"chatbot-cn-mp90s2lrk00050\\"\\n}","type":"json"}]', 'title' => 'Robot - Creation', 'changeSet' => [ ['createdAt' => '2022-06-20T11:28:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-10T03:13:25.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateInstancePublishTask' => [ 'summary' => 'Publishes a sandbox robot to the production environment.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique instance ID of the robot.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the default business space is used. You can obtain the key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', 'title' => ''], 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', 'title' => ''], 'Response' => ['description' => 'The task ID, returned as a string.', 'type' => 'string', 'example' => '8522', 'title' => ''], 'Status' => [ 'description' => 'The task status.', 'enumValueTitles' => ['FE_SUCCESS' => 'Published successfully.', 'FE_ABORTED' => 'Publishing canceled.', 'FE_WARNING' => 'A warning occurred. To proceed with publishing, call the `ContinueInstancePublishTask` operation.', 'FE_FAILED' => 'Publishing failed.', 'FE_RUNNING' => 'Publishing is in progress.'], 'type' => 'string', 'example' => 'FE_RUNNING', 'enum' => ['FE_RUNNING：正在发布中', 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], 'title' => '', ], 'BizTypeList' => [ 'title' => '', 'description' => 'A list of business types.', 'type' => 'array', 'items' => ['description' => 'The business type of the publish task.', 'type' => 'string', 'example' => 'robot', 'title' => ''], 'example' => '', ], 'Error' => ['description' => 'The error message for the publish task.', 'type' => 'string', 'title' => '', 'example' => '检查待发布模块是否空闲发生错误,faq'], 'CreateTime' => ['description' => 'The UTC time when the task was created.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'ModifyTime' => ['description' => 'The UTC time when the task was last modified.', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误,faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\"\\n}","type":"json"}]', 'title' => 'Create a robot publishing job ', 'responseParamsDescription' => '### Examples'."\n" ."\n" .'#### Sample response'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "ModifyTime": "2022-04-12T06:30:17Z",'."\n" .' "BizTypeList": ['."\n" .' "robot"'."\n" .' ],'."\n" .' "CreateTime": "2022-04-12T06:30:17Z",'."\n" .' "RequestId": "edba56e5-aac2-49b4-a406-3e4d7e7952dd",'."\n" .' "Response": "4930",'."\n" .' "Id": 4930,'."\n" .' "Status": "FE_RUNNING"'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstancePublishTask'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateIntent' => [ 'summary' => 'Creates an intent. This operation defines an intent\'s metadata, such as its name, alias, and associated slots. It does not include utterances or LGF.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you do not specify this parameter, the default business space is used. You can get the key from the business management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'IntentDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The intent definition.', 'type' => 'object', 'properties' => [ 'IntentName' => ['description' => 'The intent name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '查天气意图'], 'AliasName' => ['description' => 'The intent alias.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '查天气意图'], 'SlotInfos' => [ 'title' => '', 'description' => 'An array of objects, each defining a slot for the intent.', 'type' => 'array', 'items' => [ 'description' => 'Information about a slot.', 'type' => 'object', 'properties' => [ 'SlotId' => ['description' => 'The slot ID.', 'type' => 'string', 'required' => true, 'example' => 'fg452dfg3df23', 'title' => ''], 'Name' => ['description' => 'The slot name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '天气'], 'Value' => ['description' => 'The name of the associated entity.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '天气'], 'Interactive' => ['description' => 'Specifies whether the slot is interactive.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], 'Array' => ['description' => 'Specifies whether the slot can have multiple values.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], 'Encrypt' => ['description' => 'Specifies whether to encrypt the slot value.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '43546474', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'df56gjh5et34g3g3', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorIntent.OutRange', 'errorMessage' => 'The business error Intent is out of range.', 'description' => ''], ['errorCode' => 'BusinessErrorIntentName.OutRange', 'errorMessage' => 'The business error IntentName is out of range.', 'description' => ''], ['errorCode' => 'BusinessErrorIntentName.Repeat', 'errorMessage' => 'The business error IntentName is repeat.', 'description' => ''], ['errorCode' => 'BusinessErrorIntentName.InvalidCharactor', 'errorMessage' => 'The business error IntentName contains invalid charactor.', 'description' => ''], ['errorCode' => 'BusinessErrorIntentEntity.NotExists', 'errorMessage' => 'The business error IntentEntity is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IntentId\\": 43546474,\\n \\"RequestId\\": \\"df56gjh5et34g3g3\\"\\n}","type":"json"}]', 'title' => 'Intent - Creation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntent'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateLgf' => [ 'summary' => 'Creates an advanced semantic configuration (LGF) for a specified intent.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the default business space is used. You can find the key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The chatbot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'LgfDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The LGF definition.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '4675678567'], 'RuleText' => ['description' => 'The LGF configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '.{0,10}北京天气'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'LgfId' => ['description' => 'The LGF ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123453433453', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'af5fg3sdf457j5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LgfId\\": 123453433453,\\n \\"RequestId\\": \\"af5fg3sdf457j5\\"\\n}","type":"json"}]', 'title' => 'Intent - LGF - Creation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLgf'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreatePerspective' => [ 'summary' => 'Creates a perspective.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the perspective. The maximum length is 50 characters.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '移动端视角', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the perspective.', 'type' => 'string', 'required' => false, 'example' => '用于购物APP的移动端视角', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The agent key. If unspecified, the system uses the default agent. You can obtain this key from the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', 'title' => ''], 'PerspectiveId' => ['description' => 'The perspective ID.', 'type' => 'string', 'example' => '3001', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F285D735-D580-18A8-B97F-B2E72B00F101\\",\\n \\"PerspectiveId\\": \\"3001\\"\\n}","type":"json"}]', 'title' => 'Perspective - Creation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePerspective'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreatePublishTask' => [ 'summary' => 'Creates a publish task in the publishing center.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'description' => 'The type of content to publish. To publish a bot, use the `CreateInstancePublishTask` API.', 'enumValueTitles' => ['chitchat' => 'The chit-chat library.', 'service_center' => 'The global service.', 'faq' => 'The FAQ knowledge base.', 'dict' => 'The global dictionary. (Legacy only)', 'sensitive' => 'The global sensitive words.', 'command' => 'The global commands.', 'mrc' => 'The document library.'], 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'faq', 'enum' => [], 'title' => '', ], ], [ 'name' => 'DataIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Specifies data to publish by ID. This parameter is used only when `BizType` is set to `faq`. In this case, provide one or more category IDs to publish knowledge exclusively from the specified categories.', 'type' => 'array', 'items' => ['description' => 'The FAQ category ID.', 'type' => 'string', 'required' => false, 'example' => '8521', 'title' => ''], 'required' => false, 'enumValueTitles' => [], 'example' => '["8521"]', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you omit this parameter, the default business space is used. You can obtain the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', 'title' => ''], 'Id' => ['description' => 'The publish task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', 'title' => ''], 'Response' => ['description' => 'The publish task ID. This parameter is redundant. Use the `Id` parameter instead.', 'type' => 'string', 'example' => '8522', 'title' => ''], 'Status' => [ 'description' => 'The task status. Valid values:'."\n" ."\n" .'`FE_RUNNING`: Publishing

`FE_SUCCESS`: Published

`FE_FAILED`: Failed

`FE_ABORTED`: Canceled





', 'type' => 'string', 'example' => 'FE_RUNNING', 'enum' => ['FE_RUNNING：正在发布中', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], 'title' => '', ], 'BizTypeList' => [ 'title' => '', 'description' => 'The list of business types.', 'type' => 'array', 'items' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'faq', 'title' => ''], 'example' => '', ], 'Error' => ['description' => 'The error message if the task fails.', 'type' => 'string', 'title' => '', 'example' => '检查待发布模块是否空闲发生错误，faq'], 'CreateTime' => ['description' => 'The time when the task was created, in UTC.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'ModifyTime' => ['description' => 'The time when the task was last modified, in UTC.', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"faq\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\"\\n}","type":"json"}]', 'title' => 'Create a Publish Job', 'changeSet' => [ ['createdAt' => '2022-12-26T11:37:56.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePublishTask'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateSimQuestion' => [ 'summary' => 'Creates a similar question.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The business space key. If omitted, the default business space is used. You can find the key on the business management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30001905617'], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['description' => 'The similar question title. Maximum length: 120 characters.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '测试相似问标题'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'SimQuestionId' => ['description' => 'The similar question ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000002788'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '16AC1B3C-66E0-438B-BB7C-71B692407B67', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SimQuestionId\\": 1000002788,\\n \\"RequestId\\": \\"16AC1B3C-66E0-438B-BB7C-71B692407B67\\"\\n}","type":"json"}]', 'title' => 'Create alternate query', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSimQuestion'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateSolution' => [ 'summary' => 'Creates a knowledge 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' => ['description' => 'The ID of the knowledge.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30001905617'], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The content of the knowledge answer.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '答案内容'], ], [ 'name' => 'ContentType', 'in' => 'query', 'schema' => ['description' => 'The answer type. Valid values: `0` (plain text) and `1` (rich text).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PerspectiveCodes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '', 'description' => 'A list of perspective codes.', 'type' => 'array', 'items' => ['description' => 'A perspective code.', 'type' => 'string', 'required' => false, 'example' => 'm8qAIvUUAIf', 'title' => ''], 'required' => true, 'maxItems' => 10, 'example' => '', ], ], [ 'name' => 'TagIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of tag IDs.', 'title' => 'List of tag IDs', 'type' => 'array', 'items' => ['title' => 'Tag ID', 'description' => 'A tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '25645645', 'required' => false], 'required' => false, 'example' => '', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If this parameter is omitted, the system uses the default business space. You can obtain the key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419', 'title' => ''], 'SolutionId' => ['description' => 'The ID of the knowledge answer.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100001089003'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F55D90C1-31BE-4B2A-AA3F-25EFC36F9419\\",\\n \\"SolutionId\\": 100001089003\\n}","type":"json"}]', 'title' => 'Create an FAQ answer', 'changeSet' => [ ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSolution'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'CreateUserSay' => [ 'summary' => 'Adds a user say to a specified intent.', 'methods' => ['post', 'get'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you do not specify this parameter, the default business space is used. You can find the key on the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the chatbot instance.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'UserSayDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The definition of the user say.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The ID of the intent.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123232', 'title' => ''], 'Content' => ['description' => 'The content of the user say.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '请问明天北京的天气'], 'SlotInfos' => [ 'title' => '', 'description' => 'An array of objects, each containing information about a slot.', 'type' => 'array', 'items' => [ 'description' => 'The information about a slot.', 'type' => 'object', 'properties' => [ 'SlotId' => ['description' => 'The ID of the slot.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'fb34adf2fv43f2'], 'StartIndex' => ['description' => 'The zero-based start index of the slot in the user say content.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '4'], 'EndIndex' => ['description' => 'The zero-based end index of the slot in the user say content. This index is exclusive.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '6'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 10, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned in the response.', 'type' => 'object', 'properties' => [ 'UserSayId' => ['description' => 'The unique ID of the intent-user say pair.', 'type' => 'integer', 'format' => 'int64', 'example' => '46456176856', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8g4n8bnd236fg79', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UserSayId\\": 46456176856,\\n \\"RequestId\\": \\"8g4n8bnd236fg79\\"\\n}","type":"json"}]', 'title' => 'Creation of Intent-Utterance Pair ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserSay'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteCategory' => [ 'summary' => 'Deletes a category. A published category is marked as deleted and unpublished, while an unpublished category is deleted permanently.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the category.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30000049006'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The agent key. If not specified, the default agent is used. You can obtain the key from the agent management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B3E0DE3-DC57-5BFE-88D4-ADD8ED024F55\\"\\n}","type":"json"}]', 'title' => 'Category - Delete', 'changeSet' => [ ['createdAt' => '2024-02-22T12:10:08.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCategory'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteConnQuestion' => [ 'summary' => 'Deletes a knowledge association.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'OutlineId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the association.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '877397683', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The business space key. If you do not set this parameter, the default business space is used. You can find the key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'FC323352-3AD7-59A1-9088-A64470BAFC9D', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC323352-3AD7-59A1-9088-A64470BAFC9D\\"\\n}","type":"json"}]', 'title' => 'Delete FAQ associated questions ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConnQuestion'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteDSEntity' => [ 'summary' => 'Deletes an entity. This operation also cascade-deletes all associated entity members, synonyms, and regular expressions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'If unspecified, the default agent is used. You can get the key from the agent management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The chatbot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4dfghf56235asdf452', 'title' => ''], 'EntityId' => ['description' => 'The entity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4dfghf56235asdf452\\",\\n \\"EntityId\\": 123\\n}","type":"json"}]', 'title' => 'Entity - Delete', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDSEntity'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteDSEntityValue' => [ 'summary' => 'Deletes a specific entity value from an entity. If the entity is a standard entity, its synonyms (if any) are also deleted.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The Agent key. If omitted, the system uses the default Agent. You can get this key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the instance.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '345346223452', 'title' => ''], ], [ 'name' => 'EntityValueId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the entity value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '3453453452', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => 'dfdf2t3rfvb45y', 'title' => ''], 'EntityValueId' => ['description' => 'The ID of the deleted entity value.', 'type' => 'integer', 'format' => 'int64', 'example' => '3453453452', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], ['errorCode' => 'BusinessErrorEntityValueId.NotExists', 'errorMessage' => 'The business error EntityValueId is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dfdf2t3rfvb45y\\",\\n \\"EntityValueId\\": 3453453452\\n}","type":"json"}]', 'title' => 'Entity - Entity Member - Delete', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDSEntityValue'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteDoc' => [ 'summary' => 'Deletes a document.', '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' => 'The business space key. If this parameter is not specified, the default business space is used. You can obtain the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the knowledge.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '30001905617', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910'], 'KnowledgeId' => ['description' => 'The ID of the knowledge.', 'type' => 'integer', 'format' => 'int64', 'example' => '30002406051', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DFB71B34-4188-4EA2-9988-EF3014E75910\\",\\n \\"KnowledgeId\\": 30002406051\\n}","type":"json"}]', 'title' => 'Delete Document', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDoc'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteFaq' => [ 'summary' => 'Deletes a knowledge item.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The business space key. If you do not specify this parameter, the default business space is used. You can obtain the key from the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier for the knowledge item.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30001905617'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\"\\n}","type":"json"}]', 'title' => 'Delete FAQ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaq'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteInstance' => [ 'summary' => 'Deletes an instance from the sandbox and online environments.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the default business space is used. You can find the key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', 'title' => ''], 'Status' => ['description' => 'The task status. For more information about possible states, see the GetInstancePublishTaskState API operation.', 'type' => 'string', 'example' => 'FE_RUNNING', 'title' => ''], 'Response' => ['description' => 'The task ID. This parameter is an alias for `Id`.', 'type' => 'integer', 'format' => 'int64', 'example' => '8521', 'title' => ''], 'BizTypeList' => [ 'title' => '', 'description' => 'A list of business types.', 'type' => 'array', 'items' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'robot', 'title' => ''], 'example' => '', ], 'CreateTime' => ['description' => 'The UTC time when the task was created.', 'type' => 'string', 'example' => '2021-09-11T09:26:14Z', 'title' => ''], 'CreateUserId' => ['description' => 'The ID of the user who created the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '9052', 'title' => ''], 'Error' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => '检查待发布模块是否空闲发生错误，faq'], 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8521', 'title' => ''], 'CreateUserName' => ['description' => 'The username of the user who created the task.', 'type' => 'string', 'example' => 'xuqiang_test', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"Response\\": 8521,\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"CreateTime\\": \\"2021-09-11T09:26:14Z\\",\\n \\"CreateUserId\\": 9052,\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"Id\\": 8521,\\n \\"CreateUserName\\": \\"xuqiang_test\\"\\n}","type":"json"}]', 'title' => 'Bot - Delete', 'changeSet' => [ ['createdAt' => '2022-07-07T11:54:48.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteIntent' => [ 'summary' => 'Deletes a specified intent and its associated user utterances and advanced semantic configurations (LGF).', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key that identifies the business space. If you omit this parameter, the service uses the default business space. You can get this key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The robot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'IntentId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned for a successful request.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The ID of the deleted intent.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3464dfg3qwr34tf34', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IntentId\\": 12345,\\n \\"RequestId\\": \\"3464dfg3qwr34tf34\\"\\n}","type":"json"}]', 'title' => 'Intent - Delete ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntent'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteLgf' => [ 'summary' => 'Deletes the specified LGF configuration.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If omitted, the default business space is used. You can find this key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The robot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '23242342', 'title' => ''], ], [ 'name' => 'LgfId', 'in' => 'query', 'schema' => ['description' => 'The ID of the LGF configuration.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '2342424', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'LgfId' => ['description' => 'The ID of the LGF configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '2342424', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'dgw2342424qw42', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LgfId\\": 2342424,\\n \\"RequestId\\": \\"dgw2342424qw42\\"\\n}","type":"json"}]', 'title' => 'Intent - LGF - Delete', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLgf'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeletePerspective' => [ 'summary' => 'Deletes a perspective.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'PerspectiveId', 'in' => 'query', 'schema' => ['description' => 'The perspective ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The business space key. If you do not set this parameter, the default business space is used. You can obtain the key on the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', 'title' => ''], 'Result' => ['description' => 'Indicates whether the perspective was successfully deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC384CE1-8D42-1900-84E1-F33F990F2B5E\\",\\n \\"Result\\": true\\n}","type":"json"}]', 'title' => 'Perspective - Delete ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePerspective'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteSimQuestion' => [ 'summary' => 'Deletes a similar question.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the default business space is used. You can find the key on the business management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'SimQuestionId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the similar question.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '1000002788'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6419BA93-D111-5225-8998-13E63E6D3940', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6419BA93-D111-5225-8998-13E63E6D3940\\"\\n}","type":"json"}]', 'title' => 'Delete an FAQ alternate query', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSimQuestion'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteSolution' => [ 'summary' => 'Deletes the specified solution.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SolutionId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the solution.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '100001321580'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the default business space is used. You can obtain this key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\"\\n}","type":"json"}]', 'title' => 'Delete an FAQ answer', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSolution'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DeleteUserSay' => [ 'summary' => 'Deletes a user say from a specified intent.', 'methods' => ['post', 'get'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If omitted, the default business space is used. You can obtain the key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID of the bot.', 'type' => 'string', 'required' => true, 'example' => '343df2sdf23', 'title' => ''], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the intent.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5564564546', 'title' => ''], ], [ 'name' => 'UserSayId', 'in' => 'query', 'schema' => ['description' => 'The ID of the user say.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '4562121234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'UserSayId' => ['description' => 'The ID of the user say.', 'type' => 'integer', 'format' => 'int64', 'example' => '4562121234', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'dfgdg324gf34t34g34g3', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UserSayId\\": 4562121234,\\n \\"RequestId\\": \\"dfgdg324gf34t34g34g3\\"\\n}","type":"json"}]', 'title' => 'Intent - Utterance - Delete', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserSay'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DescribeCategory' => [ 'summary' => 'Gets information about a specific category.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the category.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30000049006'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you do not specify this parameter, the default business space is used. You can get the key from the Business Management page of your root account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2B0304FD-3804-5C06-9A83-77F5523664AF', 'title' => ''], 'Category' => [ 'title' => '', 'description' => 'The category information.', 'type' => 'object', 'properties' => [ 'CategoryId' => ['description' => 'The ID of the category.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30000049006'], 'Name' => ['description' => 'The name of the category.', 'type' => 'string', 'example' => '类目名称', 'title' => ''], 'ParentCategoryId' => ['description' => 'The ID of the parent category. A value of -1 indicates the root directory.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], 'Status' => ['description' => 'The status of the category. Valid values: 0 (Normal) or -1 (Deleted).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'BizCode' => ['description' => 'The business code.', 'type' => 'string', 'example' => 'bizcode123', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B0304FD-3804-5C06-9A83-77F5523664AF\\",\\n \\"Category\\": {\\n \\"CategoryId\\": 30000049006,\\n \\"Name\\": \\"类目名称\\",\\n \\"ParentCategoryId\\": -1,\\n \\"Status\\": 0,\\n \\"BizCode\\": \\"bizcode123\\"\\n }\\n}","type":"json"}]', 'title' => 'Category - Details', 'changeSet' => [ ['createdAt' => '2024-02-22T12:10:08.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCategory'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DescribeDSEntity' => [ 'summary' => 'Retrieves metadata for a specified entity associated with a robot, such as the entity type, entity name, creation time, and modification time.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If omitted, the default business space is used. You can find this key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The robot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ad23234dsf234fga', 'title' => ''], 'EntityId' => ['description' => 'The entity ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], 'EntityName' => ['description' => 'The entity name. The name can contain only Chinese characters, letters, digits, and underscores (\\_).', 'type' => 'string', 'title' => '', 'example' => '书类型'], 'SysEntityCode' => ['description' => 'The code of the system entity, such as sys.date. This parameter is empty for user-defined entities.', 'type' => 'string', 'title' => '', 'example' => 'sys.date'], 'EntityType' => ['description' => 'The entity type. Valid values are `synonyms` and `regex`.', 'type' => 'string', 'title' => '', 'example' => 'synonyms'], 'CreateTime' => ['description' => 'The time when the entity was created, in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'ModifyTime' => ['description' => 'The time when the entity was last modified, in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'CreateUserId' => ['description' => 'The ID of the user who created the entity.', 'type' => 'string', 'example' => '123231', 'title' => ''], 'CreateUserName' => ['description' => 'The name of the user who created the entity.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ModifyUserId' => ['description' => 'The ID of the user who last modified the entity.', 'type' => 'string', 'example' => '123231', 'title' => ''], 'ModifyUserName' => ['description' => 'The name of the user who last modified the entity.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ad23234dsf234fga\\",\\n \\"EntityId\\": 123,\\n \\"EntityName\\": \\"书类型\\",\\n \\"SysEntityCode\\": \\"sys.date\\",\\n \\"EntityType\\": \\"synonyms\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"CreateUserId\\": \\"123231\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"ModifyUserId\\": \\"123231\\",\\n \\"ModifyUserName\\": \\"test\\"\\n}","type":"json"}]', 'title' => 'Entity - details', 'responseParamsDescription' => 'If the entity is a system entity, `SysEntityCode` returns its key, such as `@sys.date`.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDSEntity'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], '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' => 'The key that identifies the workspace. If this parameter is omitted, the default workspace is used. You can find this key on the workspace management page of your root account.', 'type' => 'string', 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'required' => false, 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30001979424'], ], [ 'name' => 'ShowDetail', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return detailed information for paragraphs. true: Detailed information is returned. false: Detailed information is not returned (default).', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7F132693-212A-40A9-8A81-11E7694E478B'], 'KnowledgeId' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30001979424', 'title' => ''], 'DocName' => ['description' => 'The document name.', 'type' => 'string', 'example' => '文档名称', 'title' => ''], 'Title' => ['description' => 'The document title.', 'type' => 'string', 'example' => '测试标题', 'title' => ''], 'BizCode' => ['description' => 'The business code.', 'type' => 'string', 'example' => 'bizcode123', 'title' => ''], 'Meta' => ['description' => 'The document\'s metadata.', 'type' => 'string', 'example' => '{"code":"xxx"}', 'title' => ''], 'Config' => ['description' => 'The configuration for document parsing and splitting. Key: `Splitter`. Valid values: `paragraphSplitter` (splits by recognition level, default) and `treeSplitter` (splits by rule level).'."\n" ."\n" .'Key: `ChunkSize`. The size of each document chunk, which must be between 200 and 800. The default value is 500.'."\n" ."\n" .'Key: `TreePatterns`. The patterns for the rule-based hierarchy. The default value is \\[].'."\n" ."\n" .'Key: `TitleSource`. The source of the document title. Valid values: `ocrTitle` (OCR-recognized title, default) and `docName` (document name).', 'type' => 'string', 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}', 'title' => ''], 'Url' => ['description' => 'The OSS address of the document.', 'type' => 'string', 'example' => 'https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf', 'title' => ''], 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-11-25T08:56:55Z', 'title' => ''], 'ModifyUserName' => ['description' => 'The modifier name.', 'type' => 'string', 'example' => '李四', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'CreateUserName' => ['description' => 'The creator name.', 'type' => 'string', 'example' => '张三', 'title' => ''], 'CreateUserId' => ['description' => 'The creator ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111', 'title' => ''], 'ModifyUserId' => ['description' => 'The modifier ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2222222222', 'title' => ''], 'CategoryId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000049006', 'title' => ''], 'ProcessStatus' => ['description' => 'The processing status of the task.
-1: Queued
0: Succeeded
1: Parsing
2: Processing
3: Failed




', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ProcessMessage' => ['description' => 'The processing message.', 'type' => 'string', 'example' => '任务处理成功', 'title' => ''], 'ProcessCanRetry' => ['description' => 'Indicates whether a failed task can be retried.
`true`: The task can be retried.
`false`: The task cannot be retried.

', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Status' => ['description' => 'The edit status.
1: Unpublished
2: Published
3: Updated but not published


', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'EffectStatus' => ['description' => 'The effective status, calculated from `StartDate` and `EndDate`.
20: Active
21: Expired
22: Pending


', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'StartDate' => ['description' => 'The start time in UTC format.', 'type' => 'string', 'example' => '1979-12-31T16:00:00Z', 'title' => ''], 'EndDate' => ['description' => 'The end time in UTC format.', 'type' => 'string', 'example' => '2023-04-27T06:08:54Z', 'title' => ''], 'DocInfo' => [ 'description' => 'The document details.', 'type' => 'object', 'properties' => [ 'DocParas' => [ 'description' => 'The paragraphs of the document.', 'type' => 'array', 'items' => [ 'description' => 'A paragraph object.', 'type' => 'object', 'properties' => [ 'ParaNo' => ['description' => 'The paragraph number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ParaLevel' => ['description' => 'The paragraph level.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ParaType' => ['description' => 'The paragraph type.
text: Text
figure: Image
table: Table


', 'type' => 'string', 'example' => 'text', 'title' => ''], 'ParaText' => ['description' => 'The paragraph content. The content can be plain text, text extracted from an image using optical character recognition (OCR), or a table in Markdown format.', 'type' => 'string', 'example' => '内容', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'DocTags' => [ 'description' => 'A list of document tags.', 'type' => 'array', 'items' => [ 'description' => 'The details of a single tag.', 'type' => 'object', 'properties' => [ 'TagId' => ['title' => 'Tag ID', 'description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1201'], 'TagName' => ['title' => 'Tag Name', 'description' => 'The tag name.', 'type' => 'string', 'example' => '小说'], 'GroupId' => ['title' => 'Tag group ID', 'description' => 'The tag\'s group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3610'], 'GroupName' => ['title' => 'Tag group name', 'description' => 'The tag group name.', 'type' => 'string', 'example' => '文章'], 'DefaultTag' => ['title' => 'Indicates whether the tag is the default tag for all tags.', 'description' => 'Indicates whether the tag represents all items by default.', 'type' => 'boolean', 'example' => 'false'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DocMetadata' => [ 'description' => 'A list of metadata sets, where each set corresponds to a business view.', 'type' => 'array', 'items' => [ 'description' => 'A metadata object that corresponds to a specific business view.', 'type' => 'object', 'properties' => [ 'BusinessViewId' => ['description' => 'The ID of the business view.', 'type' => 'string', 'title' => '', 'example' => ''], 'BusinessViewName' => ['title' => 'Tag Name ', 'description' => 'The business view name.', 'type' => 'string', 'example' => ''], 'MetaCellInfoDTOList' => [ 'description' => 'A list of metadata cells.', 'type' => 'array', 'items' => [ 'description' => 'A single metadata field and its value.', 'type' => 'object', 'properties' => [ 'FieldCode' => ['description' => 'The code of the field.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'title' => '', 'example' => ''], 'Value' => ['description' => 'The value of the field.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F132693-212A-40A9-8A81-11E7694E478B\\",\\n \\"KnowledgeId\\": 30001979424,\\n \\"DocName\\": \\"文档名称\\",\\n \\"Title\\": \\"测试标题\\",\\n \\"BizCode\\": \\"bizcode123\\",\\n \\"Meta\\": \\"{\\\\\\"code\\\\\\":\\\\\\"xxx\\\\\\"}\\",\\n \\"Config\\": \\"{\\\\\\"Splitter\\\\\\":\\\\\\"treeSplitter\\\\\\",\\\\\\"ChunkSize\\\\\\":500,\\\\\\"TreePatterns\\\\\\":[\\\\\\"^# .*\\\\\\",\\\\\\"^## .*\\\\\\",\\\\\\"^### .*\\\\\\",\\\\\\"^#### .*\\\\\\"],\\\\\\"TitleSource\\\\\\":\\\\\\"docName\\\\\\"}\\",\\n \\"Url\\": \\"https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf\\",\\n \\"ModifyTime\\": \\"2020-11-25T08:56:55Z\\",\\n \\"ModifyUserName\\": \\"李四\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"CreateUserName\\": \\"张三\\",\\n \\"CreateUserId\\": 1111111111,\\n \\"ModifyUserId\\": 2222222222,\\n \\"CategoryId\\": 30000049006,\\n \\"ProcessStatus\\": 0,\\n \\"ProcessMessage\\": \\"任务处理成功\\",\\n \\"ProcessCanRetry\\": true,\\n \\"Status\\": 1,\\n \\"EffectStatus\\": 20,\\n \\"StartDate\\": \\"1979-12-31T16:00:00Z\\",\\n \\"EndDate\\": \\"2023-04-27T06:08:54Z\\",\\n \\"DocInfo\\": {\\n \\"DocParas\\": [\\n {\\n \\"ParaNo\\": 1,\\n \\"ParaLevel\\": 1,\\n \\"ParaType\\": \\"text\\",\\n \\"ParaText\\": \\"内容\\"\\n }\\n ]\\n },\\n \\"DocTags\\": [\\n {\\n \\"TagId\\": 1201,\\n \\"TagName\\": \\"小说\\",\\n \\"GroupId\\": 3610,\\n \\"GroupName\\": \\"文章\\",\\n \\"DefaultTag\\": false\\n }\\n ],\\n \\"DocMetadata\\": [\\n {\\n \\"BusinessViewId\\": \\"\\",\\n \\"BusinessViewName\\": \\"\\",\\n \\"MetaCellInfoDTOList\\": [\\n {\\n \\"FieldCode\\": \\"\\",\\n \\"FieldName\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Document Details', 'changeSet' => [ ['createdAt' => '2024-09-26T12:39:56.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-05-17T09:42:04.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDoc'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DescribeFaq' => [ 'summary' => 'Retrieves 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' => ['description' => 'Specifies the key for the business space. If this parameter is omitted, the default business space is used. You can get this key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => ['description' => 'Specifies the knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30001979424'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'KnowledgeResponse', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'KnowledgeId' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30001979424'], 'Title' => ['description' => 'The knowledge title.', 'type' => 'string', 'title' => '', 'example' => '测试标题'], 'ModifyTime' => ['description' => 'The time the knowledge was last modified, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2020-12-02T06:35:50Z'], 'ModifyUserName' => ['description' => 'The user who last modified the knowledge.', 'type' => 'string', 'title' => '', 'example' => 'test01'], 'CreateTime' => ['description' => 'The time the knowledge was created, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2020-11-30T03:03:37Z'], 'CreateUserName' => ['description' => 'The creator of the knowledge.', 'type' => 'string', 'title' => '', 'example' => 'test01'], 'CategoryId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30000055617'], 'Status' => ['description' => 'The knowledge status. Valid values: `-1` (Deleted and unpublished), `1` (Unpublished), `2` (Published), and `3` (Updated and unpublished).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], 'EffectStatus' => ['description' => 'The validity status of the knowledge, calculated based on `StartDate` and `EndDate`. Valid values: `20` (Active), `21` (Expired), and `22` (Pending).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], 'StartDate' => ['description' => 'The effective start time of the knowledge, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-04-27T07:04:39Z'], 'EndDate' => ['description' => 'The expiration time of the knowledge, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-27T06:08:54Z'], 'SimQuestions' => [ 'title' => '', 'description' => 'A list of similar questions.', 'type' => 'array', 'items' => [ 'description' => 'The details of a similar question.', 'type' => 'object', 'properties' => [ 'SimQuestionId' => ['description' => 'The similar question ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10000000581'], 'ModifyTime' => ['description' => 'The time the similar question was last modified, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-29T03:55:07Z'], 'CreateTime' => ['description' => 'The time the similar question was created, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-26T10:24:00Z'], 'Title' => ['description' => 'The similar question title.', 'type' => 'string', 'title' => '', 'example' => '测试相似问标题'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Solutions' => [ 'title' => '', 'description' => 'A list of solutions.', 'type' => 'array', 'items' => [ 'description' => 'The details of a solution.', 'type' => 'object', 'properties' => [ 'SolutionId' => ['description' => 'The solution ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10000003071'], 'ModifyTime' => ['description' => 'The time the solution was last modified, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-29T07:07:13Z'], 'CreateTime' => ['description' => 'The time the solution was created, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-26T10:24:00Z'], 'Content' => ['description' => 'The solution content.', 'type' => 'string', 'title' => '', 'example' => '测试答案内容'], 'ContentType' => ['description' => 'The solution content type. Valid values: `0` (plain text) and `1` (rich text).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], 'PlainText' => ['description' => 'The plain text content of the solution.', 'type' => 'string', 'title' => '', 'example' => '测试答案内容'], 'PerspectiveCodes' => [ 'title' => '', 'description' => 'A list of perspective codes.', 'type' => 'array', 'items' => ['description' => 'A perspective code.', 'type' => 'string', 'title' => '', 'example' => 'default'], 'example' => '', ], 'TagIdList' => [ 'description' => 'A list of tag IDs.', 'title' => 'label ID collection', 'type' => 'array', 'items' => ['title' => 'label ID', 'description' => 'A tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '322353453'], 'required' => false, 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Outlines' => [ 'title' => '', 'description' => 'A list of related questions.', 'type' => 'array', 'items' => [ 'description' => 'The details of a related question.', 'type' => 'object', 'properties' => [ 'OutlineId' => ['description' => 'The relationship ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '797'], 'ConnQuestionId' => ['description' => 'The related knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000098002'], 'Title' => ['description' => 'The related knowledge title.', 'type' => 'string', 'title' => '', 'example' => '测试关联问标题'], 'ModifyTime' => ['description' => 'The time the related question was last modified, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-26T18:12:02Z'], 'CreateTime' => ['description' => 'The time the related question was created, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-26T10:24:00Z'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32', 'title' => ''], 'TagIdList' => [ 'description' => 'A list of tag IDs associated with the knowledge.', 'title' => 'tag ID List ', 'type' => 'array', 'items' => ['title' => 'tag ID ', 'description' => 'A tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeId\\": 30001979424,\\n \\"Title\\": \\"测试标题\\",\\n \\"ModifyTime\\": \\"2020-12-02T06:35:50Z\\",\\n \\"ModifyUserName\\": \\"test01\\",\\n \\"CreateTime\\": \\"2020-11-30T03:03:37Z\\",\\n \\"CreateUserName\\": \\"test01\\",\\n \\"CategoryId\\": 30000055617,\\n \\"Status\\": 3,\\n \\"EffectStatus\\": 20,\\n \\"StartDate\\": \\"2022-04-27T07:04:39Z\\",\\n \\"EndDate\\": \\"2023-04-27T06:08:54Z\\",\\n \\"SimQuestions\\": [\\n {\\n \\"SimQuestionId\\": 10000000581,\\n \\"ModifyTime\\": \\"2022-05-29T03:55:07Z\\",\\n \\"CreateTime\\": \\"2022-05-26T10:24:00Z\\",\\n \\"Title\\": \\"测试相似问标题\\"\\n }\\n ],\\n \\"Solutions\\": [\\n {\\n \\"SolutionId\\": 10000003071,\\n \\"ModifyTime\\": \\"2022-05-29T07:07:13Z\\",\\n \\"CreateTime\\": \\"2022-05-26T10:24:00Z\\",\\n \\"Content\\": \\"测试答案内容\\",\\n \\"ContentType\\": 0,\\n \\"PlainText\\": \\"测试答案内容\\",\\n \\"PerspectiveCodes\\": [\\n \\"default\\"\\n ],\\n \\"TagIdList\\": [\\n 322353453\\n ]\\n }\\n ],\\n \\"Outlines\\": [\\n {\\n \\"OutlineId\\": 797,\\n \\"ConnQuestionId\\": 1000098002,\\n \\"Title\\": \\"测试关联问标题\\",\\n \\"ModifyTime\\": \\"2022-05-26T18:12:02Z\\",\\n \\"CreateTime\\": \\"2022-05-26T10:24:00Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"8AD9FA10-7780-5E12-B701-13C928524F32\\",\\n \\"TagIdList\\": [\\n 0\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve FAQ details ', 'changeSet' => [ ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFaq'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DescribeInstance' => [ 'summary' => 'Queries the details of a robot.', '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' => ['description' => 'The unique identifier of the robot instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If this parameter is omitted, the default business space is used. You can obtain this key from the business management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '907AA5F2-0521-49AB-80AB-1ADEFAB2B901', 'title' => ''], 'InstanceId' => ['description' => 'The unique identifier of the robot instance.', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], 'Name' => ['description' => 'The robot name.', 'type' => 'string', 'example' => '智能客服-小C', 'title' => ''], 'TimeZone' => ['description' => 'The time zone of the robot. For more information, see Time zone codes.', 'type' => 'string', 'example' => 'Asia/Chongqing', 'title' => ''], 'Introduction' => ['description' => 'The robot\'s introduction.', 'type' => 'string', 'example' => '用于C端问答的机器人', 'title' => ''], 'LanguageCode' => [ 'description' => 'The language of the robot, such as zh-cn and en-us.', 'enumValueTitles' => ['en-us' => 'English', 'zh-cn' => 'Chinese'], 'type' => 'string', 'example' => 'zh-cn', 'title' => '', ], 'RobotType' => [ 'description' => 'The robot type.', 'enumValueTitles' => ['scenario_callout' => 'outbound robot', 'scenario_im' => 'IM robot', 'scenario_ivr' => 'IVR robot'], 'type' => 'string', 'example' => 'scenario_im', 'title' => '', ], 'Avatar' => ['description' => 'The URL of the robot\'s avatar.', 'type' => 'string', 'example' => '/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png', 'title' => ''], 'EditStatus' => [ 'description' => 'The status of the robot.', 'enumValueTitles' => ['PUBLISHED' => 'published', 'EDITING' => 'editing'], 'type' => 'string', 'example' => 'PUBLISHED', 'title' => '', ], 'CreateTime' => ['description' => 'The UTC time when the robot was created.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'Categories' => [ 'title' => '', 'description' => 'A list of categories.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CategoryId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000066832', 'title' => ''], 'Name' => ['description' => 'The category name.', 'type' => 'string', 'example' => '杭州市防疫政策', 'title' => ''], 'ParentCategoryId' => ['description' => 'The parent category ID. A value of -1 indicates the root directory.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], 'AbilityType' => ['description' => 'The ability type of the category, such as FAQ or MRC.', 'type' => 'string', 'example' => 'FAQ', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"907AA5F2-0521-49AB-80AB-1ADEFAB2B901\\",\\n \\"InstanceId\\": \\"chatbot-cn-mp90s2lrk00050\\",\\n \\"Name\\": \\"智能客服-小C\\",\\n \\"TimeZone\\": \\"Asia/Chongqing\\",\\n \\"Introduction\\": \\"用于C端问答的机器人\\",\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"RobotType\\": \\"scenario_im\\",\\n \\"Avatar\\": \\"/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png\\",\\n \\"EditStatus\\": \\"PUBLISHED\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"Categories\\": [\\n {\\n \\"CategoryId\\": 30000066832,\\n \\"Name\\": \\"杭州市防疫政策\\",\\n \\"ParentCategoryId\\": -1,\\n \\"AbilityType\\": \\"FAQ\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve Bot Details ', 'responseParamsDescription' => '### Examples'."\n" ."\n" .'#### Sample response'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "Name": "test1",'."\n" .' "LanguageCode": "zh-cn",'."\n" .' "RobotType":"scenario_im",'."\n" .' "Introduction": "Customer demo",'."\n" .' "InstanceId": "chatbot-cn-mp90s2lrk00050",'."\n" .' "CreateTime": "2018-09-11T09:26:14Z",'."\n" .' "RequestId": "E7661C58-9CE7-4754-AB98-9BA40EAA7C27",'."\n" .' "Avatar": "//gw.alicdn.com/tfs/TB1N5CwqTtYBeNjy1XdXXXXyVXa-90-97.png",'."\n" .' "TimeZone": "Asia/Chongqing",'."\n" .' "Categories": ['."\n" .' {'."\n" .' "Name": "Test category test11",'."\n" .' "ParentCategoryId": -1,'."\n" .' "CategoryId": 1000006427'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```', 'changeSet' => [ ['createdAt' => '2025-08-20T07:52:54.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-10T03:13:25.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DescribeIntent' => [ 'summary' => 'Returns metadata for a specified intent, including its type, name, creation time, and modification time.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the system uses the default business space. You can obtain the key from the Business Management page of the primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The chatbot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'IntentId', 'in' => 'formData', 'schema' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'a22afaf2adfasf2gr345fga45ada', 'title' => ''], 'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '84243341', 'title' => ''], 'IntentName' => ['description' => 'The intent name.', 'type' => 'string', 'example' => '查天气意图', 'title' => ''], 'AliasName' => ['description' => 'The intent alias.', 'type' => 'string', 'example' => '查天气意图', 'title' => ''], 'SlotInfos' => [ 'description' => 'An array of objects that contain the slot information for the intent.', 'type' => 'array', 'items' => [ 'description' => 'An object that contains the information for a single slot.', 'type' => 'object', 'properties' => [ 'SlotId' => ['description' => 'The slot ID.', 'type' => 'string', 'example' => 'aa4d2a343a3ad4afad', 'title' => ''], 'Name' => ['description' => 'The slot name.', 'type' => 'string', 'example' => '天气', 'title' => ''], 'Value' => ['description' => 'The value extracted for the slot.', 'type' => 'string', 'example' => '天气', 'title' => ''], 'Interactive' => ['description' => 'Indicates whether interactive slot filling is enabled. Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Array' => ['description' => 'Indicates whether the slot can contain an array of values.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Encrypt' => ['description' => 'Indicates whether the slot is configured to encrypt its value.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time when the intent was created, in UTC format.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'ModifyTime' => ['description' => 'The time when the intent was last modified, in UTC format.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'CreateUserId' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '123231', 'title' => ''], 'CreateUserName' => ['description' => 'The creator name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ModifyUserId' => ['description' => 'The modifier ID.', 'type' => 'string', 'example' => '123231', 'title' => ''], 'ModifyUserName' => ['description' => 'The modifier name.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error IntentId is not exists.', 'description' => ''], ], ], 'staticInfo' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"a22afaf2adfasf2gr345fga45ada\\",\\n \\"IntentId\\": 84243341,\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"AliasName\\": \\"查天气意图\\",\\n \\"SlotInfos\\": [\\n {\\n \\"SlotId\\": \\"aa4d2a343a3ad4afad\\",\\n \\"Name\\": \\"天气\\",\\n \\"Value\\": \\"天气\\",\\n \\"Interactive\\": false,\\n \\"Array\\": false,\\n \\"Encrypt\\": false\\n }\\n ],\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"CreateUserId\\": \\"123231\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"ModifyUserId\\": \\"123231\\",\\n \\"ModifyUserName\\": \\"test\\"\\n}","type":"json"}]', 'title' => 'intent - details ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIntent'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'DescribePerspective' => [ 'summary' => 'Retrieves the details of a specified perspective.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PerspectiveId', 'in' => 'query', 'schema' => ['description' => 'The ID of the perspective.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you do not specify this parameter, the default business space is used. You can get the key from your main account\'s Business Management page.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', 'title' => ''], 'Status' => ['description' => 'The status of the perspective. Valid values: 3 (Enabled) and 1 (Disabled).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PerspectiveCode' => ['description' => 'The perspective code (used for the Q\\&A API).', 'type' => 'string', 'example' => 'FZJBY3raWr', 'title' => ''], 'ModifyTime' => ['description' => 'The modification time in UTC.', 'type' => 'string', 'example' => '2021-07-26T07:05:37Z', 'title' => ''], 'SelfDefine' => ['description' => 'Indicates whether the perspective is user-defined.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The creation time in UTC.', 'type' => 'string', 'example' => '2021-07-27T07:05:37Z', 'title' => ''], 'PerspectiveId' => ['description' => 'The ID of the perspective.', 'type' => 'string', 'example' => '3001', 'title' => ''], 'Name' => ['description' => 'The name of the perspective.', 'type' => 'string', 'example' => '移动端视角', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F285D735-D580-18A8-B97F-B2E72B00F101\\",\\n \\"Status\\": 1,\\n \\"PerspectiveCode\\": \\"FZJBY3raWr\\",\\n \\"ModifyTime\\": \\"2021-07-26T07:05:37Z\\",\\n \\"SelfDefine\\": true,\\n \\"CreateTime\\": \\"2021-07-27T07:05:37Z\\",\\n \\"PerspectiveId\\": \\"3001\\",\\n \\"Name\\": \\"移动端视角\\"\\n}","type":"json"}]', 'title' => 'Perspective - Details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePerspective'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'Feedback' => [ 'summary' => 'Saves user feedback on chatbot responses.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'MessageId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of a single message within the session.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5ca40988-4f99-47ad-ac96-9060d0f81db9', 'title' => ''], ], [ 'name' => 'Feedback', 'in' => 'query', 'schema' => [ 'description' => 'The feedback rating for the response. This parameter corresponds to `FeedbackType` in the session history API.'."\n" ."\n" .'Enumerated values: \'good\' (a positive rating) and \'bad\' (a negative rating).', 'enumValueTitles' => ['bad' => '', 'good' => ''], 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'good', 'title' => '', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier for the session. The instant messaging (IM) system uses this ID to track the conversation.', 'type' => 'string', 'required' => false, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', 'title' => ''], ], [ 'name' => 'FeedbackContent', 'in' => 'query', 'schema' => ['description' => 'The detailed feedback content. You can provide this as a raw string or as a JSON string. If you use a JSON string, the \'content\' field corresponds to \'FeedbackUserInfo\' and the \'feedbackLabels\' field corresponds to \'FeedbackLabels\' in the session history.', 'type' => 'string', 'example' => '{'."\n" .' "content": "我觉得这个答案不对，需要依据事实回答。",'."\n" .' "feedbackLabels": ['."\n" .' "存在事实性错误"'."\n" .' ]'."\n" .'}', 'title' => '', 'required' => false], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the chatbot instance.', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => '', 'required' => false], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If this parameter is not set, the system uses the default business space. You can obtain the key from the business management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4e5eea71-f326-450c-8849-49515473ef64', 'title' => ''], 'Feedback' => ['description' => 'The feedback rating.'."\n" ."\n" .'Enumerated values: \'good\' (a positive rating) or \'bad\' (a negative rating).', 'type' => 'string', 'example' => 'good', 'title' => ''], 'MessageId' => ['description' => 'The unique identifier of a single message within the session.', 'type' => 'string', 'example' => '5ca40988-4f99-47ad-ac96-9060d0f81db9', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4e5eea71-f326-450c-8849-49515473ef64\\",\\n \\"Feedback\\": \\"good\\",\\n \\"MessageId\\": \\"5ca40988-4f99-47ad-ac96-9060d0f81db9\\"\\n}","type":"json"}]', 'title' => 'Thumbs up or thumbs down for Q&A pairs ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Feedback'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'GenerateUserAccessToken' => [ 'summary' => 'Generates a user access token to enable single sign-on for a chat window. The token associates the user with their corporate identity.', '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' => 'This parameter is reserved. You do not need to specify it.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3600', 'minimum' => '0', 'example' => '1000', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you do not specify this parameter, the system accesses the default business space. You can obtain the key from the Business Management page of your main account.', 'type' => 'string', 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => '', 'required' => false], ], [ 'name' => 'ExtraInfo', 'in' => 'formData', 'schema' => ['description' => 'Additional information formatted as a JSON string.', 'type' => 'string', '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' => '', 'required' => false], ], [ 'name' => 'Email', 'in' => 'formData', 'schema' => ['description' => 'The user\'s email address.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'Telephone', 'in' => 'formData', 'schema' => ['description' => 'The user\'s telephone number.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'ForeignId', 'in' => 'formData', 'schema' => ['description' => 'The external user ID.', 'type' => 'string', 'required' => true, 'example' => '8882022040000000171', 'title' => ''], ], [ 'name' => 'Nick', 'in' => 'formData', 'schema' => ['description' => 'The visitor\'s nickname.', 'type' => 'string', 'required' => true, 'example' => '张三', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The root object of the response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => 'E6988CE6-41CF-1103-9BEC-2B20D26C0B51'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The response code. 200 indicates a successful request.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message for a failed request.', 'type' => 'string', 'example' => 'Parameter.Invalid', 'title' => ''], 'Data' => ['description' => 'The generated token value.', 'type' => 'string', 'example' => 'DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6988CE6-41CF-1103-9BEC-2B20D26C0B51\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Parameter.Invalid\\",\\n \\"Data\\": \\"DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF\\"\\n}","type":"json"}]', 'title' => 'Obtain a Password-Free Logon Token for Users', 'description' => 'For security, each generated token is single-use and must be used before it expires. If a user signs in from multiple browsers, you must call this operation for each session to get a unique token.', 'changeSet' => [ ['createdAt' => '2025-12-11T03:00:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-08-07T08:17:02.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-25T09:30:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-25T01:55:14.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-13T04:38:41.000Z', 'description' => 'Request parameters changed, Error codes changed'], ['createdAt' => '2022-07-12T06:38:21.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateUserAccessToken'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'GetAgentInfo' => [ 'summary' => 'Retrieves details for a specified agent.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'beebot_bot_public_cn-ca36x8v3n1x', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Parameter.Invalid', 'title' => ''], 'Data' => [ 'description' => 'The agent details.', 'type' => 'object', 'properties' => [ 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '业务空间_881', 'title' => ''], 'AgentKey' => ['description' => 'The agent key. It is used to specify the agent in Platform as a Service (PaaS) API calls.', 'type' => 'string', 'example' => '4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC384CE1-8D42-1900-84E1-F33F990F2B5E\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter.Invalid\\",\\n \\"Data\\": {\\n \\"AgentName\\": \\"业务空间_881\\",\\n \\"AgentKey\\": \\"4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public\\"\\n }\\n}","type":"json"}]', 'title' => 'Obtain workspace information by instance ID', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentInfo'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'GetAsyncResult' => [ 'summary' => 'Retrieves the execution result of an asynchronous service. This API is used in conjunction with the Chat API.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The ID of the asynchronous task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '从Chat接口中获取TASK_ID'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If unspecified, the default business space is used. This key is available on the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The task result, returned as a JSON-formatted string.', 'type' => 'string', 'example' => '{"message":"执行完成"}', 'title' => ''], 'Status' => ['description' => 'The task\'s execution status. Valid values:'."\n" ."\n" .'| Value | Description |'."\n" .'| ------- | -------------------------------- |'."\n" .'| Success | The task completed successfully. |'."\n" .'| Running | The task is running. |'."\n" .'| Fail | The task failed. |', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\\\"message\\\\\\":\\\\\\"执行完成\\\\\\"}\\",\\n \\"Status\\": \\"Success\\",\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\"\\n}","type":"json"}]', 'title' => 'Obtain the asynchronous function execution result', 'description' => 'Retrieves the execution result of an asynchronous service.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncResult'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'GetBotSessionData' => [ 'summary' => 'Retrieves overview metrics for a bot.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time for the query. The format must be `yyyyMMdd`. For example: `20240505`.', 'type' => 'string', 'required' => true, 'example' => '20240505', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time for the query. The format must be `yyyyMMdd`. For example: `20240605`.', 'type' => 'string', 'required' => true, 'example' => '20240605', 'title' => ''], ], [ 'name' => 'RobotInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the bot instance.', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the workspace. If you omit this parameter, the operation uses the default workspace. You can find the key on the business management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CostTime' => ['description' => 'The API call latency, in milliseconds (ms).', 'type' => 'string', 'example' => '116', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51', 'title' => ''], 'Datas' => [ 'type' => 'array', 'items' => ['description' => 'The details of the data object.', 'type' => 'object', 'example' => '参考JSON示例', 'title' => ''], 'description' => 'An array of objects containing the data details.', 'title' => '', 'example' => '', ], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostTime\\": \\"116\\",\\n \\"RequestId\\": \\"15CD94CC-CBEB-4189-806C-A132D1F45D51\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Robot Reception Overview ', 'description' => 'This operation retrieves data for the previous day (T-1) only. Data for the current day is not available.', 'responseParamsDescription' => '**Datas**'."\n" ."\n" .'| Field name | Type | Description |'."\n" .'| ------------------- | ------ | --------------------------- |'."\n" .'| SidCnt | int | Number of sessions |'."\n" .'| ChatCnt | int | Number of chat requests |'."\n" .'| AvgChatCnt | int | Average conversation turns |'."\n" .'| SolutionSidCnt | int | Number of resolved sessions |'."\n" .'| NoSolutionRate | double | Unresolved rate |'."\n" .'| NoAnswerRate | double | No-answer rate |'."\n" .'| FeedbackChatCnt | int | Feedback count |'."\n" .'| FeedbackGoodChatCnt | int | Positive feedback count |'."\n" .'| FeedbackBadChatCnt | int | Negative feedback count |'."\n" ."\n" .'> The fields in the `Datas` array are returned as strings. To use them for calculations, you must first parse them as numbers.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBotSessionData'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'GetInstancePublishTaskState' => [ 'summary' => 'Checks the status of a bot publishing task.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the bot instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you do not specify this parameter, the default business space is used. You can find the key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', 'title' => ''], 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', 'title' => ''], 'Response' => ['description' => 'The task ID, returned as a string.', 'type' => 'string', 'example' => '8522', 'title' => ''], 'Status' => [ 'description' => 'The status of the task.', 'enumValueTitles' => ['FE_SUCCESS' => 'Publishing succeeded.', 'FE_ABORTED' => 'Publishing was aborted.', 'FE_WARNING' => 'Indicates that warnings were generated. To proceed, call the `ContinueInstancePublishTask` API.', 'FE_FAILED' => 'Publishing failed.', 'FE_RUNNING' => 'Publishing in progress.'], 'type' => 'string', 'example' => 'FE_RUNNING', 'enum' => ['FE_RUNNING：正在发布中', 'FE_WARNING：有警告，若需继续，请调用 ContinueInstancePublishTask 接口继续发布', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], 'title' => '', ], 'BizTypeList' => [ 'title' => '', 'description' => 'The list of business types.', 'type' => 'array', 'items' => ['description' => 'The business type of the publishing task.', 'type' => 'string', 'example' => 'robot', 'title' => ''], 'example' => '', ], 'Error' => ['description' => 'The error message if the task fails.', 'type' => 'string', 'title' => '', 'example' => '检查待发布模块是否空闲发生错误，faq'], 'CreateTime' => ['description' => 'The UTC time when the task was created.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'ModifyTime' => ['description' => 'The UTC time when the task was last modified.', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', 'title' => ''], 'Warnings' => ['description' => 'A map of warning messages for each submodule, where the key is the submodule and the value is an array of warnings.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" .' "category_bind_faq": ['."\n" .' "以下类目没有发布到正式环境：项目交付类目"'."\n" .' ]'."\n" .'}'], 'Errors' => ['description' => 'A map of error messages for each submodule, where the key is the submodule and the value is an array of errors.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" .' "robot_ds": ['."\n" .' "{\\"dialogName\\":\\"TEST\\",\\"errorMessage\\":[\\"medusa@invocation.error.service.offline@请发布对话流所引用服务后重试！\\"],\\"needRefresh\\":false,\\"success\\":false}"'."\n" .' ]'."\n" .'}'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"robot\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\",\\n \\"Warnings\\": {\\n \\"category_bind_faq\\": [\\n \\"以下类目没有发布到正式环境：项目交付类目\\"\\n ]\\n },\\n \\"Errors\\": {\\n \\"robot_ds\\": [\\n \\"{\\\\\\"dialogName\\\\\\":\\\\\\"TEST\\\\\\",\\\\\\"errorMessage\\\\\\":[\\\\\\"medusa@invocation.error.service.offline@请发布对话流所引用服务后重试！\\\\\\"],\\\\\\"needRefresh\\\\\\":false,\\\\\\"success\\\\\\":false}\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Query robot publishing progress ', 'responseParamsDescription' => '### Status values'."\n" ."\n" .'| Field | Value | Description |'."\n" .'| ------ | ---------- | ----------------------------------------------------------------------------------------------- |'."\n" .'| Status | FE_RUNNING | Publishing in progress. |'."\n" .'| Status | FE_WARNING | Indicates that warnings were generated. To proceed, call the `ContinueInstancePublishTask` API. |'."\n" .'| Status | FE_SUCCESS | Publishing succeeded. |'."\n" .'| Status | FE_FAILED | Publishing failed. |'."\n" .'| Status | FE_ABORTED | Publishing was aborted. |'."\n" ."\n" .'### Submodule keys for Warnings and Errors'."\n" ."\n" .'| Key | Description |'."\n" .'| ---------------------- | ------------------------- |'."\n" .'| category_bind_chitchat | Chitchat bindings |'."\n" .'| category_bind_faq | FAQ bindings |'."\n" .'| robot_ds | Dialog Studio dialog flow |'."\n" .'| ds_entity | Dialog Studio entity |'."\n" .'| ds_intent | Dialog Studio intent |'."\n" ."\n" .'### Examples'."\n" ."\n" .'#### Sample response'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "ModifyTime": "2022-04-12T06:30:21Z",'."\n" .' "BizTypeList": ['."\n" .' "robot"'."\n" .' ],'."\n" .' "CreateTime": "2022-04-12T06:30:17Z",'."\n" .' "RequestId": "cddf472f-6ce3-4eef-a969-1e8b16850cb4",'."\n" .' "Response": "4930",'."\n" .' "Warnings": {'."\n" .' "category_bind_faq": ['."\n" .' "The following category has not been published to the production environment: Project Delivery Category"'."\n" .' ]'."\n" .' },'."\n" .' "Id": 4930,'."\n" .' "Status": "FE_WARNING"'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstancePublishTaskState'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'GetPublishTaskState' => [ 'summary' => 'Gets the progress of a publish task.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => ['description' => 'The publish task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '8521', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key that identifies the business space. If omitted, the default business space is used. You can get the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CBF0581-EAE7-1DC4-95C6-A089656A1E2D', 'title' => ''], 'Id' => ['description' => 'The publish task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8522', 'title' => ''], 'Response' => ['description' => 'The publish task ID. This field is redundant. Use the `Id` field instead.', 'type' => 'string', 'example' => '8522', 'title' => ''], 'Status' => [ 'description' => 'The task status. Valid values:'."\n" ."\n" .'- `FE_RUNNING`: Publishing'."\n" ."\n" .'- `FE_SUCCESS`: Success'."\n" ."\n" .'- `FE_FAILED`: Failed'."\n" ."\n" .'- `FE_ABORTED`: Aborted', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'FE_RUNNING', 'enum' => ['FE_RUNNING：正在发布中', 'FE_SUCCESS：发布成功', 'FE_FAILED：发布失败', 'FE_ABORTED：发布取消'], 'title' => '', ], 'BizTypeList' => [ 'title' => '', 'description' => 'The list of business types.', 'type' => 'array', 'items' => ['description' => 'The business type of the publish task.', 'type' => 'string', 'example' => 'faq', 'title' => ''], 'example' => '', ], 'Error' => ['description' => 'The error message returned if the task fails.', 'type' => 'string', 'title' => '', 'example' => '检查待发布模块是否空闲发生错误，faq'], 'CreateTime' => ['description' => 'The UTC time when the task was created.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'ModifyTime' => ['description' => 'The UTC time when the task was last modified.', 'type' => 'string', 'example' => '2022-04-12T06:30:33Z', 'title' => ''], 'Errors' => ['description' => 'A map of error messages for each submodule, where the key is the submodule name and the value is the error message.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" .' "faq": ['."\n" .' "答案资源未发布，资源类型：全局服务，名称：动态答案服务"'."\n" .' ]'."\n" .'}'], 'Warnings' => ['description' => 'A map of warning messages for each submodule, where the key is the submodule name and the value is the warning message.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" .' "faq": ['."\n" .' "答案资源未发布，类型：service，名称：null，答案资源未发布，类型：service，名称：null"'."\n" .' ]'."\n" .'}'."\n"], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Query publish progress ', 'changeSet' => [ ['createdAt' => '2022-12-26T11:37:56.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPublishTaskState'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBF0581-EAE7-1DC4-95C6-A089656A1E2D\\",\\n \\"Id\\": 8522,\\n \\"Response\\": \\"8522\\",\\n \\"Status\\": \\"FE_RUNNING\\",\\n \\"BizTypeList\\": [\\n \\"faq\\"\\n ],\\n \\"Error\\": \\"检查待发布模块是否空闲发生错误，faq\\",\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"ModifyTime\\": \\"2022-04-12T06:30:33Z\\",\\n \\"Errors\\": {\\n \\"faq\\": [\\n \\"答案资源未发布，资源类型：全局服务，名称：动态答案服务\\"\\n ]\\n },\\n \\"Warnings\\": {\\n \\"faq\\": [\\n \\"答案资源未发布，类型：service，名称：null，答案资源未发布，类型：service，名称：null\\"\\n ]\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'InitIMConnect' => [ 'summary' => 'Initializes the Instant Messaging (IM) connection using the `From` value configured in the channel console. This operation lets you pass a user authentication token during initialization.', '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' => 'The identifier for the connection source. You can obtain this value from the channel console.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'UserAccessToken', 'in' => 'formData', 'schema' => ['description' => 'The access token for user authentication.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. Omit this parameter to use the default business space. You can get the key from the business management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E6988CE6-41CF-1103-9BEC-2B20D26C0B52'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. If the request fails, this parameter provides the exception message.', 'type' => 'string', 'example' => 'Parameter.Invalid', 'title' => ''], 'Data' => ['description' => 'The IM connection information, returned as a JSON string.', 'type' => 'string', 'example' => '{ "imDomain": "im.alimebot.com", "appKey": "WDg2VfNv", "token": "QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==" }', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6988CE6-41CF-1103-9BEC-2B20D26C0B52\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Parameter.Invalid\\",\\n \\"Data\\": \\"{ \\\\\\"imDomain\\\\\\": \\\\\\"im.alimebot.com\\\\\\", \\\\\\"appKey\\\\\\": \\\\\\"WDg2VfNv\\\\\\", \\\\\\"token\\\\\\": \\\\\\"QUM4SndaY3VPMjhkQldDZUNOR0ZaTmZ5R3NBY0FKWHJ4OGc4dERZbEJzcjNIKzFiS1RyTjhXRUpBYmVpQlpsakprNDRFVkdxcy9HWVk2RXZvalU3bHhxRkJlc1NBUXZwdHFKOTE2UTNwamQ4b1U4N3dEbmhyRjc4R2hOQStvMnMrYkV2dlVpSHNvWC96SEVNZWRqMjBuMXdjNklpamJzaDNWYllnUldDZGhJPQ==\\\\\\" }\\"\\n}","type":"json"}]', 'title' => 'Initialize IM connection', 'responseParamsDescription' => 'The `Data` field contains a JSON string with the following details: `imDomain` (the IM connection domain), `appKey` (the IM authentication key), and `token` (the IM connection token).', 'changeSet' => [ ['createdAt' => '2025-12-11T03:00:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-12-26T07:22:12.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitIMConnect'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'LinkInstanceCategory' => [ 'summary' => 'Links knowledge categories to a chatbot.', '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' => ['description' => 'The unique identifier of the chatbot.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'CategoryIds', 'in' => 'formData', 'allowEmptyValue' => true, 'schema' => ['description' => 'An array of FAQ category IDs to link to the chatbot.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '[\\"30000065789\\"]'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you do not specify this parameter, the default business space is used. You can obtain the key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'AbilityType', 'in' => 'query', 'schema' => ['description' => 'The category\'s ability type. Valid values: `FAQ` and `MRC` (machine reading comprehension). Defaults to `FAQ`.', 'type' => 'string', 'example' => 'FAQ,MRC', 'default' => 'FAQ', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'D8C96601-E645-1BD7-99F3-04EADAB84E29', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8C96601-E645-1BD7-99F3-04EADAB84E29\\"\\n}","type":"json"}]', 'title' => 'Robot - Attach Category', 'changeSet' => [ ['createdAt' => '2025-08-20T07:52:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-09T12:50:08.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LinkInstanceCategory'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListAgent' => [ 'summary' => 'Lists the business spaces for your Alibaba Cloud account.', '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' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'AgentName', 'in' => 'query', 'schema' => ['description' => 'The name of the business space. Use this parameter to filter the results.', 'type' => 'string', 'required' => false, 'example' => '业务空间_001', 'title' => ''], ], [ 'name' => 'GoodsCodes', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code. Filters the results to return only business spaces associated with a specific commodity code.', 'enumValueTitles' => ['G_cloudBeeBot_public' => ''], 'type' => 'string', 'required' => false, 'example' => 'G_cloudBeeBot_public', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F55D90C1-31BE-4B2A-AA3F-25EFC36F9419'], 'PageNumber' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total count of business spaces that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Data' => [ 'description' => 'The list of business spaces.', 'type' => 'array', 'items' => [ 'description' => 'A business space object.', 'type' => 'object', 'properties' => [ 'AgentId' => ['description' => 'The business space ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '881', 'title' => ''], 'AgentKey' => ['description' => 'The business space signature, used to identify the business space in Platform-as-a-Service (PaaS) API calls.', 'type' => 'string', 'example' => '4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public', 'title' => ''], 'AgentName' => ['description' => 'The name of the business space.', 'type' => 'string', 'example' => '业务空间_881', 'title' => ''], 'InstanceInfos' => [ 'description' => 'Details of the associated commodity instance. The object keys are commodity codes.', 'enumValueTitles' => ['G_cloudBeeBot_public' => ''], 'type' => 'object', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F55D90C1-31BE-4B2A-AA3F-25EFC36F9419\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 6,\\n \\"Data\\": [\\n {\\n \\"AgentId\\": 881,\\n \\"AgentKey\\": \\"4e7400028e6f4a7393ed3acf6a7b8927_p_beebot_public\\",\\n \\"AgentName\\": \\"业务空间_881\\",\\n \\"InstanceInfos\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Obtain Workspace List', 'responseParamsDescription' => 'Example of InstanceInfos:'."\n" .'"InstanceInfos": {'."\n" .'"GoodsCode": {'."\n" .'"InstanceId": "xxxxxx"'."\n" .'}'."\n" .'}'."\n" .'Note: `GoodsCode` is a placeholder for a commodity code. See the enumerated values.', 'changeSet' => [ ['createdAt' => '2024-05-15T03:39:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-04-16T08:50:12.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgent'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListCategory' => [ 'summary' => 'Lists categories.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'KnowledgeType', 'in' => 'formData', 'schema' => ['title' => 'Knowledge type. FAQ category: 1, document category: 3.', 'description' => 'The knowledge type. Valid values: `1` (FAQ category) and `3` (document category). The default value is `1`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'ParentCategoryId', 'in' => 'formData', 'schema' => ['description' => 'The parent category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '-1'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The business space key. If you omit this parameter, the default business space is used. You can obtain the key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'Categories' => [ 'title' => '', 'description' => 'An array of categories.', 'type' => 'array', 'items' => [ 'description' => 'The category information.', 'type' => 'object', 'properties' => [ 'CategoryId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '231001028593'], 'BizCode' => ['description' => 'The business code.', 'type' => 'string', 'example' => 'bizcode123', 'title' => ''], 'Name' => ['description' => 'The category name.', 'type' => 'string', 'example' => '类目名称', 'title' => ''], 'ParentCategoryId' => ['description' => 'The parent category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], 'Status' => ['description' => 'The status of the category. Valid values: `0` (Normal) and `-1` (Deleted).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9C5F8186-2D22-433E-9545-606D344F30B5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Categories\\": [\\n {\\n \\"CategoryId\\": 231001028593,\\n \\"BizCode\\": \\"bizcode123\\",\\n \\"Name\\": \\"类目名称\\",\\n \\"ParentCategoryId\\": -1,\\n \\"Status\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"9C5F8186-2D22-433E-9545-606D344F30B5\\"\\n}","type":"json"}]', 'title' => 'Retrieve the category list', 'changeSet' => [ ['createdAt' => '2024-02-22T12:10:08.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCategory'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListConnQuestion' => [ 'summary' => 'Lists the connected questions for a knowledge item.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the knowledge item.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the workspace. If omitted, the default workspace is used. You can find this key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B', 'title' => ''], 'Outlines' => [ 'description' => 'A list of connected questions.', 'type' => 'array', 'items' => [ 'description' => 'Details of a connected question.', 'type' => 'object', 'properties' => [ 'OutlineId' => ['description' => 'The relation ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '797'], 'ConnQuestionId' => ['description' => 'The ID of the connected question.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30001979424'], 'Title' => ['description' => 'The title of the connected question.', 'type' => 'string', 'title' => '', 'example' => '关联问'], 'ModifyTime' => ['description' => 'The last modification time, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-26T10:18:15Z'], 'CreateTime' => ['description' => 'The creation time, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-02-25T02:47:18Z'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"92B81548-42B9-4B34-924B-4E778AEB412B\\",\\n \\"Outlines\\": [\\n {\\n \\"OutlineId\\": 797,\\n \\"ConnQuestionId\\": 30001979424,\\n \\"Title\\": \\"关联问\\",\\n \\"ModifyTime\\": \\"2022-05-26T10:18:15Z\\",\\n \\"CreateTime\\": \\"2022-02-25T02:47:18Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Get list of associated questions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnQuestion'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListDSEntity' => [ 'summary' => 'Lists the entities for a specified robot. This operation returns only entity metadata, such as the entity type, name, creation time, and update time.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If this parameter is not set, the default business space is used. You can find this key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The robot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'A keyword to filter entities by name using a \'contains\' match. Future releases will also support searching by entity member and synonym.', 'type' => 'string', 'example' => '实体', 'title' => '', 'required' => false], ], [ 'name' => 'EntityType', 'in' => 'query', 'schema' => [ 'description' => 'The entity type. If you omit this parameter, all custom entities are returned.', 'enumValueTitles' => ['regex' => ': A regular expression-based entity.', 'system' => ': A system entity.', 'synonyms' => ': A synonym-based entity.'], 'type' => 'string', 'example' => 'synonyms'."\n" .'regex'."\n" .'system', 'title' => '', 'required' => false, ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ga4h345defgwet2sdf223', 'title' => ''], 'TotalCount' => ['description' => 'The total count of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Entities' => [ 'description' => 'The list of entities.', 'type' => 'array', 'items' => [ 'description' => 'The details of an entity.', 'type' => 'object', 'properties' => [ 'EntityId' => ['description' => 'The ID of the entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '234564567445', 'title' => ''], 'EntityName' => ['description' => 'The entity name.', 'type' => 'string', 'example' => '书实体', 'title' => ''], 'SysEntityCode' => ['description' => 'The code for the system entity, such as `sys_date`. This parameter is blank for custom entities.', 'type' => 'string', 'title' => '', 'example' => 'sys_date'], 'EntityType' => ['description' => 'The entity type. Valid values: `synonyms`, `regex`, and `system`.', 'type' => 'string', 'example' => 'synonyms', 'title' => ''], 'CreateTime' => ['description' => 'The creation time in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'ModifyTime' => ['description' => 'The update time in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'CreateUserId' => ['description' => 'The ID of the user who created the entity.', 'type' => 'string', 'example' => '123231', 'title' => ''], 'CreateUserName' => ['description' => 'The name of the user who created the entity.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ModifyUserId' => ['description' => 'The ID of the user who last modified the entity.', 'type' => 'string', 'example' => '123231', 'title' => ''], 'ModifyUserName' => ['description' => 'The name of the user who last modified the entity.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Ds.IllegalAccess.BotIdNotExists', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ga4h345defgwet2sdf223\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Entities\\": [\\n {\\n \\"EntityId\\": 234564567445,\\n \\"EntityName\\": \\"书实体\\",\\n \\"SysEntityCode\\": \\"sys_date\\",\\n \\"EntityType\\": \\"synonyms\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"CreateUserId\\": \\"123231\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"ModifyUserId\\": \\"123231\\",\\n \\"ModifyUserName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Entity - List ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDSEntity'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListDSEntityValue' => [ 'summary' => 'Retrieves the list of entity values for a specified entity. You can filter by keyword using a `contains` match. The search covers both entity values and their synonyms.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If omitted, the default business space is used. You can get this key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'EntityValueId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the entity value.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '234', 'title' => '', 'required' => false], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => ['description' => 'The keyword used to search for entity values and their synonyms.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '书'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Defaults to 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The page size. Defaults to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => 'n3fg34gbfj8adf2gj923', 'title' => ''], 'EntityValues' => [ 'description' => 'A list of entity values.', 'type' => 'array', 'items' => [ 'description' => 'The details of an entity value.', 'type' => 'object', 'properties' => [ 'EntityId' => ['description' => 'The ID of the entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '34313785463', 'title' => ''], 'EntityValueId' => ['description' => 'The ID of the entity value.', 'type' => 'integer', 'format' => 'int64', 'example' => '3467858234534534532', 'title' => ''], 'Content' => ['description' => 'The content of the entity value, which can be a standard value or a regular expression.', 'type' => 'string', 'example' => '书类型', 'title' => ''], 'Synonyms' => [ 'description' => 'A list of synonyms for the entity value.', 'type' => 'array', 'items' => ['description' => 'A synonym.', 'type' => 'string', 'example' => '小说', 'title' => ''], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The creation time of the entity value in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'ModifyTime' => ['description' => 'The last modification time of the entity value in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total count of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries on the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], ], ], 'title' => 'Entity Members - List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDSEntityValue'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"n3fg34gbfj8adf2gj923\\",\\n \\"EntityValues\\": [\\n {\\n \\"EntityId\\": 34313785463,\\n \\"EntityValueId\\": 3467858234534534700,\\n \\"Content\\": \\"书类型\\",\\n \\"Synonyms\\": [\\n \\"小说\\"\\n ],\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListInstance' => [ 'summary' => 'Queries a list of instances.', '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' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of instances to return on each page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false], ], [ 'name' => 'RobotType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the chatbot.', 'enumValueTitles' => ['scenario_callout' => 'outbound call chatbot', 'scenario_im' => 'online text chatbot', 'scenario_ivr' => 'navigation chatbot'], 'type' => 'string', 'example' => 'scenario_im', 'title' => '', 'required' => false, ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the chatbot. A fuzzy search is supported.', 'type' => 'string', 'example' => '售前客服', 'title' => '', 'required' => false], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. You can obtain the key on the Business Management page of the primary account. If you do not set this parameter, the default business space is accessed.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'Sandbox', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Instances' => [ 'title' => '', 'description' => 'The list of chatbots.', 'type' => 'array', 'items' => [ 'description' => 'The chatbot information.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The unique ID of the chatbot.', 'type' => 'string', 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], 'Name' => ['description' => 'The name of the chatbot.', 'type' => 'string', 'example' => '智能客服-小C', 'title' => ''], 'Introduction' => ['description' => 'The remarks on the chatbot.', 'type' => 'string', 'example' => '用于C端问答的机器人', 'title' => ''], 'LanguageCode' => ['description' => 'The language of the chatbot, such as zh-cn and en-us. For more information, see http\\://www\\.lingoes.net/en/translator/langcode.htm.', 'type' => 'string', 'example' => 'zh-cn', 'title' => ''], 'RobotType' => [ 'description' => 'The type of the chatbot.', 'enumValueTitles' => ['scenario_callout' => 'outbound call chatbot', 'scenario_im' => 'online text chatbot', 'scenario_ivr' => 'navigation chatbot'], 'type' => 'string', 'example' => 'scenario_im', 'title' => '', ], 'Avatar' => ['description' => 'The URL of the chatbot avatar.', 'type' => 'string', 'example' => '/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png', 'title' => ''], 'CreateTime' => ['description' => 'The time when the chatbot was created. The time is in the UTC format.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '92B81548-42B9-4B34-924B-4E778AEB412B', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"chatbot-cn-mp90s2lrk00050\\",\\n \\"Name\\": \\"智能客服-小C\\",\\n \\"Introduction\\": \\"用于C端问答的机器人\\",\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"RobotType\\": \\"scenario_im\\",\\n \\"Avatar\\": \\"/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"PageSize\\": 5,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"92B81548-42B9-4B34-924B-4E778AEB412B\\"\\n}","type":"json"}]', 'title' => 'Robot – List', 'responseParamsDescription' => '### Example'."\n" ."\n" .'#### Response example'."\n" ."\n" .'```json'."\n" .' {'."\n" .' "PageNumber": 1,'."\n" .' "TotalCount": 1,'."\n" .' "PageSize": 10,'."\n" .' "RequestId": "787B6D28-A81E-486F-BC8C-64ADED337B25",'."\n" .' "Instances":['."\n" .' {'."\n" .' "InstanceId":"chatbot-cn-xxxxx",'."\n" .' "Avatar":"/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png",'."\n" .' "LanguageCode":"zh-cn",'."\n" .' "RobotType":"scenario_im",'."\n" .' "Name":"Smart Customer Service - Xiao C",'."\n" .' "Introduction":"A chatbot for customer-facing Q&A.",'."\n" .' "CreateTime":"2021-08-12T16:00:01Z"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```', 'changeSet' => [ ['createdAt' => '2026-02-04T11:35:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-10T03:13:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstance'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListIntent' => [ 'summary' => 'Retrieves metadata for all intents in a specified bot, including the intent type, intent name, creation time, and modification time.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The unique key for the business space. If you omit this parameter, the default business space is used. You can find this key on the business management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the chatbot.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'IntentName', 'in' => 'query', 'schema' => ['description' => 'The intent name.', 'type' => 'string', 'example' => '查天气', 'title' => '', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '999999', 'minimum' => '1', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of intents per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'example' => '10', 'default' => '10', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '23dsfa34r2s2s2sd12', 'title' => ''], 'TotalCount' => ['description' => 'The total number of intents.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of intents per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Intents' => [ 'description' => 'A list of intents.', 'type' => 'array', 'items' => [ 'description' => 'The details of an intent.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '234234234234', 'title' => ''], 'IntentName' => ['description' => 'The intent name.', 'type' => 'string', 'example' => '查天气意图', 'title' => ''], 'AliasName' => ['description' => 'The intent alias.', 'type' => 'string', 'example' => '查天气意图', 'title' => ''], 'SlotInfos' => [ 'description' => 'A list of slots associated with the intent.', 'type' => 'array', 'items' => [ 'description' => 'The details of a slot.', 'type' => 'object', 'properties' => [ 'SlotId' => ['description' => 'The slot ID.', 'type' => 'string', 'title' => '', 'example' => '12134223'], 'Name' => ['description' => 'The slot name.', 'type' => 'string', 'title' => '', 'example' => '天气'], 'Value' => ['description' => 'The slot value (entity name).', 'type' => 'string', 'title' => '', 'example' => '天气'], 'Interactive' => ['description' => 'Indicates whether the slot value is collected interactively.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Array' => ['description' => 'Indicates whether the slot can accept multiple values.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Encrypt' => ['description' => 'Indicates whether the slot contains sensitive data.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time at which the intent was created, in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'ModifyTime' => ['description' => 'The time at which the intent was last modified, in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'CreateUserId' => ['description' => 'The ID of the user who created the intent.', 'type' => 'string', 'example' => '123231', 'title' => ''], 'CreateUserName' => ['description' => 'The name of the user who created the intent.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ModifyUserId' => ['description' => 'The ID of the user who last modified the intent.', 'type' => 'string', 'example' => '123231', 'title' => ''], 'ModifyUserName' => ['description' => 'The name of the user who last modified the intent.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter InstanceId is not valid!', 'description' => ''], ], ], 'staticInfo' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23dsfa34r2s2s2sd12\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Intents\\": [\\n {\\n \\"IntentId\\": 234234234234,\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"AliasName\\": \\"查天气意图\\",\\n \\"SlotInfos\\": [\\n {\\n \\"SlotId\\": \\"12134223\\",\\n \\"Name\\": \\"天气\\",\\n \\"Value\\": \\"天气\\",\\n \\"Interactive\\": false,\\n \\"Array\\": false,\\n \\"Encrypt\\": false\\n }\\n ],\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"CreateUserId\\": \\"123231\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"ModifyUserId\\": \\"123231\\",\\n \\"ModifyUserName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Intent - List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntent'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListLgf' => [ 'summary' => 'Queries the advanced semantic configurations (LGF) for a specified intent.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you do not specify this parameter, the default business space is used. You can obtain the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the chatbot.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the intent.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'LgfText', 'in' => 'query', 'schema' => ['description' => 'The text used to filter the advanced semantic configurations.', 'type' => 'string', 'example' => '.{0,5}北京天气', 'title' => '', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. Defaults to 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Defaults to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '34fg57h2gh5783', 'title' => ''], 'Lgfs' => [ 'description' => 'A list of advanced semantic configurations.', 'type' => 'array', 'items' => [ 'description' => 'An advanced semantic configuration.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The ID of the intent.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '256756734345'], 'LgfId' => ['title' => '', 'description' => 'The LGF ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], 'RuleText' => ['description' => 'The LGF rule.', 'type' => 'string', 'title' => '', 'example' => '.{0,5}北京天气'], 'CreateTime' => ['description' => 'The creation time, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2021-08-12T16:00:01Z'], 'ModifyTime' => ['description' => 'The modification time, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2021-08-12T16:00:01Z'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total count of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'Intent-LGF List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLgf'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34fg57h2gh5783\\",\\n \\"Lgfs\\": [\\n {\\n \\"IntentId\\": 256756734345,\\n \\"LgfId\\": 123,\\n \\"RuleText\\": \\".{0,5}北京天气\\",\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListSaasInfo' => [ 'summary' => 'Lists SaaS integration information.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If this parameter is omitted, the default business space is used. You can obtain the key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'SaasName', 'in' => 'query', 'schema' => ['description' => 'The username of the business user.', 'type' => 'string', 'required' => true, 'example' => 'userTest', 'title' => ''], ], [ 'name' => 'SaasGroupCodes', 'in' => 'query', 'schema' => ['description' => 'The codes of the user\'s SaaS permission groups. Separate multiple codes with a comma.', 'type' => 'string', 'required' => false, 'example' => 'DS,FAQ', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A629A28F-F25E-5572-A679-FA46FB0151D6'], 'Data' => [ 'description' => 'A list of SaaS integrations.', 'type' => 'array', 'items' => [ 'description' => 'The details of a SaaS integration.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The unique identifier of the SaaS atomic page. Use this code to reference the page and query its information.', 'type' => 'string', 'example' => 'GLOBAL_SERVICE', 'title' => ''], 'Name' => ['description' => 'The Chinese name of the atomic page.', 'type' => 'string', 'example' => '全局服务', 'title' => ''], 'Url' => ['description' => 'The URL of the atomic page.', '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', 'title' => ''], 'EnName' => ['description' => 'The English name of the atomic page.', 'type' => 'string', 'example' => 'GLOBAL SERVICE', 'title' => ''], 'ServiceUrl' => ['description' => 'The URL to embed the SaaS page in an iframe.', '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', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SaasToken' => ['description' => 'The SaaS integration token issued by Chatbot.', 'type' => 'string', 'example' => '06614fdb-c72f-436e-8003-dfe8a2854a15', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A629A28F-F25E-5572-A679-FA46FB0151D6\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"GLOBAL_SERVICE\\",\\n \\"Name\\": \\"全局服务\\",\\n \\"Url\\": \\"https://alime.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot\\",\\n \\"EnName\\": \\"GLOBAL SERVICE\\",\\n \\"ServiceUrl\\": \\"https://pre-alime4service.console.aliyun.com/?productCode=p_beebot_public&switchAgent=1204001&saasCode=Robot&saasToken=06614fdb-c72f-436e-8003-dfe8a2854a15&saasName=123#/robot\\"\\n }\\n ],\\n \\"SaasToken\\": \\"06614fdb-c72f-436e-8003-dfe8a2854a15\\"\\n}","type":"json"}]', 'title' => 'Obtain the list of Software as a Service (SaaS) Integration information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSaasInfo'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListSaasPermissionGroupInfos' => [ 'summary' => 'Lists the permission groups for integrated SaaS applications. Use these groups to grant permissions to users.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If unspecified, the default business space is used. You can find this key on the Business Management page of your main account.', 'type' => 'string', 'required' => true, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8AD9FA10-7780-5E12-B701-13C928524F32'], 'Data' => [ 'description' => 'The permission details for integrated SaaS pages.', 'type' => 'array', 'items' => [ 'description' => 'The permission details for an integrated SaaS page.', 'type' => 'object', 'properties' => [ 'SaasCode' => ['description' => 'The unique code for the SaaS page.', 'type' => 'string', 'example' => 'FAQ', 'title' => ''], 'Name' => ['description' => 'The name of the page.', 'type' => 'string', 'example' => '发布中心', 'title' => ''], 'EnName' => ['description' => 'The name of the page in English.', 'type' => 'string', 'example' => 'Release Center', 'title' => ''], 'PgInfos' => [ 'description' => 'The SaaS permission groups.', 'type' => 'array', 'items' => [ 'description' => 'The details of a permission group.', 'type' => 'object', 'properties' => [ 'PgCode' => ['description' => 'The unique permission group code.', 'type' => 'string', 'example' => 'FAQ', 'title' => ''], 'PgName' => ['description' => 'The name of the permission group.', 'type' => 'string', 'example' => 'FAQ管理', 'title' => ''], 'PgEnName' => ['description' => 'The English name of the permission group.', 'type' => 'string', 'example' => 'FAQ', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8AD9FA10-7780-5E12-B701-13C928524F32\\",\\n \\"Data\\": [\\n {\\n \\"SaasCode\\": \\"FAQ\\",\\n \\"Name\\": \\"发布中心\\",\\n \\"EnName\\": \\"Release Center\\",\\n \\"PgInfos\\": [\\n {\\n \\"PgCode\\": \\"FAQ\\",\\n \\"PgName\\": \\"FAQ管理\\",\\n \\"PgEnName\\": \\"FAQ\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve the list of permission integration information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSaasPermissionGroupInfos'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListSimQuestion' => [ 'summary' => 'Queries the list of similar questions for a knowledge entry.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you do not specify this parameter, the default business space is used. You can get the key from the Business Management Page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => ['description' => 'The knowledge entry ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30002299537'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15CD94CC-CBEB-4189-806C-A132D1F45D51', 'title' => ''], 'SimQuestions' => [ 'title' => '', 'description' => 'The list of similar questions.', 'type' => 'array', 'items' => [ 'description' => 'The details of a similar question.', 'type' => 'object', 'properties' => [ 'SimQuestionId' => ['description' => 'The similar question ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30001979424'], 'ModifyTime' => ['description' => 'The modification time of the similar question, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-13T03:49:28Z'], 'CreateTime' => ['description' => 'The creation time of the similar question, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-30T02:08:33Z'], 'Title' => ['description' => 'The title of the similar question.', 'type' => 'string', 'title' => '', 'example' => '相似问'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15CD94CC-CBEB-4189-806C-A132D1F45D51\\",\\n \\"SimQuestions\\": [\\n {\\n \\"SimQuestionId\\": 30001979424,\\n \\"ModifyTime\\": \\"2022-05-13T03:49:28Z\\",\\n \\"CreateTime\\": \\"2022-05-30T02:08:33Z\\",\\n \\"Title\\": \\"相似问\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve the list of FAQ alternate queries', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSimQuestion'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListSolution' => [ 'summary' => 'Lists the solutions for a knowledge entry.', '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' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30001905617'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The agent key. If omitted, the default agent is used. You can find the key on the agent management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'Solutions' => [ 'title' => '', 'description' => 'A list of solutions.', 'type' => 'array', 'items' => [ 'description' => 'Information about a solution.', 'type' => 'object', 'properties' => [ 'SolutionId' => ['description' => 'The solution ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '496'], 'ModifyTime' => ['description' => 'The time when the solution was last modified, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-03-29T06:23:53Z'], 'CreateTime' => ['description' => 'The time when the solution was created, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-03-29T03:55:04Z'], 'Content' => ['description' => 'The content of the solution.', 'type' => 'string', 'title' => '', 'example' => '答案内容'], 'ContentType' => ['description' => 'The type of the solution content. Valid values: `0` (plain text) and `1` (rich text).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PlainText' => ['description' => 'The content of the solution in plain text.', 'type' => 'string', 'title' => '', 'example' => '答案内容'], 'PerspectiveCodes' => [ 'title' => '', 'description' => 'A list of perspective codes.', 'type' => 'array', 'items' => ['description' => 'A perspective code.', 'type' => 'string', 'example' => 'm8qAIvUUAIf', 'title' => ''], 'example' => '', ], 'TagIdList' => [ 'description' => 'A list of tag IDs.', 'title' => 'List of tag IDs', 'type' => 'array', 'items' => ['title' => 'Tag ID', 'description' => 'A tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1232342'], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5B29DB5E-251D-5A73-84B5-A12DF795F231'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Solutions\\": [\\n {\\n \\"SolutionId\\": 496,\\n \\"ModifyTime\\": \\"2022-03-29T06:23:53Z\\",\\n \\"CreateTime\\": \\"2022-03-29T03:55:04Z\\",\\n \\"Content\\": \\"答案内容\\",\\n \\"ContentType\\": 1,\\n \\"PlainText\\": \\"答案内容\\",\\n \\"PerspectiveCodes\\": [\\n \\"m8qAIvUUAIf\\"\\n ],\\n \\"TagIdList\\": [\\n 1232342\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"5B29DB5E-251D-5A73-84B5-A12DF795F231\\"\\n}","type":"json"}]', 'title' => 'Retrieve FAQ answer list', 'changeSet' => [ ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSolution'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListTongyiChatHistorys' => [ 'summary' => 'Retrieves chat history details.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time for the query, in `yyyy-MM-dd HH:mm:ss` format. For example: `2024-04-01 00:00:00`.', 'type' => 'string', 'required' => true, 'example' => '2024-04-01 00:00:00', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time for the query, in `yyyy-MM-dd HH:mm:ss` format. For example: `2024-04-01 08:00:00`.', 'type' => 'string', 'required' => true, 'example' => '2024-04-01 08:00:00', 'title' => ''], ], [ 'name' => 'RobotInstanceId', 'in' => 'query', 'schema' => ['description' => 'The robot instance ID.', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe', 'title' => ''], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. Default: 30. Maximum: 500.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '500', 'minimum' => '0', 'default' => '30', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If this parameter is omitted, the default business space is used. You can obtain this key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D0DDFC4C-D66D-4787-9AE4-4D757481EDEE'], 'CostTime' => ['description' => 'The request duration, in milliseconds.', 'type' => 'string', 'example' => '116', 'title' => ''], 'Datas' => [ 'description' => 'A list of chat history entries.', 'type' => 'array', 'items' => ['description' => 'A single chat history entry.', 'type' => 'object', 'example' => '参考ChatHistoryDTO', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DDFC4C-D66D-4787-9AE4-4D757481EDEE\\",\\n \\"CostTime\\": \\"116\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Session History Details '."\n", 'responseParamsDescription' => '**ChatHistoryDTO**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------- |'."\n" .'| QueryTime | String | The query time. |'."\n" .'| Question | String | The question. |'."\n" .'| Answer | String | The answer. |'."\n" .'| AnswerSource | String | The answer type. |'."\n" .'| SessionId | String | The session ID for multi-turn conversations. |'."\n" .'| ChatId | String | The request ID of a single-turn query. |'."\n" .'| UserId | String | The visitor ID. This corresponds to the `SenderId` parameter in the chat API request. |'."\n" .'| Username | String | The visitor nickname for the current session. This corresponds to the `SenderNick` parameter in the chat API request. |'."\n" .'| FeedbackType | String | The type of user feedback. |'."\n" .'| FeedbackLabels | String | The labels or tags for the feedback. |'."\n" .'| FeedbackUserInfo | String | Additional feedback details provided by the user. |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTongyiChatHistorys'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListTongyiConversationLogs' => [ 'summary' => 'Retrieves the conversation logs for a single session of a Tongyi chatbot.', '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' => 'The ID of the chatbot instance.', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the session.', 'type' => 'string', 'required' => true, 'example' => '7c3cec23cc8940bc9db4a318c8f4f0aa', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If omitted, the default business space is used. You can find this key on the Business Management page of your root account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CostTime' => ['description' => 'The request processing time, in milliseconds.', 'type' => 'string', 'example' => '66', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '28805A7C-D695-548C-A31B-67E52C2C274F', 'title' => ''], 'Datas' => [ 'description' => 'An array of conversation log entries.', 'type' => 'array', 'items' => ['description' => 'The details of a conversation log.', 'type' => 'object', 'title' => '', 'example' => '参考JSON示例'], 'title' => '', 'example' => '', ], 'SessionFlowDebugInfo' => [ 'description' => 'The debug information for the session flow.', 'title' => 'Session flow debug information ', 'type' => 'object', 'properties' => [ 'ApiParams' => ['title' => 'API parameters of the session flow debug information', 'description' => 'The API parameters from the session flow.', 'type' => 'object', 'example' => ''], 'SlotParams' => ['title' => 'Slot parameters of the session flow debug information', 'description' => 'The slot parameters from the session flow.', 'type' => 'object', 'example' => ''], ], 'example' => '', ], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostTime\\": \\"66\\",\\n \\"RequestId\\": \\"28805A7C-D695-548C-A31B-67E52C2C274F\\",\\n \\"Datas\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"SessionFlowDebugInfo\\": {\\n \\"ApiParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SlotParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]', 'title' => 'Query conversation records of a single session', 'description' => 'This operation retrieves conversation logs generated within the past two hours.', 'responseParamsDescription' => '```json'."\n" .'{'."\n" .' "CostTime": "36",'."\n" .' "RequestId": "E1B076C5-F7DD-1B63-B691-E7E90F4A5770",'."\n" .' "Datas": ['."\n" .' {'."\n" .' "Answer": "Hello! To provide you with accurate information, please tell me which match on December 2, 2022, you are asking about and provide the team\'s name. Then, I can check if that team had a match on that day.\\n\\n For example:\\n- If you want to know about the \'Beijing Guoan FC\' match on December 2, 2022, please provide: \'Beijing Guoan FC match on December 2, 2022\'.",'."\n" .' "ToAgent": "false",'."\n" .' "QueryTime": "2024-10-16 10:11:12",'."\n" .' "Question": "Which team had a match on December 2, 2022?",'."\n" .' "SessionId": "6b762779ba334ab1a79b331426247933",'."\n" .' "ChatId": "ac5c1b6c-768c-488a-9d4d-186c30f3b5b2"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```'."\n" ."\n" .'**Fields in Datas**'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| --------- | ------ | ---------------------------------------------------------- |'."\n" .'| QueryTime | String | The timestamp of the query. |'."\n" .'| Question | String | The content of the user\'s question. |'."\n" .'| Answer | String | The content of the chatbot\'s answer. |'."\n" .'| ToAgent | String | Indicates whether the session was transferred to an agent. |'."\n" .'| SessionId | String | The ID of the session. |'."\n" .'| ChatId | String | The ID of the specific chat turn. |', 'changeSet' => [ ['createdAt' => '2025-11-25T01:18:04.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'ListUserSay' => [ 'summary' => 'Queries the user says and their associated slot information for a specified intent. You can filter the results by keywords.', 'methods' => ['post', 'get'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you omit this parameter, the default business space is used. You can obtain the key from the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the bot.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the intent.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '232', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The keywords used to filter user says. The query returns only user says that contain these keywords.', 'type' => 'string', 'example' => '您做核酸了嘛', 'title' => '', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. The default value is 10. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'fs1fg4512v43572v23', 'title' => ''], 'UserSays' => [ 'description' => 'A list of user says.', 'type' => 'array', 'items' => [ 'description' => 'Details of a user say.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The ID of the intent.', 'type' => 'integer', 'format' => 'int64', 'example' => '235564564', 'title' => ''], 'UserSayId' => ['description' => 'The ID of the user say.', 'type' => 'integer', 'format' => 'int64', 'example' => '3453452138', 'title' => ''], 'Content' => ['description' => 'The content of the user say.', 'type' => 'string', 'example' => '您做核酸了嘛', 'title' => ''], 'SlotInfos' => [ 'description' => 'A list of associated slots.', 'type' => 'array', 'items' => [ 'description' => 'Details of an associated slot.', 'type' => 'object', 'properties' => [ 'SlotId' => ['description' => 'The ID of the intent slot.', 'type' => 'string', 'title' => '', 'example' => '3456sdfg3tu'], 'StartIndex' => ['description' => 'The zero-based start index of the slot in the user say. This value is inclusive.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], 'EndIndex' => ['description' => 'The zero-based end index of the slot in the user say. This value is exclusive.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time when the user say was created. The time is in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], 'ModifyTime' => ['description' => 'The time when the user say was last modified. The time is in UTC.', 'type' => 'string', 'example' => '2021-08-12T16:00:01Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"fs1fg4512v43572v23\\",\\n \\"UserSays\\": [\\n {\\n \\"IntentId\\": 235564564,\\n \\"UserSayId\\": 3453452138,\\n \\"Content\\": \\"您做核酸了嘛\\",\\n \\"SlotInfos\\": [\\n {\\n \\"SlotId\\": \\"3456sdfg3tu\\",\\n \\"StartIndex\\": 2,\\n \\"EndIndex\\": 4\\n }\\n ],\\n \\"CreateTime\\": \\"2021-08-12T16:00:01Z\\",\\n \\"ModifyTime\\": \\"2021-08-12T16:00:01Z\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', 'title' => 'Intent - Utterance - List ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserSay'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'Nlu' => [ 'summary' => 'Returns the natural language understanding (NLU) results for a user query. Currently, this feature only supports NLU from Conversation Factory and Central Control. Support for other engines will be added as needed.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the bot instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'Utterance', 'in' => 'query', 'schema' => ['description' => 'The user\'s text input.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '北京的天气怎么样', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The agent key. If not specified, the default agent is used. Find the key on the Business Management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Messages' => [ 'title' => '', 'description' => 'The list of messages.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DialogHubNluInfo' => [ 'title' => '', 'description' => 'The natural language understanding information from DialogHub.', 'type' => 'object', 'properties' => [ 'GlobalDictList' => [ 'title' => '', 'description' => 'The list of global dictionary entries.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StandardWord' => ['description' => 'The standard word.', 'type' => 'string', 'example' => '天气', 'title' => ''], 'Word' => ['description' => 'The synonym.', 'type' => 'string', 'example' => '天气', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'GlobalSensitiveWordList' => [ 'title' => '', 'description' => 'The list of global sensitive words.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StandardWord' => ['description' => 'The standard word.', 'type' => 'string', 'example' => '天气', 'title' => ''], 'Word' => ['description' => 'The synonym.', 'type' => 'string', 'example' => '天气', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'DsNluInfo' => [ 'title' => '', 'description' => 'The natural language understanding information from Dialog Studio.', 'type' => 'object', 'properties' => [ 'EntityList' => [ 'title' => '', 'description' => 'The list of entities.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the entity.', 'type' => 'string', 'example' => '@城市', 'title' => ''], 'Origin' => ['description' => 'The original word for the entity, also known as an entity member.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Type' => ['description' => 'The type of the entity. Currently, only the `text` type is supported.', 'type' => 'string', 'example' => 'text', 'title' => ''], 'Value' => ['description' => 'The entity\'s synonym.', 'type' => 'string', 'example' => '首都', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'IntentList' => [ 'title' => '', 'description' => 'The list of intents.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '724387', 'title' => ''], 'MatchDetail' => ['description' => 'The details of the matching process.', 'type' => 'string', 'example' => 'classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]', 'title' => ''], 'MatchType' => ['description' => 'The match type. Valid values are `Similarity` (match by utterance similarity), `Lgf` (match by LGF), `Classify` (match by model training), `FewShotLearning` (match by the built-in few-shot learning model), and `BuildIn` (match with a built-in intent).', 'type' => 'string', 'example' => 'FewShotLearning', 'title' => ''], 'Name' => ['description' => 'The name of the intent.', 'type' => 'string', 'example' => '查天气意图', 'title' => ''], 'Score' => ['description' => 'The confidence score of the match.', 'type' => 'number', 'format' => 'double', 'example' => '0.995', 'title' => ''], 'SlotList' => [ 'title' => '', 'description' => 'The list of slots for the matched intent.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the entity.', 'type' => 'string', 'example' => '@城市', 'title' => ''], 'Origin' => ['description' => 'The original word for the entity, also known as an entity member.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Type' => ['description' => 'The type of the entity. Currently, only the `text` type is supported.', 'type' => 'string', 'example' => 'text', 'title' => ''], 'Value' => ['description' => 'The entity\'s synonym.', 'type' => 'string', 'example' => '首都', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A6357C1B-1D79-1382-B259-BD9E80751B42', 'title' => ''], 'MessageId' => ['description' => 'The ID of the natural language understanding response.', 'type' => 'string', 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661', 'title' => ''], ], 'description' => 'The data returned.', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Messages\\": [\\n {\\n \\"DialogHubNluInfo\\": {\\n \\"GlobalDictList\\": [\\n {\\n \\"StandardWord\\": \\"天气\\",\\n \\"Word\\": \\"天气\\"\\n }\\n ],\\n \\"GlobalSensitiveWordList\\": [\\n {\\n \\"StandardWord\\": \\"天气\\",\\n \\"Word\\": \\"天气\\"\\n }\\n ]\\n },\\n \\"DsNluInfo\\": {\\n \\"EntityList\\": [\\n {\\n \\"Name\\": \\"@城市\\",\\n \\"Origin\\": \\"北京\\",\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"首都\\"\\n }\\n ],\\n \\"IntentList\\": [\\n {\\n \\"IntentId\\": 724387,\\n \\"MatchDetail\\": \\"classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]\\",\\n \\"MatchType\\": \\"FewShotLearning\\",\\n \\"Name\\": \\"查天气意图\\",\\n \\"Score\\": 0.995,\\n \\"SlotList\\": [\\n {\\n \\"Name\\": \\"@城市\\",\\n \\"Origin\\": \\"北京\\",\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"首都\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"A6357C1B-1D79-1382-B259-BD9E80751B42\\",\\n \\"MessageId\\": \\"2828708A-2C7A-1BAE-B810-87DB9DA9C661\\"\\n}","type":"json"}]', 'title' => 'Unified NLU API ', 'responseParamsDescription' => '### Example'."\n" ."\n" .'#### Response body'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "Messages": ['."\n" .' {'."\n" .' "DsNluInfo": {'."\n" .' "EntityList": ['."\n" .' {'."\n" .' "Origin": "Beijing",'."\n" .' "Name": "@city",'."\n" .' "Type": "text",'."\n" .' "Value": "capital"'."\n" .' }'."\n" .' ],'."\n" .' "IntentList": ['."\n" .' {'."\n" .' "Score": 0.995,'."\n" .' "SlotList": ['."\n" .' {'."\n" .' "Origin": "Beijing",'."\n" .' "Name": "@city",'."\n" .' "Type": "text",'."\n" .' "Value": "capital"'."\n" .' }'."\n" .' ],'."\n" .' "MatchType": "FewShotLearning",'."\n" .' "MatchDetail": "classifierType=Fewshot,from=Fewshot,content=[I want to check the weather in Beijing, Help me check the weather in Beijing, How\'s the weather in Beijing, Is it raining in Beijing today, What\'s the temperature in Beijing today]",'."\n" .' "Name": "Check weather intent",'."\n" .' "IntentId": 724387'."\n" .' }'."\n" .' ]'."\n" .' },'."\n" .' "DialogHubNluInfo": {'."\n" .' "GlobalDictList": ['."\n" .' {'."\n" .' "StandardWord": "weather",'."\n" .' "Word": "weather"'."\n" .' }'."\n" .' ],'."\n" .' "GlobalSensitiveWordList": ['."\n" .' {'."\n" .' "StandardWord": "weather",'."\n" .' "Word": "weather"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' }'."\n" .' ],'."\n" .' "RequestId": "5C20F0D4-9721-178A-8236-3BF990634962",'."\n" .' "MessageId": "e7ac691f-b166-4561-bddf-9dd00c8bdce6"'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Nlu'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'QueryPerspectives' => [ 'summary' => 'Queries a list of perspectives.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If this parameter is omitted, the default business space is used. You can find the key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F285D735-D580-18A8-B97F-B2E72B00F101', 'title' => ''], 'Perspectives' => [ 'title' => '', 'description' => 'A list of perspectives.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the perspective. Valid values are 3 (enabled) and 1 (disabled).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CreateTime' => ['description' => 'The creation time in UTC.', 'type' => 'string', 'example' => '2022-04-12T06:30:17Z', 'title' => ''], 'PerspectiveId' => ['description' => 'The perspective ID.', 'type' => 'string', 'example' => '3001', 'title' => ''], 'SelfDefine' => ['description' => 'Indicates whether the perspective is custom-defined.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Name' => ['description' => 'The perspective name.', 'type' => 'string', 'example' => '移动端视角', 'title' => ''], 'PerspectiveCode' => ['description' => 'The perspective code (used for the Q\\&A API).', 'type' => 'string', 'example' => 'FZJBY3raWr', 'title' => ''], 'ModifyTime' => ['description' => 'The modification time in UTC.', 'type' => 'string', 'example' => '2022-04-29T03:38:54Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F285D735-D580-18A8-B97F-B2E72B00F101\\",\\n \\"Perspectives\\": [\\n {\\n \\"Status\\": 1,\\n \\"CreateTime\\": \\"2022-04-12T06:30:17Z\\",\\n \\"PerspectiveId\\": \\"3001\\",\\n \\"SelfDefine\\": true,\\n \\"Name\\": \\"移动端视角\\",\\n \\"PerspectiveCode\\": \\"FZJBY3raWr\\",\\n \\"ModifyTime\\": \\"2022-04-29T03:38:54Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Perspective - List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPerspectives'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'RetryDoc' => [ 'summary' => 'Retries a document processing task.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you do not specify this parameter, the default business space is used. You can obtain the key from the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'e2a20f74cd9042558002c0f7dc873739_p_outbound_public', 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '30001905617', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned by the request.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6419BA93-D111-5225-8998-13E63E6D3940'], 'KnowledgeId' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30001905617', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6419BA93-D111-5225-8998-13E63E6D3940\\",\\n \\"KnowledgeId\\": 30001905617\\n}","type":"json"}]', 'title' => 'Retry the document.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetryDoc'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'SearchDoc' => [ 'summary' => 'Search the documentation.', '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' => 'The workspace key. If omitted, the default workspace is used. You can obtain this key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => '搜索关键字', 'title' => ''], ], [ 'name' => 'CategoryIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of category IDs.', 'type' => 'array', 'items' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000065594', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ProcessStatus', 'in' => 'query', 'schema' => ['description' => 'The task status.
Valid values:
• -1: Queued
• 0: Succeeded
• 1: Parsing
• 2: Processing
• 3: Failed





', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The edit status.
Valid values:
• 1: Unpublished
• 2: Published
• 3: Updated but not published



', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'SearchScope', 'in' => 'query', 'schema' => ['description' => 'The search scope.
Valid values:
• 1: Search titles
• 2: Search content


', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'CreateUserName', 'in' => 'query', 'schema' => ['description' => 'The name of the creator.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], ], [ 'name' => 'ModifyUserName', 'in' => 'query', 'schema' => ['description' => 'The name of the last modifier.', 'type' => 'string', 'required' => false, 'example' => '李四', 'title' => ''], ], [ 'name' => 'CreateTimeBegin', 'in' => 'query', 'schema' => ['description' => 'The start of the creation time range.', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z', 'title' => ''], ], [ 'name' => 'CreateTimeEnd', 'in' => 'query', 'schema' => ['description' => 'The end of the creation time range.', 'type' => 'string', 'required' => false, 'example' => '2022-05-02T03:09:30Z', 'title' => ''], ], [ 'name' => 'ModifyTimeBegin', 'in' => 'query', 'schema' => ['description' => 'The start of the modification time range.', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z', 'title' => ''], ], [ 'name' => 'ModifyTimeEnd', 'in' => 'query', 'schema' => ['description' => 'The end of the modification time range.', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z', 'title' => ''], ], [ 'name' => 'StartTimeBegin', 'in' => 'query', 'schema' => ['description' => 'The start of the effective time range.', 'type' => 'string', 'required' => false, 'example' => '2022-04-02T03:09:30Z', 'title' => ''], ], [ 'name' => 'StartTimeEnd', 'in' => 'query', 'schema' => ['description' => 'The end of the effective time range.', 'type' => 'string', 'required' => false, 'example' => '2022-04-03T03:09:30Z', 'title' => ''], ], [ 'name' => 'EndTimeBegin', 'in' => 'query', 'schema' => ['description' => 'The start of the expiration time range.', 'type' => 'string', 'required' => false, 'example' => '2023-04-02T03:09:30Z', 'title' => ''], ], [ 'name' => 'EndTimeEnd', 'in' => 'query', 'schema' => ['description' => 'The end of the expiration time range.', 'type' => 'string', 'required' => false, 'example' => '2023-05-02T03:09:30Z', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'TagIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of tag IDs. If you provide multiple IDs, the operation returns documents that match at least one of the specified tags (logical OR).', 'title' => 'List of tag IDs', 'type' => 'array', 'items' => ['description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1201', 'title' => ''], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The structure of the response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1'], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '141', 'title' => ''], 'DocHits' => [ 'description' => 'A list of matching documents.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'KnowledgeId' => ['description' => 'The knowledge ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30002692007', 'title' => ''], 'DocName' => ['description' => 'The document name.', 'type' => 'string', 'example' => '文档名称', 'title' => ''], 'BizCode' => ['description' => 'The business code.', 'type' => 'string', 'example' => 'cn_dytns', 'title' => ''], 'Meta' => ['description' => 'The document metadata.', 'type' => 'string', 'example' => '{"code":"xxx"}', 'title' => ''], 'Config' => ['description' => 'The splitter for the document. Key: `Splitter`. Valid values:
• `paragraphSplitter` (default): Splits the document by paragraph.
• `treeSplitter`: Splits the document based on a rule-based hierarchy.

'."\n" ."\n" .'The size of each document chunk. Key: `ChunkSize`. Default value: 500. Value range: \\[200, 800].'."\n" ."\n" .'The patterns for the rule-based hierarchy. Key: `TreePatterns`. Default value: `[]`.'."\n" ."\n" .'The source of the document title. Key: `TitleSource`. Valid values:
• `ocrTitle` (default): Uses the OCR-identified title.
• `docName`: Uses the document name as the title.

', 'type' => 'string', 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}', 'title' => ''], 'Url' => ['description' => 'The OSS URL of the object.', 'type' => 'string', 'example' => 'https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf', 'title' => ''], 'ModifyTime' => ['description' => 'The time the document was last modified (UTC).', 'type' => 'string', 'example' => '2023-06-25T02:27:42Z', 'title' => ''], 'ModifyUserName' => ['description' => 'The name of the last modifier.', 'type' => 'string', 'example' => '李四', 'title' => ''], 'CreateTime' => ['description' => 'The time the document was created (UTC).', 'type' => 'string', 'example' => '2023-06-22T03:53:41Z', 'title' => ''], 'CreateUserName' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => '张三', 'title' => ''], 'CreateUserId' => ['description' => 'The creator ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111', 'title' => ''], 'ModifyUserId' => ['description' => 'The modifier ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '222222222', 'title' => ''], 'CategoryId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000135654', 'title' => ''], 'ProcessStatus' => ['description' => 'The task\'s processing status. Valid values:
• -1: Queued
• 0: Succeeded
• 1: Parsing
• 2: Processing
• 3: Failed




', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ProcessMessage' => ['description' => 'The processing message for the task.', 'type' => 'string', 'example' => '任务处理成功', 'title' => ''], 'ProcessCanRetry' => ['description' => 'Indicates whether the task can be retried.
• `true`: The task can be retried.
• `false`: The task cannot be retried.

', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Status' => ['description' => 'The editing status of the document. Valid values:
• 1: Unpublished
• 2: Published
• 3: Updated but not published


', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'EffectStatus' => ['description' => 'The knowledge\'s effective status, calculated based on `StartDate` and `EndDate`. Valid values:
• 20: Active
• 21: Expired
• 22: Pending


', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'StartDate' => ['description' => 'The time the knowledge takes effect (UTC).', 'type' => 'string', 'example' => '2023-02-28T11:40:18Z', 'title' => ''], 'EndDate' => ['description' => 'The time the knowledge expires (UTC).', 'type' => 'string', 'example' => '2099-12-31T16:00:00Z', 'title' => ''], 'DocTags' => [ 'description' => 'A list of the document\'s tags.', 'type' => 'array', 'items' => [ 'description' => 'A tag object.', 'type' => 'object', 'properties' => [ 'TagId' => ['title' => 'Tag ID ', 'description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1201'], 'TagName' => ['title' => 'Tag Name ', 'description' => 'The tag name.', 'type' => 'string', 'example' => '小说'], 'GroupId' => ['title' => 'Tag Group ID', 'description' => 'The tag group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3610'], 'GroupName' => ['title' => 'Tag Group Name ', 'description' => 'The tag group name.', 'type' => 'string', 'example' => '文章'], 'DefaultTag' => ['title' => 'Is it the default for all tags', 'description' => 'Indicates whether this is a default tag.', 'type' => 'boolean', 'example' => 'false'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3E5C779-A630-45AC-B0F2-A4506A4212F1\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 141,\\n \\"DocHits\\": [\\n {\\n \\"KnowledgeId\\": 30002692007,\\n \\"DocName\\": \\"文档名称\\",\\n \\"BizCode\\": \\"cn_dytns\\",\\n \\"Meta\\": \\"{\\\\\\"code\\\\\\":\\\\\\"xxx\\\\\\"}\\",\\n \\"Config\\": \\"{\\\\\\"Splitter\\\\\\":\\\\\\"treeSplitter\\\\\\",\\\\\\"ChunkSize\\\\\\":500,\\\\\\"TreePatterns\\\\\\":[\\\\\\"^# .*\\\\\\",\\\\\\"^## .*\\\\\\",\\\\\\"^### .*\\\\\\",\\\\\\"^#### .*\\\\\\"],\\\\\\"TitleSource\\\\\\":\\\\\\"docName\\\\\\"}\\",\\n \\"Url\\": \\"https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf\\",\\n \\"ModifyTime\\": \\"2023-06-25T02:27:42Z\\",\\n \\"ModifyUserName\\": \\"李四\\",\\n \\"CreateTime\\": \\"2023-06-22T03:53:41Z\\",\\n \\"CreateUserName\\": \\"张三\\",\\n \\"CreateUserId\\": 111111111,\\n \\"ModifyUserId\\": 222222222,\\n \\"CategoryId\\": 30000135654,\\n \\"ProcessStatus\\": 0,\\n \\"ProcessMessage\\": \\"任务处理成功\\",\\n \\"ProcessCanRetry\\": true,\\n \\"Status\\": 1,\\n \\"EffectStatus\\": 20,\\n \\"StartDate\\": \\"2023-02-28T11:40:18Z\\",\\n \\"EndDate\\": \\"2099-12-31T16:00:00Z\\",\\n \\"DocTags\\": [\\n {\\n \\"TagId\\": 1201,\\n \\"TagName\\": \\"小说\\",\\n \\"GroupId\\": 3610,\\n \\"GroupName\\": \\"文章\\",\\n \\"DefaultTag\\": false\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Search document', 'changeSet' => [ ['createdAt' => '2024-05-17T09:42:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchDoc'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'SearchFaq' => [ 'summary' => 'Search the knowledge base.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the workspace. If this parameter is not specified, the default workspace is used. You can get the key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '搜索标题'], ], [ 'name' => 'CategoryIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'An array of category IDs to filter the search results.', 'type' => 'array', 'items' => ['description' => 'A category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000065594', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ 'description' => 'The status of the knowledge item.', 'enumValueTitles' => [1 => 'Unpublished', 'Published', 'Updated but not yet published', -1 => 'Deleted but not yet published'], 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1', ], ], [ 'name' => 'SearchScope', 'in' => 'formData', 'schema' => [ 'description' => 'The search scope.', 'enumValueTitles' => [1 => 'Search titles and similar questions', 'Search answers', 'Search all'], 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CreateUserName', 'in' => 'formData', 'schema' => ['description' => 'The creator\'s username.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test01'], ], [ 'name' => 'ModifyUserName', 'in' => 'formData', 'schema' => ['description' => 'The modifier\'s username.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test01'], ], [ 'name' => 'CreateTimeBegin', 'in' => 'formData', 'schema' => ['description' => 'The start of the creation period.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-04-02T03:09:30Z'], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'The end of the creation period.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-05-02T03:09:30Z'], ], [ 'name' => 'ModifyTimeBegin', 'in' => 'formData', 'schema' => ['description' => 'The start of the modification period.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2023-04-02T03:09:30Z'], ], [ 'name' => 'ModifyTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'The end of the modification period.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2023-05-02T03:09:30Z'], ], [ 'name' => 'StartTimeBegin', 'in' => 'formData', 'schema' => ['description' => 'The start of the effective period.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-04-02T03:09:30Z'], ], [ 'name' => 'StartTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'The end of the effective period.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-04-03T03:09:30Z'], ], [ 'name' => 'EndTimeBegin', 'in' => 'formData', 'schema' => ['description' => 'The start of the expiration period.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2023-04-02T03:09:30Z'], ], [ 'name' => 'EndTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'The end of the expiration period.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2023-05-02T03:09:30Z'], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['description' => 'The number of the page to return. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page. The default value is 10, and the maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'FaqHits' => [ 'description' => 'The list of matching FAQs.', 'type' => 'array', 'items' => [ 'description' => 'A matching FAQ.', 'type' => 'object', 'properties' => [ 'KnowledgeId' => ['description' => 'The FAQ ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30002145804'], 'ModifyTime' => ['description' => 'The modification time (UTC).', 'type' => 'string', 'title' => '', 'example' => '2022-04-02T03:09:30Z'], 'ModifyUserName' => ['description' => 'The modifier\'s username.', 'type' => 'string', 'title' => '', 'example' => 'test01'], 'CreateTime' => ['description' => 'The creation time (UTC).', 'type' => 'string', 'title' => '', 'example' => '2022-04-02T03:09:30Z'], 'CreateUserName' => ['description' => 'The creator\'s username.', 'type' => 'string', 'title' => '', 'example' => 'test01'], 'CreateUserId' => ['description' => 'The creator ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '18453'], 'ModifyUserId' => ['description' => 'The modifier ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '18453'], 'CategoryId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30000055639'], 'Status' => [ 'description' => 'The FAQ status.', 'enumValueTitles' => [1 => 'Unpublished', 'Published', 'Updated but not yet published', -1 => 'Deleted but not yet published'], 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3', ], 'EffectStatus' => [ 'description' => 'The effective status of the FAQ. This status is determined by the StartDate and EndDate parameters.', 'enumValueTitles' => [20 => 'Effective', 'Expired', 'Pending'], 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20', ], 'Title' => ['description' => 'The title of the FAQ.', 'type' => 'string', 'title' => '', 'example' => '测试标题'], 'HitSimilarTitles' => [ 'title' => '', 'description' => 'A list of matched similar titles.', 'type' => 'array', 'items' => ['description' => 'A matched similar title.', 'type' => 'string', 'example' => '测试命中的标题', 'title' => ''], 'example' => '', ], 'HitSolutions' => [ 'title' => '', 'description' => 'A list of matched answers.', 'type' => 'array', 'items' => ['description' => 'A matched answer.', 'type' => 'string', 'example' => '测试命中的答案', 'title' => ''], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'TotalCount' => ['description' => 'The total number of matched entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1075'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E45491D5-7E0A-42C6-9B21-91D1066B1475', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FaqHits\\": [\\n {\\n \\"KnowledgeId\\": 30002145804,\\n \\"ModifyTime\\": \\"2022-04-02T03:09:30Z\\",\\n \\"ModifyUserName\\": \\"test01\\",\\n \\"CreateTime\\": \\"2022-04-02T03:09:30Z\\",\\n \\"CreateUserName\\": \\"test01\\",\\n \\"CreateUserId\\": 18453,\\n \\"ModifyUserId\\": 18453,\\n \\"CategoryId\\": 30000055639,\\n \\"Status\\": 3,\\n \\"EffectStatus\\": 20,\\n \\"Title\\": \\"测试标题\\",\\n \\"HitSimilarTitles\\": [\\n \\"测试命中的标题\\"\\n ],\\n \\"HitSolutions\\": [\\n \\"测试命中的答案\\"\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1075,\\n \\"RequestId\\": \\"E45491D5-7E0A-42C6-9B21-91D1066B1475\\"\\n}","type":"json"}]', 'title' => 'FAQ search ', 'changeSet' => [ ['createdAt' => '2022-12-26T11:45:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchFaq'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'TongyiChatDebugInfo' => [ 'summary' => 'This operation returns debugging information for the large language model (LLM) Q&A process.', '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' => 'The key of the business space. If you do not specify this parameter, the default business space is used. You can get the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the chatbot.', 'type' => 'string', 'required' => true, 'example' => 'chatbot-cn-7QuUfaqMQe', 'title' => ''], ], [ 'name' => 'MessageId', 'in' => 'query', 'schema' => ['description' => 'The ID of the response message in the current session.', 'type' => 'string', 'required' => true, 'example' => '396E74B3-D84B-46CE-9E51-91C06AD22E31', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E3E5C779-A630-45AC-B0F2-A4506A4212F1'], 'MessageId' => ['description' => 'The ID of the response message in the current session.', 'type' => 'string', 'example' => '2828708A-2C7A-1BAE-B810-87DB9DA9C661', 'title' => ''], 'Pipeline' => [ 'description' => 'The array of nodes that constitute the Q\\&A workflow.', 'type' => 'array', 'items' => [ 'description' => 'A single node within the Q\\&A workflow.', 'type' => 'object', 'properties' => [ 'NodeType' => ['description' => 'The node type. Valid values:'."\n" ."\n" .'- **system\\_strategy**: system strategy.'."\n" ."\n" .'- **rewrite\\_query**: retrieval query.'."\n" ."\n" .'- **invoke\\_llm**: LLM invocation.'."\n" ."\n" .'- **invoke\\_tools**: tool invocation.', 'type' => 'string', 'example' => 'system_strategy', 'title' => ''], 'Name' => ['description' => 'The name of the strategy. Possible values include:'."\n" ."\n" .'- FAQ'."\n" ."\n" .'- Hit Keywords'."\n" ."\n" .'- Global Sensitive Words'."\n" ."\n" .'This parameter is returned only when `NodeType` is set to `system_strategy`.', 'type' => 'string', 'example' => '关键词转人工', 'title' => ''], 'Input' => ['description' => 'The input data for the node.', 'type' => 'any', 'example' => '用户问句：转人工\\n命中规则：[转]人工[客服|服务|坐席]', 'title' => ''], 'Output' => ['description' => 'The output data from the node.', 'type' => 'any', 'example' => 'commands:{\\"sysToAgent\\":\\"{\\\\\\"skillGroup\\\\\\":\\\\\\"\\\\\\",\\\\\\"ext\\\\\\":\\\\\\"\\\\\\",\\\\\\"toAgentReason\\\\\\":\\\\\\"HitKeywords\\\\\\"}\\"}\\nresponse:正在为您转接人工客服', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AnswerInfo' => [ 'type' => 'object', 'properties' => [ 'MessageBody' => [ 'type' => 'object', 'properties' => [ 'DirectMessageBody' => [ 'type' => 'object', 'properties' => [ 'ContentType' => ['type' => 'string'], 'relatedQuestionList' => [ 'type' => 'array', 'items' => ['type' => 'string'], ], 'sentenceList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Content' => ['type' => 'string'], 'ReferNumber' => ['type' => 'integer', 'format' => 'int32'], ], ], ], 'TransitionList' => [ 'type' => 'array', 'items' => ['type' => 'string'], ], ], ], 'Commands' => ['type' => 'any'], ], ], 'AnswerReferenceInfo' => [ 'type' => 'object', 'properties' => [ 'ItemList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Number' => ['type' => 'integer', 'format' => 'int32'], 'Title' => ['type' => 'string'], 'Id' => ['type' => 'string'], 'DataSource' => ['type' => 'string'], 'ContentType' => ['type' => 'string'], 'ReferenceExt' => ['type' => 'any'], ], ], ], ], ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => true, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3E5C779-A630-45AC-B0F2-A4506A4212F1\\",\\n \\"MessageId\\": \\"2828708A-2C7A-1BAE-B810-87DB9DA9C661\\",\\n \\"Pipeline\\": [\\n {\\n \\"NodeType\\": \\"system_strategy\\",\\n \\"Name\\": \\"关键词转人工\\",\\n \\"Input\\": \\"用户问句：转人工\\\\\\\\n命中规则：[转]人工[客服|服务|坐席]\\",\\n \\"Output\\": \\"commands:{\\\\\\\\\\\\\\"sysToAgent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"skillGroup\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"ext\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"toAgentReason\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"HitKeywords\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"}\\\\\\\\nresponse:正在为您转接人工客服\\"\\n }\\n ],\\n \\"AnswerInfo\\": {\\n \\"MessageBody\\": {\\n \\"DirectMessageBody\\": {\\n \\"ContentType\\": \\"\\",\\n \\"relatedQuestionList\\": [\\n \\"\\"\\n ],\\n \\"sentenceList\\": [\\n {\\n \\"Content\\": \\"\\",\\n \\"ReferNumber\\": 0\\n }\\n ],\\n \\"TransitionList\\": [\\n \\"\\"\\n ]\\n },\\n \\"Commands\\": \\"\\"\\n },\\n \\"AnswerReferenceInfo\\": {\\n \\"ItemList\\": [\\n {\\n \\"Number\\": 0,\\n \\"Title\\": \\"\\",\\n \\"Id\\": \\"\\",\\n \\"DataSource\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"ReferenceExt\\": \\"\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', 'title' => 'Debug Information for Large Language Model (LLM) Q&A', 'description' => 'This operation supports only the latest version of chatbots and can query data from only the last 90 days.', 'extraInfo' => '### Transfer to Human Agent'."\n" .'```json'."\n" .'{'."\n" .' "RequestId": "D267AB94-2438-1A39-899A-2730BBF808BC",'."\n" .' "MessageId": "8acb8120-9522-461c-babd-509f2f6814ec",'."\n" .' "Pipeline": ['."\n" .' {'."\n" .' "Input": "User query: transfer to human agent'."\n" .'Rule hits: [transfer] human [agent|service|representative]",'."\n" .' "NodeType": "system_strategy",'."\n" .' "Output": "commands:{"sysToAgent":"{\\"skillGroup\\":\\"\\",\\"ext\\":\\"\\",\\"toAgentReason\\":\\"HitKeywords\\"}"}'."\n" .'response: Transferring you to a human agent now",'."\n" .' "Name": "Keyword-based transfer to human agent"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```'."\n" ."\n" .'### Sensitive Word'."\n" .'```json'."\n" .'{'."\n" .' "RequestId": "C1BB266B-A526-1CE1-9DD0-5A008E30B061",'."\n" .' "MessageId": "b716ba46-d69a-4a07-8883-a3ac9709f446",'."\n" .' "Pipeline": ['."\n" .' {'."\n" .' "Input": "User query: Are you Yu Pengfei?'."\n" .'Rule hits: Yu Pengfei",'."\n" .' "NodeType": "system_strategy",'."\n" .' "Output": "I cannot answer this question. Please try asking something else.",'."\n" .' "Name": "Global sensitive word"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```'."\n" ."\n" .'### Direct Response from High-Frequency Q&A'."\n" .'```json'."\n" .'{'."\n" .' "RequestId": "3708D217-AE5A-139B-A669-150CA359A1D3",'."\n" .' "MessageId": "77f8ebe3-4134-44be-ae2b-a78eb1206bf5",'."\n" .' "Pipeline": ['."\n" .' {'."\n" .' "Input": "When does the streaming session API trigger a no-answer response?",'."\n" .' "NodeType": "invoke_tools",'."\n" .' "Output": ['."\n" .' {'."\n" .' "ToolName": "knowledge base retrieval",'."\n" .' "ToolResult": ['."\n" .' {'."\n" .' "Score": "1.0000",'."\n" .' "Content": "When does the streaming session API trigger a no-answer response?",'."\n" .' "BizKnowType": "FAQ",'."\n" .' "Name": "When does the streaming session API trigger a no-answer response?"'."\n" .' },'."\n" .' {'."\n" .' "Score": "0.5634",'."\n" .' "Content": "Streaming session API call fails",'."\n" .' "BizKnowType": "FAQ",'."\n" .' "Name": "Streaming session API returns HTML content"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' ]'."\n" .' },'."\n" .' {'."\n" .' "Input": "High-frequency Q&A title: When does the streaming session API trigger a no-answer response?'."\n" .'Confidence level: 1.0",'."\n" .' "NodeType": "system_strategy",'."\n" .' "Output": "

In the Chatbot Advanced Settings, there is a general knowledge toggle. If you turn off general knowledge, a no-answer response will be shown. If it remains on, the model provides a fallback reply.

",'."\n" .' "Name": "Direct response from high-frequency Q&A"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .'```'."\n" ."\n" .'### Normal Model Invocation'."\n" .'```json'."\n" .'{'."\n" .' "RequestId": "EF047782-B031-1F5F-9E4B-A8C9AD242BC0",'."\n" .' "MessageId": "f194bd8c-7f11-4fbd-833a-ebc7db08c462",'."\n" .' "Pipeline": ['."\n" .' {'."\n" .' "Input": "What error codes are available?",'."\n" .' "NodeType": "rewrite_query",'."\n" .' "Output": "What error codes are available?"'."\n" .' },'."\n" .' {'."\n" .' "Input": "What error codes are available?",'."\n" .' "NodeType": "invoke_tools",'."\n" .' "Output": ['."\n" .' {'."\n" .' "ToolName": "knowledge base retrieval",'."\n" .' "ToolResult": ['."\n" .' {'."\n" .' "Score": "0.6119",'."\n" .' "Content": "[110202]"【Document Name】Common Error Codes_Chatbot - Alibaba Cloud Help Center'."\n" .'【Title】Common Error Codes_Chatbot - Alibaba Cloud Help Center'."\n" .'【Content】Contact us: 4008013260'."\n" .'[Legal Notice](link-32472483000.png)[Cookies Policy](link-32472483001.png)[Integrity Reporting](link-32472483002.png)[Security Reporting](link-32472483003.png)[Contact Us](link-32472483004.png)[Join Us](link-32472483005.png)'."\n" .'### Friendly Links'."\n" .'[Alibaba Group](link-32472483006.png)[Taobao](link-32472483007.png)[Tmall](link-32472483008.png)[AliExpress](link-32472483009.png)[Alibaba.com](link-32472483010.png)[1688](link-32472483011.png)[Alimama](link-32472483012.png)[Fliggy](link-32472483013.png)[Alibaba Cloud Computing](link-32472483014.png)[AliOS](link-32472483015.png)[HiChina](link-32472483016.png)[Amap](link-32472483017.png)[UC](link-32472483018.png)[Umeng](link-32472483019.png)[Youku](link-32472483020.png)[DingTalk](link-32472483021.png)[Alipay](link-32472483022.png)[DAMO Academy](link-32472483023.png)[Taobao Global](link-32472483024.png)[Alibaba Cloud Drive](link-32472483025.png)[Ele.me](link-32472483026.png)'."\n" .'© 2009-2025 Aliyun.com. All rights reserved. Value-added Telecommunications Business Operating License: [Zhe B2-20080101](link-32472483027.png) Domain Name Registration Service Provider License: [Zhe D3-20210002](link-32472483028.png)'."\n" .'[![](link-32472483029.png)](link-32472483030.png)[![Zhe Public Security Bureau No. 33010602009975](link-32472483031.png)Zhe Public Security Bureau No. 33010602009975](link-32472483032.png)[Zhe B2-20080101-4](link-32472483033.png)"",'."\n" .' "BizKnowType": "WEBSITE",'."\n" .' "Name": "Common Error Codes_Chatbot - Alibaba Cloud Help Center"'."\n" .' },'."\n" .' {'."\n" .' "Score": "0.5960",'."\n" .' "Content": "[110203]"【Document Name】Common Error Codes_Chatbot - Alibaba Cloud Help Center'."\n" .'【Title】Common Error Codes_Chatbot - Alibaba Cloud Help Center'."\n" .'【Content】| 403 | InstanceFreezing | The specified instance has been frozen because it has overdue bills. | The current Chatbot instance has been frozen due to overdue payment | [Diagnosis](link-32472482000.png){#error-code-table-4-0-diagnosis-link} |'."\n" .'| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | Internal system error | [Diagnosis](link-32472482001.png){#error-code-table-4-1-diagnosis-link} |'."\n" .'| 400 | InvalidParameter | The specified parameter %s is not valid. | The API request parameter is invalid | [Diagnosis](link-32472482002.png){#error-code-table-4-2-diagnosis-link} |'."\n" .'| 403 | Forbidden | User not authorized to operate on the specified resource. | The user is not authorized to operate on the specified resource | [Diagnosis](link-32472482003.png){#error-code-table-4-3-diagnosis-link} |'."\n" .'{#error-code-3}'."\n" .'[Previous: GetBotSessionData - Chatbot Reception Overview](link-32472482004.png)[Next: Version Guide](link-32472482005.png)'."\n" .'Was this article helpful?'."\n" .'Feedback'."\n" .'### Why Choose Alibaba Cloud'."\n" .'[What is cloud computing](link-32472482006.png)[Global Infrastructure](link-32472482007.png)[Technology Leadership](link-32472482008.png)[Stability and Reliability](link-32472482009.png)[Security Compliance](link-32472482010.png)[Analyst Reports](link-32472482011.png)'."\n" .'### Products and Pricing'."\n" .'[All Products](link-32472482012.png)[Free Trial](link-32472482013.png)[Product Updates](link-32472482014.png)[Pricing](link-32472482015.png)[Pricing Calculator](link-32472482016.png)[Cloud Cost Management](link-32472482017.png)'."\n" .'### Solutions'."\n" .'[Technical Solutions](link-32472482018.png)'."\n" .'### Documentation and Community'."\n" .'[Documentation](link-32472482019.png)[Developer Community](link-32472482020.png)[Tianchi Competitions](link-32472482021.png)[Training and Certification](link-32472482022.png)'."\n" .'### Benefits Center'."\n" .'[Free Trial](link-32472482023.png)[University Program](link-32472482024.png)[Enterprise Support Program](link-32472482025.png)[Referral Rebate Program](link-32472482026.png)'."\n" .'### Support and Services'."\n" .'[Basic Services](link-32472482027.png)[Enterprise Value-Added Services](link-32472482028.png)[Cloud Migration Services](link-32472482029.png)[Official Announcements](link-32472482030.png)[Health Dashboard](link-32472482031.png)[Trust Center](link-32472482032.png)'."\n" .'### Follow Alibaba Cloud'."\n" .'Follow the Alibaba Cloud Official Account or download the Alibaba Cloud app to stay updated on cloud news and manage your Alibaba Cloud services anytime, anywhere.'."\n" .'![Alibaba Cloud App](link-32472482033.png)![Alibaba Cloud WeChat](link-32472482034.png)"",'."\n" .' "BizKnowType": "WEBSITE",'."\n" .' "Name": "Common Error Codes_Chatbot - Alibaba Cloud Help Center"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' ]'."\n" .' },'."\n" .' {'."\n" .' "Input": ['."\n" .' {'."\n" .' "Role": "system",'."\n" .' "Content": "# Environment variables utilization'."\n" ."\n" .'Below is the environment variable information known in the current conversation, including: current date, time, location, and other ingest endpoint parameters:'."\n" ."\n" .'- system_time: 2025-02-27 16:59:10'."\n" .'- day_of_week: Thursday'."\n" .'- location: '."\n" .'- Ingest endpoint parameter values: {}'."\n" ."\n" .'You may use this information when necessary."'."\n" .' }'."\n" .' ],'."\n" .' "NodeType": "invoke_llm",'."\n" .' "Output": "thought:doc{}'."\n" .'response: According to the documentation, the main error codes and their meanings are as follows:'."\n" ."\n" .'1. Common error codes:'."\n" .'- InvalidInstanceId.NotFound (404): The specified Chatbot ID does not exist'."\n" .'- InvalidParameter (400): Invalid parameter'."\n" .'- InternalError (500): Internal error [110201]'."\n" ."\n" .'2. Common error codes:'."\n" .'- InstanceFreezing (403): The current Chatbot instance has been frozen due to overdue payment'."\n" .'- InternalError (500): Internal system error'."\n" .'- InvalidParameter (400): The API request parameter is invalid'."\n" .'- Forbidden (403): The user is not authorized to operate on the specified resource [110202, 110203]'."\n" ."\n" .'3. Rate limiting error:'."\n" .'When concurrent requests exceed the version limit, rate limiting is triggered with the error code "csQueueBusy" and the message "Service is busy, please wait" [110201]'."\n" ."\n" .'For more error code information, visit the [Error Center](link-32471693000.png) [110204]"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```'."\n" ."\n\n" ."\n" .'### Plugin Invocation'."\n" .'```json'."\n" .'{'."\n" .' "RequestId": "D7C96E0A-8F1F-15FC-8B53-6BB10BF8AA50",'."\n" .' "MessageId": "6f2082d7-e32c-4823-90fe-8b0b97b71ae9",'."\n" .' "Pipeline": ['."\n" .' {'."\n" .' "Input": "Shanghai",'."\n" .' "NodeType": "rewrite_query",'."\n" .' "Output": "Query Shanghai weather"'."\n" .' },'."\n" .' {'."\n" .' "Input": "Query Shanghai weather",'."\n" .' "NodeType": "invoke_tools",'."\n" .' "Output": ['."\n" .' {'."\n" .' "ToolName": "knowledge base retrieval",'."\n" .' "ToolResult": ['."\n" .' {'."\n" .' "Score": "1.0000",'."\n" .' "Content": "Weather query 1119 processing flow:'."\n" .'flowchart TD'."\n" .'AB000(Start)--Query weather-->AB001>According to the API: getWeather definition, ask for parameters and invoke]'."\n" .'AB001--API getWeather output parameter weather is Not Empty-->AB002[Strict reply: Fixed response]'."\n" ."\n" .'API: getWeather'."\n" .'Description: Query weather, supports weather information queries for all prefecture-level cities nationwide, such as Beijing, Shanghai, Hangzhou, Chongqing, etc.'."\n" .'Input Parameter: {"type":"object","properties":{"date":{"type":"string","description":"Date"},"city":{"type":"string","description":"City name, such as Beijing, Shanghai, Hangzhou, Chongqing, etc. Parameter value reference: Shanghai"}},"required":["city"]}'."\n" .'Response Parameter: {"type":"object","properties":{"weather":{"type":"string","description":"Specific weather information"}}}",'."\n" .' "BizKnowType": "FLOW",'."\n" .' "Name": "Weather query 1119"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' ]'."\n" .' },'."\n" .' {'."\n" .' "Input": "{"city":"Shanghai"}",'."\n" .' "NodeType": "invoke_tools",'."\n" .' "Output": ['."\n" .' {'."\n" .' "ToolName": "getWeather",'."\n" .' "ToolResult": "Shanghai: fog, temperature 14 degrees Celsius, northeast wind ≤3 on the Beaufort scale"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateCategory' => [ 'summary' => 'Updates a category.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '231001028593'], ], [ 'name' => 'BizCode', 'in' => 'formData', 'schema' => ['title' => 'Business code', 'description' => 'The business code.', 'type' => 'string', 'required' => false, 'example' => 'bizcode123'], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The category name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '类目名称'], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If this parameter is omitted, the default business space is used. You can obtain the key on the **Business Management** page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F79E7305-5314-5069-A701-9591AD051902', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F79E7305-5314-5069-A701-9591AD051902\\"\\n}","type":"json"}]', 'title' => 'Category - Update', 'changeSet' => [ ['createdAt' => '2024-02-22T12:10:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCategory'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateConnQuestion' => [ 'summary' => 'Updates a connection.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ConnQuestionId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the associated question.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '1000000295', 'title' => ''], ], [ 'name' => 'OutlineId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the connection.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'example' => '877397683', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the business space. If you omit this parameter, the default business space is used. You can obtain the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '004EB5C0-9DEB-53BF-A57A-0407A6D6B3C9', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"004EB5C0-9DEB-53BF-A57A-0407A6D6B3C9\\"\\n}","type":"json"}]', 'title' => 'Update FAQ associated question', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConnQuestion'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateDSEntity' => [ 'summary' => 'Updates the metadata of an entity. You can modify the entity name, but not the entity type.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The business space key. If you do not specify this parameter, the system uses the default business space. You can get this key from the business management page of your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The ID of the entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'EntityName', 'in' => 'query', 'schema' => ['description' => 'The new name for the entity. The name can contain only Chinese characters, letters, digits, and underscores (\\_).', 'type' => 'string', 'required' => true, 'example' => '实体名称', 'title' => ''], ], [ 'name' => 'EntityType', 'in' => 'query', 'schema' => ['description' => 'The type of the entity. This parameter cannot be modified. Valid values: `synonyms` and `regex`.', 'type' => 'string', 'example' => 'synonyms', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'df23fgh4hyj67hn56', 'title' => ''], 'EntityId' => ['description' => 'The ID of the updated entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], 'title' => 'BaseResponse', 'type' => 'object', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], ['errorCode' => 'BusinessErrorEntityName.OutRange', 'errorMessage' => 'The business error EntityName is out of range.', 'description' => ''], ['errorCode' => 'BusinessErrorEntityName.Repeat', 'errorMessage' => 'The business error EntityName is repeat.', 'description' => ''], ['errorCode' => 'BusinessErrorEntityName.InvalidCharactor', 'errorMessage' => 'The business error EntityName contains invalid charactor.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"df23fgh4hyj67hn56\\",\\n \\"EntityId\\": 123\\n}","type":"json"}]', 'title' => 'Entity - Modify', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDSEntity'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateDSEntityValue' => [ 'summary' => 'Modifies an entity value. This applies to entity values that use synonyms or regular expressions. Note: You cannot add a regular expression to a standard entity, and vice versa.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the default business space is used. You can find this key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The bot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID. You can leave this parameter empty when modifying an entity value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '223423423', 'title' => ''], ], [ 'name' => 'EntityValueId', 'in' => 'query', 'schema' => ['description' => 'The ID of the entity value to update.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '2342377423', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The new content for the entity value. For an entity type of `synonyms`, this is the normalized value. For an entity type of `regex`, this is the regular expression.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '书本类型'], ], [ 'name' => 'Synonyms', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The synonym list for the normalized value.', 'type' => 'array', 'items' => ['description' => 'An entity synonym.', 'type' => 'string', 'required' => false, 'example' => '小说', 'title' => ''], 'required' => false, 'maxItems' => 10, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'sDag3g43wesf2', 'title' => ''], 'EntityValueId' => ['description' => 'The ID of the updated entity value.', 'type' => 'integer', 'format' => 'int64', 'example' => '2342377423', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorEntityId.NotExists', 'errorMessage' => 'The business error EntityId is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"sDag3g43wesf2\\",\\n \\"EntityValueId\\": 2342377423\\n}","type":"json"}]', 'title' => 'Entity Member - Modification', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDSEntityValue'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateDoc' => [ 'summary' => 'Updates a 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' => 'The key for the business space. If this parameter is not specified, the default business space is used. You can obtain the key on the Business Management page of your master account.', 'type' => 'string', 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'required' => false, 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'query', 'schema' => ['description' => 'The document ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30001905617'], ], [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'The document category ID.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'required' => false, 'example' => '231001028593'], ], [ 'name' => 'DocName', 'in' => 'query', 'schema' => ['description' => 'The document name.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 1, 'title' => '', 'required' => false, 'example' => '文档问答模块功能说明文档'], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The document title.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 1, 'title' => '', 'required' => false, 'example' => '文档问答功能说明'], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The document content.', 'type' => 'string', 'maxLength' => 40000, 'title' => '', 'required' => false, 'example' => '文档内容'], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => '**Splitter**: The method used to split the document. Valid values: `paragraphSplitter` (splits by paragraph, default) and `treeSplitter` (splits by hierarchical rules).'."\n" ."\n" .'**ChunkSize**: The chunk size. The value must be an integer from 200 to 800. The default value is 500.'."\n" ."\n" .'**TreePatterns**: An array of regular expressions that define the structure for rule-based splitting. The default value is `[]`.'."\n" ."\n" .'**TitleSource**: The source of the document title. Valid values: `ocrTitle` (uses the OCR-recognized title, default) and `docName` (uses the document name as the title).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":""}'], ], [ 'name' => 'Meta', 'in' => 'query', 'schema' => ['description' => 'The metadata of the document, specified as a JSON string.', 'type' => 'string', 'maxLength' => 1000, 'title' => '', 'required' => false, 'example' => '{"code":"xxx"}'], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => ['description' => 'The time when the document becomes effective. Specify the time in UTC, using the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'required' => false, 'example' => '2022-05-25T16:28:36Z', 'title' => ''], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => ['description' => 'The time when the document expires. Specify the time in UTC, using the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'required' => false, 'example' => '2023-03-11T23:59:59Z', 'title' => ''], ], [ 'name' => 'TagIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The tag IDs to associate with the document. Passing an empty array removes all existing tag associations.', 'type' => 'array', 'items' => ['description' => 'A tag ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1201', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'DocMetadata', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BusinessViewId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'BusinessViewName' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'MetaCellInfoDTOList' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'FieldCode' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'FieldName' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'Value' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0F9F136A-1BF6-5CC1-9D57-9717761F03B8'], 'KnowledgeId' => ['description' => 'The knowledge ID of the document.', 'type' => 'integer', 'format' => 'int64', 'example' => '30002406051', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F9F136A-1BF6-5CC1-9D57-9717761F03B8\\",\\n \\"KnowledgeId\\": 30002406051\\n}","type":"json"}]', 'title' => 'Update document', 'changeSet' => [ ['createdAt' => '2024-09-26T12:39:56.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-17T09:42:04.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDoc'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateFaq' => [ 'summary' => 'Updates an existing knowledge entry.', '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' => ['description' => 'The key for the business space. If this parameter is omitted, the default business space is used. You can find this key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the knowledge entry.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30001905617'], ], [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the knowledge entry\'s category.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '30000049006'], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['description' => 'The knowledge title.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '测试标题'], ], [ 'name' => 'StartDate', 'in' => 'formData', 'schema' => ['description' => 'The effective start date and time. The value must be in ISO 8601 format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-05-27T05:18:20Z'], ], [ 'name' => 'EndDate', 'in' => 'formData', 'schema' => ['description' => 'The expiration date and time. The value must be in ISO 8601 format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2030-12-31T16:00:00Z'], ], [ 'name' => 'TagIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of tag IDs.', 'title' => 'list of tag IDs ', 'type' => 'array', 'items' => ['title' => 'tag ID ', 'description' => 'The ID of a tag.', 'type' => 'integer', 'format' => 'int64', 'example' => '25645645', 'required' => false], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '736994BD-AA35-4742-88C9-E64BE4BAA14B', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"736994BD-AA35-4742-88C9-E64BE4BAA14B\\"\\n}","type":"json"}]', 'title' => 'Modify FAQ ', 'changeSet' => [ ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFaq'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateInstance' => [ 'summary' => 'Updates a chatbot\'s name and description.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The unique ID of the chatbot instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-cn-mp90s2lrk00050', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The new name of the chatbot. The maximum length is 50 characters.', 'type' => 'string', 'required' => false, 'example' => '智能客服-小C', 'title' => ''], ], [ 'name' => 'Introduction', 'in' => 'query', 'schema' => ['description' => 'The new description of the chatbot.', 'type' => 'string', 'example' => '用于C端问答的机器人', 'title' => '', 'required' => false], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The workspace key. If you omit this parameter, the default workspace is used. You can get this key from the Business Management page in your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C45BFEE4-F657-1332-8B47-2C757B94C972'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C45BFEE4-F657-1332-8B47-2C757B94C972\\"\\n}","type":"json"}]', 'title' => 'Robot - Update ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateIntent' => [ 'summary' => 'Updates the metadata of a specified intent, including the intent name, alias name, and associated slots. This operation does not modify the intent\'s utterances or LGF.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If you omit this parameter, the system uses the default business space. You can find this key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the chatbot instance.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'IntentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the intent.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '234234234534', 'title' => ''], ], [ 'name' => 'IntentDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The intent definition object.', 'type' => 'object', 'properties' => [ 'IntentName' => ['description' => 'The name of the intent.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '查天气意图'], 'AliasName' => ['description' => 'The alias for the intent.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '查天气意图'], 'SlotInfos' => [ 'title' => '', 'description' => 'A list of slot objects.', 'type' => 'array', 'items' => [ 'description' => 'Information about a slot.', 'type' => 'object', 'properties' => [ 'SlotId' => ['description' => 'The ID of the slot.', 'type' => 'string', 'required' => true, 'example' => 'dgadf23dfg2f', 'title' => ''], 'Name' => ['description' => 'The name of the slot.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '天气'], 'Value' => ['description' => 'The name of the associated entity.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '天气'], 'Interactive' => ['description' => 'Specifies whether the slot is interactive. If true, the chatbot prompts the user for a value if the user does not provide one.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], 'Array' => ['description' => 'Specifies whether the slot can contain an array of values.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], 'Encrypt' => ['description' => 'Specifies whether to enable data masking for the slot value.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The ID of the updated intent.', 'type' => 'integer', 'format' => 'int64', 'example' => '234234234534', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'dfaf23dfas234234234534', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', 'description' => ''], ['errorCode' => 'BusinessErrorIntent.OutRange', 'errorMessage' => 'The business error Intent is out of range.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IntentId\\": 234234234534,\\n \\"RequestId\\": \\"dfaf23dfas234234234534\\"\\n}","type":"json"}]', 'title' => 'Intent - Modify', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntent'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateLgf' => [ 'summary' => 'Updates the advanced semantic feature (LGF) for a specified intent.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key for the business space. If omitted, the default business space is used. You can get the key on the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The bot ID.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'LgfId', 'in' => 'query', 'schema' => ['title' => 'LGF ID', 'description' => 'The 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' => 'The LGF definition.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '23234523522', 'title' => ''], 'RuleText' => ['description' => 'The LGF configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '.{0,10}[天气]'], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'LgfId' => ['description' => 'The unique ID of the LGF.', 'type' => 'integer', 'format' => 'int64', 'example' => '2342556223532', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '289dfa131adf23wqe2r', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error IntentId is not exists.', 'description' => ''], ['errorCode' => '400 BusinessErrorIntentLgfId.NotExists', 'errorMessage' => 'The business error IntentLgfId is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LgfId\\": 2342556223532,\\n \\"RequestId\\": \\"289dfa131adf23wqe2r\\"\\n}","type":"json"}]', 'title' => 'LGF - Modify', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLgf'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdatePerspective' => [ 'summary' => 'Updates a perspective\'s name and description.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'PerspectiveId', 'in' => 'query', 'schema' => ['description' => 'The perspective ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3001', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the perspective. The name must be 50 characters or fewer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '客户端视角', 'title' => ''], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The business space key. If not specified, the default business space is used. You can get the key from the Business Management page of your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FC384CE1-8D42-1900-84E1-F33F990F2B5E', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC384CE1-8D42-1900-84E1-F33F990F2B5E\\"\\n}","type":"json"}]', 'title' => 'Perspective - Update ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePerspective'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateSimQuestion' => [ 'summary' => 'Updates a similar question.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The key of the workspace. If you do not specify this parameter, the default workspace is used. You can find the key on the Business Management page of your master account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['description' => 'The new title of the similar question. The title can be up to 120 characters long.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '测试相似问标题'], ], [ 'name' => 'SimQuestionId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the similar question that you want to update.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '1000002788'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'DFB71B34-4188-4EA2-9988-EF3014E75910', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DFB71B34-4188-4EA2-9988-EF3014E75910\\"\\n}","type":"json"}]', 'title' => 'Update FAQ alternate query', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSimQuestion'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateSolution' => [ 'summary' => 'Updates a solution.', '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' => ['description' => 'The ID of the solution.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-9223372036854775808', 'exclusiveMinimum' => true, 'title' => '', 'example' => '100001333260'], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['description' => 'The content of the solution.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '修改的答案内容'], ], [ 'name' => 'ContentType', 'in' => 'formData', 'schema' => ['description' => 'The content type. Valid values: 0 for plain text and 1 for rich text.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PerspectiveCodes', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '', 'description' => 'A list of perspective codes.', 'type' => 'array', 'items' => ['description' => 'A perspective code.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'required' => true, 'maxItems' => 10, 'example' => '', ], ], [ 'name' => 'TagIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of tag IDs.', 'title' => 'List of tag IDs', 'type' => 'array', 'items' => ['title' => 'Tag ID', 'description' => 'A tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '25645645', 'required' => false], 'required' => false, 'example' => '', ], ], [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The agent key. If you omit this parameter, the default agent is used. You can obtain the key on the Business Management page of your primary account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The return value.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8B8F098D-A338-54DD-B19C-24BBBCBD8498', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B8F098D-A338-54DD-B19C-24BBBCBD8498\\"\\n}","type":"json"}]', 'title' => 'Update FAQ answer', 'changeSet' => [ ['createdAt' => '2025-11-11T13:28:02.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSolution'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], 'UpdateUserSay' => [ 'summary' => 'Modifies an existing user say.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The workspace key. If you omit this parameter, the default workspace is used. You can find this key on the Workspace Management page in your main account.', 'type' => 'string', 'required' => false, 'example' => 'ac627989eb4f8a98ed05fd098bbae5_p_beebot_public', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the bot.', 'type' => 'string', 'required' => true, 'example' => ' chatbot-cn-yjzbyrEvqd', 'title' => ''], ], [ 'name' => 'UserSayId', 'in' => 'query', 'schema' => ['description' => 'The ID of the user say.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '34512323', 'title' => ''], ], [ 'name' => 'UserSayDefinition', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The definition of the user say.', 'type' => 'object', 'properties' => [ 'IntentId' => ['description' => 'The ID of the intent.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '123', 'title' => ''], 'Content' => ['description' => 'The content of the user say.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '做核酸了吗您'], 'SlotInfos' => [ 'title' => '', 'description' => 'An array that contains information for each slot.', 'type' => 'array', 'items' => [ 'description' => 'The information about a slot.', 'type' => 'object', 'properties' => [ 'SlotId' => ['description' => 'The ID of the slot.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '346ffg3q23dv'], 'StartIndex' => ['description' => 'The zero-based start index of the slot within the content of the user say.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], 'EndIndex' => ['description' => 'The zero-based end index (exclusive) of the slot within the content of the user say.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '3'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 10, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ 'UserSayId' => ['description' => 'The ID of the updated user say.', 'type' => 'integer', 'format' => 'int64', 'example' => '34512323', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2356fg3wf34634vdt23wef2', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'BusinessErrorIntentId.NotExists', 'errorMessage' => 'The business error Intent is not exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UserSayId\\": 34512323,\\n \\"RequestId\\": \\"2356fg3wf34634vdt23wef2\\"\\n}","type":"json"}]', 'title' => 'Intent - Utterance - Modify', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserSay'], ], 'product' => ['code' => 'beebot', 'title' => '智能对话机器人'], ], 'ramActions' => [], ], ], 'endpoints' => [ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'chatbot.cn-shanghai.aliyuncs.com', 'endpoint' => 'chatbot.cn-shanghai.aliyuncs.com', 'vpc' => 'chatbot-vpc.cn-shanghai.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => ''], ['code' => 'InstanceFreezing', 'message' => 'The specified instance has been frozen because it has overdue bills.', 'http_code' => 403, 'description' => ''], ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => ''], ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is not valid.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter', 'message' => 'The specified parameter InstanceId is not valid', 'http_code' => 400, 'description' => ''], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BeginSession'], ], 'createdAt' => '2026-03-24T01:58:59.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ListInstance'], ], 'createdAt' => '2026-02-04T11:35:24.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GenerateUserAccessToken'], ['description' => 'Request parameters changed', 'api' => 'InitIMConnect'], ], 'createdAt' => '2025-12-11T03:00:39.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListTongyiConversationLogs'], ], 'createdAt' => '2025-11-25T01:18:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateFaq'], ['description' => 'Request parameters changed', 'api' => 'CreateSolution'], ['description' => 'Response parameters changed', 'api' => 'DescribeFaq'], ['description' => 'Response parameters changed', 'api' => 'ListSolution'], ['description' => 'Request parameters changed', 'api' => 'UpdateFaq'], ['description' => 'Request parameters changed', 'api' => 'UpdateSolution'], ], 'createdAt' => '2025-11-11T13:28:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDoc'], ['description' => 'Response parameters changed', 'api' => 'DescribeDoc'], ['description' => 'Request parameters changed', 'api' => 'UpdateDoc'], ], 'createdAt' => '2024-09-26T12:39:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'GenerateUserAccessToken'], ], 'createdAt' => '2024-08-07T08:16:31.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDoc'], ['description' => 'Response parameters changed', 'api' => 'DescribeDoc'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchDoc'], ['description' => 'Request parameters changed', 'api' => 'UpdateDoc'], ], 'createdAt' => '2024-05-17T09:41:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAgent'], ], 'createdAt' => '2024-05-15T03:39:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'ListAgent'], ], 'createdAt' => '2024-04-16T08:50:07.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'CreateCategory'], ['description' => 'Response parameters changed', 'api' => 'DeleteCategory'], ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeCategory'], ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'ListCategory'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateCategory'], ], 'createdAt' => '2024-02-22T12:09:41.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'BeginSession'], ], 'createdAt' => '2023-12-28T09:28:07.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'Chat'], ], 'createdAt' => '2023-04-27T12:46:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'BeginSession'], ], 'createdAt' => '2023-04-18T12:34:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SearchFaq'], ], 'createdAt' => '2022-12-26T11:43:36.000Z', 'description' => '取消搜索FAQ的类目Id数组的长度限制', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CancelPublishTask'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreatePublishTask'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetPublishTaskState'], ], 'createdAt' => '2022-12-26T11:37:51.000Z', 'description' => '发布中心API，字段描述规划化', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'InitIMConnect'], ], 'createdAt' => '2022-12-26T07:08:11.000Z', 'description' => '开放小蜜IM连接能力', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'Chat'], ], 'createdAt' => '2022-09-01T02:47:47.000Z', 'description' => '问答接口支持表格问答', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'GenerateUserAccessToken'], ], 'createdAt' => '2022-07-25T09:30:29.000Z', 'description' => '修改Nick foreignId字段的必填信息。在文档透出', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'GenerateUserAccessToken'], ], 'createdAt' => '2022-07-25T01:55:32.000Z', 'description' => '增加对字段必填的校验', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'Chat'], ['description' => 'Request parameters changed', 'api' => 'CreateDSEntity'], ], 'createdAt' => '2022-07-21T13:43:35.000Z', 'description' => '5.7.0', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'GenerateUserAccessToken'], ], 'createdAt' => '2022-07-13T04:38:57.000Z', 'description' => '通过基蜜网关暴露服务API', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'GenerateUserAccessToken'], ], 'createdAt' => '2022-07-12T06:38:42.000Z', 'description' => '新增渠道获取用户Token API', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateCategory'], ['description' => 'Response parameters changed', 'api' => 'DeleteInstance'], ], 'createdAt' => '2022-07-07T12:38:08.000Z', 'description' => '1. 创建类目API，父类目参数从必填调整为可选项，默认值为-1，表示根目录2. 删除机器人出参，requestId从byte数组修复为string', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2022-06-20T11:30:03.000Z', 'description' => 'Chatbot新版本2022-04-08调整CreateInstance的LanguageCode字段为选填', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'Chat'], ], 'createdAt' => '2022-06-17T09:22:20.000Z', 'description' => 'Chat新版本2022-04-08 OpenApi发布', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListInstance'], ], 'createdAt' => '2022-06-10T03:14:42.000Z', 'description' => '调整说明', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'LinkInstanceCategory'], ], 'createdAt' => '2022-06-09T13:09:47.000Z', 'description' => 'faq，机器人管理，任务中心新版本2022-04-08 OpenApi发布', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCategory'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinueInstancePublishTask'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSolution'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSimQuestion'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSolution'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSimQuestion'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitIMConnect'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstance'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCategory'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelPublishTask'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstancePublishTaskState'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDSEntity'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLgf'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDSEntity'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLgf'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePerspective'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSolution'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConnQuestion'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIntent'], ['threshold' => '600', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateUserAccessToken'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyForStreamAccessToken'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDSEntity'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSimQuestion'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDoc'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCategory'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BeginSession'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserSay'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDSEntity'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgent'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntent'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePerspective'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFaq'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConnQuestion'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSolution'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncResult'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePublishTask'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LinkInstanceCategory'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntent'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCategory'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserSay'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLgf'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDSEntityValue'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchDoc'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnQuestion'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPublishTaskState'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchFaq'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstancePublishTask'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFaq'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPerspectives'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePerspective'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDoc'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDSEntityValue'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Feedback'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntent'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Nlu'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnQuestion'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Chat'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserSay'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaq'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSaasPermissionGroupInfos'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntent'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDoc'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTongyiChatHistorys'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLgf'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelInstancePublishTask'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSimQuestion'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDSEntityValue'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSaasInfo'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserSay'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePerspective'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentInfo'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBotSessionData'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDSEntityValue'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetryDoc'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFaq'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDSEntity'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Associate'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCategory'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDoc'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], ], 'product' => ['code' => 'beebot', 'title' => 'Chatbot'], ], 'ram' => [ 'productCode' => 'Chatbot', 'productName' => 'Chatbot', 'ramCodes' => ['chatbot'], 'ramLevel' => 'SERVICE', 'ramConditions' => [], 'ramActions' => [], 'resourceTypes' => [], ], ];