mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-29 18:18:13 +00:00
adding new docs
This commit is contained in:
@@ -18,6 +18,18 @@ In the CrewAI framework, an `Agent` is an autonomous unit that can:
|
|||||||
Think of an agent as a specialized team member with specific skills, expertise, and responsibilities. For example, a `Researcher` agent might excel at gathering and analyzing information, while a `Writer` agent might be better at creating content.
|
Think of an agent as a specialized team member with specific skills, expertise, and responsibilities. For example, a `Researcher` agent might excel at gathering and analyzing information, while a `Writer` agent might be better at creating content.
|
||||||
</Tip>
|
</Tip>
|
||||||
|
|
||||||
|
<Note type="info" title="Enterprise Enhancement: Visual Agent Builder">
|
||||||
|
CrewAI Enterprise includes a Visual Agent Builder that simplifies agent creation and configuration without writing code. Design your agents visually and test them in real-time.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The Visual Agent Builder enables:
|
||||||
|
- Intuitive agent configuration with form-based interfaces
|
||||||
|
- Real-time testing and validation
|
||||||
|
- Template library with pre-configured agent types
|
||||||
|
- Easy customization of agent attributes and behaviors
|
||||||
|
</Note>
|
||||||
|
|
||||||
## Agent Attributes
|
## Agent Attributes
|
||||||
|
|
||||||
| Attribute | Parameter | Type | Description |
|
| Attribute | Parameter | Type | Description |
|
||||||
|
|||||||
@@ -18,6 +18,20 @@ CrewAI uses an event bus architecture to emit events throughout the execution li
|
|||||||
|
|
||||||
When specific actions occur in CrewAI (like a Crew starting execution, an Agent completing a task, or a tool being used), the system emits corresponding events. You can register handlers for these events to execute custom code when they occur.
|
When specific actions occur in CrewAI (like a Crew starting execution, an Agent completing a task, or a tool being used), the system emits corresponding events. You can register handlers for these events to execute custom code when they occur.
|
||||||
|
|
||||||
|
<Note type="info" title="Enterprise Enhancement: Prompt Tracing">
|
||||||
|
CrewAI Enterprise provides a built-in Prompt Tracing feature that leverages the event system to track, store, and visualize all prompts, completions, and associated metadata. This provides powerful debugging capabilities and transparency into your agent operations.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
With Prompt Tracing you can:
|
||||||
|
- View the complete history of all prompts sent to your LLM
|
||||||
|
- Track token usage and costs
|
||||||
|
- Debug agent reasoning failures
|
||||||
|
- Share prompt sequences with your team
|
||||||
|
- Compare different prompt strategies
|
||||||
|
- Export traces for compliance and auditing
|
||||||
|
</Note>
|
||||||
|
|
||||||
## Creating a Custom Event Listener
|
## Creating a Custom Event Listener
|
||||||
|
|
||||||
To create a custom event listener, you need to:
|
To create a custom event listener, you need to:
|
||||||
|
|||||||
@@ -12,6 +12,18 @@ Tasks provide all necessary details for execution, such as a description, the ag
|
|||||||
|
|
||||||
Tasks within CrewAI can be collaborative, requiring multiple agents to work together. This is managed through the task properties and orchestrated by the Crew's process, enhancing teamwork and efficiency.
|
Tasks within CrewAI can be collaborative, requiring multiple agents to work together. This is managed through the task properties and orchestrated by the Crew's process, enhancing teamwork and efficiency.
|
||||||
|
|
||||||
|
<Note type="info" title="Enterprise Enhancement: Visual Task Builder">
|
||||||
|
CrewAI Enterprise includes a Visual Task Builder in Crew Studio that simplifies complex task creation and chaining. Design your task flows visually and test them in real-time without writing code.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The Visual Task Builder enables:
|
||||||
|
- Drag-and-drop task creation
|
||||||
|
- Visual task dependencies and flow
|
||||||
|
- Real-time testing and validation
|
||||||
|
- Easy sharing and collaboration
|
||||||
|
</Note>
|
||||||
|
|
||||||
### Task Execution Flow
|
### Task Execution Flow
|
||||||
|
|
||||||
Tasks can be executed in two ways:
|
Tasks can be executed in two ways:
|
||||||
@@ -414,7 +426,7 @@ It's also important to note that the output of the final task of a crew becomes
|
|||||||
### Using `output_pydantic`
|
### Using `output_pydantic`
|
||||||
The `output_pydantic` property allows you to define a Pydantic model that the task output should conform to. This ensures that the output is not only structured but also validated according to the Pydantic model.
|
The `output_pydantic` property allows you to define a Pydantic model that the task output should conform to. This ensures that the output is not only structured but also validated according to the Pydantic model.
|
||||||
|
|
||||||
Here’s an example demonstrating how to use output_pydantic:
|
Here's an example demonstrating how to use output_pydantic:
|
||||||
|
|
||||||
```python Code
|
```python Code
|
||||||
import json
|
import json
|
||||||
@@ -495,7 +507,7 @@ In this example:
|
|||||||
### Using `output_json`
|
### Using `output_json`
|
||||||
The `output_json` property allows you to define the expected output in JSON format. This ensures that the task's output is a valid JSON structure that can be easily parsed and used in your application.
|
The `output_json` property allows you to define the expected output in JSON format. This ensures that the task's output is a valid JSON structure that can be easily parsed and used in your application.
|
||||||
|
|
||||||
Here’s an example demonstrating how to use `output_json`:
|
Here's an example demonstrating how to use `output_json`:
|
||||||
|
|
||||||
```python Code
|
```python Code
|
||||||
import json
|
import json
|
||||||
|
|||||||
@@ -15,6 +15,18 @@ A tool in CrewAI is a skill or function that agents can utilize to perform vario
|
|||||||
This includes tools from the [CrewAI Toolkit](https://github.com/joaomdmoura/crewai-tools) and [LangChain Tools](https://python.langchain.com/docs/integrations/tools),
|
This includes tools from the [CrewAI Toolkit](https://github.com/joaomdmoura/crewai-tools) and [LangChain Tools](https://python.langchain.com/docs/integrations/tools),
|
||||||
enabling everything from simple searches to complex interactions and effective teamwork among agents.
|
enabling everything from simple searches to complex interactions and effective teamwork among agents.
|
||||||
|
|
||||||
|
<Note type="info" title="Enterprise Enhancement: Tools Repository">
|
||||||
|
CrewAI Enterprise provides a comprehensive Tools Repository with pre-built integrations for common business systems and APIs. Deploy agents with enterprise tools in minutes instead of days.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The Enterprise Tools Repository includes:
|
||||||
|
- Pre-built connectors for popular enterprise systems
|
||||||
|
- Custom tool creation interface
|
||||||
|
- Version control and sharing capabilities
|
||||||
|
- Security and compliance features
|
||||||
|
</Note>
|
||||||
|
|
||||||
## Key Characteristics of Tools
|
## Key Characteristics of Tools
|
||||||
|
|
||||||
- **Utility**: Crafted for tasks such as web searching, data analysis, content generation, and agent collaboration.
|
- **Utility**: Crafted for tasks such as web searching, data analysis, content generation, and agent collaboration.
|
||||||
@@ -79,7 +91,7 @@ research = Task(
|
|||||||
)
|
)
|
||||||
|
|
||||||
write = Task(
|
write = Task(
|
||||||
description='Write an engaging blog post about the AI industry, based on the research analyst’s summary. Draw inspiration from the latest blog posts in the directory.',
|
description='Write an engaging blog post about the AI industry, based on the research analyst's summary. Draw inspiration from the latest blog posts in the directory.',
|
||||||
expected_output='A 4-paragraph blog post formatted in markdown with engaging, informative, and accessible content, avoiding complex jargon.',
|
expected_output='A 4-paragraph blog post formatted in markdown with engaging, informative, and accessible content, avoiding complex jargon.',
|
||||||
agent=writer,
|
agent=writer,
|
||||||
output_file='blog-posts/new_post.md' # The final blog post will be saved here
|
output_file='blog-posts/new_post.md' # The final blog post will be saved here
|
||||||
@@ -141,7 +153,7 @@ Here is a list of the available tools and their descriptions:
|
|||||||
## Creating your own Tools
|
## Creating your own Tools
|
||||||
|
|
||||||
<Tip>
|
<Tip>
|
||||||
Developers can craft `custom tools` tailored for their agent’s needs or
|
Developers can craft `custom tools` tailored for their agent's needs or
|
||||||
utilize pre-built options.
|
utilize pre-built options.
|
||||||
</Tip>
|
</Tip>
|
||||||
|
|
||||||
|
|||||||
@@ -140,6 +140,27 @@ We recommend using the `YAML` template scaffolding for a structured approach to
|
|||||||
</Step>
|
</Step>
|
||||||
</Steps>
|
</Steps>
|
||||||
|
|
||||||
|
## Enterprise Installation Options
|
||||||
|
|
||||||
|
<Note type="info">
|
||||||
|
For teams and organizations, CrewAI offers enterprise deployment options that eliminate setup complexity:
|
||||||
|
|
||||||
|
### CrewAI Enterprise (SaaS)
|
||||||
|
- Zero installation required - just sign up for free at [app.crewai.com](https://app.crewai.com)
|
||||||
|
- Automatic updates and maintenance
|
||||||
|
- Managed infrastructure and scaling
|
||||||
|
- Build Crews with no Code
|
||||||
|
|
||||||
|
### CrewAI Factory (Self-hosted)
|
||||||
|
- Containerized deployment for your infrastructure
|
||||||
|
- Supports any hyperscaler including on prem depployments
|
||||||
|
- Integration with your existing security systems
|
||||||
|
|
||||||
|
<Card title="Explore Enterprise Options" icon="building" href="https://crewai.com/enterprise">
|
||||||
|
Learn about CrewAI's enterprise offerings and schedule a demo
|
||||||
|
</Card>
|
||||||
|
</Note>
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ CrewAI empowers developers with both high-level simplicity and precise low-level
|
|||||||
|
|
||||||
With over 100,000 developers certified through our community courses, CrewAI is rapidly becoming the standard for enterprise-ready AI automation.
|
With over 100,000 developers certified through our community courses, CrewAI is rapidly becoming the standard for enterprise-ready AI automation.
|
||||||
|
|
||||||
|
|
||||||
## How Crews Work
|
## How Crews Work
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
|
|||||||
@@ -200,6 +200,22 @@ Follow the steps below to get Crewing! 🚣♂️
|
|||||||
```
|
```
|
||||||
</CodeGroup>
|
</CodeGroup>
|
||||||
</Step>
|
</Step>
|
||||||
|
|
||||||
|
<Step title="Enterprise Alternative: Create in Crew Studio">
|
||||||
|
For CrewAI Enterprise users, you can create the same crew without writing code:
|
||||||
|
|
||||||
|
1. Log in to your CrewAI Enterprise account (create a free account at [app.crewai.com](https://app.crewai.com))
|
||||||
|
2. Open Crew Studio
|
||||||
|
3. Type what is the automation you're tryign to build
|
||||||
|
4. Create your tasks visually and connect them in sequence
|
||||||
|
5. Configure your inputs and click "Download Code" or "Deploy"
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
<Card title="Try CrewAI Enterprise" icon="rocket" href="https://app.crewai.com">
|
||||||
|
Start your free account at CrewAI Enterprise
|
||||||
|
</Card>
|
||||||
|
</Step>
|
||||||
<Step title="View your final report">
|
<Step title="View your final report">
|
||||||
You should see the output in the console and the `report.md` file should be created in the root of your project with the final report.
|
You should see the output in the console and the `report.md` file should be created in the root of your project with the final report.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user