Package org.springframework.ai.mistralai.ocr

Record Class MistralOcrApi.OCRRequest

java.lang.Object

java.lang.Record

org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Record Components:

model - Model to use for OCR. Can be 'mistral-ocr-latest'

id - An optional string identifier.

document - Document to run OCR on. Can be either a MistralOcrApi.OCRRequest.DocumentURLChunk or an MistralOcrApi.OCRRequest.ImageURLChunk.

pages - Specific pages to process in various formats: single number, range, or list of both. Starts from 0.

includeImageBase64 - Whether to include image URLs in the response.

imageLimit - Maximum number of images to extract.

imageMinSize - Minimum height and width of image to extract.

Enclosing class:

MistralOcrApi

public static record MistralOcrApi.OCRRequest(String model, String id, MistralOcrApi.OCRRequest.Document document, List<Integer> pages, Boolean includeImageBase64, Integer imageLimit, Integer imageMinSize)
extends Record

Represents the request for the OCR API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MistralOcrApi.OCRRequest.Document	Represents the document to be processed, which can be either a document URL or an image URL.
static final record	MistralOcrApi.OCRRequest.DocumentURLChunk	Represents a document URL chunk.
static final record	MistralOcrApi.OCRRequest.ImageURLChunk	Represents an image URL chunk.

Constructor Summary

Constructors

Constructor	Description
OCRRequest(String model, String id, MistralOcrApi.OCRRequest.Document document, List<Integer> pages, Boolean includeImageBase64, Integer imageLimit, Integer imageMinSize)	Creates an instance of a OCRRequest record class.
OCRRequest(String model, MistralOcrApi.OCRRequest.Document document)	Create an OCRRequest.

Method Summary

Modifier and Type	Method	Description
MistralOcrApi.OCRRequest.Document	document()	Returns the value of the document record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
Integer	imageLimit()	Returns the value of the imageLimit record component.
Integer	imageMinSize()	Returns the value of the imageMinSize record component.
Boolean	includeImageBase64()	Returns the value of the includeImageBase64 record component.
String	model()	Returns the value of the model record component.
List<Integer>	pages()	Returns the value of the pages record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OCRRequest

public OCRRequest(String model,
 MistralOcrApi.OCRRequest.Document document)

Create an OCRRequest.

Parameters:

model - The model to use for OCR.

document - Document to run OCR on.

OCRRequest

public OCRRequest(String model,
 String id,
 MistralOcrApi.OCRRequest.Document document,
 List<Integer> pages,
 Boolean includeImageBase64,
 Integer imageLimit,
 Integer imageMinSize)

Creates an instance of a OCRRequest record class.

Parameters:

model - the value for the model record component

id - the value for the id record component

document - the value for the document record component

pages - the value for the pages record component

includeImageBase64 - the value for the includeImageBase64 record component

imageLimit - the value for the imageLimit record component

imageMinSize - the value for the imageMinSize record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

document

public MistralOcrApi.OCRRequest.Document document()

Returns the value of the document record component.

Returns:

the value of the document record component

pages

public List<Integer> pages()

Returns the value of the pages record component.

Returns:

the value of the pages record component

includeImageBase64

public Boolean includeImageBase64()

Returns the value of the includeImageBase64 record component.

Returns:

the value of the includeImageBase64 record component

imageLimit

public Integer imageLimit()

Returns the value of the imageLimit record component.

Returns:

the value of the imageLimit record component

imageMinSize

public Integer imageMinSize()

Returns the value of the imageMinSize record component.

Returns:

the value of the imageMinSize record component