ppagent / IFeishuSourceOptions

Interface: IFeishuSourceOptions

Defined in: src/source/feishu.source.ts:171

一个source可以有多个实例，比如不同的api地址，由用户配置

Extends

• ISourceOptions

Properties

appId?

optional appId: string

Defined in: src/source/feishu.source.ts:172

---

appSecret?

optional appSecret: string

Defined in: src/source/feishu.source.ts:173

---

autoReLogin?

optional autoReLogin: boolean

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

离线后是否自动重新请求登陆，默认false

Inherited from

ISourceOptions.autoReLogin

---

cardId?

optional cardId: string

Defined in: src/source/feishu.source.ts:211

当配置输出位stream时，需要提供卡片ID，否则将使用默认的卡片模板

---

contactDepartId?

optional contactDepartId: string

Defined in: src/source/feishu.source.ts:193

联系人的列表ID，如果以od-开头表示飞书自动生成的开放id，否则认为是自定义的id

默认0，表示根路径，如果只希望对部分部门的用户可被前端选取，可以这里设置上级部门ID

该配置仅影响前端选择联系人的数量，不影响消息监听

注意，系统内部使用的都是自定义的departmentId，在部门创建时可以指定或者自动生成，客户端内可查看或者编辑。

---

contactsCacheTime?

optional contactsCacheTime: number

Defined in: src/source/feishu.source.ts:183

联系人缓存时间，单位是秒，默认24小时

---

domain?

optional domain: string

Defined in: src/source/feishu.source.ts:179

默认是 https://open.feishu.cn

---

encryptKey?

optional encryptKey: string

Defined in: src/source/feishu.source.ts:175

---

ignoreNoneUserMessage?

optional ignoreNoneUserMessage: boolean

Defined in: src/source/feishu.source.ts:197

是否忽略非用户发送的消息，默认true

---

instanceName?

optional instanceName: string

Defined in: src/instance.base.manager.ts:10

用来区分不同实例的全局唯一key

Inherited from

ISourceOptions.instanceName

---

replayTextMode?

optional replayTextMode: "text" | "stream" | "rich_text"

Defined in: src/source/feishu.source.ts:207

文本消息的回复方式，默认使用text格式。如果设置为stream，将会使用卡片模拟流式输出。

text模式下，简单的markdown标签可以显示，图片标签会被转为普通的超链

rich_text下，markdown的图片标签会被提取单独显示，其他内容会以markdown显示（飞书markdown不支持富文本消息中的图片标签）

stream下，markdown中的图片标签会被提取并上传到飞书，且嵌入在原来位置显示

---

richTextTitle?

optional richTextTitle: boolean

Defined in: src/source/feishu.source.ts:215

当使用富文本形式回复时，是否启用标题，默认false

---

richTextTitleTemplate?

optional richTextTitleTemplate: string

Defined in: src/source/feishu.source.ts:219

富文本标题模板，可以使用{title}来占位，内容是用户提问的内容的最多前10个字符（未找到则使用用户昵称），默认是RE:{title}，仅开启富文本回复和启用富文本标题后生效

---

thinkingTips?

optional thinkingTips: string

Defined in: src/source/feishu.source.ts:223

启用流式回复时，正在思考的提示语，默认是"正在思考中..."

---

verificationToken?

optional verificationToken: string

Defined in: src/source/feishu.source.ts:174

---

wavChannel?

optional wavChannel: number

Defined in: src/source/feishu.source.ts:227

收到的语音转为wav时的通道数，不设置则采用ffmpeg的默认值。

---

wavSampleRate?

optional wavSampleRate: number

Defined in: src/source/feishu.source.ts:231

收到的语音转为wav时的采样率，不设置则使用ffmpeg的默认值。