Package com.google.cloud.dialogflow.v2beta1

Class StreamingDetectIntentResponse

  • All Implemented Interfaces:
    StreamingDetectIntentResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class StreamingDetectIntentResponse
extends com.google.protobuf.GeneratedMessageV3
implements StreamingDetectIntentResponseOrBuilder
     The top-level message returned from the
 `StreamingDetectIntent` method.

 Multiple response messages can be returned in order:

 1.  If the `StreamingDetectIntentRequest.input_audio` field was
     set, the `recognition_result` field is populated for one
     or more messages.
     See the
     [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult]
     message for details about the result message sequence.

 2.  The next message contains `response_id`, `query_result`,
     `alternative_query_results` and optionally `webhook_status` if a WebHook
     was called.

 3.  If `output_audio_config` was specified in the request or agent-level
     speech synthesizer is configured, all subsequent messages contain
     `output_audio` and `output_audio_config`.
    Protobuf type google.cloud.dialogflow.v2beta1.StreamingDetectIntentResponse
    See Also:
    Serialized Form

    • Field Detail

      • RESPONSE_ID_FIELD_NUMBER

        public static final int RESPONSE_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RECOGNITION_RESULT_FIELD_NUMBER

        public static final int RECOGNITION_RESULT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QUERY_RESULT_FIELD_NUMBER

        public static final int QUERY_RESULT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALTERNATIVE_QUERY_RESULTS_FIELD_NUMBER

        public static final int ALTERNATIVE_QUERY_RESULTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEBHOOK_STATUS_FIELD_NUMBER

        public static final int WEBHOOK_STATUS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_AUDIO_FIELD_NUMBER

        public static final int OUTPUT_AUDIO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

        public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEBUGGING_INFO_FIELD_NUMBER

        public static final int DEBUGGING_INFO_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

      • 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

      • getResponseId

        public String getResponseId()
         The unique identifier of the response. It can be used to
 locate a response in the training example set or for reporting issues.
        string response_id = 1;
        Specified by:
        getResponseId in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        The responseId.

      • getResponseIdBytes

        public com.google.protobuf.ByteString getResponseIdBytes()
         The unique identifier of the response. It can be used to
 locate a response in the training example set or for reporting issues.
        string response_id = 1;
        Specified by:
        getResponseIdBytes in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        The bytes for responseId.

      • hasRecognitionResult

        public boolean hasRecognitionResult()
         The result of speech recognition.
        .google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
        Specified by:
        hasRecognitionResult in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        Whether the recognitionResult field is set.

      • hasQueryResult

        public boolean hasQueryResult()
         The selected results of the conversational query or event processing.
 See `alternative_query_results` for additional potential results.
        .google.cloud.dialogflow.v2beta1.QueryResult query_result = 3;
        Specified by:
        hasQueryResult in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        Whether the queryResult field is set.

      • getQueryResult

        public QueryResult getQueryResult()
         The selected results of the conversational query or event processing.
 See `alternative_query_results` for additional potential results.
        .google.cloud.dialogflow.v2beta1.QueryResult query_result = 3;
        Specified by:
        getQueryResult in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        The queryResult.

      • getAlternativeQueryResultsList

        public List<QueryResult> getAlternativeQueryResultsList()
         If Knowledge Connectors are enabled, there could be more than one result
 returned for a given query or event, and this field will contain all
 results except for the top one, which is captured in query_result. The
 alternative results are ordered by decreasing
 `QueryResult.intent_detection_confidence`. If Knowledge Connectors are
 disabled, this field will be empty until multiple responses for regular
 intents are supported, at which point those additional results will be
 surfaced here.
        repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
        Specified by:
        getAlternativeQueryResultsList in interface StreamingDetectIntentResponseOrBuilder

      • getAlternativeQueryResultsOrBuilderList

        public List<? extends QueryResultOrBuilder> getAlternativeQueryResultsOrBuilderList()
         If Knowledge Connectors are enabled, there could be more than one result
 returned for a given query or event, and this field will contain all
 results except for the top one, which is captured in query_result. The
 alternative results are ordered by decreasing
 `QueryResult.intent_detection_confidence`. If Knowledge Connectors are
 disabled, this field will be empty until multiple responses for regular
 intents are supported, at which point those additional results will be
 surfaced here.
        repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
        Specified by:
        getAlternativeQueryResultsOrBuilderList in interface StreamingDetectIntentResponseOrBuilder

      • getAlternativeQueryResultsCount

        public int getAlternativeQueryResultsCount()
         If Knowledge Connectors are enabled, there could be more than one result
 returned for a given query or event, and this field will contain all
 results except for the top one, which is captured in query_result. The
 alternative results are ordered by decreasing
 `QueryResult.intent_detection_confidence`. If Knowledge Connectors are
 disabled, this field will be empty until multiple responses for regular
 intents are supported, at which point those additional results will be
 surfaced here.
        repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
        Specified by:
        getAlternativeQueryResultsCount in interface StreamingDetectIntentResponseOrBuilder

      • getAlternativeQueryResults

        public QueryResult getAlternativeQueryResults​(int index)
         If Knowledge Connectors are enabled, there could be more than one result
 returned for a given query or event, and this field will contain all
 results except for the top one, which is captured in query_result. The
 alternative results are ordered by decreasing
 `QueryResult.intent_detection_confidence`. If Knowledge Connectors are
 disabled, this field will be empty until multiple responses for regular
 intents are supported, at which point those additional results will be
 surfaced here.
        repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
        Specified by:
        getAlternativeQueryResults in interface StreamingDetectIntentResponseOrBuilder

      • getAlternativeQueryResultsOrBuilder

        public QueryResultOrBuilder getAlternativeQueryResultsOrBuilder​(int index)
         If Knowledge Connectors are enabled, there could be more than one result
 returned for a given query or event, and this field will contain all
 results except for the top one, which is captured in query_result. The
 alternative results are ordered by decreasing
 `QueryResult.intent_detection_confidence`. If Knowledge Connectors are
 disabled, this field will be empty until multiple responses for regular
 intents are supported, at which point those additional results will be
 surfaced here.
        repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
        Specified by:
        getAlternativeQueryResultsOrBuilder in interface StreamingDetectIntentResponseOrBuilder

      • hasWebhookStatus

        public boolean hasWebhookStatus()
         Specifies the status of the webhook request.
        .google.rpc.Status webhook_status = 4;
        Specified by:
        hasWebhookStatus in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        Whether the webhookStatus field is set.

      • getOutputAudio

        public com.google.protobuf.ByteString getOutputAudio()
         The audio data bytes encoded as specified in the request.
 Note: The output audio is generated based on the values of default platform
 text responses found in the `query_result.fulfillment_messages` field. If
 multiple default text responses exist, they will be concatenated when
 generating audio. If no default platform text responses exist, the
 generated audio content will be empty.

 In some scenarios, multiple output audio fields may be present in the
 response structure. In these cases, only the top-most-level audio output
 has content.
        bytes output_audio = 5;
        Specified by:
        getOutputAudio in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        The outputAudio.

      • hasOutputAudioConfig

        public boolean hasOutputAudioConfig()
         The config used by the speech synthesizer to generate the output audio.
        .google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;
        Specified by:
        hasOutputAudioConfig in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        Whether the outputAudioConfig field is set.

      • hasDebuggingInfo

        public boolean hasDebuggingInfo()
         Debugging info that would get populated when
 `StreamingDetectIntentRequest.enable_debugging_info` is set to true.
        .google.cloud.dialogflow.v2beta1.CloudConversationDebuggingInfo debugging_info = 8;
        Specified by:
        hasDebuggingInfo in interface StreamingDetectIntentResponseOrBuilder
        Returns:
        Whether the debuggingInfo field is set.

      • 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 StreamingDetectIntentResponse parseFrom​(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingDetectIntentResponse parseFrom​(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingDetectIntentResponse parseFrom​(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingDetectIntentResponse parseFrom​(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingDetectIntentResponse parseFrom​(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingDetectIntentResponse parseFrom​(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public StreamingDetectIntentResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public StreamingDetectIntentResponse.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected StreamingDetectIntentResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<StreamingDetectIntentResponse> 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 StreamingDetectIntentResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder