Commit
·
0c5d50e
1
Parent(s):
d948ab4
update readme
Browse files- README.md +59 -0
- README_zh.md +59 -0
README.md
CHANGED
@@ -265,6 +265,10 @@ python owl/run.py
|
|
265 |
|
266 |
## Running with Different Models
|
267 |
|
|
|
|
|
|
|
|
|
268 |
OWL supports various LLM backends. You can use the following scripts to run with different models:
|
269 |
|
270 |
```bash
|
@@ -319,6 +323,61 @@ Example tasks you can try:
|
|
319 |
- "Help me debug this Python code: [your code here]"
|
320 |
- "Summarize the main points from this research paper: [paper URL]"
|
321 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
322 |
# 🌐 Web Interface
|
323 |
|
324 |
OWL now includes a web-based user interface that makes it easier to interact with the system. To start the web interface, run:
|
|
|
265 |
|
266 |
## Running with Different Models
|
267 |
|
268 |
+
### Additional Models
|
269 |
+
|
270 |
+
For information on configuring other AI models beyond OpenAI, please refer to our [CAMEL models documentation](https://docs.camel-ai.org/key_modules/models.html#supported-model-platforms-in-camel).
|
271 |
+
|
272 |
OWL supports various LLM backends. You can use the following scripts to run with different models:
|
273 |
|
274 |
```bash
|
|
|
323 |
- "Help me debug this Python code: [your code here]"
|
324 |
- "Summarize the main points from this research paper: [paper URL]"
|
325 |
|
326 |
+
# 🧰 Configuring Toolkits
|
327 |
+
|
328 |
+
OWL supports various toolkits that can be customized by modifying the `tools` list in your script:
|
329 |
+
|
330 |
+
```python
|
331 |
+
# Configure toolkits
|
332 |
+
tools = [
|
333 |
+
*WebToolkit(headless=False).get_tools(), # Browser automation
|
334 |
+
*VideoAnalysisToolkit(model=models["video"]).get_tools(),
|
335 |
+
*AudioAnalysisToolkit().get_tools(), # Requires OpenAI Key
|
336 |
+
*CodeExecutionToolkit(sandbox="subprocess").get_tools(),
|
337 |
+
*ImageAnalysisToolkit(model=models["image"]).get_tools(),
|
338 |
+
SearchToolkit().search_duckduckgo,
|
339 |
+
SearchToolkit().search_google, # Comment out if unavailable
|
340 |
+
SearchToolkit().search_wiki,
|
341 |
+
*ExcelToolkit().get_tools(),
|
342 |
+
*DocumentProcessingToolkit(model=models["document"]).get_tools(),
|
343 |
+
*FileWriteToolkit(output_dir="./").get_tools(),
|
344 |
+
]
|
345 |
+
```
|
346 |
+
|
347 |
+
## Available Toolkits
|
348 |
+
|
349 |
+
Key toolkits include:
|
350 |
+
- **WebToolkit**: Browser automation
|
351 |
+
- **VideoAnalysisToolkit**: Video processing
|
352 |
+
- **AudioAnalysisToolkit**: Audio processing
|
353 |
+
- **CodeExecutionToolkit**: Python code execution
|
354 |
+
- **ImageAnalysisToolkit**: Image analysis
|
355 |
+
- **SearchToolkit**: Web searches (Google, DuckDuckGo, Wikipedia)
|
356 |
+
- **DocumentProcessingToolkit**: Document parsing (PDF, DOCX, etc.)
|
357 |
+
|
358 |
+
Additional specialized toolkits: ArxivToolkit, GitHubToolkit, GoogleMapsToolkit, MathToolkit, NetworkXToolkit, NotionToolkit, RedditToolkit, WeatherToolkit, and more. For a complete list, see the [CAMEL toolkits documentation](https://docs.camel-ai.org/key_modules/tools.html#built-in-toolkits).
|
359 |
+
|
360 |
+
## Customizing Your Configuration
|
361 |
+
|
362 |
+
To customize available tools:
|
363 |
+
|
364 |
+
```python
|
365 |
+
# 1. Import toolkits
|
366 |
+
from camel.toolkits import WebToolkit, SearchToolkit, CodeExecutionToolkit
|
367 |
+
|
368 |
+
# 2. Configure tools list
|
369 |
+
tools = [
|
370 |
+
*WebToolkit(headless=True).get_tools(),
|
371 |
+
SearchToolkit().search_wiki,
|
372 |
+
*CodeExecutionToolkit(sandbox="subprocess").get_tools(),
|
373 |
+
]
|
374 |
+
|
375 |
+
# 3. Pass to assistant agent
|
376 |
+
assistant_agent_kwargs = {"model": models["assistant"], "tools": tools}
|
377 |
+
```
|
378 |
+
|
379 |
+
Selecting only necessary toolkits optimizes performance and reduces resource usage.
|
380 |
+
|
381 |
# 🌐 Web Interface
|
382 |
|
383 |
OWL now includes a web-based user interface that makes it easier to interact with the system. To start the web interface, run:
|
README_zh.md
CHANGED
@@ -267,6 +267,10 @@ python owl/run_mini.py
|
|
267 |
|
268 |
## 使用不同的模型
|
269 |
|
|
|
|
|
|
|
|
|
270 |
OWL 支持多种 LLM 后端。您可以使用以下脚本来运行不同的模型:
|
271 |
|
272 |
```bash
|
@@ -315,6 +319,61 @@ OWL 将自动调用与文档相关的工具来处理文件并提取答案。
|
|
315 |
- "帮我调试这段 Python 代码:[在此粘贴你的代码]"
|
316 |
- "总结这篇研究论文的主要观点:[论文URL]"
|
317 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
318 |
# 🌐 网页界面
|
319 |
|
320 |
OWL 现在包含一个基于网页的用户界面,使与系统交互变得更加容易。要启动网页界面,请运行:
|
|
|
267 |
|
268 |
## 使用不同的模型
|
269 |
|
270 |
+
### 其他模型
|
271 |
+
|
272 |
+
有关配置 OpenAI 以外的其他 AI 模型的信息,请参阅我们的 [CAMEL 模型文档](https://docs.camel-ai.org/key_modules/models.html#supported-model-platforms-in-camel)。
|
273 |
+
|
274 |
OWL 支持多种 LLM 后端。您可以使用以下脚本来运行不同的模型:
|
275 |
|
276 |
```bash
|
|
|
319 |
- "帮我调试这段 Python 代码:[在此粘贴你的代码]"
|
320 |
- "总结这篇研究论文的主要观点:[论文URL]"
|
321 |
|
322 |
+
# 🧰 配置工具包
|
323 |
+
|
324 |
+
OWL支持多种工具包,可通过修改脚本中的`tools`列表进行自定义:
|
325 |
+
|
326 |
+
```python
|
327 |
+
# 配置工具包
|
328 |
+
tools = [
|
329 |
+
*WebToolkit(headless=False).get_tools(), # 浏览器自动化
|
330 |
+
*VideoAnalysisToolkit(model=models["video"]).get_tools(),
|
331 |
+
*AudioAnalysisToolkit().get_tools(), # 需要OpenAI API密钥
|
332 |
+
*CodeExecutionToolkit(sandbox="subprocess").get_tools(),
|
333 |
+
*ImageAnalysisToolkit(model=models["image"]).get_tools(),
|
334 |
+
SearchToolkit().search_duckduckgo,
|
335 |
+
SearchToolkit().search_google, # 如果不可用请注释
|
336 |
+
SearchToolkit().search_wiki,
|
337 |
+
*ExcelToolkit().get_tools(),
|
338 |
+
*DocumentProcessingToolkit(model=models["document"]).get_tools(),
|
339 |
+
*FileWriteToolkit(output_dir="./").get_tools(),
|
340 |
+
]
|
341 |
+
```
|
342 |
+
|
343 |
+
## 主要工具包
|
344 |
+
|
345 |
+
关键工具包包括:
|
346 |
+
- **WebToolkit**:浏览器自动化
|
347 |
+
- **VideoAnalysisToolkit**:视频处理
|
348 |
+
- **AudioAnalysisToolkit**:音频处理
|
349 |
+
- **CodeExecutionToolkit**:Python代码执行
|
350 |
+
- **ImageAnalysisToolkit**:图像分析
|
351 |
+
- **SearchToolkit**:网络搜索(Google、DuckDuckGo、维基百科)
|
352 |
+
- **DocumentProcessingToolkit**:文档解析(PDF、DOCX等)
|
353 |
+
|
354 |
+
其他专用工具包:ArxivToolkit、GitHubToolkit、GoogleMapsToolkit、MathToolkit、NetworkXToolkit、NotionToolkit、RedditToolkit、WeatherToolkit等。完整工具包列表请参阅[CAMEL工具包文档](https://docs.camel-ai.org/key_modules/tools.html#built-in-toolkits)。
|
355 |
+
|
356 |
+
## 自定义配置
|
357 |
+
|
358 |
+
自定义可用工具的方法:
|
359 |
+
|
360 |
+
```python
|
361 |
+
# 1. 导入工具包
|
362 |
+
from camel.toolkits import WebToolkit, SearchToolkit, CodeExecutionToolkit
|
363 |
+
|
364 |
+
# 2. 配置工具列表
|
365 |
+
tools = [
|
366 |
+
*WebToolkit(headless=True).get_tools(),
|
367 |
+
SearchToolkit().search_wiki,
|
368 |
+
*CodeExecutionToolkit(sandbox="subprocess").get_tools(),
|
369 |
+
]
|
370 |
+
|
371 |
+
# 3. 传递给助手代理
|
372 |
+
assistant_agent_kwargs = {"model": models["assistant"], "tools": tools}
|
373 |
+
```
|
374 |
+
|
375 |
+
选择必要的工具包可优化性能并减少资源使用。
|
376 |
+
|
377 |
# 🌐 网页界面
|
378 |
|
379 |
OWL 现在包含一个基于网页的用户界面,使与系统交互变得更加容易。要启动网页界面,请运行:
|