Package com.google.cloud.dialogflow.cx.v3beta1

Interface StreamingDetectIntentRequestOrBuilder

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

  • Method Details

    • getSession

      String getSession()
       The name of the session this query is sent to.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
 It's up to the API caller to choose an appropriate `Session ID`. It can be
 a random number or some type of session identifiers (preferably hashed).
 The length of the `Session ID` must not exceed 36 characters.
 Note: session must be set in the first request.

 For more information, see the [sessions
 guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
      string session = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      The session.

    • getSessionBytes

      com.google.protobuf.ByteString getSessionBytes()
       The name of the session this query is sent to.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
 It's up to the API caller to choose an appropriate `Session ID`. It can be
 a random number or some type of session identifiers (preferably hashed).
 The length of the `Session ID` must not exceed 36 characters.
 Note: session must be set in the first request.

 For more information, see the [sessions
 guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
      string session = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for session.

    • hasQueryParams

      boolean hasQueryParams()
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
      Returns:
      Whether the queryParams field is set.

    • getQueryParams

      QueryParameters getQueryParams()
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
      Returns:
      The queryParams.

    • getQueryParamsOrBuilder

      QueryParametersOrBuilder getQueryParamsOrBuilder()
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;

    • hasQueryInput

      boolean hasQueryInput()
       Required. The input specification.
      .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the queryInput field is set.

    • getQueryInput

      QueryInput getQueryInput()
       Required. The input specification.
      .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The queryInput.

    • getQueryInputOrBuilder

      QueryInputOrBuilder getQueryInputOrBuilder()
       Required. The input specification.
      .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • hasOutputAudioConfig

      boolean hasOutputAudioConfig()
       Instructs the speech synthesizer how to generate the output audio.
      .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
      Returns:
      Whether the outputAudioConfig field is set.

    • getOutputAudioConfig

      OutputAudioConfig getOutputAudioConfig()
       Instructs the speech synthesizer how to generate the output audio.
      .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
      Returns:
      The outputAudioConfig.

    • getOutputAudioConfigOrBuilder

      OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
       Instructs the speech synthesizer how to generate the output audio.
      .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;

    • getEnablePartialResponse

      boolean getEnablePartialResponse()
       Enable partial detect intent response. If this flag is not enabled,
 response stream still contains only one final `DetectIntentResponse` even
 if some `Fulfillment`s in the agent have been configured to return partial
 responses.
      bool enable_partial_response = 5;
      Returns:
      The enablePartialResponse.

    • getEnableDebuggingInfo

      boolean getEnableDebuggingInfo()
       If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
      bool enable_debugging_info = 8;
      Returns:
      The enableDebuggingInfo.

    • getResponseViewValue

      int getResponseViewValue()
       Optional. Specifies which fields in the
 [QueryResult][google.cloud.dialogflow.cx.v3beta1.QueryResult] to return. If
 not set, the default is DETECT_INTENT_RESPONSE_VIEW_FULL.
      .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponseView response_view = 16 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for responseView.

    • getResponseView

      DetectIntentResponseView getResponseView()
       Optional. Specifies which fields in the
 [QueryResult][google.cloud.dialogflow.cx.v3beta1.QueryResult] to return. If
 not set, the default is DETECT_INTENT_RESPONSE_VIEW_FULL.
      .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponseView response_view = 16 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The responseView.