- 2.82.0 (latest)
 - 2.80.0
 - 2.79.0
 - 2.78.0
 - 2.77.0
 - 2.76.0
 - 2.74.0
 - 2.72.0
 - 2.71.0
 - 2.68.0
 - 2.67.0
 - 2.66.0
 - 2.64.0
 - 2.63.0
 - 2.62.0
 - 2.61.0
 - 2.60.0
 - 2.59.0
 - 2.58.0
 - 2.57.0
 - 2.56.0
 - 2.55.0
 - 2.53.0
 - 2.52.0
 - 2.51.0
 - 2.50.0
 - 2.49.0
 - 2.48.0
 - 2.47.0
 - 2.46.0
 - 2.45.0
 - 2.44.0
 - 2.43.0
 - 2.41.0
 - 2.40.0
 - 2.39.0
 - 2.38.0
 - 2.37.0
 - 2.36.0
 - 2.35.0
 - 2.34.0
 - 2.33.0
 - 2.32.0
 - 2.31.0
 - 2.28.0
 - 2.27.0
 - 2.26.0
 - 2.25.0
 - 2.24.0
 - 2.23.0
 - 2.22.0
 - 2.21.0
 - 2.20.0
 - 2.19.0
 - 2.18.0
 - 2.17.0
 - 2.16.0
 - 2.15.0
 - 2.13.0
 - 2.12.0
 - 2.11.0
 - 2.10.0
 - 2.9.0
 - 2.8.0
 - 2.7.5
 - 2.6.2
 - 2.5.1
 - 2.4.3
 - 2.3.1
 - 2.2.1
 - 2.1.9
 
public static final class Document.Label.Builder extends GeneratedMessageV3.Builder<Document.Label.Builder> implements Document.LabelOrBuilderLabel 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.BuilderImplements
Document.LabelOrBuilderStatic 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 | 
        |
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 | 
        |
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 | 
        |
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 | 
        |
clearSource()
public Document.Label.Builder clearSource()| Returns | |
|---|---|
| Type | Description | 
Document.Label.Builder | 
        |
clone()
public Document.Label.Builder clone()| Returns | |
|---|---|
| Type | Description | 
Document.Label.Builder | 
        |
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 | 
        |
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 | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
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 | 
        |
| 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 | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Document.Label.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
Document.Label.Builder | 
        |
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 | 
        StringThe 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 | 
        ByteStringThe 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 | 
        floatThe 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 | 
        |
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 | 
        StringThe 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 | 
        ByteStringThe 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 | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final Document.Label.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
Document.Label.Builder | 
        |