Package com.google.cloud.speech.v2
Class StreamingRecognizeResponse
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.speech.v2.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 zero or more `StreamingRecognizeResponse` messages are streamed back to the client. If there is no recognizable audio then no messages are streamed back to the client. Here are some examples 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 typegoogle.cloud.speech.v2.StreamingRecognizeResponse
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StreamingRecognizeResponse.Builder
`StreamingRecognizeResponse` is the only message returned to the client by `StreamingRecognize`.static class
StreamingRecognizeResponse.SpeechEventType
Indicates the type of speech 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 int
METADATA_FIELD_NUMBER
static int
RESULTS_FIELD_NUMBER
static int
SPEECH_EVENT_OFFSET_FIELD_NUMBER
static int
SPEECH_EVENT_TYPE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
static StreamingRecognizeResponse
getDefaultInstance()
StreamingRecognizeResponse
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
RecognitionResponseMetadata
getMetadata()
Metadata about the recognition.RecognitionResponseMetadataOrBuilder
getMetadataOrBuilder()
Metadata about the recognition.com.google.protobuf.Parser<StreamingRecognizeResponse>
getParserForType()
StreamingRecognitionResult
getResults(int index)
This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.int
getResultsCount()
This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.List<StreamingRecognitionResult>
getResultsList()
This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.StreamingRecognitionResultOrBuilder
getResultsOrBuilder(int index)
This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.List<? extends StreamingRecognitionResultOrBuilder>
getResultsOrBuilderList()
This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.int
getSerializedSize()
com.google.protobuf.Duration
getSpeechEventOffset()
Time offset between the beginning of the audio and event emission.com.google.protobuf.DurationOrBuilder
getSpeechEventOffsetOrBuilder()
Time offset between the beginning of the audio and event emission.StreamingRecognizeResponse.SpeechEventType
getSpeechEventType()
Indicates the type of speech event.int
getSpeechEventTypeValue()
Indicates the type of speech event.int
hashCode()
boolean
hasMetadata()
Metadata about the recognition.boolean
hasSpeechEventOffset()
Time offset between the beginning of the audio and event emission.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static StreamingRecognizeResponse.Builder
newBuilder()
static StreamingRecognizeResponse.Builder
newBuilder(StreamingRecognizeResponse prototype)
StreamingRecognizeResponse.Builder
newBuilderForType()
protected StreamingRecognizeResponse.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static StreamingRecognizeResponse
parseDelimitedFrom(InputStream input)
static StreamingRecognizeResponse
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognizeResponse
parseFrom(byte[] data)
static StreamingRecognizeResponse
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognizeResponse
parseFrom(com.google.protobuf.ByteString data)
static StreamingRecognizeResponse
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognizeResponse
parseFrom(com.google.protobuf.CodedInputStream input)
static StreamingRecognizeResponse
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognizeResponse
parseFrom(InputStream input)
static StreamingRecognizeResponse
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognizeResponse
parseFrom(ByteBuffer data)
static StreamingRecognizeResponse
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StreamingRecognizeResponse>
parser()
StreamingRecognizeResponse.Builder
toBuilder()
void
writeTo(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, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, 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
-
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SPEECH_EVENT_TYPE_FIELD_NUMBER
public static final int SPEECH_EVENT_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SPEECH_EVENT_OFFSET_FIELD_NUMBER
public static final int SPEECH_EVENT_OFFSET_FIELD_NUMBER
- See Also:
- Constant Field Values
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
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][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true` result (the newly settled portion), followed by zero or more [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false` results (the interim results).
repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
- Specified by:
getResultsList
in interfaceStreamingRecognizeResponseOrBuilder
-
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][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true` result (the newly settled portion), followed by zero or more [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false` results (the interim results).
repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
- Specified by:
getResultsOrBuilderList
in interfaceStreamingRecognizeResponseOrBuilder
-
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][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true` result (the newly settled portion), followed by zero or more [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false` results (the interim results).
repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
- Specified by:
getResultsCount
in interfaceStreamingRecognizeResponseOrBuilder
-
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][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true` result (the newly settled portion), followed by zero or more [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false` results (the interim results).
repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
- Specified by:
getResults
in interfaceStreamingRecognizeResponseOrBuilder
-
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][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true` result (the newly settled portion), followed by zero or more [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false` results (the interim results).
repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
- Specified by:
getResultsOrBuilder
in interfaceStreamingRecognizeResponseOrBuilder
-
getSpeechEventTypeValue
public int getSpeechEventTypeValue()
Indicates the type of speech event.
.google.cloud.speech.v2.StreamingRecognizeResponse.SpeechEventType speech_event_type = 3;
- Specified by:
getSpeechEventTypeValue
in interfaceStreamingRecognizeResponseOrBuilder
- Returns:
- The enum numeric value on the wire for speechEventType.
-
getSpeechEventType
public StreamingRecognizeResponse.SpeechEventType getSpeechEventType()
Indicates the type of speech event.
.google.cloud.speech.v2.StreamingRecognizeResponse.SpeechEventType speech_event_type = 3;
- Specified by:
getSpeechEventType
in interfaceStreamingRecognizeResponseOrBuilder
- Returns:
- The speechEventType.
-
hasSpeechEventOffset
public boolean hasSpeechEventOffset()
Time offset between the beginning of the audio and event emission.
.google.protobuf.Duration speech_event_offset = 7;
- Specified by:
hasSpeechEventOffset
in interfaceStreamingRecognizeResponseOrBuilder
- Returns:
- Whether the speechEventOffset field is set.
-
getSpeechEventOffset
public com.google.protobuf.Duration getSpeechEventOffset()
Time offset between the beginning of the audio and event emission.
.google.protobuf.Duration speech_event_offset = 7;
- Specified by:
getSpeechEventOffset
in interfaceStreamingRecognizeResponseOrBuilder
- Returns:
- The speechEventOffset.
-
getSpeechEventOffsetOrBuilder
public com.google.protobuf.DurationOrBuilder getSpeechEventOffsetOrBuilder()
Time offset between the beginning of the audio and event emission.
.google.protobuf.Duration speech_event_offset = 7;
- Specified by:
getSpeechEventOffsetOrBuilder
in interfaceStreamingRecognizeResponseOrBuilder
-
hasMetadata
public boolean hasMetadata()
Metadata about the recognition.
.google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;
- Specified by:
hasMetadata
in interfaceStreamingRecognizeResponseOrBuilder
- Returns:
- Whether the metadata field is set.
-
getMetadata
public RecognitionResponseMetadata getMetadata()
Metadata about the recognition.
.google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;
- Specified by:
getMetadata
in interfaceStreamingRecognizeResponseOrBuilder
- Returns:
- The metadata.
-
getMetadataOrBuilder
public RecognitionResponseMetadataOrBuilder getMetadataOrBuilder()
Metadata about the recognition.
.google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;
- Specified by:
getMetadataOrBuilder
in interfaceStreamingRecognizeResponseOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in 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:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in 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:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected StreamingRecognizeResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in 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:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public StreamingRecognizeResponse getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-