Record Class MistralOcrApi.OCRResponse

java.lang.Object

java.lang.Record

org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Record Components:

pages - List of OCR info for pages.

model - The model used to generate the OCR.

usageInfo - Usage info for the OCR request.

pagesProcessed - Number of pages processed.

docSizeBytes - Document size in bytes.

Enclosing class:

MistralOcrApi

public static record MistralOcrApi.OCRResponse(List<MistralOcrApi.OCRPage> pages, String model, MistralOcrApi.OCRUsageInfo usageInfo, Integer pagesProcessed, Integer docSizeBytes)
extends Record

Represents the response from the OCR API.

Since:

1.1.0

Author:

Alexandros Pappas

Constructor Summary

Constructors

Constructor	Description
OCRResponse(List<MistralOcrApi.OCRPage> pages, String model, MistralOcrApi.OCRUsageInfo usageInfo, Integer pagesProcessed, Integer docSizeBytes)	Creates an instance of a OCRResponse record class.

Method Summary

Modifier and Type	Method	Description
Integer	docSizeBytes()	Returns the value of the docSizeBytes 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	model()	Returns the value of the model record component.
List<MistralOcrApi.OCRPage>	pages()	Returns the value of the pages record component.
Integer	pagesProcessed()	Returns the value of the pagesProcessed record component.
final String	toString()	Returns a string representation of this record class.
MistralOcrApi.OCRUsageInfo	usageInfo()	Returns the value of the usageInfo record component.

Methods inherited from class Object

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

Constructor Details

OCRResponse

public OCRResponse(List<MistralOcrApi.OCRPage> pages,
 String model,
 MistralOcrApi.OCRUsageInfo usageInfo,
 Integer pagesProcessed,
 Integer docSizeBytes)

Creates an instance of a OCRResponse record class.

Parameters:

pages - the value for the pages record component

model - the value for the model record component

usageInfo - the value for the usageInfo record component

pagesProcessed - the value for the pagesProcessed record component

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

pages

public List<MistralOcrApi.OCRPage> pages()

Returns the value of the pages record component.

Returns:

the value of the pages record component

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

usageInfo

public MistralOcrApi.OCRUsageInfo usageInfo()

Returns the value of the usageInfo record component.

Returns:

the value of the usageInfo record component

pagesProcessed

public Integer pagesProcessed()

Returns the value of the pagesProcessed record component.

Returns:

the value of the pagesProcessed record component

docSizeBytes

public Integer docSizeBytes()

Returns the value of the docSizeBytes record component.

Returns:

the value of the docSizeBytes record component