Package com.google.cloud.dialogflow.v2beta1

Interface StreamingAnalyzeContentRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StreamingAnalyzeContentRequest, StreamingAnalyzeContentRequest.Builder
@Generated public interface StreamingAnalyzeContentRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParticipant

      String getParticipant()
       Required. The name of the participant this text comes from.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
      string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The participant.

    • getParticipantBytes

      com.google.protobuf.ByteString getParticipantBytes()
       Required. The name of the participant this text comes from.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
      string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for participant.

    • hasAudioConfig

      boolean hasAudioConfig()
       Instructs the speech recognizer how to process the speech audio.
      .google.cloud.dialogflow.v2beta1.InputAudioConfig audio_config = 2;
      Returns:
      Whether the audioConfig field is set.

    • getAudioConfig

      InputAudioConfig getAudioConfig()
       Instructs the speech recognizer how to process the speech audio.
      .google.cloud.dialogflow.v2beta1.InputAudioConfig audio_config = 2;
      Returns:
      The audioConfig.

    • getAudioConfigOrBuilder

      InputAudioConfigOrBuilder getAudioConfigOrBuilder()
       Instructs the speech recognizer how to process the speech audio.
      .google.cloud.dialogflow.v2beta1.InputAudioConfig audio_config = 2;

    • hasTextConfig

      boolean hasTextConfig()
       The natural language text to be processed.
      .google.cloud.dialogflow.v2beta1.InputTextConfig text_config = 3;
      Returns:
      Whether the textConfig field is set.

    • getTextConfig

      InputTextConfig getTextConfig()
       The natural language text to be processed.
      .google.cloud.dialogflow.v2beta1.InputTextConfig text_config = 3;
      Returns:
      The textConfig.

    • getTextConfigOrBuilder

      InputTextConfigOrBuilder getTextConfigOrBuilder()
       The natural language text to be processed.
      .google.cloud.dialogflow.v2beta1.InputTextConfig text_config = 3;

    • hasReplyAudioConfig

      boolean hasReplyAudioConfig()
       Speech synthesis configuration.
 The speech synthesis settings for a virtual agent that may be configured
 for the associated conversation profile are not used when calling
 StreamingAnalyzeContent. If this configuration is not supplied, speech
 synthesis is disabled.
      .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 4;
      Returns:
      Whether the replyAudioConfig field is set.

    • getReplyAudioConfig

      OutputAudioConfig getReplyAudioConfig()
       Speech synthesis configuration.
 The speech synthesis settings for a virtual agent that may be configured
 for the associated conversation profile are not used when calling
 StreamingAnalyzeContent. If this configuration is not supplied, speech
 synthesis is disabled.
      .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 4;
      Returns:
      The replyAudioConfig.

    • getReplyAudioConfigOrBuilder

      OutputAudioConfigOrBuilder getReplyAudioConfigOrBuilder()
       Speech synthesis configuration.
 The speech synthesis settings for a virtual agent that may be configured
 for the associated conversation profile are not used when calling
 StreamingAnalyzeContent. If this configuration is not supplied, speech
 synthesis is disabled.
      .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 4;

    • hasInputAudio

      boolean hasInputAudio()
       The input audio content to be recognized. Must be sent if `audio_config`
 is set in the first message. The complete audio over all streaming
 messages must not exceed 1 minute.
      bytes input_audio = 5;
      Returns:
      Whether the inputAudio field is set.

    • getInputAudio

      com.google.protobuf.ByteString getInputAudio()
       The input audio content to be recognized. Must be sent if `audio_config`
 is set in the first message. The complete audio over all streaming
 messages must not exceed 1 minute.
      bytes input_audio = 5;
      Returns:
      The inputAudio.

    • hasInputText

      boolean hasInputText()
       The UTF-8 encoded natural language text to be processed. Must be sent if
 `text_config` is set in the first message. Text length must not exceed
 256 bytes for virtual agent interactions. The `input_text` field can be
 only sent once, and would cancel the speech recognition if any ongoing.
      string input_text = 6;
      Returns:
      Whether the inputText field is set.

    • getInputText

      String getInputText()
       The UTF-8 encoded natural language text to be processed. Must be sent if
 `text_config` is set in the first message. Text length must not exceed
 256 bytes for virtual agent interactions. The `input_text` field can be
 only sent once, and would cancel the speech recognition if any ongoing.
      string input_text = 6;
      Returns:
      The inputText.

    • getInputTextBytes

      com.google.protobuf.ByteString getInputTextBytes()
       The UTF-8 encoded natural language text to be processed. Must be sent if
 `text_config` is set in the first message. Text length must not exceed
 256 bytes for virtual agent interactions. The `input_text` field can be
 only sent once, and would cancel the speech recognition if any ongoing.
      string input_text = 6;
      Returns:
      The bytes for inputText.

    • hasInputDtmf

      boolean hasInputDtmf()
       The DTMF digits used to invoke intent and fill in parameter value.

 This input is ignored if the previous response indicated that DTMF input
 is not accepted.
      .google.cloud.dialogflow.v2beta1.TelephonyDtmfEvents input_dtmf = 9;
      Returns:
      Whether the inputDtmf field is set.

    • getInputDtmf

      TelephonyDtmfEvents getInputDtmf()
       The DTMF digits used to invoke intent and fill in parameter value.

 This input is ignored if the previous response indicated that DTMF input
 is not accepted.
      .google.cloud.dialogflow.v2beta1.TelephonyDtmfEvents input_dtmf = 9;
      Returns:
      The inputDtmf.

    • getInputDtmfOrBuilder

      TelephonyDtmfEventsOrBuilder getInputDtmfOrBuilder()
       The DTMF digits used to invoke intent and fill in parameter value.

 This input is ignored if the previous response indicated that DTMF input
 is not accepted.
      .google.cloud.dialogflow.v2beta1.TelephonyDtmfEvents input_dtmf = 9;

    • hasInputIntent

      boolean hasInputIntent()
       The intent to be triggered on V3 agent.
 Format: `projects/<Project ID>/locations/<Location ID>/locations/
 <Location ID>/agents/<Agent ID>/intents/<Intent ID>`. This can only be
 used to trigger the Welcome intent id if you are using text_config.
      string input_intent = 17;
      Returns:
      Whether the inputIntent field is set.

    • getInputIntent

      String getInputIntent()
       The intent to be triggered on V3 agent.
 Format: `projects/<Project ID>/locations/<Location ID>/locations/
 <Location ID>/agents/<Agent ID>/intents/<Intent ID>`. This can only be
 used to trigger the Welcome intent id if you are using text_config.
      string input_intent = 17;
      Returns:
      The inputIntent.

    • getInputIntentBytes

      com.google.protobuf.ByteString getInputIntentBytes()
       The intent to be triggered on V3 agent.
 Format: `projects/<Project ID>/locations/<Location ID>/locations/
 <Location ID>/agents/<Agent ID>/intents/<Intent ID>`. This can only be
 used to trigger the Welcome intent id if you are using text_config.
      string input_intent = 17;
      Returns:
      The bytes for inputIntent.

    • hasInputEvent

      boolean hasInputEvent()
       The input event name.
 This can only be sent once and would cancel the ongoing speech
 recognition if any. To trigger the Welcome intent use the event "WELCOME"
      string input_event = 20;
      Returns:
      Whether the inputEvent field is set.

    • getInputEvent

      String getInputEvent()
       The input event name.
 This can only be sent once and would cancel the ongoing speech
 recognition if any. To trigger the Welcome intent use the event "WELCOME"
      string input_event = 20;
      Returns:
      The inputEvent.

    • getInputEventBytes

      com.google.protobuf.ByteString getInputEventBytes()
       The input event name.
 This can only be sent once and would cancel the ongoing speech
 recognition if any. To trigger the Welcome intent use the event "WELCOME"
      string input_event = 20;
      Returns:
      The bytes for inputEvent.

    • hasQueryParams

      boolean hasQueryParams()
       Parameters for a Dialogflow virtual-agent query.
      .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 7;
      Returns:
      Whether the queryParams field is set.

    • getQueryParams

      QueryParameters getQueryParams()
       Parameters for a Dialogflow virtual-agent query.
      .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 7;
      Returns:
      The queryParams.

    • getQueryParamsOrBuilder

      QueryParametersOrBuilder getQueryParamsOrBuilder()
       Parameters for a Dialogflow virtual-agent query.
      .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 7;

    • hasAssistQueryParams

      boolean hasAssistQueryParams()
       Parameters for a human assist query.
      .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 8;
      Returns:
      Whether the assistQueryParams field is set.

    • getAssistQueryParams

      AssistQueryParameters getAssistQueryParams()
       Parameters for a human assist query.
      .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 8;
      Returns:
      The assistQueryParams.

    • getAssistQueryParamsOrBuilder

      AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()
       Parameters for a human assist query.
      .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 8;

    • hasCxParameters

      boolean hasCxParameters()
       Additional parameters to be put into Dialogflow CX session parameters. To
 remove a parameter from the session, clients should explicitly set the
 parameter value to null.

 Note: this field should only be used if you are connecting to a Dialogflow
 CX agent.
      .google.protobuf.Struct cx_parameters = 13;
      Returns:
      Whether the cxParameters field is set.

    • getCxParameters

      com.google.protobuf.Struct getCxParameters()
       Additional parameters to be put into Dialogflow CX session parameters. To
 remove a parameter from the session, clients should explicitly set the
 parameter value to null.

 Note: this field should only be used if you are connecting to a Dialogflow
 CX agent.
      .google.protobuf.Struct cx_parameters = 13;
      Returns:
      The cxParameters.

    • getCxParametersOrBuilder

      com.google.protobuf.StructOrBuilder getCxParametersOrBuilder()
       Additional parameters to be put into Dialogflow CX session parameters. To
 remove a parameter from the session, clients should explicitly set the
 parameter value to null.

 Note: this field should only be used if you are connecting to a Dialogflow
 CX agent.
      .google.protobuf.Struct cx_parameters = 13;

    • getCxCurrentPage

      String getCxCurrentPage()
       The unique identifier of the Dialogflow CX page to override the
 `current_page` in the session.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/pages/<Page ID>`.

 If `cx_current_page` is specified, the previous state of the session will
 be ignored by Dialogflow CX, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters]. In most cases, `cx_current_page` and
 `cx_parameters` should be configured together to direct a session to a
 specific state.

 Note: this field should only be used if you are connecting to a Dialogflow
 CX agent.
      string cx_current_page = 15;
      Returns:
      The cxCurrentPage.

    • getCxCurrentPageBytes

      com.google.protobuf.ByteString getCxCurrentPageBytes()
       The unique identifier of the Dialogflow CX page to override the
 `current_page` in the session.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/pages/<Page ID>`.

 If `cx_current_page` is specified, the previous state of the session will
 be ignored by Dialogflow CX, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters]. In most cases, `cx_current_page` and
 `cx_parameters` should be configured together to direct a session to a
 specific state.

 Note: this field should only be used if you are connecting to a Dialogflow
 CX agent.
      string cx_current_page = 15;
      Returns:
      The bytes for cxCurrentPage.

    • getEnableExtendedStreaming

      boolean getEnableExtendedStreaming()
       Optional. Enable full bidirectional streaming. You can keep streaming the
 audio until timeout, and there's no need to half close the stream to get
 the response.

 Restrictions:

 - Timeout: 3 mins.
 - Audio Encoding: only supports
 [AudioEncoding.AUDIO_ENCODING_LINEAR_16][google.cloud.dialogflow.v2beta1.AudioEncoding.AUDIO_ENCODING_LINEAR_16]
 and
 [AudioEncoding.AUDIO_ENCODING_MULAW][google.cloud.dialogflow.v2beta1.AudioEncoding.AUDIO_ENCODING_MULAW]
 - Lifecycle: conversation should be in `Assist Stage`, go to
 [Conversation.CreateConversation][] for more information.

 InvalidArgument Error will be returned if the one of restriction checks
 failed.

 You can find more details in
 https://cloud.google.com/agent-assist/docs/extended-streaming
      bool enable_extended_streaming = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enableExtendedStreaming.

    • getEnablePartialAutomatedAgentReply

      boolean getEnablePartialAutomatedAgentReply()
       Optional. Enable partial responses from Dialogflow CX agent. If this flag
 is not enabled, response stream still contains only one final response even
 if some `Fulfillment`s in Dialogflow CX agent have been configured to
 return partial responses.
      bool enable_partial_automated_agent_reply = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enablePartialAutomatedAgentReply.

    • getOutputMultipleUtterances

      boolean getOutputMultipleUtterances()
       Optional. If multiple utterances are detected in the audio stream, process
 them individually instead of stitching them together to form a single
 utterance.
      bool output_multiple_utterances = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The outputMultipleUtterances.

    • getEnableDebuggingInfo

      boolean getEnableDebuggingInfo()
       if true, `StreamingAnalyzeContentResponse.debugging_info` will get
 populated.
      bool enable_debugging_info = 19;
      Returns:
      The enableDebuggingInfo.

    • getConfigCase

      StreamingAnalyzeContentRequest.ConfigCase getConfigCase()

    • getInputCase

      StreamingAnalyzeContentRequest.InputCase getInputCase()