StreamingRecognitionResult (proto-google-cloud-dialogflow-v2beta1 0.122.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult

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

public final class StreamingRecognitionResult
extends com.google.protobuf.GeneratedMessageV3
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.v2beta1.StreamingRecognitionResult

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StreamingRecognitionResult.Builder` 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.
`static class`	`StreamingRecognitionResult.MessageType` Type of the response message.

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONFIDENCE_FIELD_NUMBER`
`static int`	`DTMF_DIGITS_FIELD_NUMBER`
`static int`	`IS_FINAL_FIELD_NUMBER`
`static int`	`LANGUAGE_CODE_FIELD_NUMBER`
`static int`	`MESSAGE_TYPE_FIELD_NUMBER`
`static int`	`SPEECH_END_OFFSET_FIELD_NUMBER`
`static int`	`SPEECH_WORD_INFO_FIELD_NUMBER`
`static int`	`STABILITY_FIELD_NUMBER`
`static int`	`TRANSCRIPT_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`float`	`getConfidence()` The Speech confidence between 0.0 and 1.0 for the current portion of audio.
`static StreamingRecognitionResult`	`getDefaultInstance()`
`StreamingRecognitionResult`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`TelephonyDtmfEvents`	`getDtmfDigits()` DTMF digits.
`TelephonyDtmfEventsOrBuilder`	`getDtmfDigitsOrBuilder()` DTMF digits.
`boolean`	`getIsFinal()` If `false`, the `StreamingRecognitionResult` represents an interim result that may change.
`String`	`getLanguageCode()` Detected language code for the transcript.
`com.google.protobuf.ByteString`	`getLanguageCodeBytes()` Detected language code for the transcript.
`StreamingRecognitionResult.MessageType`	`getMessageType()` Type of the result message.
`int`	`getMessageTypeValue()` Type of the result message.
`com.google.protobuf.Parser<StreamingRecognitionResult>`	`getParserForType()`
`int`	`getSerializedSize()`
`com.google.protobuf.Duration`	`getSpeechEndOffset()` Time offset of the end of this Speech recognition result relative to the beginning of the audio.
`com.google.protobuf.DurationOrBuilder`	`getSpeechEndOffsetOrBuilder()` Time offset of the end of this Speech recognition result relative to the beginning of the audio.
`SpeechWordInfo`	`getSpeechWordInfo(int index)` Word-specific information for the words recognized by Speech in [transcript][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.transcript].
`int`	`getSpeechWordInfoCount()` Word-specific information for the words recognized by Speech in [transcript][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.transcript].
`List<SpeechWordInfo>`	`getSpeechWordInfoList()` Word-specific information for the words recognized by Speech in [transcript][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.transcript].
`SpeechWordInfoOrBuilder`	`getSpeechWordInfoOrBuilder(int index)` Word-specific information for the words recognized by Speech in [transcript][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.transcript].
`List<? extends SpeechWordInfoOrBuilder>`	`getSpeechWordInfoOrBuilderList()` Word-specific information for the words recognized by Speech in [transcript][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.transcript].
`float`	`getStability()` An estimate of the likelihood that the speech recognizer will not change its guess about this interim recognition result: * If the value is unspecified or 0.0, Dialogflow didn't compute the stability.
`String`	`getTranscript()` Transcript text representing the words that the user spoke.
`com.google.protobuf.ByteString`	`getTranscriptBytes()` Transcript text representing the words that the user spoke.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasDtmfDigits()` DTMF digits.
`int`	`hashCode()`
`boolean`	`hasSpeechEndOffset()` Time offset of the end of this Speech recognition result relative to the beginning of the audio.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static StreamingRecognitionResult.Builder`	`newBuilder()`
`static StreamingRecognitionResult.Builder`	`newBuilder(StreamingRecognitionResult prototype)`
`StreamingRecognitionResult.Builder`	`newBuilderForType()`
`protected StreamingRecognitionResult.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static StreamingRecognitionResult`	`parseDelimitedFrom(InputStream input)`
`static StreamingRecognitionResult`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StreamingRecognitionResult`	`parseFrom(byte[] data)`
`static StreamingRecognitionResult`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StreamingRecognitionResult`	`parseFrom(ByteBuffer data)`
`static StreamingRecognitionResult`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StreamingRecognitionResult`	`parseFrom(com.google.protobuf.ByteString data)`
`static StreamingRecognitionResult`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StreamingRecognitionResult`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static StreamingRecognitionResult`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StreamingRecognitionResult`	`parseFrom(InputStream input)`
`static StreamingRecognitionResult`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<StreamingRecognitionResult>`	`parser()`
`StreamingRecognitionResult.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, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- MESSAGE_TYPE_FIELD_NUMBER
```
public static final int MESSAGE_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRANSCRIPT_FIELD_NUMBER
```
public static final int TRANSCRIPT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IS_FINAL_FIELD_NUMBER
```
public static final int IS_FINAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONFIDENCE_FIELD_NUMBER
```
public static final int CONFIDENCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STABILITY_FIELD_NUMBER
```
public static final int STABILITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SPEECH_WORD_INFO_FIELD_NUMBER
```
public static final int SPEECH_WORD_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SPEECH_END_OFFSET_FIELD_NUMBER
```
public static final int SPEECH_END_OFFSET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LANGUAGE_CODE_FIELD_NUMBER
```
public static final int LANGUAGE_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DTMF_DIGITS_FIELD_NUMBER
```
public static final int DTMF_DIGITS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

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

getMessageTypeValue
```
public int getMessageTypeValue()
```
```
 Type of the result message.
 
```
.google.cloud.dialogflow.v2beta1.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.v2beta1.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.

getStability

public float getStability()

 An estimate of the likelihood that the speech recognizer will
 not change its guess about this interim recognition result:
 * If the value is unspecified or 0.0, Dialogflow didn't compute the
   stability. In particular, Dialogflow will only provide stability for
   `TRANSCRIPT` results with `is_final = false`.
 * Otherwise, the value is in (0.0, 1.0] where 0.0 means completely
   unstable and 1.0 means completely stable.

float stability = 6;

Specified by:: getStability in interface StreamingRecognitionResultOrBuilder
Returns:: The stability.