-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Expand file tree
/
Copy pathconfig-metadata.json
More file actions
1609 lines (1609 loc) · 67.2 KB
/
config-metadata.json
File metadata and controls
1609 lines (1609 loc) · 67.2 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 Runner",
"hint": "Select the runner for AI conversations. Defaults to AstrBot's built-in Agent runner, which supports knowledge base, persona, and tool calling features. You don't need to modify this section unless you plan to integrate third-party Agent runners like Dify, Coze, or DeerFlow.",
"provider_settings": {
"enable": {
"description": "Enable",
"hint": "Master switch for AI conversations"
},
"agent_runner_type": {
"description": "Runner",
"labels": [
"Built-in Agent",
"Dify",
"Coze",
"Alibaba Cloud Bailian Application",
"DeerFlow"
]
},
"coze_agent_runner_provider_id": {
"description": "Coze Agent Runner Provider ID"
},
"dify_agent_runner_provider_id": {
"description": "Dify Agent Runner Provider ID"
},
"dashscope_agent_runner_provider_id": {
"description": "Alibaba Cloud Bailian Application Agent Runner Provider ID"
},
"deerflow_agent_runner_provider_id": {
"description": "DeerFlow Agent Runner Provider ID"
}
}
},
"ai": {
"description": "Model",
"hint": "When using non-built-in Agent runners, the default chat model and default image caption model may not take effect, but some plugins rely on these settings to invoke AI capabilities.",
"provider_settings": {
"default_provider_id": {
"description": "Default Chat Model",
"hint": "Uses the first model when left empty"
},
"fallback_chat_models": {
"description": "Fallback chat model IDs",
"hint": "When the primary chat model request fails, fallback to these chat models in order."
},
"default_image_caption_provider_id": {
"description": "Default Image Caption Model",
"hint": "Leave empty to disable; useful for non-multimodal models"
},
"image_caption_prompt": {
"description": "Image Caption Prompt"
}
},
"provider_stt_settings": {
"enable": {
"description": "Enable Speech-to-Text",
"hint": "Master switch for STT"
},
"provider_id": {
"description": "Default Speech-to-Text Model",
"hint": "Users can also select session-specific STT models using the /provider command."
}
},
"provider_tts_settings": {
"enable": {
"description": "Enable Text-to-Speech",
"hint": "Master switch for TTS"
},
"provider_id": {
"description": "Default Text-to-Speech Model"
},
"trigger_probability": {
"description": "TTS Trigger Probability"
}
}
},
"persona": {
"description": "Persona",
"hint": "Set the default persona for AI conversations. Personas can be managed in the Persona tab.",
"provider_settings": {
"default_personality": {
"description": "Default Persona"
}
}
},
"knowledgebase": {
"description": "Knowledge Base",
"kb_names": {
"description": "Knowledge Base List",
"hint": "Supports multiple selections"
},
"kb_fusion_top_k": {
"description": "Fusion Search Results Count",
"hint": "Number of results returned after fusing search results from multiple knowledge bases"
},
"kb_final_top_k": {
"description": "Final Results Count",
"hint": "Number of results retrieved from the knowledge base. Higher values may provide more relevant information but could also introduce noise. Adjust based on actual needs"
},
"kb_agentic_mode": {
"description": "Agentic Knowledge Base Retrieval",
"hint": "When enabled, knowledge base retrieval becomes an LLM Tool, allowing the model to autonomously decide when to query the knowledge base. Requires the model to support function calling."
}
},
"websearch": {
"description": "Web Search",
"provider_settings": {
"web_search": {
"description": "Enable Web Search"
},
"websearch_provider": {
"description": "Web Search Provider"
},
"websearch_tavily_key": {
"description": "Tavily API Key",
"hint": "Multiple keys can be added for rotation."
},
"websearch_tavily_base_url": {
"description": "Tavily API Base URL",
"hint": "Default: https://api.tavily.com. Change to use a proxy or self-hosted instance."
},
"websearch_bocha_key": {
"description": "BoCha API Key",
"hint": "Multiple keys can be added for rotation."
},
"websearch_baidu_app_builder_key": {
"description": "Baidu Qianfan Smart Cloud APP Builder API Key",
"hint": "Reference: [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": "Multiple keys can be added for rotation."
},
"websearch_exa_base_url": {
"description": "Exa API Base URL",
"hint": "Default: https://api.exa.ai. Change to use a proxy or self-hosted instance."
},
"web_search_link": {
"description": "Display Source Citations"
}
}
},
"file_extract": {
"description": "File Extract",
"provider_settings": {
"file_extract": {
"enable": {
"description": "Enable File Extract"
},
"provider": {
"description": "File Extract Provider"
},
"moonshotai_api_key": {
"description": "Moonshot AI API Key"
}
}
}
},
"agent_computer_use": {
"description": "Agent Computer Use",
"hint": "Allows the AstrBot to access and use your computer or an sandbox environment to perform more complex tasks. See [Sandbox Mode](https://docs.astrbot.app/use/astrbot-agent-sandbox.html), [Skills](https://docs.astrbot.app/use/skills.html)",
"provider_settings": {
"computer_use_runtime": {
"description": "Computer Use Runtime",
"hint": "sandbox means running in a sandbox environment, local means running in a local environment, none means disabling Computer Use. If skills are uploaded, choosing none will cause them to not be usable by the Agent."
},
"computer_use_require_admin": {
"description": "Require AstrBot Admin Permission",
"hint": "When enabled, AstrBot admin permission is required to use computer capabilities. Admins can be added in Platform Config. Use the /sid command to view admin IDs."
},
"sandbox": {
"booter": {
"description": "Sandbox Environment Driver"
},
"shipyard_neo_endpoint": {
"description": "Shipyard Neo API Endpoint",
"hint": "Bay API address, default http://127.0.0.1:8114."
},
"shipyard_neo_access_token": {
"description": "Shipyard Neo Access Token",
"hint": "Bay API Key (sk-bay-...). Leave empty for auto-discovery from credentials.json."
},
"shipyard_neo_profile": {
"description": "Shipyard Neo Profile",
"hint": "Sandbox profile for Shipyard Neo, e.g. python-default."
},
"shipyard_neo_ttl": {
"description": "Shipyard Neo Sandbox TTL",
"hint": "Sandbox time-to-live in seconds."
},
"shipyard_endpoint": {
"description": "Shipyard API Endpoint",
"hint": "API access address for Shipyard service."
},
"shipyard_access_token": {
"description": "Shipyard Access Token",
"hint": "Access token for accessing Shipyard service."
},
"shipyard_ttl": {
"description": "Shipyard Session TTL",
"hint": "Session time-to-live in seconds."
},
"shipyard_max_sessions": {
"description": "Shipyard Max Sessions",
"hint": "Maximum number of Shipyard sessions an instance can handle."
}
}
}
},
"proactive_capability": {
"description": "Proactive Agent",
"hint": "AstrBot will wake up, run your tasks, and deliver the results to you. See [Proactive Agent](https://docs.astrbot.app/en/use/proactive-agent.html)",
"provider_settings": {
"proactive_capability": {
"add_cron_tools": {
"description": "Enable",
"hint": "When enabled, related tools will be passed to the Agent to implement proactive Agent capabilities. You can tell AstrBot what to do at a future time, and it will be triggered on schedule to execute the task, and report the result back to you."
}
}
}
},
"truncate_and_compress": {
"hint": "[Context Management](https://docs.astrbot.app/en/use/context-compress.html)",
"description": "Context Management Strategy",
"provider_settings": {
"max_context_length": {
"description": "Maximum Conversation Turns",
"hint": "Discards the oldest parts when this count is exceeded. One conversation round counts as 1, -1 means unlimited"
},
"dequeue_context_length": {
"description": "Dequeue Conversation Turns",
"hint": "Number of conversation turns to discard at once when maximum context length is exceeded"
},
"context_limit_reached_strategy": {
"description": "Handling When Model Context Window is Exceeded",
"labels": [
"Truncate by Turns",
"Compress by LLM"
],
"hint": "When 'Truncate by Turns' is selected, the oldest N conversation turns will be discarded based on the 'Dequeue Conversation Turns' setting above. When 'Compress by LLM' is selected, the specified model will be used for context compression."
},
"llm_compress_instruction": {
"description": "Context Compression Instruction",
"hint": "If empty, the default prompt will be used."
},
"llm_compress_keep_recent": {
"description": "Keep Recent Turns When Compressing",
"hint": "Always keep the most recent N turns of conversation when compressing context."
},
"llm_compress_provider_id": {
"description": "Model Provider ID for Context Compression",
"hint": "When left empty, will fall back to the 'Truncate by Turns' strategy."
}
}
},
"others": {
"description": "Other Settings",
"provider_settings": {
"display_reasoning_text": {
"description": "Display Reasoning Content"
},
"llm_safety_mode": {
"description": "Healthy Mode",
"hint": "Add safety guardrails to model replies."
},
"safety_mode_strategy": {
"description": "Healthy Mode Strategy",
"hint": "How to apply healthy mode."
},
"identifier": {
"description": "User Identification",
"hint": "When enabled, user ID information will be included in the prompt."
},
"group_name_display": {
"description": "Display Group Name",
"hint": "When enabled, group name information will be included in the prompt on supported platforms (OneBot v11)."
},
"datetime_system_prompt": {
"description": "Real-world Time Awareness",
"hint": "When enabled, current time information will be appended to the system prompt."
},
"show_tool_use_status": {
"description": "Output Function Call Status"
},
"show_tool_call_result": {
"description": "Output Tool Call Results",
"hint": "Only takes effect when \"Output Function Call Status\" is enabled, and shows at most 70 characters."
},
"sanitize_context_by_modalities": {
"description": "Sanitize History by Modalities",
"hint": "When enabled, sanitizes contexts before each LLM request by removing image blocks and tool-call structures that the current provider's modalities do not support (this changes what the model sees)."
},
"max_quoted_fallback_images": {
"description": "Forwarded Image Fetch Limit",
"hint": "Maximum number of images injected from forwarded-message parsing; extra images are truncated."
},
"quoted_message_parser": {
"max_component_chain_depth": {
"description": "Forwarded Rich-Text Parse Depth",
"hint": "Maximum recursive depth when parsing rich-text component chains inside forwarded messages."
},
"max_forward_node_depth": {
"description": "Forward Nesting Parse Depth",
"hint": "Maximum recursive depth when parsing nested forwarded nodes."
},
"max_forward_fetch": {
"description": "Forward Recursive Fetch Limit",
"hint": "Maximum number of recursive get_forward_msg fetch operations."
},
"warn_on_action_failure": {
"description": "Warn on Forward Parse Failure",
"hint": "When enabled, log warnings when all get_msg/get_forward_msg attempts fail."
}
},
"max_agent_step": {
"description": "Maximum Tool Call Rounds"
},
"tool_call_timeout": {
"description": "Tool Call Timeout (seconds)"
},
"tool_schema_mode": {
"description": "Tool Schema Mode",
"hint": "Skills-like sends name/description first and re-queries for parameters; Full sends the complete schema in one step.",
"labels": [
"Skills-like (two-stage)",
"Full schema"
]
},
"streaming_response": {
"description": "Streaming Output"
},
"unsupported_streaming_strategy": {
"description": "Platforms Without Streaming Support",
"hint": "Select the handling method for platforms that don't support streaming responses. Real-time segmented reply sends content immediately when the system detects segment points like punctuation during streaming reception",
"labels": [
"Real-time Segmented Reply",
"Disable Streaming Response"
]
},
"wake_prefix": {
"description": "Additional LLM Chat Wake Prefix",
"hint": "If the wake prefix is / and the additional chat wake prefix is chat, then /chat is required to trigger LLM requests"
},
"prompt_prefix": {
"description": "User Prompt",
"hint": "You can use {{prompt}} as a placeholder for user input. If no placeholder is provided, it will be added before the user input."
},
"image_compress_enabled": {
"description": "Enable image compression",
"hint": "When enabled, large local images are compressed before being sent to multimodal models."
},
"image_compress_options": {
"description": "Image compression settings",
"hint": "Control image resize limits, JPEG quality, and the minimum size threshold for compression.",
"max_size": {
"description": "Maximum edge length",
"hint": "Longest edge of the compressed image in pixels. Images larger than this are resized proportionally."
},
"quality": {
"description": "JPEG quality",
"hint": "JPEG output quality from 1 to 100. Higher values preserve more detail but produce larger files."
}
},
"reachability_check": {
"description": "Provider Reachability Check",
"hint": "When running the /provider command, test provider connectivity in parallel. This actively pings models and may consume extra tokens."
}
},
"provider_tts_settings": {
"dual_output": {
"description": "Output Both Voice and Text When TTS is Enabled"
}
}
}
},
"platform_group": {
"name": "Platform",
"platform": {
"description": "Message Platform Adapters",
"active_send_mode": {
"description": "Use Proactive Send API"
},
"appid": {
"description": "App ID",
"hint": "Required. App ID for the QQ Official Bot platform. See the docs for how to obtain it."
},
"callback_server_host": {
"description": "Callback Server Host",
"hint": "Callback server host. Leave empty to disable the callback server."
},
"card_template_id": {
"description": "Card Template ID",
"hint": "Optional. DingTalk interactive card template ID. When enabled, streaming replies will use interactive cards."
},
"discord_activity_name": {
"description": "Discord Activity Name",
"hint": "Optional Discord activity name. Leave empty to disable."
},
"discord_command_register": {
"description": "Register Discord slash commands",
"hint": "When enabled, AstrBot will automatically register plugin commands as Discord slash commands"
},
"discord_proxy": {
"description": "Discord Proxy URL",
"hint": "Optional proxy URL: http://ip:port"
},
"discord_token": {
"description": "Discord Bot Token",
"hint": "Enter your Discord Bot Token here."
},
"enable": {
"description": "Enable",
"hint": "Whether to enable this adapter. Disabled adapters will not receive messages."
},
"enable_group_c2c": {
"description": "Enable Message List Private Chat",
"hint": "When enabled, the bot can receive private chats from QQ message list. You may need to add the bot as a friend by scanning a QR code in the QQ bot platform. See docs."
},
"enable_guild_direct_message": {
"description": "Enable Guild Direct Messages",
"hint": "When enabled, the bot can receive guild direct messages."
},
"id": {
"description": "Bot Name",
"hint": "Bot name"
},
"is_sandbox": {
"description": "Sandbox Mode"
},
"kf_name": {
"description": "WeChat Customer Service Account Name",
"hint": "Optional. Customer service account name (not ID). Get it at https://kf.weixin.qq.com/kf/frame#/accounts"
},
"lark_bot_name": {
"description": "Lark Bot Name",
"hint": "Must be correct; otherwise @ mentions will not wake the bot and only prefix wake will work."
},
"lark_connection_mode": {
"description": "Subscription Mode",
"labels": [
"Long Connection Mode",
"Webhook Server Mode"
]
},
"lark_encrypt_key": {
"description": "Encrypt Key",
"hint": "Encryption key for decrypting Lark callback data."
},
"lark_verification_token": {
"description": "Verification Token",
"hint": "Token for verifying Lark callback requests."
},
"misskey_allow_insecure_downloads": {
"description": "Allow Insecure Downloads (Disable SSL Verification)",
"hint": "If remote servers have certificate issues, SSL verification will be disabled as a fallback. Use only when necessary due to security risks."
},
"misskey_default_visibility": {
"description": "Default Post Visibility",
"hint": "Default visibility for bot posts. public: public, home: home timeline, followers: followers only."
},
"misskey_download_chunk_size": {
"description": "Stream Download Chunk Size (bytes)",
"hint": "Bytes read per chunk during streaming download and MD5 calculation. Too small increases overhead; too large uses more memory."
},
"misskey_download_timeout": {
"description": "Remote Download Timeout (seconds)",
"hint": "Timeout for downloading remote files (seconds), used when falling back to local upload."
},
"misskey_enable_chat": {
"description": "Enable Chat Message Responses",
"hint": "When enabled, the bot listens and responds to private chat messages."
},
"misskey_enable_file_upload": {
"description": "Enable File Upload to Misskey",
"hint": "When enabled, the adapter uploads files in message chains to Misskey. URL files try server-side upload first; if async upload fails, it falls back to local download and upload."
},
"misskey_instance_url": {
"description": "Misskey Instance URL",
"hint": "e.g. https://misskey.example. The Misskey instance where the bot account lives."
},
"misskey_local_only": {
"description": "Local Only (No Federation)",
"hint": "When enabled, bot posts are visible only on this instance and are not federated."
},
"misskey_max_download_bytes": {
"description": "Max Download Size (bytes)",
"hint": "To limit download size to prevent OOM, set the maximum bytes; empty or null means no limit."
},
"misskey_token": {
"description": "Misskey Access Token",
"hint": "API access token generated in the connection service settings."
},
"misskey_upload_concurrency": {
"description": "Upload Concurrency Limit",
"hint": "Max number of concurrent upload tasks (integer, default 3)."
},
"misskey_upload_folder": {
"description": "Target Drive Folder ID",
"hint": "Optional: ID of the target folder in Misskey drive. Leave empty to use the root folder."
},
"port": {
"description": "Callback Server Port",
"hint": "Callback server port. Leave empty to disable the callback server."
},
"satori_api_base_url": {
"description": "Satori API Endpoint",
"hint": "Base URL for the Satori API."
},
"satori_auto_reconnect": {
"description": "Enable Auto Reconnect",
"hint": "Automatically reconnect the WebSocket when disconnected."
},
"satori_endpoint": {
"description": "Satori WebSocket Endpoint",
"hint": "WebSocket endpoint for Satori events."
},
"satori_heartbeat_interval": {
"description": "Satori Heartbeat Interval",
"hint": "Interval in seconds between heartbeat messages."
},
"satori_reconnect_delay": {
"description": "Satori Reconnect Delay",
"hint": "Delay before attempting to reconnect (seconds)."
},
"satori_token": {
"description": "Satori Token",
"hint": "Token for Satori API authentication."
},
"secret": {
"description": "Secret",
"hint": "Required."
},
"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 Command Auto Refresh",
"hint": "When enabled, AstrBot automatically refreshes Telegram commands at runtime. (Setting this alone has no effect)"
},
"telegram_command_register": {
"description": "Telegram Command Registration",
"hint": "When enabled, AstrBot automatically registers Telegram commands."
},
"telegram_command_register_interval": {
"description": "Telegram Command Auto Refresh Interval",
"hint": "Telegram command auto-refresh interval in seconds."
},
"telegram_polling_restart_delay": {
"description": "Telegram Polling Restart Delay",
"hint": "Waiting time in seconds when the polling loop needs to restart after unexpected exits. Defaults to 5s."
},
"telegram_token": {
"description": "Bot Token",
"hint": "If you are in mainland China, set a proxy or change api_base in Other Settings."
},
"type": {
"description": "Adapter Type"
},
"unified_webhook_mode": {
"description": "Unified Webhook Mode",
"hint": "When enabled, use AstrBot unified webhook entry without opening a separate port. Callback URL is /api/platform/webhook/{webhook_uuid}."
},
"webhook_uuid": {
"description": "Webhook UUID",
"hint": "Unique identifier for unified webhook mode; generated when creating the platform."
},
"wecom_ai_bot_name": {
"description": "WeCom AI Bot Name",
"hint": "Must be correct; otherwise some commands won't work."
},
"wecom_ai_bot_connection_mode": {
"description": "WeCom AI Bot Connection Mode",
"hint": "Webhook mode requires Token/EncodingAESKey; long_connection mode requires BotID/Secret."
},
"wecomaibot_friend_message_welcome_text": {
"description": "WeCom AI Bot DM Welcome Message",
"hint": "When a user enters a DM session on that day, reply with a welcome message. Leave empty to disable."
},
"wecomaibot_init_respond_text": {
"description": "WeCom AI Bot Initial Response Text",
"hint": "First reply when the bot receives a message. Leave empty to disable."
},
"wecomaibot_token": {
"description": "WeCom AI Bot Token",
"hint": "Used for authentication in webhook callback mode."
},
"wecomaibot_encoding_aes_key": {
"description": "WeCom AI Bot EncodingAESKey",
"hint": "Used for message encryption/decryption in webhook callback mode."
},
"wecomaibot_ws_bot_id": {
"description": "Long Connection BotID",
"hint": "BotID credential for WeCom AI Bot long connection mode."
},
"wecomaibot_ws_secret": {
"description": "Long Connection Secret",
"hint": "Secret credential for WeCom AI Bot long connection mode."
},
"wecomaibot_ws_url": {
"description": "Long Connection WebSocket URL",
"hint": "Default is wss://openws.work.weixin.qq.com and usually does not need changes."
},
"wecomaibot_heartbeat_interval": {
"description": "Long Connection Heartbeat Interval",
"hint": "Heartbeat interval (seconds) in long connection mode. 30 seconds is recommended."
},
"wpp_active_message_poll": {
"description": "Enable Proactive Message Polling",
"hint": "Only enable if WeChat messages are not syncing to AstrBot on time. Disabled by default."
},
"wpp_active_message_poll_interval": {
"description": "Proactive Message Poll Interval",
"hint": "Interval in seconds, default 3, should not exceed 60 or it may be considered old messages."
},
"ws_reverse_host": {
"description": "Reverse WebSocket Host",
"hint": "AstrBot acts as the server."
},
"ws_reverse_port": {
"description": "Reverse WebSocket Port"
},
"ws_reverse_token": {
"description": "Reverse WebSocket Token",
"hint": "Reverse WebSocket token. If not set, token verification is disabled."
},
"msg_push_webhook_url": {
"description": "WeCom Message Push Webhook URL",
"hint": "Used for proactive message push. It is strongly recommended to set this for a better message sending experience."
},
"only_use_webhook_url_to_send": {
"description": "Send Replies via Webhook Only",
"hint": "When enabled, all WeCom AI Bot replies are sent through msg_push_webhook_url. The message push webhook supports more message types (such as images, files, etc.). If you do not need the typing effect, it is strongly recommended to use this option. "
},
"weixin_oc_base_url": {
"description": "API Base URL",
"hint": "Default: https://ilinkai.weixin.qq.com"
},
"weixin_oc_bot_type": {
"description": "bot_type (QR login parameter)",
"hint": "Default: 3"
},
"weixin_oc_qr_poll_interval": {
"description": "QR status poll interval (seconds)",
"hint": "Polling interval in seconds for QR code status."
},
"weixin_oc_long_poll_timeout_ms": {
"description": "getUpdates long-poll timeout (ms)",
"hint": "Timeout parameter for polling messages."
},
"weixin_oc_api_timeout_ms": {
"description": "HTTP timeout (ms)",
"hint": "Generic API request timeout."
},
"weixin_oc_token": {
"description": "Token after login (optional)",
"hint": "Automatically written after QR login; can be filled manually for advanced scenarios."
},
"kook_bot_token": {
"description": "Bot Token",
"type": "string",
"hint": "Required. The Bot Token obtained from the KOOK Developer Platform."
},
"kook_reconnect_delay": {
"description": "Reconnect Delay",
"type": "int",
"hint": "Delay time for reconnection (seconds), using an exponential backoff strategy."
},
"kook_max_reconnect_delay": {
"description": "Max Reconnect Delay",
"type": "int",
"hint": "The maximum value for reconnection delay (seconds)."
},
"kook_max_retry_delay": {
"description": "Max Retry Delay",
"type": "int",
"hint": "The maximum delay time for retries (seconds)."
},
"kook_heartbeat_interval": {
"description": "Heartbeat Interval",
"type": "int",
"hint": "The interval time for heartbeat detection (seconds)."
},
"kook_heartbeat_timeout": {
"description": "Heartbeat Timeout",
"type": "int",
"hint": "The timeout duration for heartbeat detection (seconds)."
},
"kook_max_heartbeat_failures": {
"description": "Max Heartbeat Failures",
"type": "int",
"hint": "Maximum allowed heartbeat failures; the connection will be dropped if exceeded."
},
"kook_max_consecutive_failures": {
"description": "Max Consecutive Failures",
"type": "int",
"hint": "Maximum allowed consecutive failures; retries will stop if exceeded."
}
},
"general": {
"description": "General",
"admins_id": {
"description": "Administrator IDs"
},
"platform_settings": {
"unique_session": {
"description": "Isolate Sessions",
"hint": "When enabled, group members have independent contexts."
},
"friend_message_needs_wake_prefix": {
"description": "Private Messages Require Wake Word"
},
"reply_prefix": {
"description": "Reply Text Prefix"
},
"reply_with_mention": {
"description": "Mention Sender in Reply"
},
"reply_with_quote": {
"description": "Quote Sender's Message in Reply"
},
"forward_threshold": {
"description": "Forward Message Word Count Threshold"
},
"empty_mention_waiting": {
"description": "Trigger Waiting on Mention-only Messages"
}
},
"wake_prefix": {
"description": "Wake Word"
},
"disable_builtin_commands": {
"description": "Disable Built-in Commands",
"hint": "Disable all built-in AstrBot commands such as help, provider, model, etc."
}
},
"whitelist": {
"description": "Whitelist",
"platform_settings": {
"enable_id_white_list": {
"description": "Enable Whitelist",
"hint": "When enabled, only sessions in the whitelist will be responded to. If the whitelist is empty, the whitelist is disabled and all IDs are allowed."
},
"id_whitelist": {
"description": "Whitelist ID List",
"hint": "Use /sid to get IDs. If the list is empty, it means whitelist is disabled (all IDs are in the whitelist)."
},
"id_whitelist_log": {
"description": "Output Logs",
"hint": "When enabled, INFO level logs will be output when a message doesn't pass the whitelist."
},
"wl_ignore_admin_on_group": {
"description": "Administrator Group Messages Bypass ID Whitelist"
},
"wl_ignore_admin_on_friend": {
"description": "Administrator Private Messages Bypass ID Whitelist"
}
}
},
"rate_limit": {
"description": "Rate Limiting",
"platform_settings": {
"rate_limit": {
"time": {
"description": "Message Rate Limit Time (seconds)"
},
"count": {
"description": "Message Rate Limit Count"
},
"strategy": {
"description": "Rate Limit Strategy"
}
}
}
},
"content_safety": {
"description": "Content Safety",
"content_safety": {
"also_use_in_response": {
"description": "Also Check Model Response Content"
},
"baidu_aip": {
"enable": {
"description": "Use Baidu Content Safety Moderation",
"hint": "You need to manually install the baidu-aip library."
},
"app_id": {
"description": "App ID"
},
"api_key": {
"description": "API Key"
},
"secret_key": {
"description": "Secret Key"
}
},
"internal_keywords": {
"enable": {
"description": "Keyword Check"
},
"extra_keywords": {
"description": "Additional Keywords",
"hint": "Additional keyword blocklist, supports regular expressions."
}
}
}
},
"t2i": {
"description": "Text-to-Image",
"t2i": {
"description": "Text-to-Image Output"
},
"t2i_word_threshold": {
"description": "Text-to-Image Word Count Threshold"
}
},
"others": {
"description": "Other Settings",
"platform_settings": {
"ignore_bot_self_message": {
"description": "Ignore Bot's Own Messages"
},
"ignore_at_all": {
"description": "Ignore @All Events"
},
"no_permission_reply": {
"description": "Reply When User Has Insufficient Permissions"
}
},
"platform_specific": {
"lark": {
"pre_ack_emoji": {
"enable": {
"description": "[Lark] Enable Pre-acknowledgment Emoji"
},
"emojis": {
"description": "Emoji List (Lark Emoji Enum Names)",
"hint": "Emoji enum names reference: [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] Enable Pre-acknowledgment Emoji"
},
"emojis": {
"description": "Emoji List (Unicode)",
"hint": "Telegram only supports a fixed reaction set, reference: [https://gist.github.com/Soulter/3f22c8e5f9c7e152e967e8bc28c97fc9](https://gist.github.com/Soulter/3f22c8e5f9c7e152e967e8bc28c97fc9)"
}
}
},
"discord": {
"pre_ack_emoji": {
"enable": {
"description": "[Discord] Enable Pre-acknowledgment Emoji"
},
"emojis": {
"description": "Emoji List (Unicode or Custom Emoji Name)",
"hint": "Enter Unicode emoji symbols, e.g., 👍, 🤔, ⏳"
}
}
}
}
}
},
"plugin_group": {
"name": "Plugin",
"plugin": {
"description": "Plugins",
"plugin_set": {
"description": "Available Plugins",
"hint": "All non-disabled plugins are enabled by default. If a plugin is disabled on the plugins page, selections here will not take effect."
}
}
},
"ext_group": {
"name": "Ext.",
"segmented_reply": {
"description": "Segmented Reply",
"platform_settings": {
"segmented_reply": {
"enable": {
"description": "Enable Segmented Reply"
},
"only_llm_result": {
"description": "Segment Only LLM Results"
},
"interval_method": {
"description": "Interval Method",
"hint": "random uses a random delay. log calculates delay by message length: $y=log_{log\\_base}(x)$, where x is word count and y is in seconds."
},
"interval": {
"description": "Random Interval Time",
"hint": "Format: minimum,maximum (e.g., 1.5,3.5)"
},
"log_base": {
"description": "Logarithm Base",
"hint": "Base for logarithmic intervals, defaults to 2.6. Value range: 1.0-10.0."
},
"words_count_threshold": {
"description": "Segmented Reply Word Count Threshold",
"hint": "Segmented reply word count threshold. Only messages with less than this number of words will be segmented, and messages with more than this number of words will be sent directly (not segmented)."
},
"split_mode": {
"description": "Split Mode",
"hint": "Used to segment a message. By default, it will be separated by punctuation marks like period, question mark, etc. For example, filling `[。?!]` will remove all periods, question marks, and exclamation marks. re.findall(r'<regex>', text)",
"labels": [
"Regex",
"Words List"
]
},
"regex": {
"description": "Segmentation Regular Expression",
"hint": "Used to identify split points with a regular expression. Prefer patterns that match separators."
},
"split_words": {
"description": "Split Word List",
"hint": "Split when any word in the list is detected"
},
"content_cleanup_rule": {
"description": "Content Filtering Regular Expression",
"hint": "Remove specified content from segmented content. For example, `[。?!]` will remove all periods, question marks, and exclamation marks."
}
}
}
},
"ltm": {
"description": "Group Chat Context Awareness (formerly Chat Memory Enhancement)",
"provider_ltm_settings": {
"group_icl_enable": {
"description": "Enable Group Chat Context Awareness"
},
"group_message_max_cnt": {
"description": "Maximum Message Count"
},
"image_caption": {
"description": "Auto-understand Images",
"hint": "Requires setting a group chat image caption model."
},
"image_caption_provider_id": {
"description": "Group Chat Image Caption Model",
"hint": "Used for image understanding in group chat context awareness, configured separately from the default image caption model."
},
"active_reply": {
"enable": {
"description": "Active Reply"
},
"method": {
"description": "Active Reply Method"
},
"possibility_reply": {
"description": "Reply Probability",
"hint": "Value between 0.0-1.0"
},
"whitelist": {
"description": "Active Reply Whitelist",
"hint": "Whitelist filtering is disabled when empty. Use /sid to get IDs."
}
}
}
}
},
"system_group": {
"name": "System",
"system": {
"description": "System Settings",
"t2i_strategy": {
"description": "Text-to-Image Strategy",
"hint": "Text-to-image strategy. `remote` uses a remote HTML-based rendering service, `local` uses PIL for local rendering. When using local, place a TTF font named 'font.ttf' in the data/ directory to customize the font."
},
"t2i_endpoint": {
"description": "Text-to-Image Service API Endpoint",
"hint": "Uses AstrBot API service when empty"
},
"t2i_template": {
"description": "Text-to-Image Custom Template",
"hint": "When enabled, you can customize HTML templates for text-to-image rendering."
},
"t2i_active_template": {
"description": "Currently Active Text-to-Image Rendering Template",
"hint": "This value is maintained by the text-to-image template management page."
},
"log_level": {
"description": "Console Log Level",
"hint": "Log level for console output."