ContextQMD
Back to Crewai

OCR Tool

docs/en/tools/file-document/ocrtool.mdx

1.14.5a21.6 KB
Original Source

OCRTool

Description

Extract text from images (local path or URL). Uses a vision‑capable LLM via CrewAI’s LLM interface.

Installation

No extra install beyond crewai-tools. Ensure your selected LLM supports vision.

Parameters

Run Parameters

  • image_path_url (str, required): Local image path or HTTP(S) URL.

Examples

Direct usage

python
from crewai_tools import OCRTool

print(OCRTool().run(image_path_url="/tmp/receipt.png"))

With an agent

python
from crewai import Agent, Task, Crew
from crewai_tools import OCRTool

ocr = OCRTool()

agent = Agent(
    role="OCR", 
    goal="Extract text", 
    tools=[ocr],
)

task = Task(
    description="Extract text from https://example.com/invoice.jpg", 
    expected_output="All detected text in plain text",
    agent=agent,
)

crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()

Notes

  • Ensure the selected LLM supports image inputs.
  • For large images, consider downscaling to reduce token usage.
  • You can pass a specific LLM instance to the tool (e.g., LLM(model="gpt-4o")) if needed, matching the README guidance.

Example

python
from crewai import Agent, Task, Crew
from crewai_tools import OCRTool

tool = OCRTool()

agent = Agent(
    role="OCR Specialist",
    goal="Extract text from images",
    backstory="Vision‑enabled analyst",
    tools=[tool],
    verbose=True,
)

task = Task(
    description="Extract text from https://example.com/receipt.png",
    expected_output="All detected text in plain text",
    agent=agent,
)

crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()