99% done. Need to make docs match new example

2026-01-10 16:48:30 +00:00 · 2025-03-27 17:18:33 -04:00
parent 30aa5cc3b9
commit 0ec3c37912
3 changed files with 373 additions and 138 deletions
--- a/docs/concepts/lite-agent.mdx
+++ b/docs/concepts/lite-agent.mdx
@@ -0,0 +1,177 @@
+---
+title: LiteAgent
+description: A lightweight, single-purpose agent for simple autonomous tasks within the CrewAI framework.
+icon: feather
+---
+
+## Overview
+
+A `LiteAgent` is a streamlined version of CrewAI's Agent, designed for simpler, standalone tasks that don't require the full complexity of a crew-based workflow. It's perfect for quick automations, single-purpose tasks, or when you need a lightweight solution.
+
+<Tip>
+Think of a LiteAgent as a specialized worker that excels at individual tasks. While regular Agents are team players in a crew, LiteAgents are solo performers optimized for specific operations.
+</Tip>
+
+## LiteAgent Attributes
+
+| Attribute                             | Parameter           | Type                    | Description                                                                                    |
+| :------------------------------------ | :----------------- | :---------------------- | :--------------------------------------------------------------------------------------------- |
+| **Role**                              | `role`             | `str`                   | Defines the agent's function and expertise.                                                     |
+| **Goal**                              | `goal`             | `str`                   | The specific objective that guides the agent's actions.                                         |
+| **Backstory**                         | `backstory`        | `str`                   | Provides context and personality to the agent.                                                  |
+| **LLM** _(optional)_                  | `llm`              | `Union[str, LLM, Any]`  | Language model powering the agent. Defaults to "gpt-4".                                        |
+| **Tools** _(optional)_                | `tools`            | `List[BaseTool]`        | Capabilities available to the agent. Defaults to an empty list.                                |
+| **Verbose** _(optional)_              | `verbose`          | `bool`                  | Enable detailed execution logs. Default is False.                                               |
+| **Response Format** _(optional)_      | `response_format`  | `Type[BaseModel]`       | Pydantic model for structured output. Optional.                                                |
+
+## Creating a LiteAgent
+
+Here's a simple example of creating and using a LiteAgent in a flow:
+
+```python
+from typing import List
+from pydantic import BaseModel, Field
+from crewai.flow.flow import Flow, start, listen
+from crewai.lite_agent import LiteAgent
+from crewai.tools import WebSearchTool
+
+# Define a structured output format
+class MarketAnalysis(BaseModel):
+    key_trends: List[str] = Field(description="List of identified market trends")
+    market_size: str = Field(description="Estimated market size")
+    competitors: List[str] = Field(description="Major competitors in the space")
+
+# Define flow state
+class MarketResearchState(BaseModel):
+    product: str = ""
+    analysis: MarketAnalysis = None
+
+# Create a flow class
+class MarketResearchFlow(Flow[MarketResearchState]):
+    @start()
+    def initialize_research(self, product: str):
+        print(f"Starting market research for {product}")
+        self.state.product = product
+
+    @listen(initialize_research)
+    async def analyze_market(self):
+        # Create a LiteAgent for market research
+        analyst = LiteAgent(
+            role="Market Research Analyst",
+            goal=f"Analyze the market for {self.state.product}",
+            backstory="You are an experienced market analyst with expertise in "
+                     "identifying market trends and opportunities.",
+            tools=[WebSearchTool()],
+            verbose=True,
+            response_format=MarketAnalysis
+        )
+        
+        # Define the research query
+        query = f"""
+        Research the market for {self.state.product}. Include:
+        1. Key market trends
+        2. Market size
+        3. Major competitors
+        
+        Format your response according to the specified structure.
+        """
+        
+        # Execute the analysis
+        result = await analyst.kickoff_async(query)
+        self.state.analysis = result.pydantic
+        return result.pydantic
+
+    @listen(analyze_market)
+    def present_results(self):
+        analysis = self.state.analysis
+        print("\nMarket Analysis Results")
+        print("=====================")
+        
+        print("\nKey Market Trends:")
+        for trend in analysis.key_trends:
+            print(f"- {trend}")
+
+        print(f"\nMarket Size: {analysis.market_size}")
+
+        print("\nMajor Competitors:")
+        for competitor in analysis.competitors:
+            print(f"- {competitor}")
+
+# Usage example
+import asyncio
+
+async def run_flow():
+    flow = MarketResearchFlow()
+    result = await flow.kickoff(inputs={"product": "AI-powered chatbots"})
+    return result
+
+# Run the flow
+if __name__ == "__main__":
+    asyncio.run(run_flow())
+
+## Key Features
+
+### 1. Simplified Setup
+Unlike regular Agents, LiteAgents are designed for quick setup and standalone operation. They don't require crew configuration or task management.
+
+### 2. Structured Output
+LiteAgents support Pydantic models for response formatting, making it easy to get structured, type-safe data from your agent's operations.
+
+### 3. Tool Integration
+Just like regular Agents, LiteAgents can use tools to enhance their capabilities:
+```python
+from crewai.tools import SerperDevTool, CalculatorTool
+
+agent = LiteAgent(
+    role="Research Assistant",
+    goal="Find and analyze information",
+    tools=[SerperDevTool(), CalculatorTool()],
+    verbose=True
+)
+```
+
+### 4. Async Support
+LiteAgents support asynchronous execution through the `kickoff_async` method, making them suitable for non-blocking operations in your application.
+
+## Response Formatting
+
+LiteAgents support structured output through Pydantic models using the `response_format` parameter. This feature ensures type safety and consistent output structure, making it easier to work with agent responses in your application.
+
+### Basic Usage
+
+```python
+from pydantic import BaseModel, Field
+
+class SearchResult(BaseModel):
+    title: str = Field(description="The title of the found content")
+    summary: str = Field(description="A brief summary of the content")
+    relevance_score: float = Field(description="Relevance score from 0 to 1")
+
+agent = LiteAgent(
+    role="Search Specialist",
+    goal="Find and summarize relevant information",
+    response_format=SearchResult
+)
+
+result = await agent.kickoff_async("Find information about quantum computing")
+print(f"Title: {result.pydantic.title}")
+print(f"Summary: {result.pydantic.summary}")
+print(f"Relevance: {result.pydantic.relevance_score}")
+```
+
+### Handling Responses
+
+When using `response_format`, the agent's response will be available in two forms:
+
+1. **Raw Response**: Access the unstructured string response
+   ```python
+   result = await agent.kickoff_async("Analyze the market")
+   print(result.raw)  # Original LLM response
+   ```
+
+2. **Structured Response**: Access the parsed Pydantic model
+   ```python
+   print(result.pydantic)  # Parsed response as Pydantic model
+   print(result.pydantic.dict())  # Convert to dictionary
+   ```
+