[Feat][Docs] Add Function Calling and Refine Documentation

Author: juncaipeng

README.md

@@ -2,7 +2,7 @@
 
 <h1>ERNIE Bot SDK</h1>
 
-ERNIE Bot SDK提供便捷易用的接口，可以调用文心大模型的能力，包含文本创作、通用对话、语义向量、AI作图等。
+ERNIE Bot SDK提供便捷易用的接口，可以调用文心一言的能力，包含文本创作、通用对话、语义向量、AI作图等。
 
 [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE)
 [![Version](https://img.shields.io/github/release/PaddlePaddle/ERNIE-Bot-SDK.svg)](https://github.com/PaddlePaddle/ERNIE-Bot-SDK/releases)
@@ -13,17 +13,17 @@ ERNIE Bot SDK提供便捷易用的接口，可以调用文心大模型的能力
 
 ## 快速安装
 
-执行如下命令，快速安装Python语言的ERNIE Bot SDK（推荐Python >= 3.8)。
+执行如下命令，快速安装Python语言的最新版本ERNIE Bot SDK（推荐Python >= 3.8)。
 
 ```shell
 pip install --upgrade erniebot
 ```
 
 ## 快速使用
 
-大家使用ERNIE Bot SDK之前，请申请AK/SK进行认证鉴权，具体请参考[认证鉴权](./docs/authentication.md)。
+大家使用ERNIE Bot SDK之前，请首先申请并设置鉴权参数，具体请参考[认证鉴权](./docs/authentication.md)。
 
-### Python 接口
+### Python接口
 
 ```python
 import erniebot
@@ -43,9 +43,9 @@ erniebot.ak = "<ak-for-qianfan>"
 erniebot.sk = "<sk-for-qianfan>"
 
 # Create a chat completion
-chat_completion = erniebot.ChatCompletion.create(model="ernie-bot-3.5", messages=[{"role": "user", "content": "你好，请介绍下你自己"}])
+response = erniebot.ChatCompletion.create(model="ernie-bot-3.5", messages=[{"role": "user", "content": "你好，请介绍下你自己"}])
 
-print(chat_completion.result)
+print(response.result)
 ```
 
 ### 命令行接口 (CLI)
@@ -59,7 +59,7 @@ export EB_API_TYPE="qianfan"
 export EB_AK="<ak-for-qianfan>"
 export EB_SK="<sk-for-qianfan>"
 
-# Create a chat completion (ernie-bot-3.5, ernie-bot-turbo, etc.)
+# 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
@@ -75,7 +75,7 @@ erniebot api image.create --model ernie-vilg-v2 --prompt "画一只驴肉火烧"
 
 ### 对话补全 (Chat Completion)
 
-ERNIE Bot SDK提供了对话补全能力的文心一言旗舰版模型`ernie-bot-3.5`和文心一言迅捷版模型`ernie-bot-turbo`。
+ERNIE Bot SDK提供具备对话补全能力的文心一言旗舰版模型`ernie-bot-3.5`和文心一言迅捷版模型`ernie-bot-turbo`。
 旗舰版模型的效果更好，迅捷版模型的响应速度更快、推理时延更低，大家可以根据实际场景的需求选择合适的模型。
 
 以下是调用文心一言旗舰版模型进行多轮对话的示例。
@@ -87,7 +87,7 @@ erniebot.api_type = "qianfan"
 erniebot.ak = "<ak-for-qianfan>"
 erniebot.sk = "<sk-for-qianfan>"
 
