Class TextAnnotation (3.10.0) 

publicfinalclass TextAnnotationextendsGeneratedMessageV3implementsTextAnnotationOrBuilder

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

Inherited Members

Static Fields

PAGES_FIELD_NUMBER

publicstaticfinalintPAGES_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

publicstaticfinalintTEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticTextAnnotationgetDefaultInstance()
Returns
Type Description
TextAnnotation

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticTextAnnotation.BuildernewBuilder()
Returns
Type Description
TextAnnotation.Builder

newBuilder(TextAnnotation prototype)

publicstaticTextAnnotation.BuildernewBuilder(TextAnnotationprototype)
Parameter
Name Description
prototype TextAnnotation
Returns
Type Description
TextAnnotation.Builder

parseDelimitedFrom(InputStream input)

publicstaticTextAnnotationparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
TextAnnotation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticTextAnnotationparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextAnnotation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticTextAnnotationparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
TextAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticTextAnnotationparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticTextAnnotationparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
TextAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticTextAnnotationparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticTextAnnotationparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TextAnnotation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticTextAnnotationparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextAnnotation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticTextAnnotationparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
TextAnnotation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticTextAnnotationparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextAnnotation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticTextAnnotationparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TextAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticTextAnnotationparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<TextAnnotation>parser()
Returns
Type Description
Parser<TextAnnotation>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicTextAnnotationgetDefaultInstanceForType()
Returns
Type Description
TextAnnotation

getPages(int index)

publicPagegetPages(intindex)

List of pages detected by OCR.

repeated .google.cloud.vision.v1p3beta1.Page pages = 1;

Parameter
Name Description
index int
Returns
Type Description
Page

getPagesCount()

publicintgetPagesCount()

List of pages detected by OCR.

repeated .google.cloud.vision.v1p3beta1.Page pages = 1;

Returns
Type Description
int

getPagesList()

publicList<Page>getPagesList()

List of pages detected by OCR.

repeated .google.cloud.vision.v1p3beta1.Page pages = 1;

Returns
Type Description
List<Page>

getPagesOrBuilder(int index)

publicPageOrBuildergetPagesOrBuilder(intindex)

List of pages detected by OCR.

repeated .google.cloud.vision.v1p3beta1.Page pages = 1;

Parameter
Name Description
index int
Returns
Type Description
PageOrBuilder

getPagesOrBuilderList()

publicList<?extendsPageOrBuilder>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()

publicParser<TextAnnotation>getParserForType()
Returns
Type Description
Parser<TextAnnotation>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getText()

publicStringgetText()

UTF-8 text detected on the pages.

string text = 2;

Returns
Type Description
String

The text.

getTextBytes()

publicByteStringgetTextBytes()

UTF-8 text detected on the pages.

string text = 2;

Returns
Type Description
ByteString

The bytes for text.

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicTextAnnotation.BuildernewBuilderForType()
Returns
Type Description
TextAnnotation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedTextAnnotation.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TextAnnotation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicTextAnnotation.BuildertoBuilder()
Returns
Type Description
TextAnnotation.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException

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年11月19日 UTC.