| Field | Type | Required | Description |
|---|---|---|---|
model |
Nullable[str] | ✔️ | N/A |
document |
models.Document | ✔️ | Document to run OCR on |
id |
Optional[str] | ➖ | N/A |
pages |
List[int] | ➖ | Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 |
include_image_base64 |
OptionalNullable[bool] | ➖ | Include image URLs in response |
image_limit |
OptionalNullable[int] | ➖ | Max images to extract |
image_min_size |
OptionalNullable[int] | ➖ | Minimum height and width of image to extract |
bbox_annotation_format |
OptionalNullable[models.ResponseFormat] | ➖ | Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field |
document_annotation_format |
OptionalNullable[models.ResponseFormat] | ➖ | Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field |