Package com.google.cloud.documentai.v1

Class OcrConfig.Hints

  • All Implemented Interfaces:
    OcrConfig.HintsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    OcrConfig
    public static final class OcrConfig.Hints
extends com.google.protobuf.GeneratedMessageV3
implements OcrConfig.HintsOrBuilder
     Hints for OCR Engine
    Protobuf type google.cloud.documentai.v1.OcrConfig.Hints
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OcrConfig.Hints.Builder
      Hints for OCR Engine

      • 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 LANGUAGE_HINTS_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

    • Field Detail

      • LANGUAGE_HINTS_FIELD_NUMBER

        public static final int LANGUAGE_HINTS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getLanguageHintsList

        public com.google.protobuf.ProtocolStringList getLanguageHintsList()
         List of BCP-47 language codes to use for OCR. In most cases, not
 specifying it yields the best results since it enables automatic language
 detection. For languages based on the Latin alphabet, setting hints is
 not needed. In rare cases, when the language of the text in the
 image is known, setting a hint will help get better results (although it
 will be a significant hindrance if the hint is wrong).
        repeated string language_hints = 1;
        Specified by:
        getLanguageHintsList in interface OcrConfig.HintsOrBuilder
        Returns:
        A list containing the languageHints.

      • getLanguageHintsCount

        public int getLanguageHintsCount()
         List of BCP-47 language codes to use for OCR. In most cases, not
 specifying it yields the best results since it enables automatic language
 detection. For languages based on the Latin alphabet, setting hints is
 not needed. In rare cases, when the language of the text in the
 image is known, setting a hint will help get better results (although it
 will be a significant hindrance if the hint is wrong).
        repeated string language_hints = 1;
        Specified by:
        getLanguageHintsCount in interface OcrConfig.HintsOrBuilder
        Returns:
        The count of languageHints.

      • getLanguageHints

        public String getLanguageHints​(int index)
         List of BCP-47 language codes to use for OCR. In most cases, not
 specifying it yields the best results since it enables automatic language
 detection. For languages based on the Latin alphabet, setting hints is
 not needed. In rare cases, when the language of the text in the
 image is known, setting a hint will help get better results (although it
 will be a significant hindrance if the hint is wrong).
        repeated string language_hints = 1;
        Specified by:
        getLanguageHints in interface OcrConfig.HintsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The languageHints at the given index.

      • getLanguageHintsBytes

        public com.google.protobuf.ByteString getLanguageHintsBytes​(int index)
         List of BCP-47 language codes to use for OCR. In most cases, not
 specifying it yields the best results since it enables automatic language
 detection. For languages based on the Latin alphabet, setting hints is
 not needed. In rare cases, when the language of the text in the
 image is known, setting a hint will help get better results (although it
 will be a significant hindrance if the hint is wrong).
        repeated string language_hints = 1;
        Specified by:
        getLanguageHintsBytes in interface OcrConfig.HintsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the languageHints at the given index.

      • 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 OcrConfig.Hints parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

        public static com.google.protobuf.Parser<OcrConfig.Hints> parser()

      • getParserForType

        public com.google.protobuf.Parser<OcrConfig.Hints> 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 OcrConfig.Hints getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder