0.0.13 • Published 5 months ago

isquirrel-react-chatbot v0.0.13

Weekly downloads
-
License
-
Repository
-
Last release
5 months ago

React Chatbot

使用react框架实现自动回复客服聊天框,配置聊天问答模板列表,通过模糊匹配问答列表中的问题,找到适配度最高的内容进行回复。

框架

React18 + TypeScript

node

node use v20+

安装

npm install isquirrel-react-chatbot

使用方式

import { Chatbot, Dialogue, Message } from "isquirrel-react-chatbot";

const App = () => {
  // 聊天问答列表
  const dialogues: Dialogue[] = [
    {
      question: '你好',
      reply: '您好,请问有什么可以帮助您的吗?',
      isDefault: false
    }
  ]
  return (
    <div>
      <Chatbot
        title="机器人客服为您服务"
        greet="您好,很高兴为您服务。"
        dialogues={dialogues}
        failTips=""
        historyMessages={[]}
        onReply={(message: Message) => {
          console.log("回复消息:", message)
        }}
        getMessages={(messages: Message[]) => {
          console.log("消息列表:", messages)
        }}
      />
    </div>
  )
}


export default App;

props

参数类型必填默认值说明
onReplyFunctionfalse接收到用户发送的消息后,根据内容匹配到回复时调用,参数为Message回复的消息
getMessagesFunctionfalse获取当前所有的消息记录,参数为Message[]
titleStringfalse机器人客服为您服务聊天弹窗标题
greetStringfalse进入聊天窗口时默认打招呼的话语
dialoguesDialogue[]true聊天问答列表
failTipsStringfalse亲爱的用户,我不太懂您的意思。匹配失败默认回复的内容
historyMessagesMessage[]false聊天的历史记录,用于显示
robotAvatarStringfalse机器人图标机器人头像,图片url
userAvatarStringfalse用户图标用户头像,图片url
themeStringfalsedefault主题颜色,允许的值:default灰色、blue蓝色、green绿色

Dialogue

参数类型必填说明
questionStringtrue问题
replyStringtrue回复内容
isDefaultBooleanfalse是否显示在默认的”猜您想问“和底部提示按钮里

Message

参数类型必填默认值说明
createdAtNumbertrue创建时间
roleStringtrue消息发送者角色,允许的值:user用户、assistant客服机器人
typeStringfalsecontent消息内容类型,允许的值:content文本内容、list”猜您想问“问题列表
contentStringfalse消息内容,文本格式
listString[]false消息内容,”猜您想问“列表格式
0.0.13

5 months ago

0.0.12

5 months ago

0.0.11

5 months ago

0.0.10

5 months ago

0.0.9

5 months ago

0.0.8

5 months ago

0.0.7

5 months ago

0.0.6

5 months ago

0.0.5

5 months ago

0.0.4

5 months ago

0.0.3

5 months ago