chore: Update Tasks.md documentation to include example of using output JSON in tasks #746
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… JSON in tasks The documentation in Tasks.md was updated to include an example of how to use the `output_json` parameter in task definitions. This allows for specifying that the output of a task should be in JSON format. The example demonstrates how to define a task that searches for local companies and outputs the results in a JSON format according to a predefined schema using Pydantic models. Additionally, the tool override mechanism was updated to reflect this change. This fix improves the clarity and comprehensiveness of the documentation, making it easier for users to understand and utilize the `output_json` parameter. It also ensures consistency in the documentation and code examples. Note: The modifications made to the Tasks.md file are the only ones relevant to this commit message.
leandrosilvaferreira
changed the title
Updated the 'Tasks.md' document to provide a more detailed example of the tool override mechanism in CrewAI. The output of a task is now illustrated as a JSON object, demonstrating how the tool override mechanism allows for dynamic adaptation of agent capabilities. The changes made to the document improve the clarity and understanding of the feature. (Changes in: docs/core-concepts/Tasks.md)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation in Tasks.md was updated to include an example of how to use the
output_jsonparameter in task definitions. This allows for specifying that the output of a task should be in JSON format. The example demonstrates how to define a task that searches for local companies and outputs the results in a JSON format according to a predefined schema using Pydantic models.This fix improves the clarity and comprehensiveness of the documentation, making it easier for users to understand and utilize the
output_jsonparameter. It also ensures consistency in the documentation and code examples.Note: The modifications made to the Tasks.md file are the only ones relevant to this commit message.