跳转至

AppAdmin使用指引

AppAdmin是AI应用的管理员，如HaiChat和HaiAcademic等。这些Apps通过调用高能AI平台的共性服务实现面向具体场景的应用，这些服务包括AI模型、科学工具、知识图谱、智能体等等。

  • AppAdmin可以登录管理界面AdminUI。
  • AppAdmin可以查看用户信息，为用户创建专属API-KEY，查看用户的请求日志等。

1 获取AppAdmin用户和API-KEY

1.1 获取AppAdmin用户

请联系Admin创建AppAdmin用户，创建方法见此处。

1.2 登录高能AI管理界面

获得账号密码后登录高能AI框架管理页面admin_ui，界面如下：

LOGO

1.3 创建API-KEY

为自己（AppAdmin）创建API-KEY。点击创建APIKey按钮，填写相关信息，如下：

LOGO

点击提交创建，创建后API-KEY会显示在状态栏。

注意：出于安全考虑，API-KEY只会显示一次，表格中的API-KEY会被加密，如果遗失删除重新创建。

2 AppAdmin为他人创建API-KEY

为他人创建API-KEY需要使用客户端或网络请求的方式。

2.1 准备依赖

  • 需要安装hepai>=1.1.26
  • 需要app_admin的API-KEY保存到环境变量APP_ADMIN_API_KEY中。

（1）安装HepAI库

安装：

$ pip install hepai --upgrade

（2） 保存API-KEY到环境变量

需要先将app_admin的API-KEY保存到环境变量APP_ADMIN_API_KEY中，以便HepAI库调用。

$ vi ~/.bashrc
# 添加一行并保存，将<Your API-KEY>替换为实际的API-KEY
export APP_ADMIN_API_KEY="<Your API-KEY>"
# 激活环境变量
# source ~/.bashrc

注意：不建议将API-KEY直接写入代码中，以免泄露。

2.2 客户端请求创建API-KEY

import os
from hepai import HepAI
from hepai.types import APIKeyInfo, HUserListPage


api_key = os.getenv("APP_ADMIN_API_KEY")  # 从环境变量中读取API-KEY
base_url = "https://aiapi001.ihep.ac.cn/apiv2"  # 服务端地址
client = HepAI(api_key=api_key, base_url=base_url)

username = "zdzhang@ihep.ac.cn"
api_key: APIKeyInfo = self.client.fetch_api_key(username=username)
print(api_key)
  • 服务器端会进行权限验证，仅AppAdmin的API-KEY可以创建普通用户的API-KEY，被创建的API-KEY将属于相应用户，并记录由AppAdmin创建。
  • 普通用户可使用该API-KEY访问高能AI平台的模型、数据、软件等资源，权限与用户自身权限相关。

2.3 通过网络请求创建API-KEY

curl -v -X POST https://aiapi001.ihep.ac.cn/apiv2/key/fetch_api_key \
     -H "Authorization: Bearer $APP_ADMIN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
           "username": "zdzhang@ihep.ac.cn"
         }'
  • 需要将app_admin的API-KEY验证信息放入请求头中
  • 具体参数见API文档。