Package com.google.cloud.speech.v1beta1
Class StreamingRecognizeResponse
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.speech.v1beta1.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 typegoogle.cloud.speech.v1beta1.StreamingRecognizeResponse- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classStreamingRecognizeResponse.Builder`StreamingRecognizeResponse` is the only message returned to the client by `StreamingRecognize`.static classStreamingRecognizeResponse.EndpointerTypeIndicates the type of endpointer event.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intENDPOINTER_TYPE_FIELD_NUMBERstatic intERROR_FIELD_NUMBERstatic intRESULT_INDEX_FIELD_NUMBERstatic intRESULTS_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)static StreamingRecognizeResponsegetDefaultInstance()StreamingRecognizeResponsegetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()StreamingRecognizeResponse.EndpointerTypegetEndpointerType()*Output-only* Indicates the type of endpointer event.intgetEndpointerTypeValue()*Output-only* Indicates the type of endpointer event.com.google.rpc.StatusgetError()*Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.com.google.rpc.StatusOrBuildergetErrorOrBuilder()*Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.com.google.protobuf.Parser<StreamingRecognizeResponse>getParserForType()intgetResultIndex()*Output-only* Indicates the lowest index in the `results` array that has changed.StreamingRecognitionResultgetResults(int index)*Output-only* This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.intgetResultsCount()*Output-only* This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.List<StreamingRecognitionResult>getResultsList()*Output-only* This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.StreamingRecognitionResultOrBuildergetResultsOrBuilder(int index)*Output-only* This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.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.intgetSerializedSize()com.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasError()*Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.inthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static StreamingRecognizeResponse.BuildernewBuilder()static StreamingRecognizeResponse.BuildernewBuilder(StreamingRecognizeResponse prototype)StreamingRecognizeResponse.BuildernewBuilderForType()protected StreamingRecognizeResponse.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)static StreamingRecognizeResponseparseDelimitedFrom(InputStream input)static StreamingRecognizeResponseparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static StreamingRecognizeResponseparseFrom(byte[] data)static StreamingRecognizeResponseparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static StreamingRecognizeResponseparseFrom(com.google.protobuf.ByteString data)static StreamingRecognizeResponseparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static StreamingRecognizeResponseparseFrom(com.google.protobuf.CodedInputStream input)static StreamingRecognizeResponseparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static StreamingRecognizeResponseparseFrom(InputStream input)static StreamingRecognizeResponseparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static StreamingRecognizeResponseparseFrom(ByteBuffer data)static StreamingRecognizeResponseparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<StreamingRecognizeResponse>parser()StreamingRecognizeResponse.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RESULT_INDEX_FIELD_NUMBER
public static final int RESULT_INDEX_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENDPOINTER_TYPE_FIELD_NUMBER
public static final int ENDPOINTER_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.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:
hasErrorin interfaceStreamingRecognizeResponseOrBuilder
-
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:
getErrorin interfaceStreamingRecognizeResponseOrBuilder
-
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:
getErrorOrBuilderin interfaceStreamingRecognizeResponseOrBuilder
-
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:
getResultsListin interfaceStreamingRecognizeResponseOrBuilder
-
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:
getResultsOrBuilderListin interfaceStreamingRecognizeResponseOrBuilder
-
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:
getResultsCountin interfaceStreamingRecognizeResponseOrBuilder
-
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:
getResultsin interfaceStreamingRecognizeResponseOrBuilder
-
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:
getResultsOrBuilderin interfaceStreamingRecognizeResponseOrBuilder
-
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:
getResultIndexin interfaceStreamingRecognizeResponseOrBuilder
-
getEndpointerTypeValue
public int getEndpointerTypeValue()
*Output-only* Indicates the type of endpointer event.
.google.cloud.speech.v1beta1.StreamingRecognizeResponse.EndpointerType endpointer_type = 4;- Specified by:
getEndpointerTypeValuein interfaceStreamingRecognizeResponseOrBuilder
-
getEndpointerType
public StreamingRecognizeResponse.EndpointerType getEndpointerType()
*Output-only* Indicates the type of endpointer event.
.google.cloud.speech.v1beta1.StreamingRecognizeResponse.EndpointerType endpointer_type = 4;- Specified by:
getEndpointerTypein interfaceStreamingRecognizeResponseOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static StreamingRecognizeResponse.Builder newBuilder()
-
newBuilder
public static StreamingRecognizeResponse.Builder newBuilder(StreamingRecognizeResponse prototype)
-
toBuilder
public StreamingRecognizeResponse.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected StreamingRecognizeResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static StreamingRecognizeResponse getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<StreamingRecognizeResponse> parser()
-
getParserForType
public com.google.protobuf.Parser<StreamingRecognizeResponse> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public StreamingRecognizeResponse getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-