Package org.springframework.ai.mistralai.ocr

Record Class MistralOcrApi.OCRPage

java.lang.Object

java.lang.Record

org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Record Components:

index - The page index in a PDF document starting from 0.

markdown - The markdown string response of the page.

images - List of all extracted images in the page.

dimensions - The dimensions of the PDF Page's screenshot image.

Enclosing class:

MistralOcrApi

public static record MistralOcrApi.OCRPage(Integer index, String markdown, List<MistralOcrApi.ExtractedImage> images, MistralOcrApi.OCRPageDimensions dimensions)
extends Record

Represents OCR information for a single page.

Constructor Summary

Constructors

Constructor	Description
OCRPage(Integer index, String markdown, List<MistralOcrApi.ExtractedImage> images, MistralOcrApi.OCRPageDimensions dimensions)	Creates an instance of a OCRPage record class.

Method Summary

Modifier and Type	Method	Description
MistralOcrApi.OCRPageDimensions	dimensions()	Returns the value of the dimensions 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.
List<MistralOcrApi.ExtractedImage>	images()	Returns the value of the images record component.
Integer	index()	Returns the value of the index record component.
String	markdown()	Returns the value of the markdown 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

OCRPage

public OCRPage(Integer index,
 String markdown,
 List<MistralOcrApi.ExtractedImage> images,
 MistralOcrApi.OCRPageDimensions dimensions)

Creates an instance of a OCRPage record class.

Parameters:

index - the value for the index record component

markdown - the value for the markdown record component

images - the value for the images record component

dimensions - the value for the dimensions 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.

index

public Integer index()

Returns the value of the index record component.

Returns:

the value of the index record component

markdown

public String markdown()

Returns the value of the markdown record component.

Returns:

the value of the markdown record component

images

public List<MistralOcrApi.ExtractedImage> images()

Returns the value of the images record component.

Returns:

the value of the images record component

dimensions

public MistralOcrApi.OCRPageDimensions dimensions()

Returns the value of the dimensions record component.

Returns:

the value of the dimensions record component