Package com.google.cloud.documentai.v1beta2

Class Document.Label

  • All Implemented Interfaces:
    Document.LabelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Document
    public static final class Document.Label
extends com.google.protobuf.GeneratedMessageV3
implements Document.LabelOrBuilder
     Label attaches schema information and/or other metadata to segments within
 a [Document][google.cloud.documentai.v1beta2.Document]. Multiple
 [Label][google.cloud.documentai.v1beta2.Document.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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Document.Label.Builder
      Label attaches schema information and/or other metadata to segments within a [Document][google.cloud.documentai.v1beta2.Document].
      static class  Document.Label.SourceCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int AUTOML_MODEL_FIELD_NUMBER  
      static int CONFIDENCE_FIELD_NUMBER  
      static int NAME_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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;
        Specified by:
        hasAutomlModel in interface Document.LabelOrBuilder
        Returns:
        Whether the automlModel field is set.

      • 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;
        Specified by:
        getAutomlModel in interface Document.LabelOrBuilder
        Returns:
        The automlModel.

      • getAutomlModelBytes

        public com.google.protobuf.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;
        Specified by:
        getAutomlModelBytes in interface Document.LabelOrBuilder
        Returns:
        The bytes for automlModel.

      • 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;
        Specified by:
        getName in interface Document.LabelOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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;
        Specified by:
        getNameBytes in interface Document.LabelOrBuilder
        Returns:
        The bytes for name.

      • getConfidence

        public float getConfidence()
         Confidence score between 0 and 1 for label assignment.
        float confidence = 3;
        Specified by:
        getConfidence in interface Document.LabelOrBuilder
        Returns:
        The confidence.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Document.Label parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Label parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Label parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Label parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Label parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Label parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Label parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Document.Label.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Document.Label.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Document.Label.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Document.Label getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Document.Label> parser()

      • getParserForType

        public com.google.protobuf.Parser<Document.Label> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Document.Label getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder