Class Document.Label.Builder (2.17.0) 

public static final class Document.Label.Builder extends GeneratedMessageV3.Builder<Document.Label.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.Label.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Label.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Label.Builder
Overrides

build()

public Document.Label build()
Returns
Type Description
Document.Label

buildPartial()

public Document.Label buildPartial()
Returns
Type Description
Document.Label

clear()

public Document.Label.Builder clear()
Returns
Type Description
Document.Label.Builder
Overrides

clearAutomlModel()

public Document.Label.Builder clearAutomlModel()

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
Document.Label.Builder

This builder for chaining.

clearConfidence()

public Document.Label.Builder clearConfidence()

Confidence score between 0 and 1 for label assignment.

float confidence = 3;

Returns
Type Description
Document.Label.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.Label.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Document.Label.Builder
Overrides

clearName()

public Document.Label.Builder clearName()

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
Document.Label.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Label.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Document.Label.Builder
Overrides

clearSource()

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

clone()

public Document.Label.Builder clone()
Returns
Type Description
Document.Label.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Document.Label other)

public Document.Label.Builder mergeFrom(Document.Label other)
Parameter
Name Description
other Document.Label
Returns
Type Description
Document.Label.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Label.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Label.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Document.Label.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Document.Label.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Label.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Label.Builder
Overrides

setAutomlModel(String value)

public Document.Label.Builder setAutomlModel(String value)

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;

Parameter
Name Description
value String

The automlModel to set.
Returns
Type Description
Document.Label.Builder

This builder for chaining.

setAutomlModelBytes(ByteString value)

public Document.Label.Builder setAutomlModelBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for automlModel to set.
Returns
Type Description
Document.Label.Builder

This builder for chaining.

setConfidence(float value)

public Document.Label.Builder setConfidence(float value)

Confidence score between 0 and 1 for label assignment.

float confidence = 3;

Parameter
Name Description
value float

The confidence to set.
Returns
Type Description
Document.Label.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Label.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Label.Builder
Overrides

setName(String value)

public Document.Label.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Document.Label.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Document.Label.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Document.Label.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Document.Label.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Document.Label.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Label.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Label.Builder
Overrides