Package com.google.cloud.speech.v1

Class StreamingRecognizeResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.speech.v1.StreamingRecognizeResponse
All Implemented Interfaces:
StreamingRecognizeResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class StreamingRecognizeResponse extends com.google.protobuf.GeneratedMessage implements StreamingRecognizeResponseOrBuilder
 `StreamingRecognizeResponse` is the only message returned to the client by
 `StreamingRecognize`. A series of zero or more `StreamingRecognizeResponse`
 messages are streamed back to the client. If there is no recognizable
 audio, and `single_utterance` is set to false, then no messages are streamed
 back to the client.

 Here's an example of a series of `StreamingRecognizeResponse`s that might be
 returned while processing audio:

 1. results { alternatives { transcript: "tube" } stability: 0.01 }

 2. results { alternatives { transcript: "to be a" } stability: 0.01 }

 3. results { alternatives { transcript: "to be" } stability: 0.9 }
 results { alternatives { transcript: " or not to be" } stability: 0.01 }

 4. results { alternatives { transcript: "to be or not to be"
 confidence: 0.92 }
 alternatives { transcript: "to bee or not to bee" }
 is_final: true }

 5. results { alternatives { transcript: " that's" } stability: 0.01 }

 6. results { alternatives { transcript: " that is" } stability: 0.9 }
 results { alternatives { transcript: " the question" } stability: 0.01 }

 7. results { alternatives { transcript: " that is the question"
 confidence: 0.98 }
 alternatives { transcript: " that was the question" }
 is_final: true }

 Notes:

 - Only two of the above responses #4 and #7 contain final results; they are
 indicated by `is_final: true`. Concatenating these together generates the
 full transcript: "to be or not to be that is the question".

 - The others contain interim `results`. #3 and #6 contain two interim
 `results`: the first portion has a high stability and is less likely to
 change; the second portion has a low stability and is very likely to
 change. A UI designer might choose to show only high stability `results`.

 - The specific `stability` and `confidence` values shown above are only for
 illustrative purposes. Actual values may vary.

 - In each response, only one of these fields will be set:
 `error`,
 `speech_event_type`, or
 one or more (repeated) `results`.
