mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-11 09:08:31 +00:00
a499d9de42
- Update SerperDevTool documentation with accurate parameters and JSON response format - Enhance XMLSearchTool and MDXSearchTool docs with RAG capabilities and required parameters - Fix code block formatting across multiple tool documentation files - Add clarification about environment variables and configuration - Validate all examples against actual implementations - Successfully tested with mkdocs build Co-Authored-By: Joe Moura <joao@crewai.com>
50 lines
1.3 KiB
Plaintext
50 lines
1.3 KiB
Plaintext
---
|
|
title: Vision Tool
|
|
description: The `VisionTool` is designed to extract text from images.
|
|
icon: eye
|
|
---
|
|
|
|
# `VisionTool`
|
|
|
|
## Description
|
|
|
|
This tool is used to extract text from images. When passed to the agent it will extract the text from the image and then use it to generate a response, report or any other output.
|
|
The URL or the PATH of the image should be passed to the Agent.
|
|
|
|
## Installation
|
|
|
|
Install the crewai_tools package
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Example
|
|
|
|
To use the VisionTool, first ensure the OpenAI API key is set in the environment variable `OPENAI_API_KEY`. Here's an example:
|
|
|
|
```python
|
|
from crewai_tools import VisionTool
|
|
|
|
vision_tool = VisionTool()
|
|
|
|
@agent
|
|
def researcher(self) -> Agent:
|
|
'''
|
|
This agent uses the VisionTool to extract text from images.
|
|
'''
|
|
return Agent(
|
|
config=self.agents_config["researcher"],
|
|
allow_delegation=False,
|
|
tools=[vision_tool]
|
|
)
|
|
```
|
|
|
|
## Arguments
|
|
|
|
The VisionTool requires the following arguments:
|
|
|
|
| Argument | Type | Description |
|
|
| :----------------- | :------- | :------------------------------------------------------------------------------- |
|
|
| **image_path_url** | `string` | **Mandatory**. The path to the image file from which text needs to be extracted. |
|