Package com.google.cloud.speech.v1

Class PhraseSet

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.speech.v1.PhraseSet
All Implemented Interfaces:
PhraseSetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PhraseSet extends com.google.protobuf.GeneratedMessage implements PhraseSetOrBuilder
 Provides "hints" to the speech recognizer to favor specific words and phrases
 in the results.
Protobuf type google.cloud.speech.v1.PhraseSet
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PhraseSet.Builder
    Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
    static final class 
    PhraseSet.Phrase
    A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them.
    static interface 
    PhraseSet.PhraseOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BOOST_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PHRASES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    float
    getBoost()
    Hint Boost.
    static PhraseSet
    getDefaultInstance()
     
    PhraseSet
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    The resource name of the phrase set.
    com.google.protobuf.ByteString
    getNameBytes()
    The resource name of the phrase set.
    com.google.protobuf.Parser<PhraseSet>
    getParserForType()
     
    PhraseSet.Phrase
    getPhrases(int index)
    A list of word and phrases.
    int
    getPhrasesCount()
    A list of word and phrases.
    List<PhraseSet.Phrase>
    getPhrasesList()
    A list of word and phrases.
    PhraseSet.PhraseOrBuilder
    getPhrasesOrBuilder(int index)
    A list of word and phrases.
    List<? extends PhraseSet.PhraseOrBuilder>
    getPhrasesOrBuilderList()
    A list of word and phrases.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PhraseSet.Builder
    newBuilder()
     
    static PhraseSet.Builder
    newBuilder(PhraseSet prototype)
     
    PhraseSet.Builder
    newBuilderForType()
     
    protected PhraseSet.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PhraseSet
    parseDelimitedFrom(InputStream input)
     
    static PhraseSet
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet
    parseFrom(byte[] data)
     
    static PhraseSet
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet
    parseFrom(com.google.protobuf.ByteString data)
     
    static PhraseSet
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PhraseSet
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet
    parseFrom(InputStream input)
     
    static PhraseSet
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet
    parseFrom(ByteBuffer data)
     
    static PhraseSet
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PhraseSet>
    parser()
     
    PhraseSet.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    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

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       The resource name of the phrase set.
      string name = 1;
      Specified by:
      getName in interface PhraseSetOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the phrase set.
      string name = 1;
      Specified by:
      getNameBytes in interface PhraseSetOrBuilder
      Returns:
      The bytes for name.

    • getPhrasesList

      public List<PhraseSet.Phrase> getPhrasesList()
       A list of word and phrases.
      repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
      Specified by:
      getPhrasesList in interface PhraseSetOrBuilder

    • getPhrasesOrBuilderList

      public List<? extends PhraseSet.PhraseOrBuilder> getPhrasesOrBuilderList()
       A list of word and phrases.
      repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
      Specified by:
      getPhrasesOrBuilderList in interface PhraseSetOrBuilder

    • getPhrasesCount

      public int getPhrasesCount()
       A list of word and phrases.
      repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
      Specified by:
      getPhrasesCount in interface PhraseSetOrBuilder

    • getPhrases

      public PhraseSet.Phrase getPhrases(int index)
       A list of word and phrases.
      repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
      Specified by:
      getPhrases in interface PhraseSetOrBuilder

    • getPhrasesOrBuilder

      public PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(int index)
       A list of word and phrases.
      repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
      Specified by:
      getPhrasesOrBuilder in interface PhraseSetOrBuilder

    • 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 (exclusive) and 20. 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 = 4;
      Specified by:
      getBoost in interface PhraseSetOrBuilder
      Returns:
      The boost.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static PhraseSet parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PhraseSet parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PhraseSet parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PhraseSet parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PhraseSet parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PhraseSet.Builder newBuilder()

    • newBuilder

      public static PhraseSet.Builder newBuilder(PhraseSet prototype)

    • toBuilder

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

    • newBuilderForType

      protected PhraseSet.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PhraseSet getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<PhraseSet> 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.GeneratedMessage

    • getDefaultInstanceForType

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