mirror of
https://github.com/crewAIInc/crewAI.git
synced 2025-12-16 04:18:35 +00:00
1a1bb0ca3d
* docs(cli): document device-code login and config reset guidance; renumber sections * docs(cli): fix duplicate numbering (renumber Login/API Keys/Configuration sections) * docs: Fix webhook documentation to include meta dict in all webhook payloads - Add note explaining that meta objects from kickoff requests are included in all webhook payloads - Update webhook examples to show proper payload structure including meta field - Fix webhook examples to match actual API implementation - Apply changes to English, Korean, and Portuguese documentation Resolves the documentation gap where meta dict passing to webhooks was not documented despite being implemented in the API. * WIP: CrewAI docs theme, changelog, GEO, localization * docs(cli): fix merge markers; ensure mode: "wide"; convert ASCII tables to Markdown (en/pt-BR/ko) * docs: add group icons across locales; split Automation/Integrations; update tools overviews and links
51 lines
1.8 KiB
Plaintext
51 lines
1.8 KiB
Plaintext
---
|
|
title: Force Tool Output as Result
|
|
description: Learn how to force tool output as the result in an Agent's task in CrewAI.
|
|
icon: wrench-simple
|
|
mode: "wide"
|
|
---
|
|
|
|
## Introduction
|
|
|
|
In CrewAI, you can force the output of a tool as the result of an agent's task.
|
|
This feature is useful when you want to ensure that the tool output is captured and returned as the task result, avoiding any agent modification during the task execution.
|
|
|
|
## Forcing Tool Output as Result
|
|
|
|
To force the tool output as the result of an agent's task, you need to set the `result_as_answer` parameter to `True` when adding a tool to the agent.
|
|
This parameter ensures that the tool output is captured and returned as the task result, without any modifications by the agent.
|
|
|
|
Here's an example of how to force the tool output as the result of an agent's task:
|
|
|
|
```python Code
|
|
from crewai.agent import Agent
|
|
from my_tool import MyCustomTool
|
|
|
|
# Create a coding agent with the custom tool
|
|
coding_agent = Agent(
|
|
role="Data Scientist",
|
|
goal="Produce amazing reports on AI",
|
|
backstory="You work with data and AI",
|
|
tools=[MyCustomTool(result_as_answer=True)],
|
|
)
|
|
|
|
# Assuming the tool's execution and result population occurs within the system
|
|
task_result = coding_agent.execute_task(task)
|
|
```
|
|
|
|
## Workflow in Action
|
|
|
|
<Steps>
|
|
<Step title="Task Execution">
|
|
The agent executes the task using the tool provided.
|
|
</Step>
|
|
<Step title="Tool Output">
|
|
The tool generates the output, which is captured as the task result.
|
|
</Step>
|
|
<Step title="Agent Interaction">
|
|
The agent may reflect and take learnings from the tool but the output is not modified.
|
|
</Step>
|
|
<Step title="Result Return">
|
|
The tool output is returned as the task result without any modifications.
|
|
</Step>
|
|
</Steps> |