[Docs] Rename ernie-bot-sdk to erniebot (#253)

--------- Co-authored-by: Juncai <[email protected]>
PaddlePaddle · Dec 29, 2023 · b68ce95 · b68ce95
1 parent 1df3905
commit b68ce95
Show file tree

Hide file tree

Showing 33 changed files with 103 additions and 583 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <div align="center">
 
-<h1>ERNIE Bot Agent & SDK</h1>
+<h1>ERNIE Bot SDK</h1>
 
 [开发文档](http://ernie-bot-agent.readthedocs.io/) | [智能体应用体验](https://aistudio.baidu.com/application/center?tag=agent)
 
@@ -13,11 +13,9 @@
 
 </div>
 
-**ERNIE Bot Agent** 是由百度飞桨全新推出的大模型智能体(agent)开发框架。基于文心大模型强大的编排能力，并结合飞桨星河社区提供的丰富预置平台化功能，旨在成为功能全面且高度可定制的大模型智能体开发框架。
+ERNIE Bot SDK 仓库包含两个项目：ERNIE Bot Agent 和 ERNIE Bot。ERNIE Bot Agent 是百度飞桨推出的基于文心大模型编排能力的大模型智能体开发框架，结合了飞桨星河社区的丰富预置平台功能。ERNIE Bot 则为开发者提供便捷接口，轻松调用文心大模型的文本创作、通用对话、语义向量及AI作图等基础功能。
 
-**ERNIE Bot SDK**为开发者提供便捷易用的接口，使其能够轻松调用文心大模型的强大功能，涵盖了文本创作、通用对话、语义向量以及AI作图等多个基础功能。
-
-![eb_sdk_agent_structure](https://github.com/PaddlePaddle/ERNIE-Bot-SDK/assets/11987277/65fcd038-b374-49d3-a91c-5565ef0a80ab)
+![eb_sdk_agent_structure](https://github.com/PaddlePaddle/ERNIE-Bot-SDK/assets/11987277/1fbcfbca-7695-4cca-9b4f-35a49d1d7c52)
 
 ## ERNIE Bot Agent
 
@@ -46,7 +44,7 @@
 git clone https://github.com/PaddlePaddle/ERNIE-Bot-SDK.git
 cd ERNIE-Bot-SDK
 
-# 首先安装Ernie Bot SDK
+# 首先安装Ernie Bot
 pip install ./erniebot
 
 # 然后安装ERNIE Bot Agent
@@ -119,12 +117,12 @@ python quick_start.py
 
 教程[链接](https://ernie-bot-agent.readthedocs.io/zh-cn/latest/)。
 
-## ERNIE Bot SDK
+## ERNIE Bot
 
-ERNIE Bot SDK 作为 ERNIE Bot Agent 的底层依赖，为开发者提供了便捷易用的接口，使其能够轻松调用文心大模型的强大功能，涵盖了文本创作、通用对话、语义向量以及AI作图等多个基础功能。
+ERNIE Bot 作为 ERNIE Bot Agent 的底层依赖，为开发者提供了便捷易用的接口，使其能够轻松调用文心大模型的强大功能，涵盖了文本创作、通用对话、语义向量以及AI作图等多个基础功能。
 
-更多详细的使用指南，请参阅[ERNIE Bot SDK](./erniebot/README.md)。
+更多详细的使用指南，请参阅[ERNIE Bot](./erniebot/README.md)。
 
 ## License
 
-ERNIE Bot Agent 和 ERNIE Bot SDK 遵循Apache-2.0开源协议。
+ERNIE Bot Agent 和 ERNIE Bot 遵循Apache-2.0开源协议。
diff --git a/docs/index.md b/docs/index.md
@@ -1,14 +1,13 @@
 <div align="center">
 
-<h1>ERNIE Bot Agent & SDK</h1>
+<h1>ERNIE Bot SDK</h1>
 
 </div>
 
-**ERNIE Bot Agent** 是由百度飞桨全新推出的大模型智能体(agent)开发框架。基于文心大模型强大的编排能力，并结合飞桨星河社区提供的丰富预置平台化功能，旨在成为功能全面且高度可定制的大模型智能体开发框架。
+ERNIE Bot SDK 仓库包含两个项目：ERNIE Bot Agent 和 ERNIE Bot。ERNIE Bot Agent 是百度飞桨推出的基于文心大模型编排能力的大模型智能体开发框架，结合了飞桨星河社区的丰富预置平台功能。ERNIE Bot 则为开发者提供便捷接口，轻松调用文心大模型的文本创作、通用对话、语义向量及AI作图等基础功能。
 
-**ERNIE Bot SDK**为开发者提供便捷易用的接口，使其能够轻松调用文心大模型的强大功能，涵盖了文本创作、通用对话、语义向量以及AI作图等多个基础功能。
+![eb_sdk_agent_structure](https://github.com/PaddlePaddle/ERNIE-Bot-SDK/assets/11987277/1fbcfbca-7695-4cca-9b4f-35a49d1d7c52)
 
-![eb_sdk_agent_structure](https://github.com/PaddlePaddle/ERNIE-Bot-SDK/assets/11987277/65fcd038-b374-49d3-a91c-5565ef0a80ab)
 
 ## ERNIE Bot Agent
 
@@ -24,10 +23,10 @@
     - **简洁的代码**：10行代码就可以快速开发一个智能体应用。
     - **预置资源与平台支持**：大量的预置工具、平台级别的知识库，以及后续将推出的平台级别的记忆机制，都旨在加速开发过程。
 
-## ERNIE Bot SDK
+## ERNIE Bot
 
-**ERNIE Bot SDK** 作为 **ERNIE Bot Agent** 的底层依赖，为开发者提供了便捷易用的接口，使其能够轻松调用文心大模型的强大功能，涵盖了文本创作、通用对话、语义向量以及AI作图等多个基础功能。有关更多详细的使用指南，请参阅[ERNIE Bot SDK](./sdk/README.md)。
+**ERNIE Bot** 作为 **ERNIE Bot Agent** 的底层依赖，为开发者提供了便捷易用的接口，使其能够轻松调用文心大模型的强大功能，涵盖了文本创作、通用对话、语义向量以及AI作图等多个基础功能。有关更多详细的使用指南，请参阅[ERNIE Bot](./sdk/README.md)。
 
 ## License
 
-ERNIE Bot Agent 和 ERNIE Bot SDK 遵循Apache-2.0开源协议。
+ERNIE Bot Agent 和 ERNIE Bot 遵循Apache-2.0开源协议。
diff --git a/docs/modules/chat_models.md b/docs/modules/chat_models.md
@@ -4,7 +4,7 @@
 
 文心一言是百度研发的知识增强大语言模型，能够与人对话互动，回答问题，协助创作，高效便捷地帮助人们获取信息、知识和灵感。
 
-大家通过`ERNIE Bot SDK`可以调用文心一言模型完成简单的AI任务，但是如果面对复杂的场景应用，可能需要基于`ERNIE Bot SDK`开发较多的功能模块。
+大家通过`ERNIE Bot`可以调用文心一言模型完成简单的AI任务，但是如果面对复杂的场景应用，可能需要基于`ERNIE Bot`开发较多的功能模块。
 
 为了降低使用门槛和开发工作，我们推荐通过`ERNIE Bot Agent`来调用文心一言模型，助力大家快速开发出AI应用。
 

diff --git a/docs/modules/message.md b/docs/modules/message.md
@@ -72,7 +72,7 @@
 
 ### 示例1
 
-大家在使用`ERNIE Bot SDK`调用文心一言进行多轮对话时，需要按照规范定义每轮对话的信息（如下），稍显复杂。
+大家在使用`ERNIE Bot`调用文心一言进行多轮对话时，需要按照规范定义每轮对话的信息（如下），稍显复杂。
 
 ```python
 import erniebot

diff --git a/docs/modules/preparation.md b/docs/modules/preparation.md
@@ -13,7 +13,7 @@ cd ERNIE-Bot-SDK
 # 切换到特定分支，默认是develop分支
 # git checkout -b xxx origin/xxx
 
-# 首先安装Ernie Bot SDK
+# 首先安装Ernie Bot
 pip install ./erniebot
 
 # 然后安装ERNIE Bot Agent

diff --git a/docs/sdk/README.md b/docs/sdk/README.md
@@ -1,18 +1,18 @@
-# ERNIE Bot SDK
+# ERNIE Bot
 
-ERNIE Bot SDK提供便捷易用的接口，可以调用文心大模型的能力，包含文本创作、通用对话、语义向量、AI作图等。
+ERNIE Bot提供便捷易用的接口，可以调用文心大模型的能力，包含文本创作、通用对话、语义向量、AI作图等。
 
 ## 快速安装
 
-执行如下命令，快速安装Python语言的最新版本ERNIE Bot SDK（要求Python >= 3.8)。
+执行如下命令，快速安装Python语言的最新版本ERNIE Bot（要求Python >= 3.8)。
 
 ```{.sh .copy}
 pip install --upgrade erniebot
 ```
 
 ## 快速使用
 
-使用ERNIE Bot SDK之前，请首先申请用户凭证并设置鉴权参数。具体请参考[认证鉴权文档](./authentication.md)。
+使用ERNIE Bot之前，请首先申请用户凭证并设置鉴权参数。具体请参考[认证鉴权文档](./authentication.md)。
 
 ### Python接口
 
@@ -65,7 +65,7 @@ erniebot api image.create --model ernie-vilg-v2 --prompt "画一只驴肉火烧"
 
 ### 对话补全（Chat Completion）
 
-ERNIE Bot SDK提供具备对话补全能力的ernie-3.5、ernie-turbo、ernie-4.0、ernie-longtext等文心大模型。
+ERNIE Bot提供具备对话补全能力的ernie-3.5、ernie-turbo、ernie-4.0、ernie-longtext等文心大模型。
 
 不同模型在效果、速度等方面各有千秋，大家可以根据实际场景的需求选择合适的模型。
 
@@ -96,7 +96,7 @@ print(response.get_result())
 
 ### 语义向量（Embedding）
 
-ERNIE Bot SDK提供用于生成文本的向量表示的ernie-text-embedding模型。
+ERNIE Bot提供用于生成文本的向量表示的ernie-text-embedding模型。
 
 该模型基于文心大模型，使用海量数据训练得到，为[文心百中](https://wenxin.baidu.com/baizhong/index/)系统提供关键能力。该模型可以将输入文本转为384维浮点数表示的向量。这些向量具备精准的语义表达能力，可用于度量文本之间的语义相似度。
 
@@ -122,7 +122,7 @@ print(response.get_result())
 
 ### 文生图（Image Generation）
 
-ERNIE Bot SDK提供具备文生图能力的ernie-vilg-v2大模型。
+ERNIE Bot提供具备文生图能力的ernie-vilg-v2大模型。
 
 该模型具备丰富的风格与强大的中文理解能力，支持生成多种尺寸的图片。
 
@@ -153,7 +153,7 @@ print(response.get_result())
 
 ### 函数调用（Function Calling）
 
-ERNIE Bot SDK提供函数调用功能，即由大模型根据对话上下文确定何时以及如何调用函数。
+ERNIE Bot提供函数调用功能，即由大模型根据对话上下文确定何时以及如何调用函数。
 
 借由函数调用，用户可以从大模型获取结构化数据，进而利用编程手段将大模型与已有的内外部API结合以构建应用。
 
@@ -219,7 +219,7 @@ print(response.get_result())
 
 ## Gradio Demos
 
-为了让用户更全面、更直观地了解ERNIE Bot SDK的各项功能，我们基于Gradio开发了一系列带有web用户界面的演示应用。请参阅[说明文档](https://github.com/PaddlePaddle/ERNIE-Bot-SDK/tree/develop/examples/README.md)，尝试对话补全、语义向量、文生图、函数调用等可交互例子。
+为了让用户更全面、更直观地了解ERNIE Bot的各项功能，我们基于Gradio开发了一系列带有web用户界面的演示应用。请参阅[说明文档](https://github.com/PaddlePaddle/ERNIE-Bot-SDK/tree/develop/examples/README.md)，尝试对话补全、语义向量、文生图、函数调用等可交互例子。
 
 <img width="1296" src="https://user-images.githubusercontent.com/19339784/264367116-600c34b9-0103-4fb7-bbe5-6d71ddc6af09.gif" />
 
@@ -229,4 +229,4 @@ print(response.get_result())
 
 ## License
 
-ERNIE Bot SDK遵循Apache-2.0开源协议。
+ERNIE Bot遵循Apache-2.0开源协议。
diff --git a/docs/sdk/authentication.md b/docs/sdk/authentication.md
@@ -1,8 +1,8 @@
 # 认证鉴权
 
-调用文心大模型可能涉及到收费服务，所以大家使用ERNIE Bot SDK时需要进行认证鉴权。认证鉴权主要包括两步：申请用户凭证，设置鉴权参数。
+调用文心大模型可能涉及到收费服务，所以大家使用ERNIE Bot时需要进行认证鉴权。认证鉴权主要包括两步：申请用户凭证，设置鉴权参数。
 
-ERNIE Bot SDK支持多个后端平台来调用文心大模型（如下表格），大家可以根据实际情况选择。不同后端平台支持的模型、认证鉴权方式存在差异，下面我们分别介绍。
+ERNIE Bot支持多个后端平台来调用文心大模型（如下表格），大家可以根据实际情况选择。不同后端平台支持的模型、认证鉴权方式存在差异，下面我们分别介绍。
 
 | 后端 | api_type | 支持的模型 |
 | :--- | :--- | :--- |
@@ -22,7 +22,7 @@ ERNIE Bot SDK支持多个后端平台来调用文心大模型（如下表格）
 
 注意事项：
 
-* AI Studio每个账户的access token，有100万token的免费额度，可以用于ERNIE Bot SDK调用文心大模型。
+* AI Studio每个账户的access token，有100万token的免费额度，可以用于ERNIE Bot调用文心大模型。
 * 在[token管理页面](https://aistudio.baidu.com/token/manage)可以查看token获取、消耗明细和过期记录，或者购买更多token。
 * access token是私密信息，切记不要对外公开。
 
@@ -62,7 +62,7 @@ AI Studio后端可以使用access token进行鉴权，支持如下三种方法
     )
     ```
 
-如果同时使用多种方式设置鉴权参数，ERNIE Bot SDK将根据优先级确定配置项的最终取值（其他后端类似）。三种设置方式的优先级从高到低依次为：使用`_config_`参数 > 使用全局变量 > 使用环境变量。
+如果同时使用多种方式设置鉴权参数，ERNIE Bot将根据优先级确定配置项的最终取值（其他后端类似）。三种设置方式的优先级从高到低依次为：使用`_config_`参数 > 使用全局变量 > 使用环境变量。
 
 ## 千帆大模型平台后端的认证鉴权
 

diff --git a/docs/sdk/configuration.md b/docs/sdk/configuration.md
@@ -1,8 +1,8 @@
 # 参数配置
 
-ERNIE Bot SDK参数配置，主要涉及认证鉴权、后端平台等信息。
+ERNIE Bot参数配置，主要涉及认证鉴权、后端平台等信息。
 
-ERNIE Bot SDK支持3种参数配置的方法：（1）使用环境变量，（2）使用全局变量，（3）使用`_config_`参数。
+ERNIE Bot支持3种参数配置的方法：（1）使用环境变量，（2）使用全局变量，（3）使用`_config_`参数。
 
 1. 使用环境变量：
 
@@ -36,7 +36,7 @@ ERNIE Bot SDK支持3种参数配置的方法：（1）使用环境变量，（2
 
 注意：允许同时使用多种方式设置鉴权信息，程序将根据设置方式的优先级确定配置项的最终取值。三种设置方式的优先级从高到低依次为：使用`_config_`参数，使用全局变量，使用环境变量。
 
-ERNIE Bot SDK支持的参数，具体介绍如下：
+ERNIE Bot支持的参数，具体介绍如下：
 
 | API参数名称 | 环境变量名称 | 类型 | 必须设置 | 描述 |
 | :--- | :--- | :--- | :--- | :--- |

diff --git a/docs/sdk/guides/chat_completion.md b/docs/sdk/guides/chat_completion.md
@@ -67,7 +67,7 @@
 
 ### 如何计算token数量？
 
-可以采用`汉字数 + 单词数 * 1.3`估算token总数。ERNIE Bot SDK提供了估计token数量的函数：
+可以采用`汉字数 + 单词数 * 1.3`估算token总数。ERNIE Bot提供了估计token数量的函数：
 
 ```{.py .copy}
 import erniebot.utils

diff --git a/docs/sdk/guides/embedding.md b/docs/sdk/guides/embedding.md
@@ -24,7 +24,7 @@
 
 ### 如何计算token数量？
 
-可以采用`汉字数 + 单词数 * 1.3`估算token总数。ERNIE Bot SDK提供了估计token数量的函数：
+可以采用`汉字数 + 单词数 * 1.3`估算token总数。ERNIE Bot提供了估计token数量的函数：
 
 ```{.py .copy}
 import erniebot.utils

diff --git a/docs/sdk/guides/function_calling.md b/docs/sdk/guides/function_calling.md
@@ -11,7 +11,7 @@
 
 借由函数调用，用户可以从大模型获取结构化数据，进而利用编程手段将大模型与已有的内外部API结合以构建应用。
 
-在ERNIE Bot SDK中，`erniebot.ChatCompletion.create`接口提供函数调用功能。关于该接口的更多详情请参考[ChatCompletion API文档](../api_reference/chat_completion.md)。
+在ERNIE Bot中，`erniebot.ChatCompletion.create`接口提供函数调用功能。关于该接口的更多详情请参考[ChatCompletion API文档](../api_reference/chat_completion.md)。
 
 ## 使用示例
 

diff --git a/docs/sdk/installation.md b/docs/sdk/installation.md
@@ -1,6 +1,6 @@
 # 安装
 
-执行如下命令，快速安装Python语言的最新版本ERNIE Bot SDK（要求Python >= 3.8)。
+执行如下命令，快速安装Python语言的最新版本ERNIE Bot（要求Python >= 3.8)。
 
 ```{.sh .copy}
 pip install --upgrade erniebot

diff --git a/docs/sdk/models.md b/docs/sdk/models.md
@@ -1,6 +1,6 @@
 # 模型总览
 
-ERNIE Bot SDK支持的所有模型如下：
+ERNIE Bot支持的所有模型如下：
 
 | 模型名称 | 说明 | 功能 | 支持该模型的后端 | 输入token数量上限 |
 |:--- | :--- | :--- | :--- | :--- |

diff --git a/erniebot-agent/README.md b/erniebot-agent/README.md
@@ -35,7 +35,7 @@
 git clone https://github.com/PaddlePaddle/ERNIE-Bot-SDK.git
 cd ERNIE-Bot-SDK
 
-# 首先安装Ernie Bot SDK
+# 首先安装Ernie Bot
 pip install ./erniebot
 
 # 然后安装ERNIE Bot Agent

diff --git a/erniebot-agent/cookbook/chat_models.ipynb b/erniebot-agent/cookbook/chat_models.ipynb
@@ -25,14 +25,15 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "## 上手使用文心一言\n",
     "\n",
     "### 安装\n",
     "\n",
-    "大家可以参考[官方文档](https://github.com/PaddlePaddle/ERNIE-Bot-SDK)，进行安装ERNIE Bot SDK。\n",
+    "大家可以参考[官方文档](https://github.com/PaddlePaddle/ERNIE-Bot-SDK)，进行安装ERNIE Bot Agent 和 ERNIE Bot。\n",
     "\n"
    ]
   },