Class Document.Label (2.36.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

Static Fields

AUTOML_MODEL_FIELD_NUMBER

public static final int AUTOML_MODEL_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.Label getDefaultInstance()
Returns
TypeDescription
Document.Label

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Document.Label.Builder newBuilder()
Returns
TypeDescription
Document.Label.Builder

newBuilder(Document.Label prototype)

public static Document.Label.Builder newBuilder(Document.Label prototype)
Parameter
NameDescription
prototypeDocument.Label
Returns
TypeDescription
Document.Label.Builder

parseDelimitedFrom(InputStream input)

public static Document.Label parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.Label parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Label parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Label parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Document.Label parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.Label parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Label parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Label
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for automlModel.

getConfidence()

public float getConfidence()

Confidence score between 0 and 1 for label assignment.

float confidence = 3;

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Document.Label getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public Document.Label.SourceCase getSourceCase()
Returns
TypeDescription
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
TypeDescription
boolean

Whether the automlModel field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Document.Label.Builder newBuilderForType()
Returns
TypeDescription
Document.Label.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Label.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.Label.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Document.Label.Builder toBuilder()
Returns
TypeDescription
Document.Label.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException