GoATuber API list

GoATuber后端API接口列表。未来会详细化。

control页

config配置文件修改

初始化

  GET /control/init

用于请求配置文件信息。不需要请求值。返回值为复杂object。

监听平台更改（示例）

  POST /control/config/monitor

传入复杂object。返回示例（后续不再给出返回示例）。

{
"info":null,
"status":"ok"
}

过滤器选择

  POST /control/config/filter

LLM平台选择

  POST /control/config/llm

文本转语音平台选择

  POST /control/config/voice

语音转文本平台选择

  POST /control/config/speech

情感分析

  POST /control/config/mood

代理服务

  POST /control/config/proxy

修改bilibili监听配置

  POST /control/config/bilibili

修改azure相关配置

  POST /control/config/azure

修改讯飞相关配置

  POST /control/config/xunfei

传入复杂JSON object，字段解释如下(by chatgpt)：

讯飞结构体

Field	Description	JSON Key	JSON Type
XunFeiSpark	讯飞文本生成服务（星火大模型）	"xun_fei_spark"	Object (JSON Object)
XunFeiTTS	讯飞文本转语音服务	"xun_fei_tts"	Object (JSON Object)

讯飞星火大模型结构

Field	Description	JSON Key	JSON Type
HostURL	讯飞星火大模型请求地址	"host_url"	String (JSON String)
AppID	讯飞星火大模型应用ID	"app_id"	String (JSON String)
ApiKey	讯飞星火大模型API Key	"api_key"	String (JSON String)
ApiSecret	讯飞星火大模型API Secret	"api_secret"	String (JSON String)
Domain	指定访问的领域(general指向V1.5版本 generalv2指向V2版本)	"domain"	String (JSON String)
Temperature	核采样阈值(用于决定结果随机性，取值越高随机性越强即相同的问题得到的不同答案的可能性越高。取值为[0,1],默认为0.5)	"temperature"	Number (JSON Number)
MaxTokens	模型回答token最大用量(V1.5取值为[1,4096]，V2.0取值为[1,8192]。默认为2048)	"max_tokens"	Number (JSON Number)
TopK	Top K(从k个候选中随机选择⼀个（⾮等概率）,取值为[1，6],默认为4)	"top_k"	Number (JSON Number)
Prompt	Prompt提示词。按照指定方案拼接。	"prompt"	String (JSON String)
MemoryAndClean	文本生成服务:短期记忆与清理(同azure相应字段)	"memory_and_clean"	Object (JSON Object)

讯飞TTS结构

Field	Description	JSON Key	JSON Type
ApiKey	讯飞TTS API Key	"api_key"	String (JSON String)
ApiSecret	讯飞TTS API Secret	"api_secret"	String (JSON String)
AppID	讯飞TTS API ID	"app_id"	String (JSON String)
XunFeiVoice	XunFei Voice Configuration(这里不需要再起一个二级，直接跟在后面就好)	"xun_fei_voice"	Object (JSON Object)

讯飞TTS XunFeiVoice字段

Field	Description	JSON Key	JSON Type
Auf	音频采样率(audio/L16;rate=8000：合成8K 的音频audio/L16;rate=16000：合成16K 的音频)	"auf"	String (JSON String)
Vcn	发音人	"vcn"	String (JSON String)
Speed	语速(可选值：[0-100]，默认为50)	"speed"	Number (JSON Number)
Volume	音量(可选值：[0-100]，默认为50)	"volume"	Number (JSON Number)
Pitch	音高(可选值：[0-100]，默认为50)	"pitch"	Number (JSON Number)
Reg	英文发音方式(0：自动判断处理.如果不确定将按照英文词语拼写处理（缺省）1：所有英文按字母发音 2：自动判断处理，如果不确定将按照字母朗读)	"reg"	String (JSON String)
Rdn	合成音频数字发音方式(0：自动判断（默认值）1：完全数值 2：完全字符串 3：字符串优先)	"rdn"	String (JSON String)

修改百度相关配置

  POST /control/config/baidu

传入复杂object。字段解释如下(by chatgpt):

百度结构体

Field	Description	JSON Key	JSON Type
BaiduFilter	百度过滤服务配置	"baidu_filter"	Object (JSON Object)
BaiduErnie	百度文本生成服务(文心一言)	"baidu_ernie"	Object (JSON Object)

百度 文心一言服务结构

Field	Description	JSON Key	JSON Type
APPID	文心一言应用ID	"app_id"	String (JSON String)
APIKey	文心一言API Key	"api_key"	String (JSON String)
SecretKey	文心一言Secret Key	"secret_key"	String (JSON String)
Temperature	温度(说明:（1）较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定（2）默认0.95，范围 (0, 1.0]，不能为0（3）建议top_p和temperature不要同时更改)	"temperature"	Number (JSON Number)
TopP	TopP (说明：（1）影响输出文本的多样性，取值越大，生成文本的多样性越强（2）默认0.8，取值范围 [0, 1.0]（3）建议top_p和temperature不要同时更改)	"top_p"	Number (JSON Number)
PenaltyScore	Penalty Score(通过对已生成的token增加惩罚，减少重复生成的现象。说明：（1）值越大表示惩罚越大（2）默认1.0，取值范围：[1.0, 2.0])	"penalty_score"	Number (JSON Number)
Prompt	Prompt (前端通过指定方式拼接得到)	"prompt"	String (JSON String)
MemoryAndClean	记忆与清理，同azure	"memory_and_clean"	Object (JSON Object)

百度文本审查服务结构

Field	Description	JSON Key	JSON Type
APIKey	百度文本审查服务API Key	"api_key"	String (JSON String)
SecretKey	百度文本审查服务Secret Key	"secret_key"	String (JSON String)