Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

docs: Unify Data Processing Cookbooks (#1645)

Huihui Xu717706d3ac14
diff --git a/docs/cookbooks/basic_concepts/agents_prompting.ipynb b/docs/cookbooks/basic_concepts/agents_prompting.ipynb
index 60068e6ca..ee9a388b2 100644
--- a/docs/cookbooks/basic_concepts/agents_prompting.ipynb
+++ b/docs/cookbooks/basic_concepts/agents_prompting.ipynb
@@ -119,7 +119,7 @@
},
{
"cell_type": "code",
- "execution_count": null,
+ "execution_count": 3,
"metadata": {
"colab": {
"base_uri": "https://localhost:8080/"
@@ -127,7 +127,17 @@
"id": "754A8R7X2rnP",
"outputId": "c4daf659-df39-4fb5-8e2b-10e01f75f505"
},
- "outputs": [],
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "Specified task prompt:\n",
+ "Develop a captivating 5-minute solo performance that incorporates dynamic movement, audience interaction, and emotional storytelling. Focus on mastering vocal projection, facial expressions, and body language to enhance stage presence. Rehearse in front of a small audience for feedback, refining your act to create a memorable and engaging experience.\n",
+ "\n"
+ ]
+ }
+ ],
"source": [
"from camel.agents import TaskSpecifyAgent\n",
"from camel.configs import ChatGPTConfig\n",
@@ -515,7 +525,7 @@
"provenance": []
},
"kernelspec": {
- "display_name": "case_study",
+ "display_name": "camel-ai-bO_GxOlJ-py3.11",
"language": "python",
"name": "python3"
},
@@ -529,7 +539,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.10.16"
+ "version": "3.11.4"
}
},
"nbformat": 4,
diff --git a/docs/cookbooks/data_processing/agent_with_chunkr_for_pdf_parsing.ipynb b/docs/cookbooks/data_processing/agent_with_chunkr_for_pdf_parsing.ipynb
index 8ebbdc561..f6a2ec16a 100644
--- a/docs/cookbooks/data_processing/agent_with_chunkr_for_pdf_parsing.ipynb
+++ b/docs/cookbooks/data_processing/agent_with_chunkr_for_pdf_parsing.ipynb
@@ -13,6 +13,17 @@
"\n",
"In this blog, we’ll introduce Chunkr, a cutting-edge document processing API designed for seamless and scalable data extraction and preparation, ideal for Retrieval-Augmented Generation (RAG) workflows and large language models (LLMs). Chunkr has been integrated with CAMEL. We’ll explore its three core capabilities—Segment, OCR, and Structure—each optimized to enhance document understanding and make data integration effortless. Finally, we’ll wrap up with a conclusion and a call to action.\n",
"\n",
+ "Key tools utilized in this notebook include:\n",
+ "\n",
+ "* **CAMEL**: A powerful multi-agent framework that enables Retrieval-Augmented Generation and multi-agent role-playing scenarios, allowing for sophisticated AI-driven tasks.\n",
+ "* **Chunkr**: A powerful document processing API built for efficient and scalable data extraction and preparation, perfect for Retrieval-Augmented Generation (RAG) workflows and large language models (LLMs).\n",
+ "* **Mistral AI**: A series of high-performance LLMs.\n"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
"## Table of Content:\n",
"\n",
"1. 🧑🏻‍💻 Introduction\n",
@@ -30,7 +41,7 @@
" <a href=\"https://discord.camel-ai.org\"><img src=\"https://i.postimg.cc/L4wPdG9N/join-2.png\" width=\"150\"></a></a>\n",
" \n",
"⭐ <i>Star us on [*Github*](https://github.com/camel-ai/camel), join our [*Discord*](https://discord.camel-ai.org) or follow our [*X*](https://x.com/camelaiorg)\n",
- "</div>\n"
+ "</div>"
]
},
{
@@ -85,6 +96,13 @@
"\n"
]
},
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## 📦 Installation"
+ ]
+ },
{
"cell_type": "markdown",
"metadata": {
@@ -120,9 +138,7 @@
},
{
"cell_type": "markdown",
- "metadata": {
- "id": "FmuVvhpDyCT8"
- },
+ "metadata": {},
"source": [
"Step 1: Set up your [chunkr API key](https://docs.chunkr.ai/quickstart).\n",
"\n",
@@ -134,7 +150,7 @@
"\n",
"2. Get your API key:\n",
"\n",
- "Once logged in, navigate to the API section of your account dashboard to find your API key. A new API key will be generated. Copy this key and store it securely.\n"
+ "Once logged in, navigate to the API section of your account dashboard to find your API key. A new API key will be generated. Copy this key and store it securely."
]
},
{
@@ -410,9 +426,15 @@
"id": "sR4BU5Z_oanP"
},
"source": [
- "## 🧑🏻‍💻 Conclusion\n",
+ "## 🌟 Highlights\n",
"\n",
- "In conclusion, integrating Chunkr within CAMEL-AI revolutionizes the process of document data extraction and preparation, enhancing your capabilities for AI-driven applications. With Chunkr’s robust features like Segment, OCR, and Structure, you can seamlessly process complex documents into structured, machine-readable formats optimized for LLMs, directly feeding into CAMEL-AI’s multi-agent workflows. This integration not only simplifies data preparation but also empowers intelligent and accurate analytics. With these tools at your disposal, you’re equipped to transform raw document data into actionable insights, unlocking new possibilities in automation and AI-powered decision-making."
+ "In conclusion, integrating Chunkr within CAMEL-AI revolutionizes the process of document data extraction and preparation, enhancing your capabilities for AI-driven applications. With Chunkr’s robust features like Segment, OCR, and Structure, you can seamlessly process complex documents into structured, machine-readable formats optimized for LLMs, directly feeding into CAMEL-AI’s multi-agent workflows. This integration not only simplifies data preparation but also empowers intelligent and accurate analytics. With these tools at your disposal, you’re equipped to transform raw document data into actionable insights, unlocking new possibilities in automation and AI-powered decision-making.\n",
+ "\n",
+ "\n",
+ "Key tools utilized in this notebook include:\n",
+ "\n",
+ "* **CAMEL**: A powerful multi-agent framework that enables Retrieval-Augmented Generation and multi-agent role-playing scenarios, allowing for sophisticated AI-driven tasks.\n",
+ "* **Chunkr**: An advanced document processing API built for efficient and scalable data extraction and preparation, perfect for Retrieval-Augmented Generation (RAG) workflows and large language models (LLMs)."
]
},
{
@@ -452,11 +474,21 @@
"provenance": []
},
"kernelspec": {
- "display_name": "Python 3",
+ "display_name": "camel-ai-r_m-dpnI-py3.11",
+ "language": "python",
"name": "python3"
},
"language_info": {
- "name": "python"
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.11.5"
}
},
"nbformat": 4,
diff --git a/docs/cookbooks/data_processing/ingest_data_from_websites_with_Firecrawl.ipynb b/docs/cookbooks/data_processing/ingest_data_from_websites_with_Firecrawl.ipynb
index 988915708..8aa9db859 100644
--- a/docs/cookbooks/data_processing/ingest_data_from_websites_with_Firecrawl.ipynb
+++ b/docs/cookbooks/data_processing/ingest_data_from_websites_with_Firecrawl.ipynb
@@ -18,8 +18,19 @@
"source": [
"You can also check this cookbook in colab [here](https://colab.research.google.com/drive/1lOmM3VmgR1hLwDKdeLGFve_75RFW0R9I?usp=sharing)\n",
"\n",
- "In this blog, we’ll introduce Firecrawl, a versatile web scraping and crawling tool designed to extract data efficiently from websites, which has been integrated with CAMEL. Today we’ll walk through three key features—Scrape, Crawl, and Map—each tailored with a CAMEL agent use case.\n",
+ "In this notebook, we’ll introduce Firecrawl, a versatile web scraping and crawling tool designed to extract data efficiently from websites, which has been integrated with CAMEL. Today we’ll walk through three key features—Scrape, Crawl, and Map—each tailored with a CAMEL agent use case.\n",
"\n",
+ "In this notebook, you'll explore:\n",
+ "\n",
+ "* **CAMEL**: A powerful multi-agent framework that enables Retrieval-Augmented Generation and multi-agent role-playing scenarios, allowing for sophisticated AI-driven tasks.\n",
+ "\n",
+ "* **Firecrawl**: A data ingestion tool that simplifies web data extraction through web scraping, API integration, and automated browser actions."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
"## Table of Content:\n",
"\n",
"1. Introduction\n",
@@ -29,8 +40,12 @@
"5. Conclusion\n",
"\n",
"\n",
+ "<div class=\"align-center\">\n",
+ " <a href=\"https://www.camel-ai.org/\"><img src=\"https://i.postimg.cc/KzQ5rfBC/button.png\"width=\"150\"></a>\n",
+ " <a href=\"https://discord.camel-ai.org\"><img src=\"https://i.postimg.cc/L4wPdG9N/join-2.png\" width=\"150\"></a></a>\n",
+ " \n",
"⭐ <i>Star us on [*Github*](https://github.com/camel-ai/camel), join our [*Discord*](https://discord.camel-ai.org) or follow our [*X*](https://x.com/camelaiorg)\n",
- "\n",
+ "</div>\n",
"\n"
]
},
@@ -61,6 +76,13 @@
"***CAMEL-AI has integrated Firecrawl to enhance its web data extraction capabilities***.\n"
]
},
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## 📦 Installation"
+ ]
+ },
{
"cell_type": "markdown",
"metadata": {
@@ -82,6 +104,13 @@
"pip install \"camel-ai[all]==0.2.16\""
]
},
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## 🔑 Setting Up API Keys"
+ ]
+ },
{
"cell_type": "code",
"execution_count": null,
@@ -713,25 +742,50 @@
},
{
"cell_type": "markdown",
- "metadata": {
- "id": "YMRyjmWuU5a_"
- },
+ "metadata": {},
"source": [
- "## Conclusion\n",
+ "## 🌟 Highlights"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "This notebook has guided you through streamlining the process of web data extraction and enhances your agents capabilities using Firecrawl within the CAMEL framework. With Firecrawl’s powerful features like Scrape, Crawl, and Map, you can efficiently gather content in formats ready for LLMs to use, directly feeding into CAMEL-AI’s multi-agent workflows. This setup not only simplifies data collection but also enables more intelligent and insightful agents.\n",
"\n",
+ "Key tools utilized in this notebook include:\n",
"\n",
- "In conclusion, using Firecrawl within the CAMEL framework streamlines the process of web data extraction and enhances your agents capabilities. With Firecrawl’s powerful features like Scrape, Crawl, and Map, you can efficiently gather content in formats ready for LLMs to use, directly feeding into CAMEL-AI’s multi-agent workflows. This setup not only simplifies data collection but also enables more intelligent and insightful agents."
+ "* **CAMEL**: A powerful multi-agent framework that enables Retrieval-Augmented Generation and multi-agent role-playing scenarios, allowing for sophisticated AI-driven tasks.\n",
+ "* **Firecrawl**: A data ingestion tool that streamlines web data extraction using web scraping, API access, and automated browser interactions.\n"
]
},
{
"cell_type": "markdown",
- "metadata": {
- "id": "XVjsJvXQy3V8"
- },
+ "metadata": {},
"source": [
- "⭐ **Star the Repo**\n",
+ "That's everything: Got questions about 🐫 CAMEL-AI? Join us on [Discord](https://discord.camel-ai.org)! Whether you want to share feedback, explore the latest in multi-agent systems, get support, or connect with others on exciting projects, we’d love to have you in the community! 🤝\n",
+ "\n",
+ "Check out some of our other work:\n",
+ "\n",
+ "1. 🐫 Creating Your First CAMEL Agent [free Colab](https://docs.camel-ai.org/cookbooks/create_your_first_agent.html)\n",
+ "\n",
+ "2. Graph RAG Cookbook [free Colab](https://colab.research.google.com/drive/1uZKQSuu0qW6ukkuSv9TukLB9bVaS1H0U?usp=sharing)\n",
+ "\n",
+ "3. 🧑‍⚖️ Create A Hackathon Judge Committee with Workforce [free Colab](https://colab.research.google.com/drive/18ajYUMfwDx3WyrjHow3EvUMpKQDcrLtr?usp=sharing)\n",
"\n",
- "If you find CAMEL useful or interesting, please consider giving it a star on [GitHub](https://github.com/camel-ai/camel)! Your stars help others find this project and motivate us to continue improving it."
+ "4. 🔥 3 ways to ingest data from websites with Firecrawl & CAMEL [free Colab](https://colab.research.google.com/drive/1lOmM3VmgR1hLwDKdeLGFve_75RFW0R9I?usp=sharing)\n",
+ "\n",
+ "5. 🦥 Agentic SFT Data Generation with CAMEL and Mistral Models, Fine-Tuned with Unsloth [free Colab](https://colab.research.google.com/drive/1lYgArBw7ARVPSpdwgKLYnp_NEXiNDOd-?usp=sharingg)\n",
+ "\n",
+ "Thanks from everyone at 🐫 CAMEL-AI\n",
+ "\n",
+ "\n",
+ "<div class=\"align-center\">\n",
+ " <a href=\"https://www.camel-ai.org/\"><img src=\"https://i.postimg.cc/KzQ5rfBC/button.png\"width=\"150\"></a>\n",
+ " <a href=\"https://discord.camel-ai.org\"><img src=\"https://i.postimg.cc/L4wPdG9N/join-2.png\" width=\"150\"></a></a>\n",
+ " \n",
+ "⭐ <i>Star us on [*Github*](https://github.com/camel-ai/camel), join our [*Discord*](https://discord.camel-ai.org) or follow our [*X*](https://x.com/camelaiorg)\n",
+ "</div>\n"
]
}
],
diff --git a/docs/cookbooks/data_processing/video_analysis.ipynb b/docs/cookbooks/data_processing/video_analysis.ipynb
index 4daf4d177..ec8755bb2 100644
--- a/docs/cookbooks/data_processing/video_analysis.ipynb
+++ b/docs/cookbooks/data_processing/video_analysis.ipynb
@@ -18,7 +18,31 @@
"source": [
"You can also check this cookbook in colab [here](https://colab.research.google.com/drive/1XfF4BOSzo_rj9J58aZYanMUk5vixn-eR?usp=sharing)\n",
"\n",
- "⭐ <i>Star us on [*Github*](https://github.com/camel-ai/camel), join our [*Discord*](https://discord.camel-ai.org) or follow our [*X*](https://x.com/camelaiorg)"
+ "<div class=\"align-center\">\n",
+ " <a href=\"https://www.camel-ai.org/\"><img src=\"https://i.postimg.cc/KzQ5rfBC/button.png\"width=\"150\"></a>\n",
+ " <a href=\"https://discord.camel-ai.org\"><img src=\"https://i.postimg.cc/L4wPdG9N/join-2.png\" width=\"150\"></a></a>\n",
+ " \n",
+ "⭐ <i>Star us on [*Github*](https://github.com/camel-ai/camel), join our [*Discord*](https://discord.camel-ai.org) or follow our [*X*](https://x.com/camelaiorg)\n",
+ "</div>"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "This notebook demonstrates how to set up and leverage CAMEL's ability to do video analysis.\n",
+ "\n",
+ "In this notebook, you'll explore:\n",
+ "\n",
+ "* **CAMEL**: A powerful multi-agent framework that enables Retrieval-Augmented Generation and multi-agent role-playing scenarios, allowing for sophisticated AI-driven tasks.\n",
+ "* **Video Analysis**: How to use CAMEL to read and generate descriptions of uploaded videos."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## 📦 Installation"
]
},
{
@@ -33,6 +57,13 @@
"%pip install \"camel-ai[all]==0.2.16\""
]
},
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## 🔑 Setting Up API Keys"
+ ]
+ },
{
"cell_type": "code",
"execution_count": 2,
@@ -61,6 +92,13 @@
"os.environ[\"OPENAI_API_KEY\"] = openai_api_key"
]
},
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## Set up an agent for video analysis task"
+ ]
+ },
{
"cell_type": "code",
"execution_count": 3,
@@ -100,6 +138,13 @@
")"
]
},
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## Providing video and set user message"
+ ]
+ },
{
"cell_type": "code",
"execution_count": null,
@@ -213,6 +258,56 @@
"response_content_mode = camel_agent.step(user_msg_content_mode)\n",
"print(response_content_mode.msgs[0].content)"
]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## 🌟 Highlights"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "This notebook has guided you through setting up an agent and analying videos using CAMEL. \n",
+ "\n",
+ "Now, you know how to generate description for uploaded videos."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "That's everything: Got questions about 🐫 CAMEL-AI? Join us on [Discord](https://discord.camel-ai.org)! Whether you want to share feedback, explore the latest in multi-agent systems, get support, or connect with others on exciting projects, we’d love to have you in the community! 🤝\n",
+ "\n",
+ "Check out some of our other work:\n",
+ "\n",
+ "1. 🐫 Creating Your First CAMEL Agent [free Colab](https://docs.camel-ai.org/cookbooks/create_your_first_agent.html)\n",
+ "\n",
+ "2. Graph RAG Cookbook [free Colab](https://colab.research.google.com/drive/1uZKQSuu0qW6ukkuSv9TukLB9bVaS1H0U?usp=sharing)\n",
+ "\n",
+ "3. 🧑‍⚖️ Create A Hackathon Judge Committee with Workforce [free Colab](https://colab.research.google.com/drive/18ajYUMfwDx3WyrjHow3EvUMpKQDcrLtr?usp=sharing)\n",
+ "\n",
+ "4. 🔥 3 ways to ingest data from websites with Firecrawl & CAMEL [free Colab](https://colab.research.google.com/drive/1lOmM3VmgR1hLwDKdeLGFve_75RFW0R9I?usp=sharing)\n",
+ "\n",
+ "5. 🦥 Agentic SFT Data Generation with CAMEL and Mistral Models, Fine-Tuned with Unsloth [free Colab](https://colab.research.google.com/drive/1lYgArBw7ARVPSpdwgKLYnp_NEXiNDOd-?usp=sharingg)\n",
+ "\n",
+ "Thanks from everyone at 🐫 CAMEL-AI\n",
+ "\n",
+ "\n",
+ "<div class=\"align-center\">\n",
+ " <a href=\"https://www.camel-ai.org/\"><img src=\"https://i.postimg.cc/KzQ5rfBC/button.png\"width=\"150\"></a>\n",
+ " <a href=\"https://discord.camel-ai.org\"><img src=\"https://i.postimg.cc/L4wPdG9N/join-2.png\" width=\"150\"></a></a>\n",
+ " \n",
+ "⭐ <i>Star us on [*Github*](https://github.com/camel-ai/camel), join our [*Discord*](https://discord.camel-ai.org) or follow our [*X*](https://x.com/camelaiorg)\n",
+ "</div>\n"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": []
}
],
"metadata": {