PPAgent 文档

Appearance

ppagent / IAgentOptions

Interface: IAgentOptions ​

Defined in: src/agent/agent.ts:30

Properties ​

botResponseRule ​

botResponseRule: IMessageRule

Defined in: src/agent/agent.ts:31

bufferWordsMinCount? ​

optional bufferWordsMinCount: number

Defined in: src/agent/agent.ts:59

当不支持流式传输时，系统会尽快把后段返回的内容发送回去。通过设置单词最小数量，可以避免连续发送过多条数据。 默认70个字符。实际返回数量不一定刚好等于该数。该特性仅对中文生效。

如果希望等待后端回答完成后一次性发送，可以设置为负值。

建议在支持流式模式的source下，设置较小，比如10-20

小于0表示最后全部输出完成一起回复

checkWavAudio? ​

optional checkWavAudio: boolean

Defined in: src/agent/agent.ts:44

是否检测音频wav，默认是

contentPrefix? ​

optional contentPrefix: string

Defined in: src/agent/agent.ts:136

回复内容的前缀，如 【回复】。仅对推理模型生效。正常对内容的修改可以通过添加技能完成

fallbackAnswer? ​

optional fallbackAnswer: string

Defined in: src/agent/agent.ts:98

兜底回复。当没有匹配到规则，但是bot无法回复的时候触发该回复。如果不设置，则不回复。如果消息被技能取消回复，不会触发该回复。

historyEnabled? ​

optional historyEnabled: boolean

Defined in: src/agent/agent.ts:75

是否激活历史消息。需要机器的实现类也支持历史消息，即触发历史消息事件，并在发送到后端时带上历史消息

historyOptions? ​

optional historyOptions: IHisotryMessageManagerOptions

Defined in: src/agent/agent.ts:79

历史消息管理的构建参数

instanceName ​

instanceName: string

Defined in: src/agent/agent.ts:48

agent实例的名称

maxReasoningSplitCount? ​

optional maxReasoningSplitCount: number

Defined in: src/agent/agent.ts:124

思考过程最大的拆分数量，默认为3。如果超过了，则最后一次性回复。避免被拆分的太零散，也能符合部分平台对回复数量的要求。

maxSplitCount? ​

optional maxSplitCount: number

Defined in: src/agent/agent.ts:65

一次回复最多被拆分成多少条，如果超过了，则最后一次性回复。避免被拆分的太零散，也能符合部分平台对回复数量的要求。

默认3。建议在支持流式的source下，设置尽可能的大，避免造成最后一起回复。

minSendInterval? ​

optional minSendInterval: number

Defined in: src/agent/agent.ts:84

仅sendMode为queue时生效。最小发送时间间隔，单位是毫秒。防止发送过快被识别为垃圾消息。默认为1000。 source的流式模式下，建议设置的较小

multiActiveChatInConversationMode? ​

optional multiActiveChatInConversationMode: "pool" | "tips" | "pool_tips"

Defined in: src/agent/agent.ts:112

如果一个用户同时在一个bot还没有回答结束时又提问，且bot不支持一个会话中多个活跃对话时，要采取的措施，pool是直接放入等待区，不提示；tips是给出提示，不放入等待区；pool_tips是放入等待区且给出提示。

提示内容可以通过multiActiveChatInConversationTips进行配置。

默认为pool。

multiActiveChatInConversationTips? ​

optional multiActiveChatInConversationTips: string

Defined in: src/agent/agent.ts:104

表示如果一个用户同时在一个bot还没有回答结束时又提问，且bot不支持一个会话中多个活跃对话时，输出的提示词。

当multiActiveChatInConversationMode配置为发送提示时才会生效。

reasoningPrefix? ​

optional reasoningPrefix: string

Defined in: src/agent/agent.ts:132

思考部分内容的前缀，如 【思考中】

removeImageAfterSplit? ​

optional removeImageAfterSplit: boolean

Defined in: src/agent/agent.ts:40

图片拆出来之后是否需要从原来的文字中移除

sendErrorLog? ​

optional sendErrorLog: boolean

Defined in: src/agent/agent.ts:116

是否发送消息处理异常的日志到客户端，默认false

sendMode? ​

optional sendMode: "now" | "queue"

Defined in: src/agent/agent.ts:90

发送模式，now是所有消息都默认立即发送，interval是加入发送队列，隔一段时间发送一条，避免认为乱发。发送间隔可以通过minSendInterval配置。 如果立即发送，有可能造成发送顺序与bot返回的不一致（下载和传输耗时导致） 默认队列发送。

sendReasoning? ​

optional sendReasoning: boolean

Defined in: src/agent/agent.ts:128

是否显示思考过程（仅对推理模型有效）

skillRules? ​

optional skillRules: IMessageRule[]

Defined in: src/agent/agent.ts:94

技能规则列表

sourceInstanceNames ​

sourceInstanceNames: string[]

Defined in: src/agent/agent.ts:32

splitCharacters? ​

optional splitCharacters: string[]

Defined in: src/agent/agent.ts:71

用于拆分句子的标记，默认["！","。","？"]

如果设置为["none"]，则表示只关注字数，不考虑分句，适用于流式回复。非流式回复请务必设置合理值或者不做设置，否则异常的断句可能导致图片无法被识别或者错误识别

splitImageFromBotText? ​

optional splitImageFromBotText: boolean

Defined in: src/agent/agent.ts:36

是否从文本消息中提取图片单独发送。钉钉这类支持混编的建议使用混编的类型发送，而不是提取后单独发送。

timeoutInSeconds? ​

optional timeoutInSeconds: number

Defined in: src/agent/agent.ts:120

正在执行中的问答，执行的超时时间，默认60秒。超过的任务将不再等待，继续执行一个提问（不会被取消回调，有返回后仍然会发送）。