|
3 | 3 |
|
4 | 4 | ## Fields
|
5 | 5 |
|
6 |
| -| Field | Type | Required | Description | |
7 |
| -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | |
8 |
| -| `model` | *Nullable[str]* | :heavy_check_mark: | N/A | |
9 |
| -| `document` | [models.Document](../models/document.md) | :heavy_check_mark: | Document to run OCR on | |
10 |
| -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | |
11 |
| -| `pages` | List[*int*] | :heavy_minus_sign: | Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 | |
12 |
| -| `include_image_base64` | *OptionalNullable[bool]* | :heavy_minus_sign: | Include image URLs in response | |
13 |
| -| `image_limit` | *OptionalNullable[int]* | :heavy_minus_sign: | Max images to extract | |
14 |
| -| `image_min_size` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum height and width of image to extract | |
| 6 | +| Field | Type | Required | Description | |
| 7 | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 8 | +| `model` | *Nullable[str]* | :heavy_check_mark: | N/A | |
| 9 | +| `document` | [models.Document](../models/document.md) | :heavy_check_mark: | Document to run OCR on | |
| 10 | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | |
| 11 | +| `pages` | List[*int*] | :heavy_minus_sign: | Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 | |
| 12 | +| `include_image_base64` | *OptionalNullable[bool]* | :heavy_minus_sign: | Include image URLs in response | |
| 13 | +| `image_limit` | *OptionalNullable[int]* | :heavy_minus_sign: | Max images to extract | |
| 14 | +| `image_min_size` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum height and width of image to extract | |
| 15 | +| `bbox_annotation_format` | [OptionalNullable[models.ResponseFormat]](../models/responseformat.md) | :heavy_minus_sign: | Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field | |
| 16 | +| `document_annotation_format` | [OptionalNullable[models.ResponseFormat]](../models/responseformat.md) | :heavy_minus_sign: | Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field | |
0 commit comments