Class Word (3.74.0)
public final class Word extends GeneratedMessageV3 implements WordOrBuilder
A word representation.
Protobuf type google.cloud.vision.v1.Word
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BOUNDING_BOX_FIELD_NUMBER
public static final int BOUNDING_BOX_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
CONFIDENCE_FIELD_NUMBER
public static final int CONFIDENCE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PROPERTY_FIELD_NUMBER
public static final int PROPERTY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
SYMBOLS_FIELD_NUMBER
public static final int SYMBOLS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Word getDefaultInstance()
Returns |
Type |
Description |
Word |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Word.Builder newBuilder()
newBuilder(Word prototype)
public static Word.Builder newBuilder(Word prototype)
Parameter |
Name |
Description |
prototype |
Word
|
public static Word parseDelimitedFrom(InputStream input)
Returns |
Type |
Description |
Word |
|
public static Word parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Returns |
Type |
Description |
Word |
|
parseFrom(byte[] data)
public static Word parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
Returns |
Type |
Description |
Word |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Word parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Returns |
Type |
Description |
Word |
|
parseFrom(ByteString data)
public static Word parseFrom(ByteString data)
Returns |
Type |
Description |
Word |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Word parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Returns |
Type |
Description |
Word |
|
public static Word parseFrom(CodedInputStream input)
Returns |
Type |
Description |
Word |
|
public static Word parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Returns |
Type |
Description |
Word |
|
public static Word parseFrom(InputStream input)
Returns |
Type |
Description |
Word |
|
public static Word parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Returns |
Type |
Description |
Word |
|
parseFrom(ByteBuffer data)
public static Word parseFrom(ByteBuffer data)
Returns |
Type |
Description |
Word |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Word parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Returns |
Type |
Description |
Word |
|
parser()
public static Parser<Word> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getBoundingBox()
public BoundingPoly getBoundingBox()
The bounding box for the word.
The vertices are in the order of top-left, top-right, bottom-right,
bottom-left. When a rotation of the bounding box is detected the rotation
is represented as around the top-left corner as defined when the text is
read in the 'natural' orientation.
For example:
- when the text is horizontal it might look like:
0----1
| |
3----2
- when it's rotated 180 degrees around the top-left corner it becomes:
2----3
| |
1----0
and the vertex order will still be (0, 1, 2, 3).
.google.cloud.vision.v1.BoundingPoly bounding_box = 2;
getBoundingBoxOrBuilder()
public BoundingPolyOrBuilder getBoundingBoxOrBuilder()
The bounding box for the word.
The vertices are in the order of top-left, top-right, bottom-right,
bottom-left. When a rotation of the bounding box is detected the rotation
is represented as around the top-left corner as defined when the text is
read in the 'natural' orientation.
For example:
- when the text is horizontal it might look like:
0----1
| |
3----2
- when it's rotated 180 degrees around the top-left corner it becomes:
2----3
| |
1----0
and the vertex order will still be (0, 1, 2, 3).
.google.cloud.vision.v1.BoundingPoly bounding_box = 2;
getConfidence()
public float getConfidence()
Confidence of the OCR results for the word. Range [0, 1].
float confidence = 4;
Returns |
Type |
Description |
float |
The confidence.
|
getDefaultInstanceForType()
public Word getDefaultInstanceForType()
Returns |
Type |
Description |
Word |
|
getParserForType()
public Parser<Word> getParserForType()
Overrides
getProperty()
public TextAnnotation.TextProperty getProperty()
Additional information detected for the word.
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
getPropertyOrBuilder()
public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()
Additional information detected for the word.
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
getSymbols(int index)
public Symbol getSymbols(int index)
List of symbols in the word.
The order of the symbols follows the natural reading order.
repeated .google.cloud.vision.v1.Symbol symbols = 3;
Parameter |
Name |
Description |
index |
int
|
Returns |
Type |
Description |
Symbol |
|
getSymbolsCount()
public int getSymbolsCount()
List of symbols in the word.
The order of the symbols follows the natural reading order.
repeated .google.cloud.vision.v1.Symbol symbols = 3;
Returns |
Type |
Description |
int |
|
getSymbolsList()
public List<Symbol> getSymbolsList()
List of symbols in the word.
The order of the symbols follows the natural reading order.
repeated .google.cloud.vision.v1.Symbol symbols = 3;
getSymbolsOrBuilder(int index)
public SymbolOrBuilder getSymbolsOrBuilder(int index)
List of symbols in the word.
The order of the symbols follows the natural reading order.
repeated .google.cloud.vision.v1.Symbol symbols = 3;
Parameter |
Name |
Description |
index |
int
|
getSymbolsOrBuilderList()
public List<? extends SymbolOrBuilder> getSymbolsOrBuilderList()
List of symbols in the word.
The order of the symbols follows the natural reading order.
repeated .google.cloud.vision.v1.Symbol symbols = 3;
Returns |
Type |
Description |
List<? extends com.google.cloud.vision.v1.SymbolOrBuilder> |
|
hasBoundingBox()
public boolean hasBoundingBox()
The bounding box for the word.
The vertices are in the order of top-left, top-right, bottom-right,
bottom-left. When a rotation of the bounding box is detected the rotation
is represented as around the top-left corner as defined when the text is
read in the 'natural' orientation.
For example:
- when the text is horizontal it might look like:
0----1
| |
3----2
- when it's rotated 180 degrees around the top-left corner it becomes:
2----3
| |
1----0
and the vertex order will still be (0, 1, 2, 3).
.google.cloud.vision.v1.BoundingPoly bounding_box = 2;
Returns |
Type |
Description |
boolean |
Whether the boundingBox field is set.
|
hasProperty()
public boolean hasProperty()
Additional information detected for the word.
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
Returns |
Type |
Description |
boolean |
Whether the property field is set.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Word.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Word.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public Word.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
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-11 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-11 UTC."],[],[]]