-completion = erniebot.ChatCompletion.create(
+response = erniebot.ChatCompletion.create(
     model="ernie-bot-3.5",
     messages=[{
         "role": "user",
@@ -101,13 +101,12 @@ completion = erniebot.ChatCompletion.create(
         "content": "我在深圳，周末可以去哪里玩？"
     }])
 
-print(completion)
+print(response)
 ```
 
+### 语义向量生成 (Embedding Generation)
 
-### 语义向量 (Embedding)
-
-ERNIE Bot SDK提供了提取语义向量的Embedding模型。
+ERNIE Bot SDK提供用于提取语义向量的Embedding模型。
 该模型基于文心大模型，使用海量数据训练得到，为[文心百中](https://wenxin.baidu.com/baizhong/index/)系统提供关键能力。该模型可以将字符串转为384维浮点数表达的语义向量，语义向量具备极其精准的语义表达能力，可以用于度量两个字符串之间的语义相似度。
 
 大家可以使用以下代码提取句子的语义向量。
@@ -119,21 +118,21 @@ erniebot.api_type = "qianfan"
 erniebot.ak = "<ak-for-qianfan>"
 erniebot.sk = "<sk-for-qianfan>"
 
-embedding = erniebot.Embedding.create(
+response = erniebot.Embedding.create(
     model="ernie-text-embedding",
     input=[
         "我是百度公司开发的人工智能语言模型，我的中文名是文心一言，英文名是ERNIE-Bot，可以协助您完成范围广泛的任务并提供有关各种主题的信息，比如回答问题，提供定义和解释及建议。如果您有任何问题，请随时向我提问。",
         "2018年深圳市各区GDP"
         ])
 
-print(embedding)
+print(response)
 ```
 
 大家可以登陆[文心百中体验中心](https://wenxin.baidu.com/baizhong/knowledgesearch)，体验更多大模型语义搜索的能力。
 
 ### 文生图（Image Generation）
 
-ERNIE Bot SDK提供了文生图能力的ERNIE-ViLG大模型。
+ERNIE Bot SDK提供具备文生图能力的ERNIE-ViLG大模型。
 该模型具备丰富的风格与强大的中文理解能力，支持生成多种尺寸的图片。
 
 ```python
@@ -152,7 +151,6 @@ response = erniebot.Image.create(
 )
 
 print(response)
-
 ```
 
 <img width="512" alt="image" src="https://github.com/PaddlePaddle/ERNIE-Bot-SDK/assets/1371212/73911c97-ef42-4803-8dc6-d385486c128c">
@@ -164,9 +162,65 @@ print(response)
 
 大家也可登陆[文心一格](https://yige.baidu.com/)平台，体验更多AI艺术与创意辅助的能力。
 
+## 【beta】函数调用（Function Calling）
+
+ERNIE Bot SDK提供函数调用功能，即通过大模型根据对话上下文确定何时以及如何调用函数。该功能目前处于测试状态。
+
+以下是调用文心一言旗舰版模型进行函数调用的示例。
+
+```python
+import json
+import erniebot
+
+erniebot.api_type = "qianfan"
+erniebot.ak = "<ak-for-qianfan>"
+erniebot.sk = "<sk-for-qianfan>"
+
+response = erniebot.ChatCompletion.create(
+    model="ernie-bot-3.5",
+    messages=[
+        {
+            "role": "user",
+            "content": "深圳市今天气温如何？",
+        }, ],
+    functions=[{
+        "name": "get_current_temperature",
+        "description": "获取指定城市的气温",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "location": {
+                    "type": "string",
+                    "description": "城市名称",
+                },
+                "unit": {
+                    "type": "string",
+                    "enum": ["摄氏度", "华氏度"],
+                },
+            },
+            "required": ["location", "unit"],
+        },
+        "responses": {
+            "type": "object",
+            "properties": {
+                "temperature": {
+                    "type": "int",
+                    "description": "城市气温",
+                },
+                "unit": {
+                    "type": "string",
+                    "enum": ["摄氏度", "华氏度"],
+                },
+            },
+        },
+    }, ],
+)
+print(response)
+```
+
 ## Gradio可视化应用
 
-为了让开发者可以更全面更低门槛的了解ERNIE Bot SDK的全功能，我们基于Gradio实现了一个功能丰富的可视化界面，参阅[示例说明](examples)可以快速本地测试ChatCompletion、Embedding和Image的可视化交互示例。
+为了让开发者可以更全面更低门槛的了解ERNIE Bot SDK的全功能，我们基于Gradio实现了一个功能丰富的可视化界面，参阅[示例说明](./examples)可以快速本地测试ChatCompletion、Embedding和Image的可视化交互示例。
 
 <img width="1296" alt="36dd85dbe30682a287b6a5c5d13e0cdc" src="https://user-images.githubusercontent.com/19339784/264367116-600c34b9-0103-4fb7-bbe5-6d71ddc6af09.gif">
 
@@ -178,17 +232,16 @@ print(response)
   * [参数配置](./docs/configuration.md)
 * 使用指南
   * [对话补全ChatCompletion](./docs/guide/chat_completion.md)
-  * [语义向量Embedding](./docs/guide/embedding.md)
+  * [语义向量生成Embedding](./docs/guide/embedding.md)
   * [文生图Image](./docs/guide/image.md)
 * API文档
   * [对话补全ChatCompletion](./docs/api_reference/chat_completion.md)
-  * [语义向量Embedding](./docs/api_reference/embedding.md)
+  * [语义向量生成Embedding](./docs/api_reference/embedding.md)
   * [文生图Image](./docs/api_reference/image.md)
 
-
 ## Acknowledgement
 
-我们借鉴了[OpenAI Python Library](https://github.com/openai/openai-python)部分API设计，在此对OpenAI Python Library作者及开源社区表示感谢。
+我们借鉴了[OpenAI Python Library](https://github.com/openai/openai-python)的部分API设计，在此对OpenAI Python Library作者及开源社区表示感谢。
 
 ## License