Class Document.Label (2.50.0) 

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 Labels 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.Label

Static Fields

AUTOML_MODEL_FIELD_NUMBER

public static final int AUTOML_MODEL_FIELD_NUMBER
Field Value
Type Description
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.Label getDefaultInstance()
Returns
Type Description
Document.Label

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Document.Label.Builder newBuilder()
Returns
Type Description
Document.Label.Builder

newBuilder(Document.Label prototype)

public static Document.Label.Builder newBuilder(Document.Label prototype)
Parameter
Name Description
prototype Document.Label
Returns
Type Description
Document.Label.Builder

parseDelimitedFrom(InputStream input)

public static Document.Label parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Label
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Label
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.Label parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.Label
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Label
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Label parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.Label
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Label
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Label parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.Label
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Label
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.Label parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Label
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Label
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.Label parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.Label
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Label
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Document.Label> parser()
Returns
Type Description
Parser<Label>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
Document.Label

getName()

public String 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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Document.Label> getParserForType()
Returns
Type Description
Parser<Label>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public Document.Label.SourceCase getSourceCase()
Returns
Type Description
Document.Label.SourceCase

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Document.Label.Builder newBuilderForType()
Returns
Type Description
Document.Label.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Label.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.Label.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Document.Label.Builder toBuilder()
Returns
Type Description
Document.Label.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException