Skip to content

Commit cceb879

Browse files
authored
Change version & Explicit setting api type
Change version & Explicit setting api type
2 parents 4254502 + 0b7a111 commit cceb879

File tree

3 files changed

+22
-18
lines changed

3 files changed

+22
-18
lines changed

README.md

+20-16
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<h1>ERNIE Bot SDK</h1>
44

5-
ERNIE Bot SDK 提供一系列便捷易用的接口,可以调用文心大模型的能力,包含文本创作、通用对话、语义向量、AI作图等。
5+
ERNIE Bot SDK提供便捷易用的接口,可以调用文心大模型的能力,包含文本创作、通用对话、语义向量、AI作图等。
66

77
[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE)
88
[![Version](https://img.shields.io/github/release/PaddlePaddle/ERNIE-Bot-SDK.svg)](https://github.com/PaddlePaddle/ERNIE-Bot-SDK/releases)
@@ -37,9 +37,10 @@ print(models)
3737
# ernie-text-embedding 文心百中语义模型
3838
# ernie-vilg-v2 文心一格模型
3939

40-
# Set ak/sk
41-
erniebot.ak = "<EB-ACCESS-KEY>"
42-
erniebot.sk = "<EB-SECRET-KEY>"
40+
# Set authentication params
41+
erniebot.api_type = "qianfan"
42+
erniebot.ak = "<ak-for-qianfan>"
43+
erniebot.sk = "<sk-for-qianfan>"
4344

4445
# Create a chat completion
4546
chat_completion = erniebot.ChatCompletion.create(model="ernie-bot-3.5", messages=[{"role": "user", "content": "你好,请介绍下你自己"}])
@@ -53,18 +54,18 @@ print(chat_completion.result)
5354
# List supported models
5455
erniebot api model.list
5556

56-
# Set api_type, ak, sk for chat_completion.create
57+
# Set authentication params for chat_completion.create
5758
export EB_API_TYPE="qianfan"
58-
export EB_AK="<EB-ACCESS-KEY>"
59-
export EB_SK="<EB-SECRET-KEY>"
59+
export EB_AK="<ak-for-qianfan>"
60+
export EB_SK="<sk-for-qianfan>"
6061

6162
# Create a chat completion (ernie-bot-3.5, ernie-bot-turbo, etc.)
6263
erniebot api chat_completion.create --model ernie-bot-3.5 --message user '请介绍下你自己'
6364

64-
# Set api_type, ak, sk for image.create
65+
# Set authentication params for image.create
6566
export EB_API_TYPE="yinian"
66-
export EB_AK="<EB-ACCESS-KEY>"
67-
export EB_SK="<EB-SECRET-KEY>"
67+
export EB_AK="<ak-for-yinian>"
68+
export EB_SK="<sk-for-yinian>"
6869

6970
# Generate images via ERNIE-ViLG
7071
erniebot api image.create --model ernie-vilg-v2 --prompt '画一只驴肉火烧' --height 1024 --width 1024 --image-num 1
@@ -82,8 +83,9 @@ ERNIE Bot SDK提供了对话补全能力的文心一言旗舰版模型`ernie-bot
8283
```python
8384
import erniebot
8485

85-
erniebot.ak = "<EB-ACCESS-KEY>"
86-
erniebot.sk = "<EB-SECRET-KEY>"
86+
erniebot.api_type = "qianfan"
87+
erniebot.ak = "<ak-for-qianfan>"
88+
erniebot.sk = "<sk-for-qianfan>"
8789

8890
completion = erniebot.ChatCompletion.create(
8991
model='ernie-bot-3.5',
@@ -113,8 +115,9 @@ ERNIE Bot SDK提供了提取语义向量的Embedding模型。
113115
```python
114116
import erniebot
115117

116-
erniebot.ak = "<EB-ACCESS-KEY>"
117-
erniebot.sk = "<EB-SECRET-KEY>"
118+
erniebot.api_type = "qianfan"
119+
erniebot.ak = "<ak-for-qianfan>"
120+
erniebot.sk = "<sk-for-qianfan>"
118121

119122
embedding = erniebot.Embedding.create(
120123
model="ernie-text-embedding",
@@ -136,9 +139,10 @@ ERNIE Bot SDK提供了文生图能力的ERNIE-ViLG大模型。
136139
```python
137140
import erniebot
138141

139-
erniebot.ak = "<EB-ACCESS-KEY>"
140-
erniebot.sk = "<EB-SECRET-KEY>"
141142
erniebot.api_type = "yinian"
143+
erniebot.ak = "<ak-for-yinian>"
144+
erniebot.sk = "<sk-for-yinian>"
145+
142146

143147
response = erniebot.Image.create(
144148
model="ernie-vilg-v2",

docs/authentication.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ erniebot.sk = "<EB-SECRET-KEY>"
4040
注意事项:
4141

4242
* 使用Python API设置的优先级高于使用环境变量设置。
43-
* 请准确设置模型对应后端平台的认证鉴权参数,否则无法通过认证鉴权
43+
* **使用特定模型,请准确设置对应后端平台的认证鉴权参数**
4444

4545
## 申请千帆大模型平台的AK/SK
4646

erniebot/version.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
VERSION = '0.0.0.dev0'
15+
VERSION = '0.1.0'

0 commit comments

Comments
 (0)