Class TextAnnotation (2.0.29)
Version 2.0.29keyboard_arrow_down
public final class TextAnnotation extends GeneratedMessageV3 implements TextAnnotationOrBuilder
TextAnnotation contains a structured representation of OCR extracted text.
The hierarchy of an OCR extracted text structure is like this:
TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
Each structural component, starting from Page, may further have their own
properties. Properties describe detected languages, breaks etc.. Please refer
to the
TextAnnotation.TextProperty
message definition below for more detail.
Protobuf type google.cloud.vision.v1p3beta1.TextAnnotation
Static Fields
PAGES_FIELD_NUMBER
public static final int PAGES_FIELD_NUMBER
Field Value
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TextAnnotation getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static TextAnnotation . Builder newBuilder ()
Returns
newBuilder(TextAnnotation prototype)
public static TextAnnotation . Builder newBuilder ( TextAnnotation prototype )
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static TextAnnotation parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TextAnnotation parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TextAnnotation parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TextAnnotation parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TextAnnotation parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TextAnnotation parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static TextAnnotation parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TextAnnotation parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static TextAnnotation parseFrom ( InputStream input )
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TextAnnotation parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TextAnnotation parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TextAnnotation parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<TextAnnotation> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public TextAnnotation getDefaultInstanceForType ()
Returns
getPages(int index)
public Page getPages ( int index )
List of pages detected by OCR.
repeated .google.cloud.vision.v1p3beta1.Page pages = 1;
Parameter
Name Description
index int
Returns
getPagesCount()
public int getPagesCount ()
List of pages detected by OCR.
repeated .google.cloud.vision.v1p3beta1.Page pages = 1;
Returns
getPagesList()
public List<Page> getPagesList ()
List of pages detected by OCR.
repeated .google.cloud.vision.v1p3beta1.Page pages = 1;
Returns
getPagesOrBuilder(int index)
public PageOrBuilder getPagesOrBuilder ( int index )
List of pages detected by OCR.
repeated .google.cloud.vision.v1p3beta1.Page pages = 1;
Parameter
Name Description
index int
Returns
getPagesOrBuilderList()
public List <? extends PageOrBuilder > getPagesOrBuilderList ()
List of pages detected by OCR.
repeated .google.cloud.vision.v1p3beta1.Page pages = 1;
Returns
Type Description
List <? extends com.google.cloud.vision.v1p3beta1.PageOrBuilder >
getParserForType()
public Parser<TextAnnotation> getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getText()
UTF-8 text detected on the pages.
string text = 2;
Returns
Type Description
String The text.
getTextBytes()
public ByteString getTextBytes ()
UTF-8 text detected on the pages.
string text = 2;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public TextAnnotation . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TextAnnotation . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public TextAnnotation . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
