[Docs] Access Token as First Choice

Author: juncaipeng

README.md

@@ -38,9 +38,8 @@ print(models)
 # ernie-vilg-v2         文心一格模型
 
 # Set authentication params
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 # Create a chat completion
 response = erniebot.ChatCompletion.create(model="ernie-bot-3.5", messages=[{"role": "user", "content": "你好，请介绍下你自己"}])
@@ -55,17 +54,15 @@ print(response.result)
 erniebot api model.list
 
 # Set authentication params for chat_completion.create
-export EB_API_TYPE="qianfan"
-export EB_AK="<ak-for-qianfan>"
-export EB_SK="<sk-for-qianfan>"
+export EB_API_TYPE="aistudio"
+export EB_ACCESS_TOKEN="<access-token-for-aistudio>"
 
 # Create a chat completion (using ernie-bot-3.5, ernie-bot-turbo, etc.)
 erniebot api chat_completion.create --model ernie-bot-3.5 --message user "请介绍下你自己"
 
 # Set authentication params for image.create
 export EB_API_TYPE="yinian"
-export EB_AK="<ak-for-yinian>"
-export EB_SK="<sk-for-yinian>"
+export EB_ACCESS_TOKEN="<access-token-for-yinian>"
 
 # Generate images via ERNIE-ViLG
 erniebot api image.create --model ernie-vilg-v2 --prompt "画一只驴肉火烧" --height 1024 --width 1024 --image-num 1
