Class StreamingRecognizeResponse

  • All Implemented Interfaces:
    StreamingRecognizeResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class StreamingRecognizeResponse
    extends com.google.protobuf.GeneratedMessageV3
    implements StreamingRecognizeResponseOrBuilder
     `StreamingRecognizeResponse` is the only message returned to the client by
     `StreamingRecognize`. A series of one or more `StreamingRecognizeResponse`
     messages are streamed back to the client.
     Here's an example of a series of ten `StreamingRecognizeResponse`s that might
     be returned while processing audio:
     1. endpointer_type: START_OF_SPEECH
     2. results { alternatives { transcript: "tube" } stability: 0.01 }
        result_index: 0
     3. results { alternatives { transcript: "to be a" } stability: 0.01 }
        result_index: 0
     4. results { alternatives { transcript: "to be" } stability: 0.9 }
        results { alternatives { transcript: " or not to be" } stability: 0.01 }
        result_index: 0
     5. results { alternatives { transcript: "to be or not to be"
                                 confidence: 0.92 }
                  alternatives { transcript: "to bee or not to bee" }
                  is_final: true }
        result_index: 0
     6. results { alternatives { transcript: " that's" } stability: 0.01 }
        result_index: 1
     7. results { alternatives { transcript: " that is" } stability: 0.9 }
        results { alternatives { transcript: " the question" } stability: 0.01 }
        result_index: 1
     8. endpointer_type: END_OF_SPEECH
     9. results { alternatives { transcript: " that is the question"
                                 confidence: 0.98 }
                  alternatives { transcript: " that was the question" }
                  is_final: true }
        result_index: 1
     10. endpointer_type: END_OF_AUDIO
     Notes:
     - Only two of the above responses #5 and #9 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`. #4 and #7 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.
     - The `result_index` indicates the portion of audio that has had final
       results returned, and is no longer being processed. For example, the
       `results` in #6 and later correspond to the portion of audio after
       "to be or not to be".
     
    Protobuf type google.cloud.speech.v1beta1.StreamingRecognizeResponse
    See Also:
    Serialized Form
    • Method Detail

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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
      • hasError

        public boolean hasError()
         *Output-only* 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
      • getError

        public com.google.rpc.Status getError()
         *Output-only* 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
      • getErrorOrBuilder

        public com.google.rpc.StatusOrBuilder getErrorOrBuilder()
         *Output-only* 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()
         *Output-only* 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.
         
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResultsList in interface StreamingRecognizeResponseOrBuilder
      • getResultsOrBuilderList

        public List<? extends StreamingRecognitionResultOrBuilder> getResultsOrBuilderList()
         *Output-only* 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.
         
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResultsOrBuilderList in interface StreamingRecognizeResponseOrBuilder
      • getResultsCount

        public int getResultsCount()
         *Output-only* 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.
         
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResultsCount in interface StreamingRecognizeResponseOrBuilder
      • getResults

        public StreamingRecognitionResult getResults​(int index)
         *Output-only* 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.
         
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResults in interface StreamingRecognizeResponseOrBuilder
      • getResultsOrBuilder

        public StreamingRecognitionResultOrBuilder getResultsOrBuilder​(int index)
         *Output-only* 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.
         
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResultsOrBuilder in interface StreamingRecognizeResponseOrBuilder
      • getResultIndex

        public int getResultIndex()
         *Output-only* Indicates the lowest index in the `results` array that has
         changed. The repeated `StreamingRecognitionResult` results overwrite past
         results at this index and higher.
         
        int32 result_index = 3;
        Specified by:
        getResultIndex in interface StreamingRecognizeResponseOrBuilder
      • getEndpointerTypeValue

        public int getEndpointerTypeValue()
         *Output-only* Indicates the type of endpointer event.
         
        .google.cloud.speech.v1beta1.StreamingRecognizeResponse.EndpointerType endpointer_type = 4;
        Specified by:
        getEndpointerTypeValue in interface StreamingRecognizeResponseOrBuilder
      • 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 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
      • newBuilderForType

        public StreamingRecognizeResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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