extract • AI Agent SDK
extract: Extract text from a document or image.
extract
Method
</div>
This is a method of the OCRAgent class in the ocr_agent module.
Extract text from a document or image.
Signature
def extract(source: str, include_image_base64: Optional[bool], pages: Optional[List[int]], image_limit: Optional[int], model: Optional[str]) -> AnyParameters
ParamField
strURL or path to document/image
ParamField
Optional[bool]Include base64 images in response
ParamField
OptionalSpecific pages to extract (for PDFs)
ParamField
Optional[int]Maximum images per page
ParamField
Optional[str]Override model for this call **kwargs: Additional parameters
Returns
ResponseField
AnyOCRResponse with pages, markdown content, and metadata
Usage
agent = OCRAgent(llm="mistral/mistral-ocr-latest")
result = agent.extract("https://arxiv.org/pdf/2201.04234")
for page in result.pages:
print(f"Page {page.index}: {page.markdown}")Uses
ocr
Used By
Source
View on GitHubpraisonaiagents/agent/ocr_agent.py at line 168