Package com.google.cloud.speech.v1

Class PhraseSet.Phrase

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.speech.v1.PhraseSet.Phrase
All Implemented Interfaces:
PhraseSet.PhraseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
PhraseSet
public static final class PhraseSet.Phrase extends com.google.protobuf.GeneratedMessage implements PhraseSet.PhraseOrBuilder
 A phrases containing 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. See
 [usage limits](https://cloud.google.com/speech-to-text/quotas#content).

 List items can also include pre-built or custom classes containing groups
 of words that represent common concepts that occur in natural language. For
 example, rather than providing a phrase hint for every month of the
 year (e.g. "i was born in january", "i was born in febuary", ...), use the
 pre-built `$MONTH` class improves the likelihood of correctly transcribing
 audio that includes months (e.g. "i was born in $month").
 To refer to pre-built classes, use the class' symbol prepended with `$`
 e.g. `$MONTH`. To refer to custom classes that were defined inline in the
 request, set the class's `custom_class_id` to a string unique to all class
 resources and inline classes. Then use the class' id wrapped in $`{...}`
 e.g. "${my-months}". To refer to custom classes resources, use the class'
 id wrapped in `${}` (e.g. `${my-months}`).

 Speech-to-Text supports three locations: `global`, `us` (US North America),
 and `eu` (Europe). If you are calling the `speech.googleapis.com`
 endpoint, use the `global` location. To specify a region, use a
 [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
 with matching `us` or `eu` location value.
Protobuf type google.cloud.speech.v1.PhraseSet.Phrase
See Also:

  • Nested Class Summary

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

    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
    VALUE_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.Phrase
    getDefaultInstance()
     
    PhraseSet.Phrase
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<PhraseSet.Phrase>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getValue()
    The phrase itself.
    com.google.protobuf.ByteString
    getValueBytes()
    The phrase itself.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PhraseSet.Phrase.Builder
    newBuilder()
     
    static PhraseSet.Phrase.Builder
    newBuilder(PhraseSet.Phrase prototype)
     
    PhraseSet.Phrase.Builder
    newBuilderForType()
     
    protected PhraseSet.Phrase.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PhraseSet.Phrase
    parseDelimitedFrom(InputStream input)
     
    static PhraseSet.Phrase
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet.Phrase
    parseFrom(byte[] data)
     
    static PhraseSet.Phrase
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet.Phrase
    parseFrom(com.google.protobuf.ByteString data)
     
    static PhraseSet.Phrase
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet.Phrase
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PhraseSet.Phrase
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet.Phrase
    parseFrom(InputStream input)
     
    static PhraseSet.Phrase
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PhraseSet.Phrase
    parseFrom(ByteBuffer data)
     
    static PhraseSet.Phrase
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PhraseSet.Phrase>
    parser()
     
    PhraseSet.Phrase.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

    • getValue

      public String getValue()
       The phrase itself.
      string value = 1;
      Specified by:
      getValue in interface PhraseSet.PhraseOrBuilder
      Returns:
      The value.

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

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static PhraseSet.Phrase 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.Phrase parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PhraseSet.Phrase.Builder newBuilder()

    • newBuilder

      public static PhraseSet.Phrase.Builder newBuilder(PhraseSet.Phrase prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PhraseSet.Phrase getDefaultInstance()

    • parser

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

    • getParserForType

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