跳到主要内容
版本:2.0.0

插件

LCMessager

对接Laiye CAIP的对话接口,功能包括消息收发、消息渲染、用户注册、接口鉴权、获取逐键联想等。

可配置参数

type LCMeesagerConfig = {
// required / 必要参数
// 机器人ID
agentId: string
// 渠道ID
channelId: string
// 服务账号
serviceAccountId: string
// 服务Hash
serviceAccountSecret: string
// 历史消息
historyChannelId?: string
// 运行环境。default: 'PRODUCT'
env?: 'PRODUCT' | 'SKETCH'
// 是否需要加鉴权请求头。default: true
needSign?: boolean
// ---------------------------
// optional / 可选参数
// 请求配置
request?: {
// 接口地址。default: ''
baseUrl: string
}

// 消息渲染函数。default: defaultGenMessages
genMessages?: (message: FormatedMessage[]) => Message[]

// 是否发送欢迎语。default: true
sendWelcomeMsg?: boolean

// 获取历史消息。default: true
getHistory?: boolean

// 创建用户。用户名为model.userInfo.name。default: false
createUser?: boolean
}

监听事件

didInitial

  • 参数:-
  • 响应:
    1. 如果是生产环境或createUser为true,则查找是否有当前用户,没有则创建;
    2. 确认当前渠道是否是LC,不是则结束响应;
    3. 如果getHistory为true,则获取历史并渲染;
    4. 如果sendWelcomeMsg为true,则发送欢迎语;

sendUserMessage

  • 参数:
    type payload = {
    type: 'text'
    content: any
    appendUserMessage: boolean // default: true
    appendReciveMessage: boolean // default: true
    setQuickReplies: boolean // default: true
    setIsTyping: boolean // default: true
    }
  • 响应:调用LC对话接口发送消息

clickQuickReply

  • 参数:
    type payload = {
    item: QuickReply
    index: number
    }
  • 响应:如果是text类型,则触发sendUserMessage

公共数据(待更新)

API(待更新)