andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-01-11 00:58:30 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

improve readme, add link to template

Browse Source
This commit is contained in:
MQ
2025-02-28 12:35:23 +01:00
parent 975c71a920
commit f329b0d9d2
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/crewai_tools/tools/apify_actors/README.md
View File

@@ -1,7 +1,9 @@
# ApifyActorsTool # ApifyActorsTool
Integrate [Apify Actors](https://apify.com/) into your CrewAI workflows with Ease. Integrate [Apify Actors](https://apify.com/) into your CrewAI workflows with Ease.
## Description ## Description
The `ApifyActorsTool` seamlessly integrates [Apify Actors](https://apify.com/) - cloud-based web scraping and automation programs—into your CrewAI workflows. Whether you need to extract data, crawl websites, or automate tasks, this tool simplifies the process without requiring infrastructure management. The `ApifyActorsTool` seamlessly integrates [Apify Actors](https://apify.com/) - cloud-based web scraping and automation programs—into your CrewAI workflows. Whether you need to extract data, crawl websites, or automate tasks, this tool simplifies the process without requiring infrastructure management.
Key features: Key features:
@@ -12,9 +14,11 @@ Key features:
For detailed integration guidance, see the [Apify CrewAI documentation](https://docs.apify.com/platform/integrations/crewai). For detailed integration guidance, see the [Apify CrewAI documentation](https://docs.apify.com/platform/integrations/crewai).
## Installation ## Installation
To use `ApifyActorsTool`, install the required packages and configure your Apify API token. You’ll need an API token from Apify - see the [Apify API documentation](https://docs.apify.com/platform/integrations/api) for instructions. To use `ApifyActorsTool`, install the required packages and configure your Apify API token. You’ll need an API token from Apify - see the [Apify API documentation](https://docs.apify.com/platform/integrations/api) for instructions.
### Steps ### Steps
1. **Install Dependencies** 1. **Install Dependencies**
Use pip to install `crewai[tools]` and `langchain-apify`: Use pip to install `crewai[tools]` and `langchain-apify`:
```bash ```bash
@@ -41,6 +45,7 @@ To use `ApifyActorsTool`, install the required packages and configure your Apify
Run `python -c "import langchain_apify; print('Setup complete')"` to ensure dependencies are installed. Run `python -c "import langchain_apify; print('Setup complete')"` to ensure dependencies are installed.
## Usage example ## Usage example
Here’s how to use `ApifyActorsTool` to run the [RAG Web Browser Actor](https://apify.com/apify/rag-web-browser) for web searching within a CrewAI workflow: Here’s how to use `ApifyActorsTool` to run the [RAG Web Browser Actor](https://apify.com/apify/rag-web-browser) for web searching within a CrewAI workflow:
```python ```python
@@ -59,6 +64,7 @@ for result in results:
``` ```
### Expected output ### Expected output
``` ```
URL: https://www.example.com/crewai-intro URL: https://www.example.com/crewai-intro
Content: CrewAI is a framework for building AI-powered workflows... Content: CrewAI is a framework for building AI-powered workflows...
@@ -66,9 +72,12 @@ URL: https://docs.crewai.com/
Content: Official documentation for CrewAI... Content: Official documentation for CrewAI...
``` ```
For a more comprehensive example with tool-agent, see [CrewAI Apify Actor template](https://apify.com/templates/python-crewai).
Try other Actors from the [Apify Store](https://apify.com/store) by changing `actor_name` and adjusting `run_input` per the Actor's input schema. Try other Actors from the [Apify Store](https://apify.com/store) by changing `actor_name` and adjusting `run_input` per the Actor's input schema.
## Configuration ## Configuration
The `ApifyActorsTool` requires specific inputs to operate: The `ApifyActorsTool` requires specific inputs to operate:
- **`actor_name` (str, required)** - **`actor_name` (str, required)**
@@ -81,6 +90,7 @@ The `ApifyActorsTool` requires specific inputs to operate:
The tool adapts dynamically to the chosen Actor. The tool adapts dynamically to the chosen Actor.
## Resources ## Resources
- **[Apify Platform](https://apify.com/)**: Explore the Apify ecosystem. - **[Apify Platform](https://apify.com/)**: Explore the Apify ecosystem.
- **[RAG Web Browser Actor](https://apify.com/apify/rag-web-browser)**: Try this popular Actor for web data retrieval. - **[RAG Web Browser Actor](https://apify.com/apify/rag-web-browser)**: Try this popular Actor for web data retrieval.
- **[Apify Actors Documentation](https://docs.apify.com/platform/actors)**: Learn how to use and create Actors. - **[Apify Actors Documentation](https://docs.apify.com/platform/actors)**: Learn how to use and create Actors.