diff --git a/README.md b/README.md index 0ee9270..aee4d26 100644 --- a/README.md +++ b/README.md @@ -265,6 +265,10 @@ python owl/run.py ## Running with Different Models +### Additional Models + +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). + OWL supports various LLM backends. You can use the following scripts to run with different models: ```bash @@ -319,6 +323,61 @@ Example tasks you can try: - "Help me debug this Python code: [your code here]" - "Summarize the main points from this research paper: [paper URL]" +# 🧰 Configuring Toolkits + +OWL supports various toolkits that can be customized by modifying the `tools` list in your script: + +```python +# Configure toolkits +tools = [ + *WebToolkit(headless=False).get_tools(), # Browser automation + *VideoAnalysisToolkit(model=models["video"]).get_tools(), + *AudioAnalysisToolkit().get_tools(), # Requires OpenAI Key + *CodeExecutionToolkit(sandbox="subprocess").get_tools(), + *ImageAnalysisToolkit(model=models["image"]).get_tools(), + SearchToolkit().search_duckduckgo, + SearchToolkit().search_google, # Comment out if unavailable + SearchToolkit().search_wiki, + *ExcelToolkit().get_tools(), + *DocumentProcessingToolkit(model=models["document"]).get_tools(), + *FileWriteToolkit(output_dir="./").get_tools(), +] +``` + +## Available Toolkits + +Key toolkits include: +- **WebToolkit**: Browser automation +- **VideoAnalysisToolkit**: Video processing +- **AudioAnalysisToolkit**: Audio processing +- **CodeExecutionToolkit**: Python code execution +- **ImageAnalysisToolkit**: Image analysis +- **SearchToolkit**: Web searches (Google, DuckDuckGo, Wikipedia) +- **DocumentProcessingToolkit**: Document parsing (PDF, DOCX, etc.) + +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). + +## Customizing Your Configuration + +To customize available tools: + +```python +# 1. Import toolkits +from camel.toolkits import WebToolkit, SearchToolkit, CodeExecutionToolkit + +# 2. Configure tools list +tools = [ + *WebToolkit(headless=True).get_tools(), + SearchToolkit().search_wiki, + *CodeExecutionToolkit(sandbox="subprocess").get_tools(), +] + +# 3. Pass to assistant agent +assistant_agent_kwargs = {"model": models["assistant"], "tools": tools} +``` + +Selecting only necessary toolkits optimizes performance and reduces resource usage. + # 🌐 Web Interface OWL now includes a web-based user interface that makes it easier to interact with the system. To start the web interface, run: diff --git a/README_zh.md b/README_zh.md index b70d51b..588f0f7 100644 --- a/README_zh.md +++ b/README_zh.md @@ -267,6 +267,10 @@ python owl/run_mini.py ## 使用不同的模型 +### 其他模型 + +有关配置 OpenAI 以外的其他 AI 模型的信息,请参阅我们的 [CAMEL 模型文档](https://docs.camel-ai.org/key_modules/models.html#supported-model-platforms-in-camel)。 + OWL 支持多种 LLM 后端。您可以使用以下脚本来运行不同的模型: ```bash @@ -315,6 +319,61 @@ OWL 将自动调用与文档相关的工具来处理文件并提取答案。 - "帮我调试这段 Python 代码:[在此粘贴你的代码]" - "总结这篇研究论文的主要观点:[论文URL]" +# 🧰 配置工具包 + +OWL支持多种工具包,可通过修改脚本中的`tools`列表进行自定义: + +```python +# 配置工具包 +tools = [ + *WebToolkit(headless=False).get_tools(), # 浏览器自动化 + *VideoAnalysisToolkit(model=models["video"]).get_tools(), + *AudioAnalysisToolkit().get_tools(), # 需要OpenAI API密钥 + *CodeExecutionToolkit(sandbox="subprocess").get_tools(), + *ImageAnalysisToolkit(model=models["image"]).get_tools(), + SearchToolkit().search_duckduckgo, + SearchToolkit().search_google, # 如果不可用请注释 + SearchToolkit().search_wiki, + *ExcelToolkit().get_tools(), + *DocumentProcessingToolkit(model=models["document"]).get_tools(), + *FileWriteToolkit(output_dir="./").get_tools(), +] +``` + +## 主要工具包 + +关键工具包包括: +- **WebToolkit**:浏览器自动化 +- **VideoAnalysisToolkit**:视频处理 +- **AudioAnalysisToolkit**:音频处理 +- **CodeExecutionToolkit**:Python代码执行 +- **ImageAnalysisToolkit**:图像分析 +- **SearchToolkit**:网络搜索(Google、DuckDuckGo、维基百科) +- **DocumentProcessingToolkit**:文档解析(PDF、DOCX等) + +其他专用工具包:ArxivToolkit、GitHubToolkit、GoogleMapsToolkit、MathToolkit、NetworkXToolkit、NotionToolkit、RedditToolkit、WeatherToolkit等。完整工具包列表请参阅[CAMEL工具包文档](https://docs.camel-ai.org/key_modules/tools.html#built-in-toolkits)。 + +## 自定义配置 + +自定义可用工具的方法: + +```python +# 1. 导入工具包 +from camel.toolkits import WebToolkit, SearchToolkit, CodeExecutionToolkit + +# 2. 配置工具列表 +tools = [ + *WebToolkit(headless=True).get_tools(), + SearchToolkit().search_wiki, + *CodeExecutionToolkit(sandbox="subprocess").get_tools(), +] + +# 3. 传递给助手代理 +assistant_agent_kwargs = {"model": models["assistant"], "tools": tools} +``` + +选择必要的工具包可优化性能并减少资源使用。 + # 🌐 网页界面 OWL 现在包含一个基于网页的用户界面,使与系统交互变得更加容易。要启动网页界面,请运行: