-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Expand file tree
/
Copy pathconfig-metadata.json
More file actions
1611 lines (1611 loc) · 66.6 KB
/
config-metadata.json
File metadata and controls
1611 lines (1611 loc) · 66.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"ai_group": {
"name": "AI 配置",
"agent_runner": {
"description": "Agent 执行方式",
"hint": "选择 AI 对话的执行器,默认为 AstrBot 内置 Agent 执行器,可使用 AstrBot 内的知识库、人格、工具调用功能。如果不打算接入 Dify、Coze、DeerFlow 等第三方 Agent 执行器,不需要修改此节。",
"provider_settings": {
"enable": {
"description": "启用",
"hint": "AI 对话总开关"
},
"agent_runner_type": {
"description": "执行器",
"labels": [
"内置 Agent",
"Dify",
"Coze",
"阿里云百炼应用",
"DeerFlow"
]
},
"coze_agent_runner_provider_id": {
"description": "Coze Agent 执行器提供商 ID"
},
"dify_agent_runner_provider_id": {
"description": "Dify Agent 执行器提供商 ID"
},
"dashscope_agent_runner_provider_id": {
"description": "阿里云百炼应用 Agent 执行器提供商 ID"
},
"deerflow_agent_runner_provider_id": {
"description": "DeerFlow Agent 执行器提供商 ID"
}
}
},
"ai": {
"description": "模型",
"hint": "当使用非内置 Agent 执行器时,默认对话模型和默认图片转述模型可能会无效,但某些插件会依赖此配置项来调用 AI 能力。",
"provider_settings": {
"default_provider_id": {
"description": "默认对话模型",
"hint": "留空时使用第一个模型"
},
"fallback_chat_models": {
"description": "回退对话模型列表",
"hint": "主对话模型请求失败时,按顺序切换到这些对话模型。"
},
"default_image_caption_provider_id": {
"description": "默认图片转述模型",
"hint": "留空代表不使用,可用于非多模态模型"
},
"image_caption_prompt": {
"description": "图片转述提示词"
}
},
"provider_stt_settings": {
"enable": {
"description": "启用语音转文本",
"hint": "STT 总开关"
},
"provider_id": {
"description": "默认语音转文本模型",
"hint": "用户也可使用 /provider 指令单独选择会话的 STT 模型。"
}
},
"provider_tts_settings": {
"enable": {
"description": "启用文本转语音",
"hint": "TTS 总开关"
},
"provider_id": {
"description": "默认文本转语音模型"
},
"trigger_probability": {
"description": "TTS 触发概率"
}
}
},
"persona": {
"description": "人格",
"hint": "赋予 AstrBot 人格。",
"provider_settings": {
"default_personality": {
"description": "默认采用的人格"
}
}
},
"knowledgebase": {
"description": "知识库",
"hint": "AstrBot 的 “外置大脑”。",
"kb_names": {
"description": "知识库列表",
"hint": "支持多选"
},
"kb_fusion_top_k": {
"description": "融合检索结果数",
"hint": "多个知识库检索结果融合后的返回结果数量"
},
"kb_final_top_k": {
"description": "最终返回结果数",
"hint": "从知识库中检索到的结果数量,越大可能获得越多相关信息,但也可能引入噪音。建议根据实际需求调整"
},
"kb_agentic_mode": {
"description": "Agentic 知识库检索",
"hint": "启用后,知识库检索将作为 LLM Tool,由模型自主决定何时调用知识库进行查询。需要模型支持函数调用能力。"
}
},
"websearch": {
"description": "网页搜索",
"hint": "让 AstrBot 能够访问互联网,获悉时讯。",
"provider_settings": {
"web_search": {
"description": "启用网页搜索"
},
"websearch_provider": {
"description": "网页搜索提供商"
},
"websearch_tavily_key": {
"description": "Tavily API Key",
"hint": "可添加多个 Key 进行轮询。"
},
"websearch_tavily_base_url": {
"description": "Tavily API Base URL",
"hint": "默认为 https://api.tavily.com,可改为代理地址。"
},
"websearch_bocha_key": {
"description": "BoCha API Key",
"hint": "可添加多个 Key 进行轮询。"
},
"websearch_baidu_app_builder_key": {
"description": "百度千帆智能云 APP Builder API Key",
"hint": "参考:[https://console.bce.baidu.com/iam/#/iam/apikey/list](https://console.bce.baidu.com/iam/#/iam/apikey/list)"
},
"websearch_exa_key": {
"description": "Exa API Key",
"hint": "可添加多个 Key 进行轮询。"
},
"websearch_exa_base_url": {
"description": "Exa API Base URL",
"hint": "默认为 https://api.exa.ai,可改为代理地址。"
},
"web_search_link": {
"description": "显示来源引用"
}
}
},
"file_extract": {
"description": "文档解析能力",
"provider_settings": {
"file_extract": {
"enable": {
"description": "启用文档解析能力"
},
"provider": {
"description": "文档解析提供商"
},
"moonshotai_api_key": {
"description": "Moonshot AI API Key"
}
}
}
},
"agent_computer_use": {
"description": "使用电脑能力",
"hint": "让 AstrBot 访问和使用你的电脑或者隔离的沙盒环境,以执行更复杂的任务。详见: [沙盒模式](https://docs.astrbot.app/use/astrbot-agent-sandbox.html), [Skills](https://docs.astrbot.app/use/skills.html)。",
"provider_settings": {
"computer_use_runtime": {
"description": "运行环境",
"hint": "sandbox 代表在沙箱环境中运行, local 代表在本地环境中运行, none 代表不启用。如果上传了 skills,选择 none 会导致其无法被 Agent 正常使用。"
},
"computer_use_require_admin": {
"description": "需要 AstrBot 管理员权限",
"hint": "开启后,需要 AstrBot 管理员权限才能调用使用电脑能力。在平台配置->管理员中可添加管理员。使用 /sid 指令查看管理员 ID。"
},
"sandbox": {
"booter": {
"description": "沙箱环境驱动器"
},
"shipyard_neo_endpoint": {
"description": "Shipyard Neo API Endpoint",
"hint": "Shipyard Neo(Bay) 服务的 API 地址,默认 http://127.0.0.1:8114。"
},
"shipyard_neo_access_token": {
"description": "Shipyard Neo 访问令牌",
"hint": "Bay 的 API Key(sk-bay-...)。留空时自动从 credentials.json 发现。"
},
"shipyard_neo_profile": {
"description": "Shipyard Neo Profile",
"hint": "Shipyard Neo 沙箱 profile,例如 python-default。"
},
"shipyard_neo_ttl": {
"description": "Shipyard Neo Sandbox 存活时间(秒)",
"hint": "Shipyard Neo 沙箱的生存时间(秒)。"
},
"shipyard_endpoint": {
"description": "Shipyard API Endpoint",
"hint": "Shipyard 服务的 API 访问地址。"
},
"shipyard_access_token": {
"description": "Shipyard 访问令牌",
"hint": "用于访问 Shipyard 服务的访问令牌。"
},
"shipyard_ttl": {
"description": "Shipyard Ship 存活时间(秒)",
"hint": "Shipyard 会话的生存时间(秒)。"
},
"shipyard_max_sessions": {
"description": "Shipyard Ship 会话复用上限",
"hint": "决定了一个实例承载的最大会话数量。"
}
}
}
},
"proactive_capability": {
"description": "主动型能力",
"hint": "让 AstrBot 能够在某一时刻自动唤醒,帮你完成任务。详见: [主动型 Agent](https://docs.astrbot.app/use/proactive-agent.html)。",
"provider_settings": {
"proactive_capability": {
"add_cron_tools": {
"description": "启用",
"hint": "启用后,将会传递给 Agent 相关工具来实现主动型 Agent。你可以告诉 AstrBot 未来某个时间要做的事情,它将被定时触发然后执行任务,然后将结果发送给你。"
}
}
}
},
"truncate_and_compress": {
"hint": "AstrBot 如何管理工作记忆。详见: [上下文管理策略](https://docs.astrbot.app/use/context-compress.html)。",
"description": "上下文管理策略",
"provider_settings": {
"max_context_length": {
"description": "最多携带对话轮数",
"hint": "超出这个数量时丢弃最旧的部分,一轮聊天记为 1 条,-1 为不限制"
},
"dequeue_context_length": {
"description": "丢弃对话轮数",
"hint": "超出最多携带对话轮数时, 一次丢弃的聊天轮数"
},
"context_limit_reached_strategy": {
"description": "超出模型上下文窗口时的处理方式",
"labels": [
"按对话轮数截断",
"由 LLM 压缩上下文"
],
"hint": "当按对话轮数截断时,会根据上面\"丢弃对话轮数\"的配置丢弃最旧的 N 轮对话。当由 LLM 压缩上下文时,会使用指定的模型进行上下文压缩。"
},
"llm_compress_instruction": {
"description": "上下文压缩提示词",
"hint": "如果为空则使用默认提示词。"
},
"llm_compress_keep_recent": {
"description": "压缩时保留最近对话轮数",
"hint": "始终保留的最近 N 轮对话。"
},
"llm_compress_provider_id": {
"description": "用于上下文压缩的模型提供商 ID",
"hint": "留空时将降级为\"按对话轮数截断\"的策略。"
}
}
},
"others": {
"description": "其他配置",
"provider_settings": {
"display_reasoning_text": {
"description": "显示思考内容"
},
"llm_safety_mode": {
"description": "健康模式",
"hint": "引导模型输出健康、安全、积极的内容,避免有害或敏感话题。"
},
"safety_mode_strategy": {
"description": "健康模式策略",
"hint": "选择健康模式的实现方式。"
},
"identifier": {
"description": "用户识别",
"hint": "启用后,会在提示词前包含用户 ID 信息。"
},
"group_name_display": {
"description": "显示群名称",
"hint": "启用后,在支持的平台(OneBot v11)上会在提示词前包含群名称信息。"
},
"datetime_system_prompt": {
"description": "现实世界时间感知",
"hint": "启用后,会在系统提示词中附带当前时间信息。"
},
"show_tool_use_status": {
"description": "输出函数调用状态"
},
"show_tool_call_result": {
"description": "输出函数调用返回结果",
"hint": "仅在启用“输出函数调用状态”时生效,且最多展示 70 个字符。"
},
"sanitize_context_by_modalities": {
"description": "按模型能力清理历史上下文",
"hint": "开启后,在每次请求 LLM 前会按当前模型提供商中所选择的模型能力删除对话中不支持的图片/工具调用结构(会改变模型看到的历史)"
},
"max_quoted_fallback_images": {
"description": "转发消息中图片获取上限",
"hint": "转发消息解析到的图片最多注入数量,超出部分会截断。"
},
"quoted_message_parser": {
"max_component_chain_depth": {
"description": "转发消息富文本解析深度",
"hint": "解析转发消息中的富文本组件链时允许的最大递归深度。"
},
"max_forward_node_depth": {
"description": "转发消息嵌套解析深度",
"hint": "解析嵌套转发节点时允许的最大递归深度。"
},
"max_forward_fetch": {
"description": "转发消息递归拉取上限",
"hint": "递归调用 get_forward_msg 拉取转发内容的最大次数。"
},
"warn_on_action_failure": {
"description": "转发消息解析失败告警",
"hint": "开启后,get_msg/get_forward_msg 全部尝试失败时输出 warning 日志。"
}
},
"max_agent_step": {
"description": "工具调用轮数上限"
},
"tool_call_timeout": {
"description": "工具调用超时时间(秒)"
},
"tool_schema_mode": {
"description": "工具调用模式",
"hint": "skills-like 先下发工具名称与描述,再下发参数;full 一次性下发完整参数。",
"labels": [
"Skills-like(两阶段)",
"Full(完整参数)"
]
},
"streaming_response": {
"description": "流式输出"
},
"unsupported_streaming_strategy": {
"description": "不支持流式回复的平台",
"hint": "选择在不支持流式回复的平台上的处理方式。实时分段回复会在系统接收流式响应检测到诸如标点符号等分段点时,立即发送当前已接收的内容",
"labels": [
"实时分段回复",
"关闭流式回复"
]
},
"wake_prefix": {
"description": "LLM 聊天额外唤醒前缀",
"hint": "如果唤醒前缀为 /, 额外聊天唤醒前缀为 chat,则需要 /chat 才会触发 LLM 请求"
},
"prompt_prefix": {
"description": "用户提示词",
"hint": "可使用 {{prompt}} 作为用户输入的占位符。如果不输入占位符则代表添加在用户输入的前面。"
},
"image_compress_enabled": {
"description": "启用图片压缩",
"hint": "启用后,发送给多模态模型前会先压缩本地大图片。"
},
"image_compress_options": {
"description": "图片压缩配置",
"hint": "用于控制图片压缩的尺寸、质量和触发阈值。",
"max_size": {
"description": "最大边长",
"hint": "压缩后图片的最长边,单位为像素。超过该尺寸时会按比例缩放。"
},
"quality": {
"description": "JPEG 质量",
"hint": "JPEG 输出质量,范围为 1-100。值越高,画质越好,文件也越大。"
}
},
"reachability_check": {
"description": "提供商可达性检测",
"hint": "/provider 命令列出模型时并发检测连通性。开启后会主动调用模型测试连通性,可能产生额外 token 消耗。"
}
},
"provider_tts_settings": {
"dual_output": {
"description": "开启 TTS 时同时输出语音和文字内容"
}
}
}
},
"platform_group": {
"name": "平台配置",
"platform": {
"description": "消息平台适配器",
"active_send_mode": {
"description": "是否换用主动发送接口"
},
"appid": {
"description": "appid",
"hint": "必填项。QQ 官方机器人平台的 appid。如何获取请参考文档。"
},
"callback_server_host": {
"description": "回调服务器主机",
"hint": "回调服务器主机。留空则不启用回调服务器。"
},
"card_template_id": {
"description": "卡片模板 ID",
"hint": "可选。钉钉互动卡片模板 ID。启用后将使用互动卡片进行流式回复。"
},
"discord_activity_name": {
"description": "Discord 活动名称",
"hint": "可选的 Discord 活动名称。留空则不设置活动。"
},
"discord_command_register": {
"description": "注册 Discord 指令",
"hint": "启用后,自动将插件指令注册为 Discord 斜杠指令"
},
"discord_proxy": {
"description": "Discord 代理地址",
"hint": "可选的代理地址:http://ip:port"
},
"discord_token": {
"description": "Discord Bot Token",
"hint": "在此处填入你的 Discord Bot Token"
},
"enable": {
"description": "启用",
"hint": "是否启用该适配器。未启用的适配器对应的消息平台将不会接收到消息。"
},
"enable_group_c2c": {
"description": "启用消息列表单聊",
"hint": "启用后,机器人可以接收到 QQ 消息列表中的私聊消息。你可能需要在 QQ 机器人平台上通过扫描二维码的方式添加机器人为你的好友。详见文档。"
},
"enable_guild_direct_message": {
"description": "启用频道私聊",
"hint": "启用后,机器人可以接收到频道的私聊消息。"
},
"id": {
"description": "机器人名称",
"hint": "机器人名称"
},
"is_sandbox": {
"description": "沙箱模式"
},
"kf_name": {
"description": "微信客服账号名",
"hint": "如果填写此项,即代表你将使用企业微信客服,而不是企业微信应用。可在 https://kf.weixin.qq.com/kf/frame#/accounts 获取。"
},
"lark_bot_name": {
"description": "飞书机器人的名字",
"hint": "请务必填写正确,否则 @ 机器人将无法唤醒,只能通过前缀唤醒。"
},
"lark_connection_mode": {
"description": "订阅方式",
"labels": [
"长连接模式",
"推送至服务器模式"
]
},
"lark_encrypt_key": {
"description": "Encrypt Key",
"hint": "用于解密飞书回调数据的加密密钥"
},
"lark_verification_token": {
"description": "Verification Token",
"hint": "用于验证飞书回调请求的令牌"
},
"misskey_allow_insecure_downloads": {
"description": "允许不安全下载(禁用 SSL 验证)",
"hint": "当远端服务器存在证书问题导致无法正常下载时,自动禁用 SSL 验证作为回退方案。适用于某些图床的证书配置问题。启用有安全风险,仅在必要时使用。"
},
"misskey_default_visibility": {
"description": "默认帖子可见性",
"hint": "机器人发帖时的默认可见性设置。public:公开,home:主页时间线,followers:仅关注者。"
},
"misskey_download_chunk_size": {
"description": "流式下载分块大小(字节)",
"hint": "流式下载和计算 MD5 时使用的每次读取字节数,过小会增加开销,过大会占用内存。"
},
"misskey_download_timeout": {
"description": "远端下载超时时间(秒)",
"hint": "下载远程文件时的超时时间(秒),用于异步上传回退到本地上传的场景。"
},
"misskey_enable_chat": {
"description": "启用聊天消息响应",
"hint": "启用后,机器人将会监听和响应私信聊天消息"
},
"misskey_enable_file_upload": {
"description": "启用文件上传到 Misskey",
"hint": "启用后,适配器会尝试将消息链中的文件上传到 Misskey。URL 文件会先尝试服务器端上传,异步上传失败时会回退到下载后本地上传。"
},
"misskey_instance_url": {
"description": "Misskey 实例 URL",
"hint": "例如 https://misskey.example,填写 Bot 账号所在的 Misskey 实例地址"
},
"misskey_local_only": {
"description": "仅限本站(不参与联合)",
"hint": "启用后,机器人发出的帖子将仅在本实例可见,不会联合到其他实例"
},
"misskey_max_download_bytes": {
"description": "最大允许下载字节数(超出则中止)",
"hint": "如果希望限制下载文件的最大大小以防止 OOM,请填写最大字节数;留空或 null 表示不限制。"
},
"misskey_token": {
"description": "Misskey Access Token",
"hint": "连接服务设置生成的 API 鉴权访问令牌(Access token)"
},
"misskey_upload_concurrency": {
"description": "并发上传限制",
"hint": "同时进行的文件上传任务上限(整数,默认 3)。"
},
"misskey_upload_folder": {
"description": "上传到网盘的目标文件夹 ID",
"hint": "可选:填写 Misskey 网盘中目标文件夹的 ID,上传的文件将放置到该文件夹内。留空则使用账号网盘根目录。"
},
"port": {
"description": "回调服务器端口",
"hint": "回调服务器端口。留空则不启用回调服务器。"
},
"satori_api_base_url": {
"description": "Satori API 终结点",
"hint": "Satori API 的基础地址。"
},
"satori_auto_reconnect": {
"description": "启用自动重连",
"hint": "断开连接时是否自动重新连接 WebSocket。"
},
"satori_endpoint": {
"description": "Satori WebSocket 终结点",
"hint": "Satori 事件的 WebSocket 端点。"
},
"satori_heartbeat_interval": {
"description": "Satori 心跳间隔",
"hint": "发送心跳消息的间隔(秒)。"
},
"satori_reconnect_delay": {
"description": "Satori 重连延迟",
"hint": "尝试重新连接前的延迟时间(秒)。"
},
"satori_token": {
"description": "Satori 令牌",
"hint": "用于 Satori API 身份验证的令牌。"
},
"secret": {
"description": "secret",
"hint": "必填项。"
},
"slack_connection_mode": {
"description": "Slack Connection Mode",
"hint": "The connection mode for Slack. `webhook` uses a webhook server, `socket` uses Slack's Socket Mode."
},
"slack_webhook_host": {
"description": "Slack Webhook Host",
"hint": "Only valid when Slack connection mode is `webhook`."
},
"slack_webhook_path": {
"description": "Slack Webhook Path",
"hint": "Only valid when Slack connection mode is `webhook`."
},
"slack_webhook_port": {
"description": "Slack Webhook Port",
"hint": "Only valid when Slack connection mode is `webhook`."
},
"telegram_command_auto_refresh": {
"description": "Telegram 命令自动刷新",
"hint": "启用后,AstrBot 将会在运行时自动刷新 Telegram 命令。(单独设置此项无效)"
},
"telegram_command_register": {
"description": "Telegram 命令注册",
"hint": "启用后,AstrBot 将会自动注册 Telegram 命令。"
},
"telegram_command_register_interval": {
"description": "Telegram 命令自动刷新间隔",
"hint": "Telegram 命令自动刷新间隔,单位为秒。"
},
"telegram_polling_restart_delay": {
"description": "Telegram 轮询重启延迟",
"hint": "当轮询意外结束尝试自动重启时的延迟时间,单位为秒。默认为 5s。"
},
"telegram_token": {
"description": "Bot Token",
"hint": "如果你的网络环境为中国大陆,请在 `其他配置` 处设置代理或更改 api_base。"
},
"type": {
"description": "适配器类型"
},
"unified_webhook_mode": {
"description": "统一 Webhook 模式",
"hint": "Webhook 模式下使用 AstrBot 统一 Webhook 入口,无需单独开启端口。回调地址为 /api/platform/webhook/{webhook_uuid}。"
},
"webhook_uuid": {
"description": "Webhook UUID",
"hint": "统一 Webhook 模式下的唯一标识符,创建平台时自动生成。"
},
"wecom_ai_bot_name": {
"description": "企业微信智能机器人的名字",
"hint": "请务必填写正确,否则无法使用一些指令。"
},
"wecom_ai_bot_connection_mode": {
"description": "企业微信智能机器人连接模式",
"hint": "Webhook 回调模式需要配置 Token/EncodingAESKey;长连接模式需要配置 BotID/Secret。"
},
"wecomaibot_friend_message_welcome_text": {
"description": "企业微信智能机器人私聊欢迎语",
"hint": "可选。当用户当天进入智能机器人单聊会话,回复欢迎语,如 “💭 思考中...”。留空则不回复。"
},
"wecomaibot_init_respond_text": {
"description": "企业微信智能机器人初始响应文本",
"hint": "可选。当机器人收到消息时,首先回复的文本内容。留空则不设置。"
},
"wecomaibot_token": {
"description": "企业微信智能机器人 Token",
"hint": "用于 Webhook 回调模式的身份验证。"
},
"wecomaibot_encoding_aes_key": {
"description": "企业微信智能机器人 EncodingAESKey",
"hint": "用于 Webhook 回调模式的消息加密解密。"
},
"wecomaibot_ws_bot_id": {
"description": "长连接 BotID",
"hint": "企业微信智能机器人长连接模式凭证 BotID。"
},
"wecomaibot_ws_secret": {
"description": "长连接 Secret",
"hint": "企业微信智能机器人长连接模式凭证 Secret。"
},
"wecomaibot_ws_url": {
"description": "长连接 WebSocket 地址",
"hint": "默认值为 wss://openws.work.weixin.qq.com,一般无需修改。"
},
"wecomaibot_heartbeat_interval": {
"description": "长连接心跳间隔",
"hint": "长连接模式心跳间隔(秒),建议 30 秒。"
},
"wpp_active_message_poll": {
"description": "是否启用主动消息轮询",
"hint": "只有当你发现微信消息没有按时同步到 AstrBot 时,才需要启用这个功能,默认不启用。"
},
"wpp_active_message_poll_interval": {
"description": "主动消息轮询间隔",
"hint": "主动消息轮询间隔,单位为秒,默认 3 秒,最大不要超过 60 秒,否则可能被认为是旧消息。"
},
"ws_reverse_host": {
"description": "反向 Websocket 主机",
"hint": "AstrBot 将作为服务器端。"
},
"ws_reverse_port": {
"description": "反向 Websocket 端口"
},
"ws_reverse_token": {
"description": "反向 Websocket Token",
"hint": "反向 Websocket Token。未设置则不启用 Token 验证。"
},
"msg_push_webhook_url": {
"description": "企业微信消息推送 Webhook URL",
"hint": "可选。用于主动消息推送,请在企微群->消息推送得到 URL。建议设置此项以带来更好的消息发送体验。"
},
"only_use_webhook_url_to_send": {
"description": "仅使用 Webhook 发送消息",
"hint": "可选。启用后,企业微信智能机器人的所有回复都改为通过消息推送 Webhook 发送。消息推送 Webhook 支持更多的消息类型(如图片、文件等)。如果不需要打字机效果,强烈建议使用此选项。"
},
"weixin_oc_base_url": {
"description": "Base URL 地址",
"hint": "默认值: https://ilinkai.weixin.qq.com"
},
"weixin_oc_bot_type": {
"description": "扫码参数 bot_type",
"hint": "默认值: 3"
},
"weixin_oc_qr_poll_interval": {
"description": "二维码状态轮询间隔(秒)",
"hint": "每隔多少秒轮询一次二维码状态。"
},
"weixin_oc_long_poll_timeout_ms": {
"description": "getUpdates 长轮询超时时间(毫秒)",
"hint": "会话消息拉取接口超时参数。"
},
"weixin_oc_api_timeout_ms": {
"description": "HTTP 请求超时(毫秒)",
"hint": "通用 API 请求超时参数。"
},
"weixin_oc_token": {
"description": "登录后 token(可留空)",
"hint": "扫码登录成功后会自动写入;高级场景可手动填写。"
},
"kook_bot_token": {
"description": "机器人 Token",
"type": "string",
"hint": "必填项。从 KOOK 开发者平台获取的机器人 Token"
},
"kook_reconnect_delay": {
"description": "重连延迟",
"type": "int",
"hint": "重连延迟时间(秒),使用指数退避策略"
},
"kook_max_reconnect_delay": {
"description": "最大重连延迟",
"type": "int",
"hint": "重连延迟的最大值(秒)"
},
"kook_max_retry_delay": {
"description": "最大重试延迟",
"type": "int",
"hint": "重试的最大延迟时间(秒)"
},
"kook_heartbeat_interval": {
"description": "心跳间隔",
"type": "int",
"hint": "心跳检测间隔时间(秒)"
},
"kook_heartbeat_timeout": {
"description": "心跳超时时间",
"type": "int",
"hint": "心跳检测超时时间(秒)"
},
"kook_max_heartbeat_failures": {
"description": "最大心跳失败次数",
"type": "int",
"hint": "允许的最大心跳失败次数,超过后断开连接"
},
"kook_max_consecutive_failures": {
"description": "最大连续失败次数",
"type": "int",
"hint": "允许的最大连续失败次数,超过后停止重试"
}
},
"general": {
"description": "基本",
"admins_id": {
"description": "管理员 ID"
},
"platform_settings": {
"unique_session": {
"description": "隔离会话",
"hint": "启用后,群成员的上下文独立。"
},
"friend_message_needs_wake_prefix": {
"description": "私聊消息需要唤醒词"
},
"reply_prefix": {
"description": "回复时的文本前缀"
},
"reply_with_mention": {
"description": "回复时 @ 发送人"
},
"reply_with_quote": {
"description": "回复时引用发送人消息"
},
"forward_threshold": {
"description": "转发消息的字数阈值"
},
"empty_mention_waiting": {
"description": "只 @ 机器人是否触发等待"
}
},
"wake_prefix": {
"description": "唤醒词"
},
"disable_builtin_commands": {
"description": "禁用自带指令",
"hint": "禁用所有 AstrBot 自带指令,如 help, provider, model 等"
}
},
"whitelist": {
"description": "白名单",
"platform_settings": {
"enable_id_white_list": {
"description": "启用白名单",
"hint": "启用后,只有在白名单内的会话会被响应,白名单列表为空时代表不启用白名单(所有 ID 都会被放行)。"
},
"id_whitelist": {
"description": "白名单 ID 列表",
"hint": "使用 /sid 获取 ID。列表为空时表示该白名单不启用(即所有 ID 都在白名单内)。"
},
"id_whitelist_log": {
"description": "输出日志",
"hint": "启用后,当一条消息没通过白名单时,会输出 INFO 级别的日志。"
},
"wl_ignore_admin_on_group": {
"description": "管理员群组消息无视 ID 白名单"
},
"wl_ignore_admin_on_friend": {
"description": "管理员私聊消息无视 ID 白名单"
}
}
},
"rate_limit": {
"description": "速率限制",
"platform_settings": {
"rate_limit": {
"time": {
"description": "消息速率限制时间(秒)"
},
"count": {
"description": "消息速率限制计数"
},
"strategy": {
"description": "速率限制策略"
}
}
}
},
"content_safety": {
"description": "内容安全",
"content_safety": {
"also_use_in_response": {
"description": "同时检查模型的响应内容"
},
"baidu_aip": {
"enable": {
"description": "使用百度内容安全审核",
"hint": "您需要手动安装 baidu-aip 库。"
},
"app_id": {
"description": "App ID"
},
"api_key": {
"description": "API Key"
},
"secret_key": {
"description": "Secret Key"
}
},
"internal_keywords": {
"enable": {
"description": "关键词检查"
},
"extra_keywords": {
"description": "额外关键词",
"hint": "额外的屏蔽关键词列表,支持正则表达式。"
}
}
}
},
"t2i": {
"description": "文本转图像",
"t2i": {
"description": "文本转图像输出"
},
"t2i_word_threshold": {
"description": "文本转图像字数阈值"
}
},
"others": {
"description": "其他配置",
"platform_settings": {
"ignore_bot_self_message": {
"description": "是否忽略机器人自身的消息"
},
"ignore_at_all": {
"description": "是否忽略 @ 全体成员事件"
},
"no_permission_reply": {
"description": "用户权限不足时是否回复"
}
},
"platform_specific": {
"lark": {
"pre_ack_emoji": {
"enable": {
"description": "[飞书] 启用预回应表情"
},
"emojis": {
"description": "表情列表(飞书表情枚举名)",
"hint": "表情枚举名参考:[https://open.feishu.cn/document/server-docs/im-v1/message-reaction/emojis-introduce](https://open.feishu.cn/document/server-docs/im-v1/message-reaction/emojis-introduce)"
}
}
},
"telegram": {
"pre_ack_emoji": {
"enable": {
"description": "[Telegram] 启用预回应表情"
},
"emojis": {
"description": "表情列表(Unicode)",
"hint": "Telegram 仅支持固定反应集合,参考:[https://gist.github.com/Soulter/3f22c8e5f9c7e152e967e8bc28c97fc9](https://gist.github.com/Soulter/3f22c8e5f9c7e152e967e8bc28c97fc9)"
}
}
},
"discord": {
"pre_ack_emoji": {
"enable": {
"description": "[Discord] 启用预回应表情"
},
"emojis": {
"description": "表情列表(Unicode 或自定义表情名)",
"hint": "填写 Unicode 表情符号,例如:👍、🤔、⏳"
}
}
}
}
}
},
"plugin_group": {
"name": "插件配置",
"plugin": {
"description": "插件",
"plugin_set": {
"description": "可用插件",
"hint": "默认启用全部未被禁用的插件。若插件在插件页面被禁用,则此处的选择不会生效。"
}
}
},
"ext_group": {
"name": "扩展功能",
"segmented_reply": {
"description": "分段回复",
"platform_settings": {
"segmented_reply": {
"enable": {
"description": "启用分段回复"
},
"only_llm_result": {
"description": "仅对 LLM 结果分段"
},
"interval_method": {
"description": "间隔方法",
"hint": "random 为随机时间,log 为根据消息长度计算,$y=log_<log_base>(x)$,x为字数,y的单位为秒。"
},
"interval": {
"description": "随机间隔时间",
"hint": "格式:最小值,最大值(如:1.5,3.5)"
},
"log_base": {
"description": "对数底数",
"hint": "对数间隔的底数,默认为 2.6。取值范围为 1.0-10.0。"
},
"words_count_threshold": {
"description": "分段回复字数阈值",
"hint": "分段回复的字数上限。只有字数小于此值的消息才会被分段,超过此值的长消息将直接发送(不分段),默认为 150。"
},
"split_mode": {
"description": "分段模式",
"hint": "用于分隔一段消息。默认情况下会根据句号、问号等标点符号分隔。如填写 `[。?!]` 将移除所有的句号、问号、感叹号。re.findall(r'<regex>', text)",
"labels": [
"正则表达式",
"分段词列表"
]
},
"regex": {
"description": "分段正则表达式",
"hint": "用于按正则规则识别分段点。建议使用能匹配分隔符的表达式。"
},
"split_words": {
"description": "分段词列表",
"hint": "检测到列表中的任意词时进行分段"
},
"content_cleanup_rule": {
"description": "内容过滤正则表达式",
"hint": "移除分段后内容中的指定内容。如填写 `[。?!]` 将移除所有的句号、问号、感叹号。"
}
}
}
},
"ltm": {
"description": "群聊上下文感知(原聊天记忆增强)",
"provider_ltm_settings": {
"group_icl_enable": {
"description": "启用群聊上下文感知"
},
"group_message_max_cnt": {
"description": "最大消息数量"
},
"image_caption": {
"description": "自动理解图片",
"hint": "需要设置群聊图片转述模型。"
},
"image_caption_provider_id": {
"description": "群聊图片转述模型",
"hint": "用于群聊上下文感知的图片理解,与默认图片转述模型分开配置。"
},
"active_reply": {
"enable": {
"description": "主动回复"
},
"method": {
"description": "主动回复方法"
},
"possibility_reply": {
"description": "回复概率",
"hint": "0.0-1.0 之间的数值"
},
"whitelist": {
"description": "主动回复白名单",
"hint": "为空时不启用白名单过滤。使用 /sid 获取 ID。"
}
}
}
}
},
"system_group": {
"name": "系统配置",
"system": {
"description": "系统配置",
"t2i_strategy": {
"description": "文本转图像策略",
"hint": "文本转图像策略。`remote` 为使用远程基于 HTML 的渲染服务,`local` 为使用 PIL 本地渲染。当使用 local 时,将 ttf 字体命名为 'font.ttf' 放在 data/ 目录下可自定义字体。"
},
"t2i_endpoint": {
"description": "文本转图像服务 API 地址",
"hint": "为空时使用 AstrBot API 服务"
},
"t2i_template": {
"description": "文本转图像自定义模版",
"hint": "启用后可自定义 HTML 模板用于文转图渲染。"
},
"t2i_active_template": {
"description": "当前应用的文转图渲染模板",
"hint": "此处的值由文转图模板管理页面进行维护。"
},
"log_level": {