Class Document.Label (2.3.1)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 2.3.1keyboard_arrow_down
public static final class Document . Label extends GeneratedMessageV3 implements Document . LabelOrBuilder
Label attaches schema information and/or other metadata to segments within
a Document . Multiple Label s on a single field can denote either
different labels, different instances of the same label created at
different times, or some combination of both.
Protobuf type google.cloud.documentai.v1beta2.Document.Label
Static Fields
AUTOML_MODEL_FIELD_NUMBER
public static final int AUTOML_MODEL_FIELD_NUMBER
Field Value
CONFIDENCE_FIELD_NUMBER
public static final int CONFIDENCE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Document . Label getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Document . Label . Builder newBuilder ()
Returns
newBuilder(Document.Label prototype)
public static Document . Label . Builder newBuilder ( Document . Label prototype )
Parameter
Returns
public static Document . Label parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Document . Label parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document . Label parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document . Label parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document . Label parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document . Label parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Document . Label parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Document . Label parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Document . Label parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Document . Label parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document . Label parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document . Label parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Document . Label > parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getAutomlModel()
public String getAutomlModel ()
Label is generated AutoML model. This field stores the full resource
name of the AutoML model.
Format:
projects/{project-id}/locations/{location-id}/models/{model-id}
string automl_model = 2;
Returns
Type Description
String The automlModel.
getAutomlModelBytes()
public ByteString getAutomlModelBytes ()
Label is generated AutoML model. This field stores the full resource
name of the AutoML model.
Format:
projects/{project-id}/locations/{location-id}/models/{model-id}
string automl_model = 2;
Returns
Type Description
ByteString The bytes for automlModel.
getConfidence()
public float getConfidence ()
Confidence score between 0 and 1 for label assignment.
float confidence = 3;
Returns
Type Description
float The confidence.
getDefaultInstanceForType()
public Document . Label getDefaultInstanceForType ()
Returns
getName()
Name of the label.
When the label is generated from AutoML Text Classification model, this
field represents the name of the category.
string name = 1;
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Name of the label.
When the label is generated from AutoML Text Classification model, this
field represents the name of the category.
string name = 1;
Returns
getParserForType()
public Parser<Document . Label > getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getSourceCase()
public Document . Label . SourceCase getSourceCase ()
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hasAutomlModel()
public boolean hasAutomlModel ()
Label is generated AutoML model. This field stores the full resource
name of the AutoML model.
Format:
projects/{project-id}/locations/{location-id}/models/{model-id}
string automl_model = 2;
Returns
Type Description
boolean Whether the automlModel field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Document . Label . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document . Label . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Document . Label . 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-02 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-02 UTC."],[],[]]
