Package com.google.cloud.speech.v1

Class SpeechContext

  • All Implemented Interfaces:
    SpeechContextOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SpeechContext
extends com.google.protobuf.GeneratedMessageV3
implements SpeechContextOrBuilder
     Provides "hints" to the speech recognizer to favor specific words and phrases
 in the results.
    Protobuf type google.cloud.speech.v1.SpeechContext
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SpeechContext.Builder
      Provides "hints" to the speech recognizer to favor specific words and phrases in the results.

      • 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 BOOST_FIELD_NUMBER  
      static int PHRASES_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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      float getBoost()
      Hint Boost.
      static SpeechContext getDefaultInstance()  
      SpeechContext getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<SpeechContext> getParserForType()  
      String getPhrases​(int index)
      A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them.
      com.google.protobuf.ByteString getPhrasesBytes​(int index)
      A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them.
      int getPhrasesCount()
      A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them.
      com.google.protobuf.ProtocolStringList getPhrasesList()
      A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them.
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static SpeechContext.Builder newBuilder()  
      static SpeechContext.Builder newBuilder​(SpeechContext prototype)  
      SpeechContext.Builder newBuilderForType()  
      protected SpeechContext.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static SpeechContext parseDelimitedFrom​(InputStream input)  
      static SpeechContext parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SpeechContext parseFrom​(byte[] data)  
      static SpeechContext parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SpeechContext parseFrom​(com.google.protobuf.ByteString data)  
      static SpeechContext parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SpeechContext parseFrom​(com.google.protobuf.CodedInputStream input)  
      static SpeechContext parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SpeechContext parseFrom​(InputStream input)  
      static SpeechContext parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SpeechContext parseFrom​(ByteBuffer data)  
      static SpeechContext parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<SpeechContext> parser()  
      SpeechContext.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

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

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

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

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • 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

      • getPhrasesList

        public com.google.protobuf.ProtocolStringList getPhrasesList()
         A list of strings containing words and phrases "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. See
 [usage limits](https://cloud.google.com/speech-to-text/quotas#content).

 List items can also be set to classes for groups of words that represent
 common concepts that occur in natural language. For example, rather than
 providing phrase hints for every month of the year, using the $MONTH class
 improves the likelihood of correctly transcribing audio that includes
 months.
        repeated string phrases = 1;
        Specified by:
        getPhrasesList in interface SpeechContextOrBuilder
        Returns:
        A list containing the phrases.

      • getPhrasesCount

        public int getPhrasesCount()
         A list of strings containing words and phrases "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. See
 [usage limits](https://cloud.google.com/speech-to-text/quotas#content).

 List items can also be set to classes for groups of words that represent
 common concepts that occur in natural language. For example, rather than
 providing phrase hints for every month of the year, using the $MONTH class
 improves the likelihood of correctly transcribing audio that includes
 months.
        repeated string phrases = 1;
        Specified by:
        getPhrasesCount in interface SpeechContextOrBuilder
        Returns:
        The count of phrases.

      • getPhrases

        public String getPhrases​(int index)
         A list of strings containing words and phrases "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. See
 [usage limits](https://cloud.google.com/speech-to-text/quotas#content).

 List items can also be set to classes for groups of words that represent
 common concepts that occur in natural language. For example, rather than
 providing phrase hints for every month of the year, using the $MONTH class
 improves the likelihood of correctly transcribing audio that includes
 months.
        repeated string phrases = 1;
        Specified by:
        getPhrases in interface SpeechContextOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The phrases at the given index.

      • getPhrasesBytes

        public com.google.protobuf.ByteString getPhrasesBytes​(int index)
         A list of strings containing words and phrases "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. See
 [usage limits](https://cloud.google.com/speech-to-text/quotas#content).

 List items can also be set to classes for groups of words that represent
 common concepts that occur in natural language. For example, rather than
 providing phrase hints for every month of the year, using the $MONTH class
 improves the likelihood of correctly transcribing audio that includes
 months.
        repeated string phrases = 1;
        Specified by:
        getPhrasesBytes in interface SpeechContextOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the phrases at the given index.

      • getBoost

        public float getBoost()
         Hint Boost. 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 will simply be ignored. Though `boost` can
 accept a wide range of positive values, most use cases are best served with
 values between 0 and 20. We recommend using a binary search approach to
 finding the optimal value for your use case.
        float boost = 4;
        Specified by:
        getBoost in interface SpeechContextOrBuilder
        Returns:
        The boost.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static SpeechContext getDefaultInstance()

      • parser

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

      • getParserForType

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