Class PhraseSet.Phrase.Builder

  • All Implemented Interfaces:
    PhraseSet.PhraseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    PhraseSet.Phrase

    public static final class PhraseSet.Phrase.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
    implements PhraseSet.PhraseOrBuilder
     A Phrase contains words and phrase "hints" so that the speech recognition
     is more likely to recognize them. This can be used to improve the accuracy
     for specific words and phrases, for example, if specific commands are
     typically spoken by the user. This can also be used to add additional words
     to the vocabulary of the recognizer.
    
     List items can also include CustomClass references containing groups of
     words that represent common concepts that occur in natural language.
     
    Protobuf type google.cloud.speech.v2.PhraseSet.Phrase
    • Method Detail

      • 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.Builder<PhraseSet.Phrase.Builder>
      • clear

        public PhraseSet.Phrase.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • getDefaultInstanceForType

        public PhraseSet.Phrase getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public PhraseSet.Phrase build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public PhraseSet.Phrase buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public PhraseSet.Phrase.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • setField

        public PhraseSet.Phrase.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • clearField

        public PhraseSet.Phrase.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • clearOneof

        public PhraseSet.Phrase.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • setRepeatedField

        public PhraseSet.Phrase.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • addRepeatedField

        public PhraseSet.Phrase.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • mergeFrom

        public PhraseSet.Phrase.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PhraseSet.Phrase.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • mergeFrom

        public PhraseSet.Phrase.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PhraseSet.Phrase.Builder>
        Throws:
        IOException
      • getValueBytes

        public com.google.protobuf.ByteString getValueBytes()
         The phrase itself.
         
        string value = 1;
        Specified by:
        getValueBytes in interface PhraseSet.PhraseOrBuilder
        Returns:
        The bytes for value.
      • setValue

        public PhraseSet.Phrase.Builder setValue​(String value)
         The phrase itself.
         
        string value = 1;
        Parameters:
        value - The value to set.
        Returns:
        This builder for chaining.
      • clearValue

        public PhraseSet.Phrase.Builder clearValue()
         The phrase itself.
         
        string value = 1;
        Returns:
        This builder for chaining.
      • setValueBytes

        public PhraseSet.Phrase.Builder setValueBytes​(com.google.protobuf.ByteString value)
         The phrase itself.
         
        string value = 1;
        Parameters:
        value - The bytes for value to set.
        Returns:
        This builder for chaining.
      • getBoost

        public float getBoost()
         Hint Boost. Overrides the boost set at the phrase set level.
         Positive value will increase the probability that a specific phrase will
         be recognized over other similar sounding phrases. The higher the boost,
         the higher the chance of false positive recognition as well. Negative
         boost values would correspond to anti-biasing. Anti-biasing is not
         enabled, so negative boost values will return an error. Boost values must
         be between 0 and 20. Any values outside that range will return an error.
         We recommend using a binary search approach to finding the optimal value
         for your use case as well as adding phrases both with and without boost
         to your requests.
         
        float boost = 2;
        Specified by:
        getBoost in interface PhraseSet.PhraseOrBuilder
        Returns:
        The boost.
      • setBoost

        public PhraseSet.Phrase.Builder setBoost​(float value)
         Hint Boost. Overrides the boost set at the phrase set level.
         Positive value will increase the probability that a specific phrase will
         be recognized over other similar sounding phrases. The higher the boost,
         the higher the chance of false positive recognition as well. Negative
         boost values would correspond to anti-biasing. Anti-biasing is not
         enabled, so negative boost values will return an error. Boost values must
         be between 0 and 20. Any values outside that range will return an error.
         We recommend using a binary search approach to finding the optimal value
         for your use case as well as adding phrases both with and without boost
         to your requests.
         
        float boost = 2;
        Parameters:
        value - The boost to set.
        Returns:
        This builder for chaining.
      • clearBoost

        public PhraseSet.Phrase.Builder clearBoost()
         Hint Boost. Overrides the boost set at the phrase set level.
         Positive value will increase the probability that a specific phrase will
         be recognized over other similar sounding phrases. The higher the boost,
         the higher the chance of false positive recognition as well. Negative
         boost values would correspond to anti-biasing. Anti-biasing is not
         enabled, so negative boost values will return an error. Boost values must
         be between 0 and 20. Any values outside that range will return an error.
         We recommend using a binary search approach to finding the optimal value
         for your use case as well as adding phrases both with and without boost
         to your requests.
         
        float boost = 2;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final PhraseSet.Phrase.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>
      • mergeUnknownFields

        public final PhraseSet.Phrase.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PhraseSet.Phrase.Builder>