Class Document.Label.Builder (2.2.1) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 2.2.1keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
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 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 Methods
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  Returns 
  
  Methods
   
  addRepeatedField(Descriptors.FieldDescriptor field, Object value) 
  
    
public   Document . Label . Builder   addRepeatedField ( Descriptors . FieldDescriptor   field ,   Object   value )  
  Parameters 
  
  Returns 
  
  Overrides 
  
  build() 
  
    
public   Document . Label   build ()  
  Returns 
  
  buildPartial() 
  
    
public   Document . Label   buildPartial ()  
  Returns 
  
  clear() 
  
    
public   Document . Label . Builder   clear ()  
  Returns 
  
  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 
  
  clearConfidence() 
  
    
public   Document . Label . Builder   clearConfidence ()  
   Confidence score between 0 and 1 for label assignment.
 float confidence = 3;
Returns 
  
  clearField(Descriptors.FieldDescriptor field) 
  
    
public   Document . Label . Builder   clearField ( Descriptors . FieldDescriptor   field )  
  Parameter 
  
  Returns 
  
  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 
  
  clearOneof(Descriptors.OneofDescriptor oneof) 
  
    
public   Document . Label . Builder   clearOneof ( Descriptors . OneofDescriptor   oneof )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  clearSource() 
  
    
public   Document . Label . Builder   clearSource ()  
  Returns 
  
  clone() 
  
    
public   Document . Label . Builder   clone ()  
  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 
  
  getDescriptorForType() 
  
    
public   Descriptors . Descriptor   getDescriptorForType ()  
  Returns 
  
  Overrides 
  
  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 
  
  getSourceCase() 
  
    
public   Document . Label . SourceCase   getSourceCase ()  
  Returns 
  
  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 
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  Returns 
  
  Overrides 
  
  mergeFrom(Document.Label other) 
  
    
public   Document . Label . Builder   mergeFrom ( Document . Label   other )  
  Parameter 
  
  Returns 
  
  
    
public   Document . Label . Builder   mergeFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  Parameters 
  
  Returns 
  
  Overrides 
  
  Exceptions 
  
  mergeFrom(Message other) 
  
    
public   Document . Label . Builder   mergeFrom ( Message   other )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  mergeUnknownFields(UnknownFieldSet unknownFields) 
  
    
public   final   Document . Label . Builder   mergeUnknownFields ( UnknownFieldSet   unknownFields )  
  Parameter 
  
  Returns 
  
  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 
  
  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 
  
  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 
  
  setField(Descriptors.FieldDescriptor field, Object value) 
  
    
public   Document . Label . Builder   setField ( Descriptors . FieldDescriptor   field ,   Object   value )  
  Parameters 
  
  Returns 
  
  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 
  
  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 
  
  setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) 
  
    
public   Document . Label . Builder   setRepeatedField ( Descriptors . FieldDescriptor   field ,   int   index ,   Object   value )  
  Parameters 
  
  Returns 
  
  Overrides 
  
  setUnknownFields(UnknownFieldSet unknownFields) 
  
    
public   final   Document . Label . Builder   setUnknownFields ( UnknownFieldSet   unknownFields )  
  Parameter 
  
  Returns 
  
  Overrides 
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  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-29 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-29 UTC."],[],[]]