{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-chatbot/apply-for-stream-access-token":{"post":{"operationId":"cloud_aliyun_chatbot_apply_for_stream_access_token","summary":"Retrieves the connection information for streaming calls","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not set, the default business space is accessed. You can obtain the key value on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/associate":{"post":{"operationId":"cloud_aliyun_chatbot_associate","summary":"Suggests FAQs from the knowledge base based on a user query","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the robot"},"Utterance":{"type":"string","description":"The user utterance"},"Perspective":{"type":"string","description":"The perspective code, which is used to call answers from different perspectives under the same knowledge title. When assembling request…"},"SessionId":{"type":"string","description":"The session ID, which is used to identify a visitor's session and maintain context information. For a new visitor, you do not need to pass…"},"RecommendNum":{"type":"integer","description":"The number of recommended questions, ranging from 1 to 10. This parameter takes effect only when recommendations are returned. The number…"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/begin-session":{"post":{"operationId":"cloud_aliyun_chatbot_begin_session","summary":"Retrieves the welcome message","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the workspace. If this parameter is not set, the default workspace is accessed. You can obtain the key on the business…"},"InstanceId":{"type":"string","description":"The InstanceId"},"SandBox":{"type":"string","description":"The SandBox"},"VendorParam":{"type":"string","description":"The VendorParam"},"SessionId":{"type":"string","description":"The SessionId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/cancel-chat":{"post":{"operationId":"cloud_aliyun_chatbot_cancel_chat","summary":"Cancels or interrupts a specified conversation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"SessionId":{"type":"string","description":"The session ID, which is used to identify a visitor's session and maintain context information. For a new visitor, you do not need to…"},"ChatId":{"type":"string","description":"The ID that identifies a single conversation"},"InstanceId":{"type":"string","description":"The chatbot ID"},"Type":{"type":"string","description":"The interruption type"},"Answer":{"type":"string","description":"The answer content"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/cancel-instance-publish-task":{"post":{"operationId":"cloud_aliyun_chatbot_cancel_instance_publish_task","summary":"Cancels a chatbot publish task during the publishing process","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"Id":{"type":"integer","description":"The task ID"},"AgentKey":{"type":"string","description":"The key of the business space. If not specified, the default business space is accessed. You can obtain the key on the business management…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/cancel-publish-task":{"post":{"operationId":"cloud_aliyun_chatbot_cancel_publish_task","summary":"Cancels a publish task that is in progress","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"Id":{"type":"integer","description":"The publish task ID"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/chat":{"post":{"operationId":"cloud_aliyun_chatbot_chat","summary":"Initiates a conversation with a chatbot by using the unique chatbot identifier (chatbot ID). This operation…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique chatbot identifier (chatbot ID). Log on to the Chatbot console and navigate to Chatbot Details > Session Interface to view the…"},"Utterance":{"type":"string","description":"The input from the chatbot visitor"},"SessionId":{"type":"string","description":"The session ID, which identifies a visitor's session and maintains context information. For a new visitor, you do not need to pass this…"},"KnowledgeId":{"type":"string","description":"The ID of a knowledge title in the knowledge base. If this ID is specified, the chatbot directly returns the answer for the specified…"},"SenderId":{"type":"string","description":"The visitor ID, which identifies the user in the current session"},"SenderNick":{"type":"string","description":"The nickname of the visitor in the current session"},"IntentName":{"type":"string","description":"The intent name in the dialog flow. If this name is specified, the chatbot directly enters this intent for Q&A"},"Perspective":{"type":"string","description":"The array of perspective codes, which is used to call answers from different perspectives under the same knowledge title. Example:…"},"VendorParam":{"type":"string","description":"A JSON-formatted set of user-defined parameters that can be passed to various dialog engines"},"SandBox":{"type":"string","description":"Specifies whether to use the test or production environment. Default value: false (production environment). Valid values: true: Test…"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. Obtain the key value from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/continue-instance-publish-task":{"post":{"operationId":"cloud_aliyun_chatbot_continue_instance_publish_task","summary":"Ignores alerts and continues publishing when the chatbot triggers a publish alert","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"Id":{"type":"integer","description":"The task ID"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-category":{"post":{"operationId":"cloud_aliyun_chatbot_create_category","summary":"Creates a category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"Name":{"type":"string","description":"The category name"},"BizCode":{"type":"string","description":"The business code"},"KnowledgeType":{"type":"integer","description":"The knowledge type. Valid values: 1: FAQ category. 3: Document category. Default value: 1"},"ParentCategoryId":{"type":"integer","description":"The parent category ID. Default value: -1, which indicates the root directory"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-conn-question":{"post":{"operationId":"cloud_aliyun_chatbot_create_conn_question","summary":"Adds associated knowledge to a knowledge entry","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ConnQuestionId","KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ConnQuestionId":{"type":"integer","description":"The ID of the associated knowledge"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-dsentity":{"post":{"operationId":"cloud_aliyun_chatbot_create_dsentity","summary":"Creates an entity, specifically the meta information of the entity, such as the entity name and entity type","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","EntityName"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not set, the default business space is accessed. You can obtain the key value on the business…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"EntityName":{"type":"string","description":"The entity name. Only Chinese characters, uppercase and lowercase letters, digits, and underscores are supported"},"EntityType":{"type":"string","description":"The entity type. Valid values: synonyms: synonym. regex: regular expression"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-dsentity-value":{"post":{"operationId":"cloud_aliyun_chatbot_create_dsentity_value","summary":"Adds entity member information for a specified entity, including the entity value and the corresponding…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","EntityId","Content"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key value on the…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"EntityId":{"type":"integer","description":"The entity ID. This parameter can be left empty when you modify an entity member"},"Content":{"type":"string","description":"The entity value or regular expression"},"Synonyms":{"type":"string","description":"The synonym list (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-doc":{"post":{"operationId":"cloud_aliyun_chatbot_create_doc","summary":"Creates a document","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CategoryId","Title"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"CategoryId":{"type":"integer","description":"The document category ID"},"Title":{"type":"string","description":"The document title"},"Content":{"type":"string","description":"The document content. Specify either this parameter or URL"},"Config":{"type":"string","description":"The document parsing and chunking configuration. Configuration item: Splitter KEY: Splitter Valid values: ParagraphSplitter:…"},"Meta":{"type":"string","description":"The document metadata"},"StartDate":{"type":"string","description":"The effective start time in UTC"},"EndDate":{"type":"string","description":"The effective end time in UTC"},"Url":{"type":"string","description":"The URL of the document. Specify either this parameter or Content. Supported formats: txt, pdf, markdown, doc, and docx. Limits for a…"},"TagIds":{"type":"string","description":"The list of tag IDs (JSON-encoded)"},"DocMetadata":{"type":"string","description":"The DocMetadata (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-faq":{"post":{"operationId":"cloud_aliyun_chatbot_create_faq","summary":"Creates a knowledge entry","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CategoryId","Title"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not set, the default business space is accessed. You can obtain the key value from the…"},"CategoryId":{"type":"integer","description":"The category ID of the knowledge entry"},"Title":{"type":"string","description":"The title of the knowledge entry. Maximum length: 120 characters"},"StartDate":{"type":"string","description":"The effective period"},"EndDate":{"type":"string","description":"The expiration time"},"SolutionContent":{"type":"string","description":"The default answer content. This parameter is required if the fallback perspective is enabled"},"SolutionType":{"type":"integer","description":"The type of the default answer. Valid values: 0: plain text. 1: rich text"},"TagIdList":{"type":"string","description":"The list of label IDs (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-instance":{"post":{"operationId":"cloud_aliyun_chatbot_create_instance","summary":"Creates a chatbot in a sandbox environment","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"Name":{"type":"string","description":"The name of the chatbot. The name can be up to 50 characters in length"},"LanguageCode":{"type":"string","description":"The language of the chatbot service, such as zh-cn or en-us. Default value: the default language of the workspace. Valid values: the…"},"Introduction":{"type":"string","description":"The description of the chatbot. The description can be up to 50 characters in length"},"RobotType":{"type":"string","description":"The type of the chatbot. Default value: scenario_im"},"AgentKey":{"type":"string","description":"The workspace key. If this parameter is not specified, the default workspace is accessed. Obtain the key value from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-instance-publish-task":{"post":{"operationId":"cloud_aliyun_chatbot_create_instance_publish_task","summary":"Publishes a sandbox chatbot to the production environment","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot instance"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key from the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-intent":{"post":{"operationId":"cloud_aliyun_chatbot_create_intent","summary":"Creates an intent. The intent includes meta information such as the intent name, intent alias, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not set, the default business space is accessed. You can obtain the key value on the business…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"IntentDefinition":{"type":"string","description":"The intent definition struct (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-lgf":{"post":{"operationId":"cloud_aliyun_chatbot_create_lgf","summary":"Creates an advanced semantic configuration (LGF) for a specified intent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"InstanceId":{"type":"string","description":"The robot ID"},"LgfDefinition":{"type":"string","description":"The LGF definition information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-perspective":{"post":{"operationId":"cloud_aliyun_chatbot_create_perspective","summary":"Creates a perspective","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"Name":{"type":"string","description":"The name of the perspective. The name can be up to 50 characters in length"},"Description":{"type":"string","description":"The description of the perspective"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key from the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-publish-task":{"post":{"operationId":"cloud_aliyun_chatbot_create_publish_task","summary":"Creates a publish task in the publish center","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"BizType":{"type":"string","description":"The publish unit type. To publish a chatbot, use the CreateInstancePublishTask API"},"DataIdList":{"type":"string","description":"Additional publish information. Currently supported: if BizType is faq, this field specifies category IDs, indicating that only knowledge…"},"AgentKey":{"type":"string","description":"The workspace key. If not specified, the default workspace is accessed. Obtain the key value from the business management page of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-sim-question":{"post":{"operationId":"cloud_aliyun_chatbot_create_sim_question","summary":"Creates a similar question","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId","Title"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"},"Title":{"type":"string","description":"The title of the similar question. The maximum length is 120 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-solution":{"post":{"operationId":"cloud_aliyun_chatbot_create_solution","summary":"Creates a knowledge answer","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId","Content","PerspectiveCodes"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"},"Content":{"type":"string","description":"The content of the answer"},"ContentType":{"type":"integer","description":"The type of the answer. Valid values: 0: plain text. 1: rich text"},"PerspectiveCodes":{"type":"string","description":"The list of perspective codes (JSON-encoded)"},"TagIdList":{"type":"string","description":"The list of tag IDs (JSON-encoded)"},"AgentKey":{"type":"string","description":"The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-tag":{"post":{"operationId":"cloud_aliyun_chatbot_create_tag","summary":"Creates a label","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TagName","GroupId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The idempotence parameter"},"TagName":{"type":"string","description":"The name of the label group"},"GroupId":{"type":"integer","description":"The ID of the label group"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-tag-group":{"post":{"operationId":"cloud_aliyun_chatbot_create_tag_group","summary":"Creates a tag group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupName"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The client token for idempotence"},"GroupName":{"type":"string","description":"The name of the tag group"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/create-user-say":{"post":{"operationId":"cloud_aliyun_chatbot_create_user_say","summary":"Adds utterance information to a specified intent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"UserSayDefinition":{"type":"string","description":"The user utterance definition information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-category":{"post":{"operationId":"cloud_aliyun_chatbot_delete_category","summary":"Deletes a category. A published category changes to the deleted and unpublished state, while an unpublished…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CategoryId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"CategoryId":{"type":"integer","description":"The category ID"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-conn-question":{"post":{"operationId":"cloud_aliyun_chatbot_delete_conn_question","summary":"Deletes the associated knowledge of a knowledge item","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OutlineId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"OutlineId":{"type":"integer","description":"The ID of the association"},"AgentKey":{"type":"string","description":"The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-dsentity":{"post":{"operationId":"cloud_aliyun_chatbot_delete_dsentity","summary":"Deletes an entity. This operation cascade deletes all entity members, synonyms, and regular expressions…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","EntityId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"Business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page of…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"EntityId":{"type":"integer","description":"The entity ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-dsentity-value":{"post":{"operationId":"cloud_aliyun_chatbot_delete_dsentity_value","summary":"Deletes a member of a specified entity. If the entity is a standard entity, the synonyms of the member are…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","EntityId","EntityValueId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business…"},"InstanceId":{"type":"string","description":"The robot ID"},"EntityId":{"type":"integer","description":"The entity ID"},"EntityValueId":{"type":"integer","description":"The entity member ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-doc":{"post":{"operationId":"cloud_aliyun_chatbot_delete_doc","summary":"Deletes a document","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not set, the default business space is accessed. You can obtain the key on the…"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-faq":{"post":{"operationId":"cloud_aliyun_chatbot_delete_faq","summary":"Deletes a knowledge entry","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-instance":{"post":{"operationId":"cloud_aliyun_chatbot_delete_instance","summary":"Deletes a chatbot from both the sandbox and production environments","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-intent":{"post":{"operationId":"cloud_aliyun_chatbot_delete_intent","summary":"Deletes an intent and cascade deletes all intent utterances and advanced semantic configurations (LGF) under…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","IntentId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the…"},"InstanceId":{"type":"string","description":"The robot ID"},"IntentId":{"type":"integer","description":"The intent ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-lgf":{"post":{"operationId":"cloud_aliyun_chatbot_delete_lgf","summary":"Deletes a specified advanced semantic configuration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","IntentId","LgfId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value on the business management…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"IntentId":{"type":"integer","description":"The intent ID"},"LgfId":{"type":"integer","description":"lgf Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-perspective":{"post":{"operationId":"cloud_aliyun_chatbot_delete_perspective","summary":"Deletes a perspective","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"PerspectiveId":{"type":"string","description":"The perspective ID"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-sim-question":{"post":{"operationId":"cloud_aliyun_chatbot_delete_sim_question","summary":"Deletes a similar question","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SimQuestionId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"SimQuestionId":{"type":"integer","description":"The ID of the similar question"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-solution":{"post":{"operationId":"cloud_aliyun_chatbot_delete_solution","summary":"Deletes an answer","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SolutionId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"SolutionId":{"type":"integer","description":"The ID of the answer"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-tag":{"post":{"operationId":"cloud_aliyun_chatbot_delete_tag","summary":"Deletes a tag","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","GroupId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The idempotence parameter"},"Id":{"type":"integer","description":"The tag ID"},"GroupId":{"type":"integer","description":"The tag group ID"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-tag-group":{"post":{"operationId":"cloud_aliyun_chatbot_delete_tag_group","summary":"Deletes a tag group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The idempotence parameter"},"Id":{"type":"integer","description":"The ID of the tag group"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/delete-user-say":{"post":{"operationId":"cloud_aliyun_chatbot_delete_user_say","summary":"Modifies the utterance information of an intent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","IntentId","UserSayId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not set, the default business space is accessed. You can obtain the key value on the business…"},"InstanceId":{"type":"string","description":"The robot ID"},"IntentId":{"type":"integer","description":"The intent ID"},"UserSayId":{"type":"integer","description":"The utterance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-category":{"post":{"operationId":"cloud_aliyun_chatbot_describe_category","summary":"Queries the information of a single category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CategoryId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"CategoryId":{"type":"integer","description":"The category ID"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-dsentity":{"post":{"operationId":"cloud_aliyun_chatbot_describe_dsentity","summary":"Queries the metadata of a specified entity under a specified chatbot, such as entity type, entity name,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","EntityId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not set, the default business space is accessed. Obtain the key value from the business…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"EntityId":{"type":"integer","description":"The entity ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-doc":{"post":{"operationId":"cloud_aliyun_chatbot_describe_doc","summary":"Queries the details of a document","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"},"ShowDetail":{"type":"string","description":"Specifies whether to display detailed paragraph information of the document. Valid values: true: Display. false: Ignore (default)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-faq":{"post":{"operationId":"cloud_aliyun_chatbot_describe_faq","summary":"Queries the details of a knowledge entry","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-instance":{"post":{"operationId":"cloud_aliyun_chatbot_describe_instance","summary":"Queries the details of a chatbot","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-intent":{"post":{"operationId":"cloud_aliyun_chatbot_describe_intent","summary":"Returns the metadata of a specified intent, such as the intent type, intent name, creation time, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","IntentId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"IntentId":{"type":"integer","description":"The intent ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-perspective":{"post":{"operationId":"cloud_aliyun_chatbot_describe_perspective","summary":"Queries the details of a perspective","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"PerspectiveId":{"type":"string","description":"The perspective ID"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-tag":{"post":{"operationId":"cloud_aliyun_chatbot_describe_tag","summary":"Retrieves the details of a tag","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","GroupId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The idempotence parameter"},"Id":{"type":"integer","description":"The tag ID"},"GroupId":{"type":"integer","description":"The tag group ID"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/describe-tag-group":{"post":{"operationId":"cloud_aliyun_chatbot_describe_tag_group","summary":"Retrieves the details of a tag group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The idempotence parameter"},"Id":{"type":"integer","description":"The ID of the tag group"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/feedback":{"post":{"operationId":"cloud_aliyun_chatbot_feedback","summary":"Saves user feedback on Q&A results","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"MessageId":{"type":"string","description":"The ID that uniquely identifies a single message in a session window"},"Feedback":{"type":"string","description":"The feedback type, which corresponds to the FeedbackType field in the session history API. Valid values: good: Like. bad: Dislike"},"SessionId":{"type":"string","description":"The session ID that uniquely identifies an IM session"},"FeedbackContent":{"type":"string","description":"The content of the like or dislike feedback. You can directly enter the feedback content or pass in a JSON string as shown in the example.…"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/generate-user-access-token":{"post":{"operationId":"cloud_aliyun_chatbot_generate_user_access_token","summary":"Retrieves a token for passwordless logon in the chat window, which carries the enterprise identity of the user","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ForeignId","Nick"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ExpireTime":{"type":"integer","description":"Reserved parameter. You do not need to specify this parameter"},"AgentKey":{"type":"string","description":"The key of the business space. If you do not specify this parameter, the default business space is accessed. You can obtain the key value…"},"ExtraInfo":{"type":"string","description":"The additional information in JSON string format"},"Email":{"type":"string","description":"The Email"},"Telephone":{"type":"string","description":"The Telephone"},"ForeignId":{"type":"string","description":"The external user ID"},"Nick":{"type":"string","description":"The nickname of the visitor"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/get-agent-info":{"post":{"operationId":"cloud_aliyun_chatbot_get_agent_info","summary":"Retrieves the business space ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/get-async-result":{"post":{"operationId":"cloud_aliyun_chatbot_get_async_result","summary":"Retrieves the result of an asynchronous service execution. This operation is used together with the Chat…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"TaskId":{"type":"string","description":"The task ID of the asynchronous service"},"AgentKey":{"type":"string","description":"The workspace key. If not specified, the default workspace is accessed. Obtain the key value from the business management page of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/get-bot-session-data":{"post":{"operationId":"cloud_aliyun_chatbot_get_bot_session_data","summary":"Queries the overview metrics of chatbot Q&A","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartTime","EndTime","RobotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"StartTime":{"type":"string","description":"The start time of the query. The time format is yyyyMMdd, such as 20240505"},"EndTime":{"type":"string","description":"The end time of the query. The time format is yyyyMMdd, such as 20240605"},"RobotInstanceId":{"type":"string","description":"The ID of the chatbot instance"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/get-instance-publish-task-state":{"post":{"operationId":"cloud_aliyun_chatbot_get_instance_publish_task_state","summary":"Queries the publish progress of a chatbot","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"Id":{"type":"integer","description":"The task ID"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/get-publish-task-state":{"post":{"operationId":"cloud_aliyun_chatbot_get_publish_task_state","summary":"Queries the publish progress","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"Id":{"type":"integer","description":"The ID of the publish task"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. Obtain the key value from the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/init-imconnect":{"post":{"operationId":"cloud_aliyun_chatbot_init_imconnect","summary":"Initializes an IM connection with custom settings by using the from value generated from the channel backend…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["From"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"From":{"type":"string","description":"The From"},"UserAccessToken":{"type":"string","description":"The UserAccessToken"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/link-instance-category":{"post":{"operationId":"cloud_aliyun_chatbot_link_instance_category","summary":"Associates knowledge categories with a chatbot","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"CategoryIds":{"type":"string","description":"The array of FAQ category IDs to associate with the chatbot"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key on the business…"},"AbilityType":{"type":"string","description":"The capability type of the category. Valid values: FAQ: Frequently asked questions. MRC: Document-based machine reading comprehension.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-agent":{"post":{"operationId":"cloud_aliyun_chatbot_list_agent","summary":"Retrieves the list of business spaces for the current Alibaba Cloud account","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"PageNumber":{"type":"integer","description":"The current page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of records per page in the response. Maximum value: 100. Default value: 10"},"AgentName":{"type":"string","description":"The business space name. You can use this parameter to search by name"},"GoodsCodes":{"type":"string","description":"The commodity code. You can use this parameter to filter by commodity code and query instance information"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-category":{"post":{"operationId":"cloud_aliyun_chatbot_list_category","summary":"Retrieves the list of categories","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"KnowledgeType":{"type":"integer","description":"The knowledge type. Valid values: 1: FAQ category. 3: Document category. Default value: 1"},"ParentCategoryId":{"type":"integer","description":"The ID of the parent category"},"AgentKey":{"type":"string","description":"The key of the business space. If not specified, the default business space is accessed. Obtain the key value from the business management…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-conn-question":{"post":{"operationId":"cloud_aliyun_chatbot_list_conn_question","summary":"Queries the list of associated questions for a knowledge item","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-dsentity":{"post":{"operationId":"cloud_aliyun_chatbot_list_dsentity","summary":"Queries the list of entities under a specified chatbot. Only the metadata of each entity is returned, such…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"Keyword":{"type":"string","description":"The filter keyword. Uses contains matching. Scope: entity name (future expansion: entity members, synonyms)"},"EntityType":{"type":"string","description":"If left empty, all custom entities are returned (default)"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-dsentity-value":{"post":{"operationId":"cloud_aliyun_chatbot_list_dsentity_value","summary":"Queries the list and details of entity members for a specified entity. Keyword filtering (contains) is…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","EntityId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"EntityId":{"type":"integer","description":"The entity ID"},"EntityValueId":{"type":"integer","description":"The entity member ID"},"Keyword":{"type":"string","description":"The search keyword for the entity member name"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The page size"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-instance":{"post":{"operationId":"cloud_aliyun_chatbot_list_instance","summary":"Queries the list of chatbots","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"PageNumber":{"type":"integer","description":"The page number for pagination. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"RobotType":{"type":"string","description":"Filters chatbots by type"},"Name":{"type":"string","description":"Performs a fuzzy match by chatbot name"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page…"},"Sandbox":{"type":"string","description":"The Sandbox"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-intent":{"post":{"operationId":"cloud_aliyun_chatbot_list_intent","summary":"Queries the list of intents under a specified chatbot. Only the metadata of each intent is returned, such as…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"IntentName":{"type":"string","description":"The intent name"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-lgf":{"post":{"operationId":"cloud_aliyun_chatbot_list_lgf","summary":"Queries the advanced semantic configuration (LGF) of a specified intent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","IntentId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"IntentId":{"type":"integer","description":"The intent ID"},"LgfText":{"type":"string","description":"The semantic configuration content to filter"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-saas-info":{"post":{"operationId":"cloud_aliyun_chatbot_list_saas_info","summary":"Retrieves the list of SaaS integration information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SaasName"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the…"},"SaasName":{"type":"string","description":"The username of the business party"},"SaasGroupCodes":{"type":"string","description":"The SaaS permission group codes owned by the user. Separate multiple codes with commas (,)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-saas-permission-group-infos":{"post":{"operationId":"cloud_aliyun_chatbot_list_saas_permission_group_infos","summary":"Retrieves the list of permission integration information. You can use the permission groups returned in this…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AgentKey"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business workspace key. If this parameter is not specified, the default business workspace is accessed. You can obtain the key value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-sim-question":{"post":{"operationId":"cloud_aliyun_chatbot_list_sim_question","summary":"Queries the list of similar questions for a knowledge entry","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The workspace key. If not specified, the default workspace is accessed. You can obtain the key value on the business management page of…"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-solution":{"post":{"operationId":"cloud_aliyun_chatbot_list_solution","summary":"Queries the list of answers for a knowledge item","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"},"AgentKey":{"type":"string","description":"The key of the business space. If not specified, the default business space is accessed. Obtain the key value from the business management…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-tag":{"post":{"operationId":"cloud_aliyun_chatbot_list_tag","summary":"Queries tags","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The client token"},"TagName":{"type":"string","description":"The tag name"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"AgentKey":{"type":"string","description":"AgentKey"},"GroupId":{"type":"integer","description":"The ID of the tag group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-tag-group":{"post":{"operationId":"cloud_aliyun_chatbot_list_tag_group","summary":"Queries tag groups","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The client token for idempotency"},"GroupName":{"type":"string","description":"The name of the tag group"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-tongyi-chat-historys":{"post":{"operationId":"cloud_aliyun_chatbot_list_tongyi_chat_historys","summary":"Retrieves the session history details","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartTime","EndTime","RobotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"StartTime":{"type":"string","description":"The start time of the query. The time is in the yyyy-MM-dd HH:mm:ss format, such as 2024-04-01 00:00:00"},"EndTime":{"type":"string","description":"The end time of the query. The time is in the yyyy-MM-dd HH:mm:ss format, such as 2024-04-01 08:00:00"},"RobotInstanceId":{"type":"string","description":"The ID of the robot instance"},"Limit":{"type":"integer","description":"The number of data entries. Default value: 30. Maximum value: 500"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key value on…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-tongyi-conversation-logs":{"post":{"operationId":"cloud_aliyun_chatbot_list_tongyi_conversation_logs","summary":"Queries the conversation records of a single session for Chatbot Tongyi Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RobotInstanceId","SessionId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"RobotInstanceId":{"type":"string","description":"The robot instance ID"},"SessionId":{"type":"string","description":"The session ID"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/list-user-say":{"post":{"operationId":"cloud_aliyun_chatbot_list_user_say","summary":"Queries the utterance content and associated slot information of a specified intent. Supports filtering…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","IntentId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"IntentId":{"type":"integer","description":"The intent ID"},"Content":{"type":"string","description":"The keyword used to filter user utterances"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 1000"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/nlu":{"post":{"operationId":"cloud_aliyun_chatbot_nlu","summary":"Returns the natural language understanding (NLU) result of a chatbot for a user query. Currently, only NLU…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"Utterance":{"type":"string","description":"The user utterance"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key on the business management page…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/query-perspectives":{"post":{"operationId":"cloud_aliyun_chatbot_query_perspectives","summary":"Queries the list of perspectives","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/retry-doc":{"post":{"operationId":"cloud_aliyun_chatbot_retry_doc","summary":"Retries document processing","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business…"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/search-doc":{"post":{"operationId":"cloud_aliyun_chatbot_search_doc","summary":"Searches for documents","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"},"Keyword":{"type":"string","description":"The keyword"},"CategoryIds":{"type":"string","description":"The list of category IDs (JSON-encoded)"},"ProcessStatus":{"type":"integer","description":"The task status. Valid values: -1: queued 0: succeeded 1: parsing 2: processing 3: processing failed"},"Status":{"type":"integer","description":"The editing status. Valid values: 1: unpublished 2: published 3: updated but not published"},"SearchScope":{"type":"integer","description":"The search scope. Valid values: 1: search by title 2: search by content"},"CreateUserName":{"type":"string","description":"The name of the creator"},"ModifyUserName":{"type":"string","description":"The name of the modifier"},"CreateTimeBegin":{"type":"string","description":"The start of the creation time range"},"CreateTimeEnd":{"type":"string","description":"The end of the creation time range"},"ModifyTimeBegin":{"type":"string","description":"The start of the modification time range"},"ModifyTimeEnd":{"type":"string","description":"The end of the modification time range"},"StartTimeBegin":{"type":"string","description":"The start of the effective time range"},"StartTimeEnd":{"type":"string","description":"The end of the effective time range"},"EndTimeBegin":{"type":"string","description":"The start of the expiration time range"},"EndTimeEnd":{"type":"string","description":"The end of the expiration time range"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"},"TagIds":{"type":"string","description":"The list of label IDs. When multiple labels are specified, the union logic is used for filtering (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/search-faq":{"post":{"operationId":"cloud_aliyun_chatbot_search_faq","summary":"Searches for knowledge","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page…"},"Keyword":{"type":"string","description":"The keyword"},"CategoryIds":{"type":"string","description":"The unique identifier of the category (JSON-encoded)"},"Status":{"type":"integer","description":"The knowledge status. Valid values: -1: deleted and unpublished. 1: unpublished. 2: published. 3: updated and unpublished"},"SearchScope":{"type":"integer","description":"The search scope. Valid values: 1: Search titles and similar questions. 2: Search answers. 3: Search all"},"CreateUserName":{"type":"string","description":"The name of the creator"},"ModifyUserName":{"type":"string","description":"The name of the modifier"},"CreateTimeBegin":{"type":"string","description":"The start of the creation time range"},"CreateTimeEnd":{"type":"string","description":"The end of the creation time range"},"ModifyTimeBegin":{"type":"string","description":"The start of the modification time range"},"ModifyTimeEnd":{"type":"string","description":"The end of the modification time range"},"StartTimeBegin":{"type":"string","description":"The start of the effective time range"},"StartTimeEnd":{"type":"string","description":"The end of the effective time range"},"EndTimeBegin":{"type":"string","description":"The start of the expiration time range"},"EndTimeEnd":{"type":"string","description":"The end of the expiration time range"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/tongyi-chat-debug-info":{"post":{"operationId":"cloud_aliyun_chatbot_tongyi_chat_debug_info","summary":"Retrieves the debugging information for large language model Q&A","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","MessageId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the workspace. If you do not specify this parameter, the default workspace is accessed. You can obtain the key value from the…"},"InstanceId":{"type":"string","description":"The ID of the chatbot"},"MessageId":{"type":"string","description":"The ID of the response message for the current session"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-category":{"post":{"operationId":"cloud_aliyun_chatbot_update_category","summary":"Updates a category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CategoryId","Name"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"CategoryId":{"type":"integer","description":"The category ID"},"BizCode":{"type":"string","description":"The business code"},"Name":{"type":"string","description":"The category name"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. Obtain the key value from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-conn-question":{"post":{"operationId":"cloud_aliyun_chatbot_update_conn_question","summary":"Updates an association","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ConnQuestionId","OutlineId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ConnQuestionId":{"type":"integer","description":"The ID of the associated knowledge"},"OutlineId":{"type":"integer","description":"The ID of the association"},"AgentKey":{"type":"string","description":"The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-dsentity":{"post":{"operationId":"cloud_aliyun_chatbot_update_dsentity","summary":"Modifies the meta information of an entity. Only the entity name can be modified. The entity type cannot be…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","EntityId","EntityName"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not set, the default business space is accessed. You can obtain the key value from the…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"EntityId":{"type":"integer","description":"The entity ID"},"EntityName":{"type":"string","description":"The entity name. Only Chinese characters, uppercase and lowercase letters, digits, and underscores are supported"},"EntityType":{"type":"string","description":"The entity type. Valid values: synonyms (synonym) and regex (regular expression)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-dsentity-value":{"post":{"operationId":"cloud_aliyun_chatbot_update_dsentity_value","summary":"Modifies a member of a specified entity. Two types of data can be modified: entity values with synonyms, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","EntityId","EntityValueId","Content"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not set, the default business space is accessed. Obtain the key value from the business…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"EntityId":{"type":"integer","description":"The entity ID. This parameter can be left empty when you modify an entity member"},"EntityValueId":{"type":"integer","description":"The entity member ID. This parameter is left empty when you create an entity member"},"Content":{"type":"string","description":"When the entity type is synonyms, this parameter specifies the normalized value of the entity. When the entity type is regex, this…"},"Synonyms":{"type":"string","description":"The list of synonyms (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-doc":{"post":{"operationId":"cloud_aliyun_chatbot_update_doc","summary":"Updates a document","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"KnowledgeId":{"type":"integer","description":"The document ID"},"CategoryId":{"type":"integer","description":"The document category ID"},"DocName":{"type":"string","description":"The document name"},"Title":{"type":"string","description":"The document title"},"Content":{"type":"string","description":"The document content"},"Config":{"type":"string","description":"The document parsing/chunking configuration. Configuration item: Splitter KEY: Splitter Valid values: paragraphSplitter - hierarchy…"},"Meta":{"type":"string","description":"The document metadata"},"StartDate":{"type":"string","description":"The start of the effective period"},"EndDate":{"type":"string","description":"The end of the effective period"},"TagIds":{"type":"string","description":"The list of tag IDs. If this parameter is left empty, the tag bindings are removed (JSON-encoded)"},"DocMetadata":{"type":"string","description":"The DocMetadata (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-faq":{"post":{"operationId":"cloud_aliyun_chatbot_update_faq","summary":"Edits a knowledge entry","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeId","CategoryId","Title"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The workspace key. If not specified, the default workspace is accessed. You can obtain the key value from the business management page of…"},"KnowledgeId":{"type":"integer","description":"The knowledge ID"},"CategoryId":{"type":"integer","description":"The category ID of the knowledge entry"},"Title":{"type":"string","description":"The title of the knowledge entry"},"StartDate":{"type":"string","description":"The effective period"},"EndDate":{"type":"string","description":"The expiration time"},"TagIdList":{"type":"string","description":"The list of tag IDs (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-instance":{"post":{"operationId":"cloud_aliyun_chatbot_update_instance","summary":"Updates the name and description of a chatbot","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"InstanceId":{"type":"string","description":"The unique identifier of the chatbot"},"Name":{"type":"string","description":"The name of the chatbot to update. The name can be up to 50 characters in length"},"Introduction":{"type":"string","description":"The remarks of the chatbot to update"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-intent":{"post":{"operationId":"cloud_aliyun_chatbot_update_intent","summary":"Modifies an intent, including the meta information of the intent, such as the intent name, intent alias, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","IntentId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"IntentId":{"type":"integer","description":"The intent ID"},"IntentDefinition":{"type":"string","description":"The intent definition struct (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-lgf":{"post":{"operationId":"cloud_aliyun_chatbot_update_lgf","summary":"Creates an advanced semantic configuration (LGF) for a specified intent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","LgfId","LgfDefinition"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business…"},"InstanceId":{"type":"string","description":"The chatbot ID"},"LgfId":{"type":"integer","description":"LGF ID"},"LgfDefinition":{"type":"string","description":"The LGF information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-perspective":{"post":{"operationId":"cloud_aliyun_chatbot_update_perspective","summary":"Updates the name and description of a perspective","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"PerspectiveId":{"type":"string","description":"The perspective ID"},"Name":{"type":"string","description":"The perspective name. The name can be up to 50 characters in length"},"AgentKey":{"type":"string","description":"The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-sim-question":{"post":{"operationId":"cloud_aliyun_chatbot_update_sim_question","summary":"Updates a similar question","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Title","SimQuestionId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the…"},"Title":{"type":"string","description":"The title of the similar question. The maximum length is 120 characters"},"SimQuestionId":{"type":"integer","description":"The ID of the similar question"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-solution":{"post":{"operationId":"cloud_aliyun_chatbot_update_solution","summary":"Updates an answer","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SolutionId","Content","PerspectiveCodes"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"SolutionId":{"type":"integer","description":"The answer ID"},"Content":{"type":"string","description":"The answer content"},"ContentType":{"type":"integer","description":"The answer type. Valid values: 0: plain text 1: rich text"},"PerspectiveCodes":{"type":"string","description":"The list of perspective codes (JSON-encoded)"},"TagIdList":{"type":"string","description":"The list of tag IDs (JSON-encoded)"},"AgentKey":{"type":"string","description":"The workspace key. If this parameter is not specified, the default workspace is accessed. You can obtain the key from the business…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-tag":{"post":{"operationId":"cloud_aliyun_chatbot_update_tag","summary":"Updates a tag","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TagName","Id","GroupId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The idempotence parameter"},"TagName":{"type":"string","description":"The tag name"},"Id":{"type":"integer","description":"The tag ID"},"GroupId":{"type":"integer","description":"The tag group ID"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-tag-group":{"post":{"operationId":"cloud_aliyun_chatbot_update_tag_group","summary":"Updates a label group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupName","Id"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"ClientToken":{"type":"string","description":"The idempotence parameter"},"GroupName":{"type":"string","description":"The name of the label group"},"Id":{"type":"integer","description":"The ID of the label group"},"AgentKey":{"type":"string","description":"AgentKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/update-user-say":{"post":{"operationId":"cloud_aliyun_chatbot_update_user_say","summary":"Modifies the utterance information of an intent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","UserSayId"],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"},"AgentKey":{"type":"string","description":"The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the…"},"InstanceId":{"type":"string","description":"The robot ID"},"UserSayId":{"type":"integer","description":"The user utterance ID"},"UserSayDefinition":{"type":"string","description":"The definition of the user utterance (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-chatbot/version":{"post":{"operationId":"cloud_aliyun_chatbot_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://chatbot.cn-shanghai.aliyuncs.com"],"default":"https://chatbot.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}