ALIYUN::AppFlow::Chatbot资源类型定义与示例-资源编排-阿里云

ALIYUN::AppFlow::Chatbot类型用于创建Chatbot。

语法

{
  "Type": "ALIYUN::AppFlow::Chatbot",
  "Properties": {
    "ChatbotName": String,
    "ChatbotIcon": String,
    "ChatbotDesc": String,
    "TemplateId": String,
    "From": String,
    "ChatbotConfig": Map
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
ChatbotName	String	是	否	聊天机器人的名称。	无
ChatbotIcon	String	否	是	聊天机器人的图标。	无
ChatbotDesc	String	否	是	聊天机器人的描述信息。	无
ChatbotConfig	Map	否	否	AI助手配置。	更多信息。请参考ChatbotConfig属性。
From	String	否	否	请求的来源。	无
TemplateId	String	否	否	聊天机器人的配置模板ID。	无

ChatbotConfig语法

"ChatbotConfig": {
  "Config": Map,
  "Welcome": String
}

ChatbotConfig属性

属性名称	类型	必须	允许更新	描述	约束
Config	Map	否	否	AI助手配置信息。	更多信息，请参考Config属性。
Welcome	String	否	否	聊天机器人的欢迎留言	无

Config语法

"ChatbotConfig": {
  "HistoryCount": Integer,
  "SlsLogEnabled": Boolean,
  "Prompt": String,
  "ShowDocumentReference": Boolean,
  "Input": String,
  "SlsProjectInfo": Map,
  "Questions": List
}

Config属性

属性名称	类型	必须	允许更新	描述	约束
HistoryCount	Integer	否	否	要保留的上下文消息数。	无
SlsLogEnabled	Boolean	否	否	是否启用SLS日志记录。	无
Prompt	String	否	否	对话上下文或背景提示。	无
ShowDocumentReference	Boolean	否	否	是否显示文档引用。	无
Input	String	否	否	输入框的占位符文本。	无
SlsProjectInfo	Map	否	否	SLS项目配置信息。	更多信息，请参考SlsProjectInfo属性。
Questions	List	否	否	聊天机器人的预定义问题。	无

SlsProjectInfo语法

"SlsProjectInfo": {
  "LogStoreName": String,
  "ProjectName": String,
  "RegionId": String
}

SlsProjectInfo属性

属性名称	类型	必须	允许更新	描述	约束
LogStoreName	String	否	否	LogStore名称。	无
ProjectName	String	否	否	SLS项目名称。	无
RegionId	String	否	否	SLS项目所属地域。	无

返回值

Fn::GetAtt

ChatbotId：Chatbot ID。

示例

YAML

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

JSON

{
  "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"
        ]
      }
    }
  }
}