Protobuf type google.cloud.speech.v1.StreamingRecognizeResponse
See Also:

  • Field Details

    • ERROR_FIELD_NUMBER

      public static final int ERROR_FIELD_NUMBER
      See Also:

    • RESULTS_FIELD_NUMBER

      public static final int RESULTS_FIELD_NUMBER
      See Also:

    • SPEECH_EVENT_TYPE_FIELD_NUMBER

      public static final int SPEECH_EVENT_TYPE_FIELD_NUMBER
      See Also:

    • SPEECH_EVENT_TIME_FIELD_NUMBER

      public static final int SPEECH_EVENT_TIME_FIELD_NUMBER
      See Also:

    • TOTAL_BILLED_TIME_FIELD_NUMBER

      public static final int TOTAL_BILLED_TIME_FIELD_NUMBER
      See Also:

    • SPEECH_ADAPTATION_INFO_FIELD_NUMBER

      public static final int SPEECH_ADAPTATION_INFO_FIELD_NUMBER
      See Also:

    • REQUEST_ID_FIELD_NUMBER

      public static final int REQUEST_ID_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

    • hasError

      public boolean hasError()
       If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
      .google.rpc.Status error = 1;
      Specified by:
      hasError in interface StreamingRecognizeResponseOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public Status getError()
       If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
      .google.rpc.Status error = 1;
      Specified by:
      getError in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The error.

    • getErrorOrBuilder

      public StatusOrBuilder getErrorOrBuilder()
       If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
      .google.rpc.Status error = 1;
      Specified by:
      getErrorOrBuilder in interface StreamingRecognizeResponseOrBuilder

    • getResultsList

      public List<StreamingRecognitionResult> getResultsList()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one `is_final=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
      repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
      Specified by:
      getResultsList in interface StreamingRecognizeResponseOrBuilder

    • getResultsOrBuilderList

      public List<? extends StreamingRecognitionResultOrBuilder> getResultsOrBuilderList()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one `is_final=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
      repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
      Specified by:
      getResultsOrBuilderList in interface StreamingRecognizeResponseOrBuilder

    • getResultsCount

      public int getResultsCount()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one `is_final=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
      repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
      Specified by:
      getResultsCount in interface StreamingRecognizeResponseOrBuilder

    • getResults

      public StreamingRecognitionResult getResults(int index)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one `is_final=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
      repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
      Specified by:
      getResults in interface StreamingRecognizeResponseOrBuilder

    • getResultsOrBuilder

      public StreamingRecognitionResultOrBuilder getResultsOrBuilder(int index)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one `is_final=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
      repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
      Specified by:
      getResultsOrBuilder in interface StreamingRecognizeResponseOrBuilder

    • getSpeechEventTypeValue

      public int getSpeechEventTypeValue()
       Indicates the type of speech event.
      .google.cloud.speech.v1.StreamingRecognizeResponse.SpeechEventType speech_event_type = 4;
      Specified by:
      getSpeechEventTypeValue in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The enum numeric value on the wire for speechEventType.

    • getSpeechEventType

      public StreamingRecognizeResponse.SpeechEventType getSpeechEventType()
       Indicates the type of speech event.
      .google.cloud.speech.v1.StreamingRecognizeResponse.SpeechEventType speech_event_type = 4;
      Specified by:
      getSpeechEventType in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The speechEventType.

    • hasSpeechEventTime

      public boolean hasSpeechEventTime()
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_time = 8;
      Specified by:
      hasSpeechEventTime in interface StreamingRecognizeResponseOrBuilder
      Returns:
      Whether the speechEventTime field is set.

    • getSpeechEventTime

      public com.google.protobuf.Duration getSpeechEventTime()
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_time = 8;
      Specified by:
      getSpeechEventTime in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The speechEventTime.

    • getSpeechEventTimeOrBuilder

      public com.google.protobuf.DurationOrBuilder getSpeechEventTimeOrBuilder()
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_time = 8;
      Specified by:
      getSpeechEventTimeOrBuilder in interface StreamingRecognizeResponseOrBuilder

    • hasTotalBilledTime

      public boolean hasTotalBilledTime()
       When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
      .google.protobuf.Duration total_billed_time = 5;
      Specified by:
      hasTotalBilledTime in interface StreamingRecognizeResponseOrBuilder
      Returns:
      Whether the totalBilledTime field is set.

    • getTotalBilledTime

      public com.google.protobuf.Duration getTotalBilledTime()
       When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
      .google.protobuf.Duration total_billed_time = 5;
      Specified by:
      getTotalBilledTime in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The totalBilledTime.

    • getTotalBilledTimeOrBuilder

      public com.google.protobuf.DurationOrBuilder getTotalBilledTimeOrBuilder()
       When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
      .google.protobuf.Duration total_billed_time = 5;
      Specified by:
      getTotalBilledTimeOrBuilder in interface StreamingRecognizeResponseOrBuilder

    • hasSpeechAdaptationInfo

      public boolean hasSpeechAdaptationInfo()
       Provides information on adaptation behavior in response
      .google.cloud.speech.v1.SpeechAdaptationInfo speech_adaptation_info = 9;
      Specified by:
      hasSpeechAdaptationInfo in interface StreamingRecognizeResponseOrBuilder
      Returns:
      Whether the speechAdaptationInfo field is set.

    • getSpeechAdaptationInfo

      public SpeechAdaptationInfo getSpeechAdaptationInfo()
       Provides information on adaptation behavior in response
      .google.cloud.speech.v1.SpeechAdaptationInfo speech_adaptation_info = 9;
      Specified by:
      getSpeechAdaptationInfo in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The speechAdaptationInfo.

    • getSpeechAdaptationInfoOrBuilder

      public SpeechAdaptationInfoOrBuilder getSpeechAdaptationInfoOrBuilder()
       Provides information on adaptation behavior in response
      .google.cloud.speech.v1.SpeechAdaptationInfo speech_adaptation_info = 9;
      Specified by:
      getSpeechAdaptationInfoOrBuilder in interface StreamingRecognizeResponseOrBuilder

    • getRequestId

      public long getRequestId()
       The ID associated with the request. This is a unique ID specific only to
 the given request.
      int64 request_id = 10;
      Specified by:
      getRequestId in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The requestId.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StreamingRecognizeResponse.Builder newBuilder()

    • newBuilder

      public static StreamingRecognizeResponse.Builder newBuilder(StreamingRecognizeResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static StreamingRecognizeResponse getDefaultInstance()

    • parser

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

    • getParserForType

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