# Ocr

## Overview

OCR API

### Available Operations

* [process](#process) - OCR

## process

OCR

### Example Usage

<!-- UsageSnippet language="python" operationID="ocr_v1_ocr_post" method="post" path="/v1/ocr" example="userExample" -->
```python
from mistralai.client import Mistral
import os


with Mistral(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:

    res = mistral.ocr.process(model="CX-9", document={
        "type": "document_url",
        "document_url": "https://upset-labourer.net/",
    }, bbox_annotation_format={
        "type": "text",
    }, document_annotation_format={
        "type": "text",
    }, include_blocks=True)

    # Handle response
    print(res)

```

### Parameters

| Parameter                                                                                                                                                                                                                                                                                                                                                                                                                                             | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Required                                                                                                                                                                                                                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                           | Example                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `model`                                                                                                                                                                                                                                                                                                                                                                                                                                               | *Nullable[str]*                                                                                                                                                                                                                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `document`                                                                                                                                                                                                                                                                                                                                                                                                                                            | [models.DocumentUnion](../../models/documentunion.md)                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Document to run OCR on                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `pages`                                                                                                                                                                                                                                                                                                                                                                                                                                               | [OptionalNullable[models.Pages]](../../models/pages.md)                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Specific pages to process. Accepts a list of integers or a string of comma-separated numbers and ranges (e.g. '0,1,2' or '0-5' or '0,2-4'). Page numbers start from 0.                                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `include_image_base64`                                                                                                                                                                                                                                                                                                                                                                                                                                | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Include image URLs in response                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `image_limit`                                                                                                                                                                                                                                                                                                                                                                                                                                         | *OptionalNullable[int]*                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Max images to extract                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `image_min_size`                                                                                                                                                                                                                                                                                                                                                                                                                                      | *OptionalNullable[int]*                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Minimum height and width of image to extract                                                                                                                                                                                                                                                                                                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `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                                                                                                                                                                                                                                                                                            | **Example 1:** {<br/>"type": "text"<br/>}<br/>**Example 2:** {<br/>"type": "json_object"<br/>}<br/>**Example 3:** {<br/>"type": "json_schema",<br/>"json_schema": {<br/>"schema": {<br/>"properties": {<br/>"name": {<br/>"title": "Name",<br/>"type": "string"<br/>},<br/>"authors": {<br/>"items": {<br/>"type": "string"<br/>},<br/>"title": "Authors",<br/>"type": "array"<br/>}<br/>},<br/>"required": [<br/>"name",<br/>"authors"<br/>],<br/>"title": "Book",<br/>"type": "object",<br/>"additionalProperties": false<br/>},<br/>"name": "book",<br/>"strict": true<br/>}<br/>} |
| `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                                                                                                                                                                                                                                                                                                                          | **Example 1:** {<br/>"type": "text"<br/>}<br/>**Example 2:** {<br/>"type": "json_object"<br/>}<br/>**Example 3:** {<br/>"type": "json_schema",<br/>"json_schema": {<br/>"schema": {<br/>"properties": {<br/>"name": {<br/>"title": "Name",<br/>"type": "string"<br/>},<br/>"authors": {<br/>"items": {<br/>"type": "string"<br/>},<br/>"title": "Authors",<br/>"type": "array"<br/>}<br/>},<br/>"required": [<br/>"name",<br/>"authors"<br/>],<br/>"title": "Book",<br/>"type": "object",<br/>"additionalProperties": false<br/>},<br/>"name": "book",<br/>"strict": true<br/>}<br/>} |
| `document_annotation_prompt`                                                                                                                                                                                                                                                                                                                                                                                                                          | *OptionalNullable[str]*                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Optional prompt to guide the model in extracting structured output from the entire document. A document_annotation_format must be provided.                                                                                                                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `table_format`                                                                                                                                                                                                                                                                                                                                                                                                                                        | [OptionalNullable[models.TableFormat]](../../models/tableformat.md)                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `extract_header`                                                                                                                                                                                                                                                                                                                                                                                                                                      | *Optional[bool]*                                                                                                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Extract the page header into the response's `header` field and remove it from the markdown content                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `extract_footer`                                                                                                                                                                                                                                                                                                                                                                                                                                      | *Optional[bool]*                                                                                                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Extract the page footer into the response's `footer` field and remove it from the markdown content                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `include_blocks`                                                                                                                                                                                                                                                                                                                                                                                                                                      | *Optional[bool]*                                                                                                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Return paragraph-level bounding boxes for all content blocks in the response                                                                                                                                                                                                                                                                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `confidence_scores_granularity`                                                                                                                                                                                                                                                                                                                                                                                                                       | [OptionalNullable[models.ConfidenceScoresGranularity]](../../models/confidencescoresgranularity.md)                                                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Granularity for confidence scores: 'page' (aggregate only), 'word' (per-word scores), or 'block' (per-block scores). Defaults to None (no confidence scores) to keep response payload small.                                                                                                                                                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `retries`                                                                                                                                                                                                                                                                                                                                                                                                                                             | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)                                                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                    | Configuration to override the default retry behavior of the client.                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

### Response

**[models.OCRResponse](../../models/ocrresponse.md)**

### Errors

| Error Type                 | Status Code                | Content Type               |
| -------------------------- | -------------------------- | -------------------------- |
| errors.HTTPValidationError | 422                        | application/json           |
| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |