ppagent / IBot
Interface: IBot
Defined in: src/bot/bot.ts:74
一个被动接收消息并响应的机器人
Extends
Accessors
options
Get Signature
get options():
IBotOptions
Defined in: src/bot/bot.ts:75
Returns
Overrides
params
Get Signature
get params():
IBotParams
Defined in: src/bot/bot.ts:76
Returns
Overrides
Methods
clearHistoryRequested()
clearHistoryRequested(
data):Promise<string>
Defined in: src/bot/bot.ts:107
请求清除当前聊天对象的历史对话
Parameters
data
Returns
Promise<string>
如果有异常，返回异常说明。成功清除无需返回信息。
getResponse()
getResponse(
data,receiver,readyMessage,historyBotMessages?):Promise<IBotHistoryMessage>
Defined in: src/bot/bot.ts:101
单聊时，每次对方发来消息都会调用该方法获取回复 群聊时，只有被@或者以指定名称开头呼叫时，才会被调用
该方法请务必等待回复完成后再异步返回。
Parameters
data
receiver
readyMessage
historyBotMessages?
当bot支持历史消息，且调用的agent开启了历史消息存储时会传入历史消息
Returns
Promise<IBotHistoryMessage>
返回本次回答的botMessage信息，以便存入历史消息
init()
init():
Promise<void>
Defined in: src/bot/bot.ts:81
bot的初始化代码，支持预加载资源
Returns
Promise<void>
prepareMessage()
prepareMessage(
data):Promise<IBotReadyMessage>
Defined in: src/bot/bot.ts:88
仅仅对消息实现一个平台化的转换。 如果涉及到图片或者文件的上传，应该在用户提问的时候，识别提问中是否存在引用消息（即针对文件图片的提问，必须使用引用消息实现），如果存在，在获取回复之前执行上传等异步动作，而不是一收到文件消息就上传 该接口返回的IBotMessage的type应该都是user
Parameters
data
Returns
Promise<IBotReadyMessage>