Skip to content

Commit 750b605

Browse files
committed
Fix docs
1 parent bfad359 commit 750b605

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/authentication.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ERNIE Bot SDK支持的文心大模型来自多个后端平台,不同平台支
2424

2525
与其它参数类似,鉴权参数可通过如下3种方式设置,请根据需要自由选择。关于参数配置的更多技巧,请在[此文档](./configuration.md)了解。
2626

27-
1. 使用环境变量:
27+
(1) 使用环境变量:
2828

2929
```shell
3030
export EB_API_TYPE="<EB-API-TYPE>"
@@ -33,7 +33,7 @@ export EB_SK="<EB-SECRET-KEY>"
3333
export EB_ACCESS_TOKEN="<EB-ACCESS-TOKEN>"
3434
```
3535

36-
2. 使用全局变量:
36+
(2) 使用全局变量:
3737

3838
``` {.py .copy}
3939
import erniebot
@@ -44,7 +44,7 @@ erniebot.sk = "<EB-SECRET-KEY>"
4444
erniebot.access_token = "<EB-ACCESS-TOKEN>"
4545
```
4646

47-
3. 使用`_config_`参数:
47+
(3) 使用`_config_`参数:
4848

4949
``` {.py .copy}
5050
import erniebot

docs/configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ ERNIE Bot SDK参数配置,主要涉及认证鉴权、后端平台等信息。
44

55
ERNIE Bot SDK支持3种参数配置的方法:1)使用环境变量,2)使用全局变量,3) 使用`_config_`参数。
66

7-
1. 使用环境变量:
7+
(1) 使用环境变量:
88

99
``` {.copy}
1010
export EB_API_TYPE="<EB-API-TYPE>"
1111
```
1212

13-
2. 使用全局变量:
13+
(2) 使用全局变量:
1414

1515
``` {.py .copy}
1616
import erniebot
1717
erniebot.api_type = "<EB-API-TYPE>"
1818
```
1919

20-
3. 使用`_config_`参数:
20+
(3) 使用`_config_`参数:
2121

2222
``` {.py .copy}
2323
import erniebot

docs/guides/function_calling.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
如下展示了一个函数调用的例子。
1919

20-
1. 首先,对函数的基本信息进行描述,使用[JSON Schema](https://json-schema.org/)格式描述函数的请求参数与响应参数。
20+
(1) 首先,对函数的基本信息进行描述,使用[JSON Schema](https://json-schema.org/)格式描述函数的请求参数与响应参数。
2121

2222
``` {.py .copy}
2323
functions = [
@@ -66,7 +66,7 @@ functions = [
6666

6767
代码中定义了一个列表`functions`,作为示例,其中仅包含对一个函数`get_current_temperature`的名称、请求参数等信息的描述。
6868

69-
2. 接着,将以上信息与对需要完成的任务的自然语言描述一同传给`erniebot.ChatCompletion` API。
69+
(2) 接着,将以上信息与对需要完成的任务的自然语言描述一同传给`erniebot.ChatCompletion` API。
7070

7171
``` {.py .copy}
7272
import erniebot
@@ -100,7 +100,7 @@ print(function_call)
100100

101101
`function_call`是一个字典,其中包含的键`name``thoughts`分别对应大模型选择调用的函数名称以及模型的思考过程。`function_call["arguments"]`是一个JSON格式的字符串,其中包含了调用函数时需要用到的参数。
102102

103-
3. 然后,根据模型的提示调用相应函数得到结果。
103+
(3) 然后,根据模型的提示调用相应函数得到结果。
104104

105105
``` {.py .copy}
106106
import json
@@ -116,7 +116,7 @@ res = func(location=args["location"], unit=args["unit"])
116116

117117
以上代码从`function_call`中获取模型选择调用的函数名称(`function_call["name"]`),通过该名称找到对应的函数,并从`function_call["arguments"]`中解析需要传入函数的参数,最终完成对函数的调用。作为演示,以上代码所使用的`get_current_temperature`是一个硬编码的dummy函数,在实际生产中可将其替换为真正具备相应功能的API。
118118

119-
4. 最后,将模型上一轮的响应以及函数的响应加入到对话上下文信息中,再次传递给模型。回传给模型的函数响应内容应当是JSON格式的字符串(如`'{"temperature": 25, "unit": "摄氏度"}'`),在本示例中,函数的响应是一个字典,因此需要先调用`json.dumps`函数对其进行编码。
119+
(4) 最后,将模型上一轮的响应以及函数的响应加入到对话上下文信息中,再次传递给模型。回传给模型的函数响应内容应当是JSON格式的字符串(如`'{"temperature": 25, "unit": "摄氏度"}'`),在本示例中,函数的响应是一个字典,因此需要先调用`json.dumps`函数对其进行编码。
120120

121121
``` {.py .copy}
122122
messages.append(

0 commit comments

Comments
 (0)