Skip to content

ppagent / IBotParams

Interface: IBotParams

Defined in: src/bot/bot.ts:10

机器人的固有属性,如名称等,在机器人类型属性中配置

Extends

Properties

allowMultiActiveChat?

optional allowMultiActiveChat: boolean

Defined in: src/bot/bot.ts:19

在一个用户的当前对话中是否允许有多个活跃的chat,默认false。,一般均不允许,agent会等待bot上一个回复完成再继续下一次对话


desc?

optional desc: string

Defined in: src/config.ts:68

Inherited from

IConfigParams.desc


logoPath?

optional logoPath: string

Defined in: src/config.ts:72

公共目录的相对路径,如 /public/images/logo.png

Inherited from

IConfigParams.logoPath


name

name: string

Defined in: src/config.ts:67

类型的名称(非实例名称),所有该类型的实例都一样

Inherited from

IConfigParams.name


needHistoryMessage?

optional needHistoryMessage: boolean

Defined in: src/bot/bot.ts:15

是否需要框架提供历史消息,默认false。对于原生支持历史消息的后端,如dify,可以不需要平台进行历史消息存储 或者没有实现历史功能的bot,也应该设置为false。


optionsSchema

optionsSchema: IConfigSchema

Defined in: src/config.ts:76

实例属性配置的结构

Inherited from

IConfigParams.optionsSchema


readMeUrl?

optional readMeUrl: string

Defined in: src/config.ts:85

使用文档地址

Inherited from

IConfigParams.readMeUrl


supported?

optional supported: object

Defined in: src/config.ts:77

groupInAndOut?

optional groupInAndOut: boolean

inTypes?

optional inTypes: SourceChatMessageType[]

outTypes?

optional outTypes: SourceChatMessageType[]

Inherited from

IConfigParams.supported