后台管理¶

登录¶

BRConnector 的管理后台路径为：http(s)://your-endpoint/manager/

一旦您有了 BRConnector 的 API Key，就可以登录 manager 管理后台了。

API key 分管理员权限和普通用户权限。普通用户可以看到自己的消费和聊天记录。

管理员角色除了拥有普通用户的功能，还可以管理 API key，模型和组。

API Keys 管理¶

主要功能¶

创建一个用户（颁发一个 Key）。
批量导入用户。
修改这个 Key，修改名字，月消费额等。
重置 Key。
给 Key 充值。

批量导入用户¶

需要准备一个 csv 文件，列应该包含 name 和 email 两个字段。

本项目直接支持了 cognito 的导入模版，这里是一个 cognito 的 excel 示例，用户的名字会优先采纳 cognito:username，然后 name。

cognito:username,name,given_name,family_name,middle_name,nickname,preferred_username,profile,picture,website,email,email_verified,gender,birthdate,zoneinfo,locale,phone_number,phone_number_verified,address,updated_at,cognito:mfa_enabled
John,,John,Doe,,,,,,,johndoe@example.com,TRUE,,02/01/1985,,,+12345550100,TRUE,123 Any Street,,FALSE
Jane,,Jane,Roe,,,,,,,janeroe@example.com,TRUE,,01/01/1985,,,+12345550199,TRUE,100 Main Street,,FALSE

Note

如果您配置了 SMTP，并且在 csv 文件里里包含了用户 email，那么 API key 会直接通过邮件发送给用户。

模型管理¶

包含如下功能：

创建模型
修改模型

您第一次部署 BRConnector 的时候，会发现系统仅内置了 bedrock-converse 支持的部分模型。

为了使用新的 Provider，您需要在后台创建一个模型。

创建模型，进入 manager 后台，如图：

模型表单：

模型由以下几个字段组成：

Key	Type	Required	Default value	Description
Name	string	Y		模型的名字，这个名字也是 API 调用中的模型名字
Provider	string	Y		Privder 这个由 BRConnector 提供选择。
Multiple	int	N	0	当前模型是否支持多模态。
Prince-In	number	Y		输入 token 的价格。这个价格您可以随意定义，主要用于控制本系统的模型调用
Prince-Out	number	Y		输出 token 的价格。
Config	string(json)	N		根据不同的提供器会提供不同的配置。

Tip

某些客户端可能限制用户自定义模型名称。为了使 BRConnector 能够响应这类请求，您可以采取以下策略：

在后台创建一个与客户端指定名称相匹配的新模型，从而将请求转发至您的实际后端模型。
另外，您可以创建一个名为 “default” 的通用模型。这样，无论前端传入何种模型名称，BRConnector 都能做出响应。

这些方法可以确保 BRConnector 在面对各种客户端请求时保持灵活性和兼容性，从而提高系统的整体适应能力。

组管理¶

通过组，您可以方便地给模型授权。

同时 API Keys 也可以属于某一个组。

模型授权¶

创建完模型，您需要将该模型授权给组或者用户（API Key）。

在 API Keys 的列表页面，点击 Models 按钮。

在 Groups 的列表页面，同样也有 Models 按钮。

API Keys 与组授权的模型是 “并” 的关系。

Webhoook 配置¶

包含如下功能：

添加飞书机器人
修改飞书机器人

创建飞书机器人，进入 manager 后台，如图：

Webhook表单：

Webhook由以下几个字段组成：

Key	Type	Required	Description
Name	string	Y	Webhook的名字，这个名字也决定了 Webhook 的 URL 地址
Provider	string	Y	Privder 这个由 BRConnector 提供选择。
Config	string(json)	N	根据不同的提供器会提供不同的配置。

Config样例¶

{
  "appId": "cli_xxxxx",
  "apiKey": "br-xxxxx",
  "modelId": "claude-3-sonnet",
  "appSecret": "xxxxx"
}

appId: 飞书机器人的 app id
apiKey: BRConnector 用户的 api key，飞书机器人将用这个 api key 的相关权限调用模型
modelId: BRConnector中模型的名字
appSecret: 飞书机器人的 app secret

Note

注意：目前添加 Webhook 后必须重启BRConnector 才能生效。

配置完成后的 Webhook URL 示例：

https://<yourdomain>/bot/feishu/<webhook-name>/webhook/event
https://www.example.com/bot/feishu/feishu001/webhook/event