Package org.springframework.ai.mistralai.ocr

Class MistralOcrApi

java.lang.Object

org.springframework.ai.mistralai.ocr.MistralOcrApi

public class MistralOcrApi
extends Object

Java Client library for the Mistral AI OCR API. Provides access to the OCR functionality.

The API processes a document and returns a markdown string representation of the text, along with information about extracted images.

Since:

1.1.0

Author:

Alexandros Pappas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MistralOcrApi.ExtractedImage	Represents an extracted image from a page.
static enum	MistralOcrApi.OCRModel	List of well-known Mistral OCR models.
static final record	MistralOcrApi.OCRPage	Represents OCR information for a single page.
static final record	MistralOcrApi.OCRPageDimensions	Represents the dimensions of a PDF page's screenshot image.
static final record	MistralOcrApi.OCRRequest	Represents the request for the OCR API.
static final record	MistralOcrApi.OCRResponse	Represents the response from the OCR API.
static final record	MistralOcrApi.OCRUsageInfo	Represents usage information for the OCR request.

Constructor Summary

Constructors

Constructor	Description
MistralOcrApi(String mistralAiApiKey)	Create a new MistralOcrApi instance.
MistralOcrApi(String baseUrl, String mistralAiApiKey)	Create a new MistralOcrApi instance.
MistralOcrApi(String baseUrl, String mistralAiApiKey, org.springframework.web.client.RestClient.Builder restClientBuilder)	Create a new MistralOcrApi instance.
MistralOcrApi(String baseUrl, String mistralAiApiKey, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new MistralOcrApi instance.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<MistralOcrApi.OCRResponse>	ocr(MistralOcrApi.OCRRequest ocrRequest)	Performs OCR on a document and returns the extracted information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MistralOcrApi

public MistralOcrApi(String mistralAiApiKey)

Create a new MistralOcrApi instance.

Parameters:

mistralAiApiKey - Mistral AI API key.

MistralOcrApi

public MistralOcrApi(String baseUrl,
 String mistralAiApiKey)

Create a new MistralOcrApi instance.

Parameters:

baseUrl - API base URL.

mistralAiApiKey - Mistral AI API key.

MistralOcrApi

public MistralOcrApi(String baseUrl,
 String mistralAiApiKey,
 org.springframework.web.client.RestClient.Builder restClientBuilder)

Create a new MistralOcrApi instance.

Parameters:

baseUrl - API base URL.

mistralAiApiKey - Mistral AI API key.

restClientBuilder - RestClient builder.

MistralOcrApi

public MistralOcrApi(String baseUrl,
 String mistralAiApiKey,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new MistralOcrApi instance.

Parameters:

baseUrl - API base URL.

mistralAiApiKey - Mistral AI API key.

restClientBuilder - RestClient builder.

responseErrorHandler - Response error handler.

Method Details

ocr

public org.springframework.http.ResponseEntity<MistralOcrApi.OCRResponse> ocr(MistralOcrApi.OCRRequest ocrRequest)

Performs OCR on a document and returns the extracted information.

Parameters:

ocrRequest - The OCR request containing document details and processing options.

Returns:

ResponseEntity containing the OCR response with markdown text and image data.