@@ -84,9 +81,8 @@ ERNIE Bot SDK提供具备对话补全能力的文心一言旗舰版模型ernie-b
 ```python
 import erniebot
 
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 response = erniebot.ChatCompletion.create(
     model="ernie-bot-3.5",
@@ -116,9 +112,8 @@ ERNIE Bot SDK提供用于提取语义向量的Embedding模型。
 ```python
 import erniebot
 
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 response = erniebot.Embedding.create(
     model="ernie-text-embedding",
@@ -142,8 +137,7 @@ ERNIE Bot SDK提供具备文生图能力的ERNIE-ViLG大模型。
 import erniebot
 
 erniebot.api_type = "yinian"
-erniebot.ak = "<ak-for-yinian>"
-erniebot.sk = "<sk-for-yinian>"
+erniebot.access_token = "<access-token-for-yinian>"
 
 
 response = erniebot.Image.create(
@@ -175,9 +169,8 @@ ERNIE Bot SDK提供函数调用功能，即由大模型根据对话上下文确
 ```python
 import erniebot
 
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 response = erniebot.ChatCompletion.create(
     model="ernie-bot-3.5",
@@ -223,7 +216,7 @@ print(response)
 
 ## Gradio Demos
 
-为了让用户更全面、更直观地了解ERNIE Bot SDK的各项功能，我们基于Gradio开发了一个带有web用户界面的演示应用。请参阅[示例说明](./examples)，尝试对话补全、语义向量、文生图等可交互例子。
+为了让用户更全面、更直观地了解ERNIE Bot SDK的各项功能，我们基于Gradio开发了一系列带有web用户界面的演示应用。请参阅[示例说明](./examples)，尝试对话补全、语义向量、文生图、函数调用等可交互例子。
 
 <img width="1296" alt="36dd85dbe30682a287b6a5c5d13e0cdc" src="https://user-images.githubusercontent.com/19339784/264367116-600c34b9-0103-4fb7-bbe5-6d71ddc6af09.gif">
 

docs/README.md

@@ -29,9 +29,8 @@ print(models)
 # ernie-vilg-v2         文心一格模型
 
 # Set authentication params
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 # Create a chat completion
 response = erniebot.ChatCompletion.create(model="ernie-bot-3.5", messages=[{"role": "user", "content": "你好，请介绍下你自己"}])
@@ -46,17 +45,15 @@ print(response.result)
 erniebot api model.list
 
 # Set authentication params for chat_completion.create
-export EB_API_TYPE="qianfan"
-export EB_AK="<ak-for-qianfan>"
-export EB_SK="<sk-for-qianfan>"
+export EB_API_TYPE="aistudio"
+export EB_ACCESS_TOKEN="<access-token-for-aistudio>"
 
 # Create a chat completion (using ernie-bot-3.5, ernie-bot-turbo, etc.)
 erniebot api chat_completion.create --model ernie-bot-3.5 --message user "请介绍下你自己"
 
 # Set authentication params for image.create
 export EB_API_TYPE="yinian"
-export EB_AK="<ak-for-yinian>"
-export EB_SK="<sk-for-yinian>"
+export EB_ACCESS_TOKEN="<access-token-for-yinian>"
 
 # Generate images via ERNIE-ViLG
 erniebot api image.create --model ernie-vilg-v2 --prompt "画一只驴肉火烧" --height 1024 --width 1024 --image-num 1
@@ -75,9 +72,8 @@ ERNIE Bot SDK提供具备对话补全能力的文心一言旗舰版模型ernie-b
 ```python
 import erniebot
 
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 response = erniebot.ChatCompletion.create(
     model="ernie-bot-3.5",
@@ -107,9 +103,8 @@ ERNIE Bot SDK提供提取语义向量的Embedding模型。
 ```python
 import erniebot
 
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 response = erniebot.Embedding.create(
     model="ernie-text-embedding",
@@ -133,8 +128,7 @@ ERNIE Bot SDK提供具备文生图能力的ERNIE-ViLG大模型。
 import erniebot
 
 erniebot.api_type = "yinian"
-erniebot.ak = "<ak-for-yinian>"
-erniebot.sk = "<sk-for-yinian>"
+erniebot.access_token = "<access-token-for-yinian>"
 
 
 response = erniebot.Image.create(
@@ -167,9 +161,8 @@ ERNIE Bot SDK提供函数调用功能，即由大模型根据对话上下文确
 ```python
 import erniebot
 
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 response = erniebot.ChatCompletion.create(
     model="ernie-bot-3.5",
@@ -215,7 +208,7 @@ print(response)
 
 ## Gradio Demos
 
-为了让用户更全面、更直观地了解ERNIE Bot SDK的各项功能，我们基于Gradio开发了一个带有web用户界面的演示应用。请参阅[示例说明](../examples)，尝试对话补全、语义向量、文生图等可交互例子。
+为了让用户更全面、更直观地了解ERNIE Bot SDK的各项功能，我们基于Gradio开发了一系列带有web用户界面的演示应用。请参阅[示例说明](../examples)，尝试对话补全、语义向量、文生图、函数调用等可交互例子。
 
 <img width="1296" alt="36dd85dbe30682a287b6a5c5d13e0cdc" src="https://user-images.githubusercontent.com/19339784/264367116-600c34b9-0103-4fb7-bbe5-6d71ddc6af09.gif">
 

docs/api_reference/chat_completion.md

@@ -172,8 +172,8 @@ erniebot.ChatCompletion.create(**kwargs: Any)
 ``` {.py .copy}
 import erniebot
 
-# erniebot.ak = "<EB-ACCESS-KEY-ID>"
-# erniebot.sk = "<EB-SECRET-ACCESS-KEY>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 stream = False
 response = erniebot.ChatCompletion.create(

docs/api_reference/embedding.md

@@ -73,8 +73,8 @@ erniebot.Embedding.create(**kwargs: Any)
 import erniebot
 import numpy as np
 
-# erniebot.ak = "<EB-ACCESS-KEY-ID>"
-# erniebot.sk = "<EB-SECRET-ACCESS-KEY>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<access-token-for-aistudio>"
 
 response = erniebot.Embedding.create(
     model="ernie-text-embedding",

docs/api_reference/image.md

@@ -87,10 +87,8 @@ ernie.api_type = "yinian"
 ``` {.py .copy}
 import erniebot
 
-# erniebot.ak = "<EB-ACCESS-KEY-ID>"
-# erniebot.sk = "<EB-SECRET-ACCESS-KEY>"
-
-erniebot.api_type = "yinian"
+erniebot.api_type = "yinian
+erniebot.access_token = "<access-token-for-yinian>"
 
 response = erniebot.Image.create(model="ernie-vilg-v2", prompt="请帮我画一只可爱的大猫咪", width=512, height=512, version="v2", image_num=1)
 

docs/authentication.md

@@ -9,39 +9,38 @@
 | API参数名称   | 环境变量名称  |  类型   |  必须设置 |  描述   |
 | :---         | :----       | :----  | :---- |  :---- |
 | api_type     | EB_API_TYPE | string | 否 | 后端平台的类型。支持`'qianfan'`、`'yinian'`和`'aistudio'`，默认是`'qianfan'`。|
-| ak           | EB_AK       | string | 否 | 认证鉴权使用的access key（AK）。必须和`sk`同时设置。 |
-| sk           | EB_SK       | string | 否 | 认证鉴权使用的secret key（SK）。必须和`ak`同时设置。 |
-| access_token | EB_ACCESS_TOKEN | string | 否 | 认证鉴权使用的access token。推荐优先使用`ak`和`sk`。如果设置了`access_token`，则使用该access token；如果`access_token`没有设置或者失效，并且设置了`ak`和`sk`，部分后端平台类型支持自动通过AK/SK获取access token。|
-| access_token_path | EB_ACCESS_TOKEN_PATH | string | 否 | 存有access token的文件路径。推荐优先使用`ak`和`sk`。`access_token_path`生效原理和`access_token`相同。|
+| ak           | EB_AK       | string | 否 | 认证鉴权使用的access key ID（AK）。必须和`sk`同时设置。 |
+| sk           | EB_SK       | string | 否 | 认证鉴权使用的secret access key（SK）。必须和`ak`同时设置。 |
+| access_token | EB_ACCESS_TOKEN | string | 否 | 认证鉴权使用的access token。如果设置了`access_token`，则使用该access token；如果`access_token`没有设置或者失效，并且设置了`ak`和`sk`，部分后端平台类型支持自动通过AK/SK获取access token。|
 
 ERNIE Bot SDK支持的文心大模型来自多个后端平台，不同平台支持的用户凭证类型不尽相同。请阅读下表，参照对应的文档申请用户凭证。
 
 | 后端平台   |  EB_API_TYPE  |  支持的用户凭证类型 | 申请用户凭证的方法 | 支持的模型 |
 | :---     | :----      | :----  | :----  | :---  |
 | 千帆大模型平台 | qianfan | AK/SK，access token | [申请千帆大模型平台的用户凭证](#申请千帆大模型平台的用户凭证) | ernie-bot-3.5，ernie-bot-turbo，ernie-text-embedding |
 | 智能创作平台 | yinian | AK/SK，access token | [申请智能创作平台的用户凭证](#申请智能创作平台的用户凭证) | ernie-vilg-v2 |
-| AI Studio | aistudio | access token |  | ernie-bot-3.5，ernie-bot-turbo，ernie-text-embedding |
+| AI Studio | aistudio | access token | [申请AI Studio平台的用户凭证](#申请ai-studio平台的用户凭证) | ernie-bot-3.5，ernie-bot-turbo，ernie-text-embedding |
 
 与其它参数类似，鉴权参数可通过如下3种方式设置，请根据需要自由选择。关于参数配置的更多技巧，请在[此文档](./configuration.md)了解。
 
 (1) 使用环境变量：
 
 ```shell
-export EB_API_TYPE="<EB-API-TYPE>"
-export EB_AK="<EB-ACCESS-KEY>"
-export EB_SK="<EB-SECRET-KEY>"
-export EB_ACCESS_TOKEN="<EB-ACCESS-TOKEN>"
+export EB_API_TYPE="<eb-api-type>"
+export EB_ACCESS_TOKEN="<eb-access-token>"
+export EB_AK="<eb-access-key-id>"
+export EB_SK="<eb-secret-access-key>"
 ```
 
 (2) 使用全局变量：
 
 ``` {.py .copy}
 import erniebot
 
-erniebot.api_type = "<EB-API-TYPE>"
-erniebot.ak = "<EB-ACCESS-KEY>"
-erniebot.sk = "<EB-SECRET-KEY>"
-erniebot.access_token = "<EB-ACCESS-TOKEN>"
+erniebot.api_type = "<eb-api-type>"
+erniebot.access_token = "<eb-access-token>"
+erniebot.ak = "<eb-access-key-id>"
+erniebot.sk = "<eb-secret-access-key>"
 ```
 
 (3) 使用`_config_`参数：
@@ -51,10 +50,10 @@ import erniebot
 
 response = erniebot.ChatCompletion.create(
     _config_=dict(
-        api_type="<EB-API-TYPE>",
-        ak="<EB-ACCESS-KEY>",
-        sk="<EB-SECRET-KEY>",
-        access_token="<EB-ACCESS-TOKEN>",
+        api_type="<eb-api-type>",
+        access_token="<eb-access-token>",
+        ak="<eb-access-key-id>",
+        sk="<eb-secret-access-key>",
     ),
     model="ernie-bot-3.5",
     messages=[{
@@ -108,3 +107,11 @@ response = erniebot.ChatCompletion.create(
 
 * AK/SK是私人信息，大家不要分享给他人，也不要对外暴露。
 * 智能创作平台的完整介绍，请参考[使用文档](https://ai.baidu.com/ai-doc/NLP/Uk53wndcb)；费用、充值相关的问题，请参考[计费简介](https://ai.baidu.com/ai-doc/NLP/qla2beec2)。
+
+## 申请AI Studio平台的用户凭证
+
+AI Studio平台用户可以直接在个人中心的[访问令牌页面](https://aistudio.baidu.com/usercenter/token)获取access token。
+
+注意事项：
+
+* AI Studio平台为每个账户提供了100万token的免费额度，可以用于ERNIE Bot SDK调用文心一言大模型。

docs/configuration.md

@@ -7,14 +7,14 @@ ERNIE Bot SDK支持3种参数配置的方法：(1）使用环境变量，(2）
 (1) 使用环境变量：
 
 ``` {.copy}
-export EB_API_TYPE="<EB-API-TYPE>"
+export EB_API_TYPE="<eb-api-type>"
 ```
 
 (2) 使用全局变量：
 
 ``` {.py .copy}
 import erniebot
-erniebot.api_type = "<EB-API-TYPE>"
+erniebot.api_type = "<eb-api-type>"
 ```
 
 (3) 使用`_config_`参数：
@@ -24,7 +24,7 @@ import erniebot
 
 response = erniebot.ChatCompletion.create(
     _config_=dict(
-        api_type="<EB-API-TYPE>",
+        api_type="<eb-api-type>",
     ),
     model="ernie-bot-3.5",
     messages=[{
@@ -40,10 +40,9 @@ ERNIE Bot SDK支持的参数，具体介绍如下：
 
 | API参数名称   | 环境变量名称  |  类型   |  必须设置 |  描述   |
 | :---         | :----       | :----  | :---- |  :---- |
-| api_type     | EB_API_TYPE | string | 否 | 设置后端平台的类型。支持`'qianfan'`和`'yinian'`，默认是`'qianfan'`。|
-| ak           | EB_AK       | string | 否 | 设置认证鉴权的access key。必须和`sk`同时设置。 |
-| sk           | EB_SK       | string | 否 | 设置认证鉴权的secret key。必须和`ak`同时设置。 |
-| access_token | EB_ACCESS_TOKEN | string | 否 | 设置认证鉴权的access token。推荐优先使用`ak`和`sk`。如果设置了`access_token`，则使用该access token；如果`access_token`没有设置或者失效，并且设置了`ak`和`sk`，部分后端平台类型支持自动通过`ak`和`sk`获取access token。|
-| access_token_path | EB_ACCESS_TOKEN_PATH | string | 否 | 设置存有access token的文件路径。推荐优先使用`ak`和`sk`。`access_token_path`生效原理和`access_token`相同。|
+| api_type     | EB_API_TYPE | string | 否 | 设置后端平台的类型。支持`'qianfan'`、`'yinian'`和`'aistudio'`，默认是`'qianfan'`。|
+| access_token | EB_ACCESS_TOKEN | string | 否 | 设置认证鉴权的access token。具体参见[认证鉴权文档](./authentication.md)。|
+| ak           | EB_AK       | string | 否 | 设置认证鉴权的access key ID（AK）。必须和`sk`同时设置。 |
+| sk           | EB_SK       | string | 否 | 设置认证鉴权的secret access key（SK）。必须和`ak`同时设置。 |
 | proxy        | EB_PROXY    | string | 否 | 设置请求的代理 。|
 | timeout      | EB_TIMEOUT  | float  | 否 | 设置请求超时的时间。如果设置了`timeout`，请求失败后会再次请求，直到成功或者超过设置的时间。|

docs/guides/function_calling.md

@@ -71,9 +71,8 @@ functions = [
 ``` {.py .copy}
 import erniebot
 
-erniebot.api_type = "qianfan"
-erniebot.ak = "<ak-for-qianfan>"
-erniebot.sk = "<sk-for-qianfan>"
+erniebot.api_type = "aistudio"
+erniebot.access_token = "<eb-access-token>"
 
 messages = [
     {

docs/guides/image.md

@@ -10,19 +10,19 @@ ERNIE Bot SDK中，文生图功能的接口如下。接口具体支持的输入
 erniebot.Image.create(**kwargs: Any) -> EBResponse:
 ```
 
+请注意，目前仅`yinian`后端支持文生图功能。
+
 # 使用示例
 
-大家可以使用下面示例代码，体验文生图的服务（请注意替换成自己的AK和SK）。
+大家可以使用下面示例代码，体验文生图的服务（请注意替换成自己的access token）。
 
 执行完成后，请及时通过`image_url`下载创作的图片，默认1小时后链接失效。
 
 ``` {.py .copy}
 import erniebot
 
 erniebot.api_type = "yinian"
-
-# erniebot.ak = "<EB-ACCESS-KEY-ID>"
-# erniebot.sk = "<EB-SECRET-ACCESS-KEY>"
+erniebot.access_token = "<access-token-for-yinian>"
 
 response = erniebot.Image.create(model="ernie-vilg-v2", prompt="请帮我画一只可爱的大猫咪", width=512, height=512, version="v2", image_num=1)
 

docs/installation.md

@@ -1,4 +1,4 @@
-# 安装
+# 快速安装
 
 执行如下命令，快速安装Python语言的最新版本ERNIE Bot SDK（推荐Python >= 3.8)。
 ```shell