Skip to content

Commit d52d75f

Browse files
committed
Upgrade skills readme
1 parent d1ed047 commit d52d75f

File tree

2 files changed

+22
-26
lines changed

2 files changed

+22
-26
lines changed

skills/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,25 +88,23 @@ Below are configuration methods for some AI apps:
8888
"entries": {
8989
"paddleocr-text-recognition": {
9090
"enabled": true,
91-
"apiKey": "<ACCESS_TOKEN>",
9291
"env": {
93-
"PADDLEOCR_OCR_API_URL": "<OCR_API_URL>"
92+
"PADDLEOCR_OCR_API_URL": "<OCR_API_URL>",
93+
"PADDLEOCR_ACCESS_TOKEN": "<ACCESS_TOKEN>"
9494
}
9595
},
9696
"paddleocr-doc-parsing": {
9797
"enabled": true,
98-
"apiKey": "<ACCESS_TOKEN>",
9998
"env": {
100-
"PADDLEOCR_DOC_PARSING_API_URL": "<DOC_PARSING_API_URL>"
99+
"PADDLEOCR_DOC_PARSING_API_URL": "<DOC_PARSING_API_URL>",
100+
"PADDLEOCR_ACCESS_TOKEN": "<ACCESS_TOKEN>"
101101
}
102102
}
103103
}
104104
}
105105
}
106106
```
107107

108-
Please note that this approach may store the access token in plain text in the configuration file. A more secure way is to configure it through the OpenClaw onboarding wizard or the dashboard.
109-
110108
### Usage Examples
111109

112110
After configuration, describe the OCR or document parsing task in natural language and provide a file URL or local path so the AI app can invoke the corresponding skill.
@@ -158,7 +156,7 @@ Make sure your working directory is the directory containing this file.
158156

159157
2. Configure environment variables (see [Configure Environment Variables](#configure-environment-variables) for the list of variables). Choose one of the following methods:
160158

161-
**Option A**: run the interactive configuration script.
159+
**Option A**: run the configuration script.
162160

163161
```shell
164162
python paddleocr-text-recognition/scripts/configure.py

skills/README_cn.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,10 @@ git clone https://github.com/PaddlePaddle/PaddleOCR.git
7272

7373
```json
7474
{
75-
env: {
76-
PADDLEOCR_ACCESS_TOKEN”: “<ACCESS_TOKEN>,
77-
PADDLEOCR_OCR_API_URL”: “<OCR_API_URL>,
78-
PADDLEOCR_DOC_PARSING_API_URL”: “<DOC_PARSING_API_URL>
75+
"env": {
76+
"PADDLEOCR_ACCESS_TOKEN": "<ACCESS_TOKEN>",
77+
"PADDLEOCR_OCR_API_URL": "<OCR_API_URL>",
78+
"PADDLEOCR_DOC_PARSING_API_URL": "<DOC_PARSING_API_URL>"
7979
}
8080
}
8181
```
@@ -84,29 +84,27 @@ git clone https://github.com/PaddlePaddle/PaddleOCR.git
8484

8585
```json
8686
{
87-
skills: {
88-
entries: {
89-
paddleocr-text-recognition: {
90-
enabled: true,
91-
“apiKey”: “<ACCESS_TOKEN>”,
92-
“env”: {
93-
“PADDLEOCR_OCR_API_URL”: “<OCR_API_URL>”
87+
"skills": {
88+
"entries": {
89+
"paddleocr-text-recognition": {
90+
"enabled": true,
91+
"env": {
92+
"PADDLEOCR_OCR_API_URL": "<OCR_API_URL>",
93+
"PADDLEOCR_ACCESS_TOKEN": "<ACCESS_TOKEN>"
9494
}
9595
},
96-
paddleocr-doc-parsing: {
97-
enabled: true,
98-
“apiKey”: “<ACCESS_TOKEN>”,
99-
“env”: {
100-
“PADDLEOCR_DOC_PARSING_API_URL”: “<DOC_PARSING_API_URL>”
96+
"paddleocr-doc-parsing": {
97+
"enabled": true,
98+
"env": {
99+
"PADDLEOCR_DOC_PARSING_API_URL": "<DOC_PARSING_API_URL>",
100+
"PADDLEOCR_ACCESS_TOKEN": "<ACCESS_TOKEN>"
101101
}
102102
}
103103
}
104104
}
105105
}
106106
```
107107

108-
请注意这种方式可能在配置文件中明文存储 access token。更安全的方式是通过 OpenClaw onboarding wizard 或者 dashboard 配置。
109-
110108
### 使用示例
111109

112110
配置完成后,可以直接用自然语言描述 OCR 或文档解析需求,并附上文件 URL 或本地路径,让 AI 应用调用对应 skill。以下是部分提示词示例:
@@ -158,7 +156,7 @@ git clone https://github.com/PaddlePaddle/PaddleOCR.git
158156

159157
2. 配置环境变量(需要配置的变量参见[配置环境变量](#配置环境变量)一节),可选择以下任一方式:
160158

161-
**方式 A**运行交互式配置脚本
159+
**方式 A**运行配置脚本
162160

163161
```shell
164162
python paddleocr-text-recognition/scripts/configure.py

0 commit comments

Comments
 (0)