The ALIYUN::AppFlow::Chatbot resource is used to create a chatbot.
Syntax
{
"Type": "ALIYUN::AppFlow::Chatbot",
"Properties": {
"ChatbotName": String,
"ChatbotIcon": String,
"ChatbotDesc": String,
"TemplateId": String,
"From": String,
"ChatbotConfig": Map
}
}Properties
Property | Type | Required | Editable | Description | Constraints |
ChatbotName | String | Yes | No | The name of the chatbot. | None |
ChatbotIcon | String | No | Yes | The icon of the chatbot. | None |
ChatbotDesc | String | No | Yes | The description of the chatbot. | None |
ChatbotConfig | Map | No | No | The AI assistant configuration. | For more information, see ChatbotConfig properties. |
From | String | No | No | The source of the request. | None |
TemplateId | String | No | No | The ID of the configuration template for the chatbot. | None |
ChatbotConfig syntax
"ChatbotConfig": {
"Config": Map,
"Welcome": String
}ChatbotConfig properties
Property | Type | Required | Editable | Description | Constraints |
Config | Map | No | No | The AI assistant configuration information. | For more information, see Config properties. |
Welcome | String | No | No | The welcome message of the chatbot. | None |
Config syntax
"ChatbotConfig": {
"HistoryCount": Integer,
"SlsLogEnabled": Boolean,
"Prompt": String,
"ShowDocumentReference": Boolean,
"Input": String,
"SlsProjectInfo": Map,
"Questions": List
}Config properties
Property | Type | Required | Editable | Description | Constraints |
HistoryCount | Integer | No | No | The number of contextual messages to retain. | None |
SlsLogEnabled | Boolean | No | No | Specifies whether to enable SLS logging. | None |
Prompt | String | No | No | The conversational context or background prompt. | None |
ShowDocumentReference | Boolean | No | No | Specifies whether to display document references. | None |
Input | String | No | No | The placeholder text for the input box. | None |
SlsProjectInfo | Map | No | No | The SLS project configuration information. | For more information, see SlsProjectInfo properties. |
Questions | List | No | No | The predefined questions for the chatbot. | None |
SlsProjectInfo syntax
"SlsProjectInfo": {
"LogStoreName": String,
"ProjectName": String,
"RegionId": String
}SlsProjectInfo properties
Property | Type | Required | Editable | Description | Constraints |
LogStoreName | String | No | No | The name of the Logstore. | None |
ProjectName | String | No | No | The name of the SLS project. | None |
RegionId | String | No | No | The region where the SLS project resides. | None |
Return value
Fn::GetAtt
ChatbotId: The ID of the chatbot.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
ChatbotName:
Type: String
Description:
en: The name of the chatbot.
Required: true
Resources:
Chatbot:
Type: ALIYUN::AppFlow::Chatbot
Properties:
ChatbotName:
Ref: ChatbotName
Outputs:
ChatbotId:
Description: The ID of the chatbot.
Value:
Fn::GetAtt:
- Chatbot
- ChatbotId
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"ChatbotName": {
"Type": "String",
"Description": {
"en": "The name of the chatbot."
},
"Required": true
}
},
"Resources": {
"Chatbot": {
"Type": "ALIYUN::AppFlow::Chatbot",
"Properties": {
"ChatbotName": {
"Ref": "ChatbotName"
}
}
}
},
"Outputs": {
"ChatbotId": {
"Description": "The ID of the chatbot.",
"Value": {
"Fn::GetAtt": [
"Chatbot",
"ChatbotId"
]
}
}
}
}