访问令牌
访问令牌
目录
1. 什么是访问令牌
访问令牌用于AI Studio用户进行身份验证,可通过访问令牌向 AI Studio执行授权范围(如仓库相关的读取访问权限、服务 API 的调用权限等)指定的特定操作。
个人访问令牌管理
说明:若您已切换至新版,可通过右上角个人头像,进入【个人中心】查看您的访问令牌。
目前访问令牌允许执行以下权限范围的操作:
-
Git仓库相关:是指对 AI Studio模型库repo相关操作的权限。
- 读取:具有此权限的令牌只能用于提供对您账户下仓库的访问权限。如果您需要从AI Studio读取内容(例如,在下载私有模型或进行推理时),请使用此权限。
- 写入:具有此权限的令牌另外授予对您账户下仓库的写入访问权限。如果您需要创建或修改仓库的内容(例如,在训练模型或修改模型卡时),请使用此令牌。
- 非Git仓库相关:是指对该帐号下其他与仓库管理无关的 API 调用权限,如大模型开发 API调用授权。
说明:目前 AI Studio个人中心的默认访问令牌权限包括以上所有权限范围,后续权限范围管理功能将逐步上线,敬请期待。
注意:请谨慎管理您的访问令牌,若该令牌意外泄漏可尽快通过邮箱( aistudio@baidu.com )联系平台更新修改 Token Key。
2. 如何使用访问令牌
AI Studio访问令牌目前支持以下三种使用方式:
- 在接口调用时,添加token为入参;
- 执行前,设置环境变量AISTUDIO_ACCESS_TOKEN=token值,随后请求将会直接使用环境变量中的token,无需再次输入;
- 执行前,设置token值到文件${AISTUDIO_CACHE_HOME}/.cache/aistudio/.auth/token的正文(AISTUDIO_CACHE_HOME值为可配置的sdk本地工作目录,默认为$HOME)(注意:此方式在 AI Studio项目notebook中禁用)
说明:以上三种使用方式的优先级为1>2>3,即前一种设置方式的token值会被优先使用,后一种方法设置的token值将被忽略。
3. 访问令牌应用示例
3.1 示例一:ERNIE SDK的认证鉴权
ERNIE SDK是文心&飞桨官方提供的Python软件开发工具包,简称EB SDK。
EB SDK提供便捷易用的Python接口,可调用文心大模型能力,完成包含文本创作、通用对话、语义向量、AI作图在内的多项任务。使用ERNIE SDK需要优先完成认证鉴权。
ERNIE SDK认证鉴权主要是设置后端和access token,分别通过api_type
和access_token
参数来指定。
对于 AI Studio 的用户,默认使用aistudio
后端(api_type
为aistudio
),可前往个人中心的 访问令牌页面 查看个人专属 access token,复制后填入下面代码中即可(替换{access-token-for-aistudio}
),具体鉴权参数设置方式说明如下:
- 使用环境变量:
export EB_API_TYPE="aistudio"
export EB_ACCESS_TOKEN="<access-token-for-aistudio>"
- 使用全局变量:
import erniebot
erniebot.api_type = "aistudio"
erniebot.access_token = "<access-token-for-aistudio>"
- 使用config参数:
import erniebot
response = erniebot.ChatCompletion.create(
_config_=dict(
api_type="aistudio",
access_token="<access-token-for-aistudio>",
),
model="ernie-3.5",
messages=[{"role": "user", "content": "你好,请介绍下你自己",
}],
)
请注意:
- 不同后端的access token获取方式不同,特定后端获取的access token无法用于其他后端的认证鉴权(上述示例为使用
aistudio
后端的情况)。 - Access Token属于个人账户的重要隐私信息,切记随意对外公开。
aistudio
后端的Access Token对应每个用户的个人账户,目前每个账户均拥有100万token的免费额度,可以用于ERNIE SDK相关功能的调用。
更多 ERNIE SDK相关教程及应用体验可参见以下内容:
2 示例二:AI Studio模型库SDK的认证鉴权
飞桨AI Studio模型库 是用户分享深度学习模型、demo体验和相关范例教程的地方,支持用户轻松地创建和管理自己的模型,可通过界面或开发环境快速方便地上传、下载相关模型文件并进行二次开发。
aistudio_sdk.hub库可帮助您在不离开开发环境的情况下与Hub进行交互。您可以轻松创建和管理您的个人仓库,下载和上传文件,并从Hub获得有用的模型和相关元数据。
目前{aistudio_hub}
SDK支持以下三种鉴权参数设置方式:
- 在接口调用时,添加token为入参
- 执行前,设置环境变量AISTUDIO_ACCESS_TOKEN=token值
- 执行前,设置token值到文件${AISTUDIO_CACHE_HOME}/.cache/aistudio/.auth/token的正文(AISTUDIO_CACHE_HOME值为可配置的sdk本地工作目录,默认为$HOME)
三种方法的优先级为1>2>3,即优先级高的方法设置的token值会被优先使用,优先级较低方法设置的token值将会被忽略。更多{aistudio_hub}
使用教程可参考AI Studio SDK快速开始。