com.google.cloud.dialogflow.v2

Class StreamingRecognitionResult.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

com.google.cloud.dialogflow.v2.StreamingRecognitionResult.Builder

All Implemented Interfaces:

StreamingRecognitionResultOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:

StreamingRecognitionResult

public static final class StreamingRecognitionResult.Builder
extends GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>
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.
 Example:
 1.  transcript: "tube"
 2.  transcript: "to be a"
 3.  transcript: "to be"
 4.  transcript: "to be or not to be"
     is_final: true
 5.  transcript: " that's"
 6.  transcript: " that is"
 7.  recognition_event_type: `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE`
 8.  transcript: " that is the question"
     is_final: true
 Only two of the responses contain final results (#4 and #8 indicated by
 `is_final: true`). Concatenating these generates the full transcript: "to be
 or not to be that is the question".
 In each response we populate:
 *  for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`.
 *  for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`.
 

Protobuf type google.cloud.dialogflow.v2.StreamingRecognitionResult

Method Summary

Modifier and Type	Method and Description
StreamingRecognitionResult.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
StreamingRecognitionResult	build()
StreamingRecognitionResult	buildPartial()
StreamingRecognitionResult.Builder	clear()
StreamingRecognitionResult.Builder	clearConfidence() The Speech confidence between 0.0 and 1.0 for the current portion of audio.
StreamingRecognitionResult.Builder	clearField(Descriptors.FieldDescriptor field)
StreamingRecognitionResult.Builder	clearIsFinal() The default of 0.0 is a sentinel value indicating `confidence` was not set.
StreamingRecognitionResult.Builder	clearMessageType() Type of the result message.
StreamingRecognitionResult.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
StreamingRecognitionResult.Builder	clearTranscript() Transcript text representing the words that the user spoke.
StreamingRecognitionResult.Builder	clone()
float	getConfidence() The Speech confidence between 0.0 and 1.0 for the current portion of audio.
StreamingRecognitionResult	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
boolean	getIsFinal() The default of 0.0 is a sentinel value indicating `confidence` was not set.
StreamingRecognitionResult.MessageType	getMessageType() Type of the result message.
int	getMessageTypeValue() Type of the result message.
java.lang.String	getTranscript() Transcript text representing the words that the user spoke.
ByteString	getTranscriptBytes() Transcript text representing the words that the user spoke.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
StreamingRecognitionResult.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
StreamingRecognitionResult.Builder	mergeFrom(Message other)
StreamingRecognitionResult.Builder	mergeFrom(StreamingRecognitionResult other)
StreamingRecognitionResult.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
StreamingRecognitionResult.Builder	setConfidence(float value) The Speech confidence between 0.0 and 1.0 for the current portion of audio.
StreamingRecognitionResult.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value)
StreamingRecognitionResult.Builder	setIsFinal(boolean value) The default of 0.0 is a sentinel value indicating `confidence` was not set.
StreamingRecognitionResult.Builder	setMessageType(StreamingRecognitionResult.MessageType value) Type of the result message.
StreamingRecognitionResult.Builder	setMessageTypeValue(int value) Type of the result message.
StreamingRecognitionResult.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
StreamingRecognitionResult.Builder	setTranscript(java.lang.String value) Transcript text representing the words that the user spoke.
StreamingRecognitionResult.Builder	setTranscriptBytes(ByteString value) Transcript text representing the words that the user spoke.
StreamingRecognitionResult.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

clear

public StreamingRecognitionResult.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

getDefaultInstanceForType

public StreamingRecognitionResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public StreamingRecognitionResult build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public StreamingRecognitionResult buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public StreamingRecognitionResult.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

setField

public StreamingRecognitionResult.Builder setField(Descriptors.FieldDescriptor field,
                                                   java.lang.Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

clearField

public StreamingRecognitionResult.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

clearOneof

public StreamingRecognitionResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

setRepeatedField

public StreamingRecognitionResult.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                           int index,
                                                           java.lang.Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

addRepeatedField

public StreamingRecognitionResult.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                           java.lang.Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

mergeFrom

public StreamingRecognitionResult.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<StreamingRecognitionResult.Builder>

mergeFrom

public StreamingRecognitionResult.Builder mergeFrom(StreamingRecognitionResult other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

mergeFrom

public StreamingRecognitionResult.Builder mergeFrom(CodedInputStream input,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<StreamingRecognitionResult.Builder>

Throws:

java.io.IOException

getMessageTypeValue

public int getMessageTypeValue()

 Type of the result message.
 

.google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType message_type = 1;

Specified by:

getMessageTypeValue in interface StreamingRecognitionResultOrBuilder

setMessageTypeValue

public StreamingRecognitionResult.Builder setMessageTypeValue(int value)

 Type of the result message.
 

.google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType message_type = 1;

getMessageType

public StreamingRecognitionResult.MessageType getMessageType()

 Type of the result message.
 

.google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType message_type = 1;

Specified by:

getMessageType in interface StreamingRecognitionResultOrBuilder

setMessageType

public StreamingRecognitionResult.Builder setMessageType(StreamingRecognitionResult.MessageType value)

 Type of the result message.
 

.google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType message_type = 1;

clearMessageType

public StreamingRecognitionResult.Builder clearMessageType()

 Type of the result message.
 

.google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType message_type = 1;

getTranscript

public java.lang.String getTranscript()

 Transcript text representing the words that the user spoke.
 Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

string transcript = 2;

Specified by:

getTranscript in interface StreamingRecognitionResultOrBuilder

getTranscriptBytes

public ByteString getTranscriptBytes()

 Transcript text representing the words that the user spoke.
 Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

string transcript = 2;

Specified by:

getTranscriptBytes in interface StreamingRecognitionResultOrBuilder

setTranscript

public StreamingRecognitionResult.Builder setTranscript(java.lang.String value)

 Transcript text representing the words that the user spoke.
 Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

string transcript = 2;

clearTranscript

public StreamingRecognitionResult.Builder clearTranscript()

 Transcript text representing the words that the user spoke.
 Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

string transcript = 2;

setTranscriptBytes

public StreamingRecognitionResult.Builder setTranscriptBytes(ByteString value)

 Transcript text representing the words that the user spoke.
 Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

string transcript = 2;

getIsFinal

public boolean getIsFinal()

 The default of 0.0 is a sentinel value indicating `confidence` was not set.
 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 `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

bool is_final = 3;

Specified by:

getIsFinal in interface StreamingRecognitionResultOrBuilder

setIsFinal

public StreamingRecognitionResult.Builder setIsFinal(boolean value)

 The default of 0.0 is a sentinel value indicating `confidence` was not set.
 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 `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

bool is_final = 3;

clearIsFinal

public StreamingRecognitionResult.Builder clearIsFinal()

 The default of 0.0 is a sentinel value indicating `confidence` was not set.
 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 `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

bool is_final = 3;

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

setConfidence

public StreamingRecognitionResult.Builder setConfidence(float value)

 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;

clearConfidence

public StreamingRecognitionResult.Builder clearConfidence()

 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;

setUnknownFields

public final StreamingRecognitionResult.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>

mergeUnknownFields

public final StreamingRecognitionResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<StreamingRecognitionResult.Builder>