Package com.google.cloud.dialogflow.v2

Class StreamingRecognitionResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.StreamingRecognitionResult
All Implemented Interfaces:
StreamingRecognitionResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class StreamingRecognitionResult extends com.google.protobuf.GeneratedMessage implements StreamingRecognitionResultOrBuilder
 Contains a speech recognition result corresponding to a portion of the audio
 that is currently being processed or an indication that this is the end
 of the single requested utterance.

 While end-user audio is being processed, Dialogflow sends a series of
 results. Each result may contain a `transcript` value. A transcript
 represents a portion of the utterance. While the recognizer is processing
 audio, transcript values may be interim values or finalized values.
 Once a transcript is finalized, the `is_final` value is set to true and
 processing continues for the next transcript.

 If `StreamingDetectIntentRequest.query_input.audio_config.single_utterance`
 was true, and the recognizer has completed processing audio,
 the `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the
 following (last) result contains the last finalized transcript.

 The complete end-user utterance is determined by concatenating the
 finalized transcript values received for the series of results.

 In the following example, single utterance is enabled. In the case where
 single utterance is not enabled, result 7 would not occur.

 ```
 Num | transcript              | message_type            | is_final
 --- | ----------------------- | ----------------------- | --------
 1   | "tube"                  | TRANSCRIPT              | false
 2   | "to be a"               | TRANSCRIPT              | false
 3   | "to be"                 | TRANSCRIPT              | false
 4   | "to be or not to be"    | TRANSCRIPT              | true
 5   | "that's"                | TRANSCRIPT              | false
 6   | "that is                | TRANSCRIPT              | false
 7   | unset                   | END_OF_SINGLE_UTTERANCE | unset
 8   | " that is the question" | TRANSCRIPT              | true
 ```

 Concatenating the finalized transcripts with `is_final` set to true,
 the complete utterance becomes "to be or not to be that is the question".
Protobuf type google.cloud.dialogflow.v2.StreamingRecognitionResult
See Also:

  • Field Details

    • MESSAGE_TYPE_FIELD_NUMBER

      public static final int MESSAGE_TYPE_FIELD_NUMBER
      See Also:

    • TRANSCRIPT_FIELD_NUMBER

      public static final int TRANSCRIPT_FIELD_NUMBER
      See Also:

    • IS_FINAL_FIELD_NUMBER

      public static final int IS_FINAL_FIELD_NUMBER
      See Also:

    • CONFIDENCE_FIELD_NUMBER

      public static final int CONFIDENCE_FIELD_NUMBER
      See Also:

    • SPEECH_WORD_INFO_FIELD_NUMBER

      public static final int SPEECH_WORD_INFO_FIELD_NUMBER
      See Also:

    • SPEECH_END_OFFSET_FIELD_NUMBER

      public static final int SPEECH_END_OFFSET_FIELD_NUMBER
      See Also:

    • LANGUAGE_CODE_FIELD_NUMBER

      public static final int LANGUAGE_CODE_FIELD_NUMBER
      See Also:

  • 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

    • getMessageTypeValue

      public int getMessageTypeValue()
       Type of the result message.
      .google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType message_type = 1;
      Specified by:
      getMessageTypeValue in interface StreamingRecognitionResultOrBuilder
      Returns:
      The enum numeric value on the wire for messageType.

    • getMessageType

      public StreamingRecognitionResult.MessageType getMessageType()
       Type of the result message.
      .google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType message_type = 1;
      Specified by:
      getMessageType in interface StreamingRecognitionResultOrBuilder
      Returns:
      The messageType.

    • getTranscript

      public String getTranscript()
       Transcript text representing the words that the user spoke.
 Populated if and only if `message_type` = `TRANSCRIPT`.
      string transcript = 2;
      Specified by:
      getTranscript in interface StreamingRecognitionResultOrBuilder
      Returns:
      The transcript.

    • getTranscriptBytes

      public com.google.protobuf.ByteString getTranscriptBytes()
       Transcript text representing the words that the user spoke.
 Populated if and only if `message_type` = `TRANSCRIPT`.
      string transcript = 2;
      Specified by:
      getTranscriptBytes in interface StreamingRecognitionResultOrBuilder
      Returns:
      The bytes for transcript.

    • getIsFinal

      public boolean getIsFinal()
       If `false`, the `StreamingRecognitionResult` represents an
 interim result that may change. If `true`, the recognizer will not return
 any further hypotheses about this piece of the audio. May only be populated
 for `message_type` = `TRANSCRIPT`.
      bool is_final = 3;
      Specified by:
      getIsFinal in interface StreamingRecognitionResultOrBuilder
      Returns:
      The isFinal.

    • getConfidence

      public float getConfidence()
       The Speech confidence between 0.0 and 1.0 for the current portion of audio.
 A higher number indicates an estimated greater likelihood that the
 recognized words are correct. The default of 0.0 is a sentinel value
 indicating that confidence was not set.

 This field is typically only provided if `is_final` is true and you should
 not rely on it being accurate or even set.
      float confidence = 4;
      Specified by:
      getConfidence in interface StreamingRecognitionResultOrBuilder
      Returns:
      The confidence.

    • getSpeechWordInfoList

      public List<SpeechWordInfo> getSpeechWordInfoList()
       Word-specific information for the words recognized by Speech in
 [transcript][google.cloud.dialogflow.v2.StreamingRecognitionResult.transcript].
 Populated if and only if `message_type` = `TRANSCRIPT` and
 [InputAudioConfig.enable_word_info] is set.
      repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;
      Specified by:
      getSpeechWordInfoList in interface StreamingRecognitionResultOrBuilder

    • getSpeechWordInfoOrBuilderList

      public List<? extends SpeechWordInfoOrBuilder> getSpeechWordInfoOrBuilderList()
       Word-specific information for the words recognized by Speech in
 [transcript][google.cloud.dialogflow.v2.StreamingRecognitionResult.transcript].
 Populated if and only if `message_type` = `TRANSCRIPT` and
 [InputAudioConfig.enable_word_info] is set.
      repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;
      Specified by:
      getSpeechWordInfoOrBuilderList in interface StreamingRecognitionResultOrBuilder

    • getSpeechWordInfoCount

      public int getSpeechWordInfoCount()
       Word-specific information for the words recognized by Speech in
 [transcript][google.cloud.dialogflow.v2.StreamingRecognitionResult.transcript].
 Populated if and only if `message_type` = `TRANSCRIPT` and
 [InputAudioConfig.enable_word_info] is set.
      repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;
      Specified by:
      getSpeechWordInfoCount in interface StreamingRecognitionResultOrBuilder

    • getSpeechWordInfo

      public SpeechWordInfo getSpeechWordInfo(int index)
       Word-specific information for the words recognized by Speech in
 [transcript][google.cloud.dialogflow.v2.StreamingRecognitionResult.transcript].
 Populated if and only if `message_type` = `TRANSCRIPT` and
 [InputAudioConfig.enable_word_info] is set.
      repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;
      Specified by:
      getSpeechWordInfo in interface StreamingRecognitionResultOrBuilder

    • getSpeechWordInfoOrBuilder

      public SpeechWordInfoOrBuilder getSpeechWordInfoOrBuilder(int index)
       Word-specific information for the words recognized by Speech in
 [transcript][google.cloud.dialogflow.v2.StreamingRecognitionResult.transcript].
 Populated if and only if `message_type` = `TRANSCRIPT` and
 [InputAudioConfig.enable_word_info] is set.
      repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;
      Specified by:
      getSpeechWordInfoOrBuilder in interface StreamingRecognitionResultOrBuilder

    • hasSpeechEndOffset

      public boolean hasSpeechEndOffset()
       Time offset of the end of this Speech recognition result relative to the
 beginning of the audio. Only populated for `message_type` = `TRANSCRIPT`.
      .google.protobuf.Duration speech_end_offset = 8;
      Specified by:
      hasSpeechEndOffset in interface StreamingRecognitionResultOrBuilder
      Returns:
      Whether the speechEndOffset field is set.

    • getSpeechEndOffset

      public com.google.protobuf.Duration getSpeechEndOffset()
       Time offset of the end of this Speech recognition result relative to the
 beginning of the audio. Only populated for `message_type` = `TRANSCRIPT`.
      .google.protobuf.Duration speech_end_offset = 8;
      Specified by:
      getSpeechEndOffset in interface StreamingRecognitionResultOrBuilder
      Returns:
      The speechEndOffset.

    • getSpeechEndOffsetOrBuilder

      public com.google.protobuf.DurationOrBuilder getSpeechEndOffsetOrBuilder()
       Time offset of the end of this Speech recognition result relative to the
 beginning of the audio. Only populated for `message_type` = `TRANSCRIPT`.
      .google.protobuf.Duration speech_end_offset = 8;
      Specified by:
      getSpeechEndOffsetOrBuilder in interface StreamingRecognitionResultOrBuilder

    • getLanguageCode

      public String getLanguageCode()
       Detected language code for the transcript.
      string language_code = 10;
      Specified by:
      getLanguageCode in interface StreamingRecognitionResultOrBuilder
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      public com.google.protobuf.ByteString getLanguageCodeBytes()
       Detected language code for the transcript.
      string language_code = 10;
      Specified by:
      getLanguageCodeBytes in interface StreamingRecognitionResultOrBuilder
      Returns:
      The bytes for languageCode.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StreamingRecognitionResult.Builder newBuilder()

    • newBuilder

      public static StreamingRecognitionResult.Builder newBuilder(StreamingRecognitionResult prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static StreamingRecognitionResult getDefaultInstance()

    • parser

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

    • getParserForType

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