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

Class StreamingDetectIntentRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StreamingDetectIntentRequest.Builder>
com.google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.Builder
All Implemented Interfaces:
StreamingDetectIntentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StreamingDetectIntentRequest
public static final class StreamingDetectIntentRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<StreamingDetectIntentRequest.Builder> implements StreamingDetectIntentRequestOrBuilder
 The top-level message sent by the client to the
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent]
 method.

 Multiple request messages should be sent in order:

 1.  The first message must contain
 [session][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.session],
 [query_input][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.query_input]
 plus optionally
 [query_params][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.query_params].
 If the client wants to receive an audio response, it should also contain
 [output_audio_config][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.output_audio_config].

 2.  If
 [query_input][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.query_input]
 was set to
 [query_input.audio.config][google.cloud.dialogflow.cx.v3beta1.AudioInput.config],
 all subsequent messages must contain
 [query_input.audio.audio][google.cloud.dialogflow.cx.v3beta1.AudioInput.audio]
 to continue with Speech recognition. If you decide to rather detect an
 intent from text input after you already started Speech recognition,
 please send a message with
 [query_input.text][google.cloud.dialogflow.cx.v3beta1.QueryInput.text].

 However, note that:

 * Dialogflow will bill you for the audio duration so far.
 * Dialogflow discards all Speech recognition results in favor of the
 input text.
 * Dialogflow will use the language code from the first message.

 After you sent all input, you must half-close or abort the request stream.
Protobuf type google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<StreamingDetectIntentRequest.Builder>

    • clear

      public StreamingDetectIntentRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<StreamingDetectIntentRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<StreamingDetectIntentRequest.Builder>

    • getDefaultInstanceForType

      public StreamingDetectIntentRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public StreamingDetectIntentRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public StreamingDetectIntentRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public StreamingDetectIntentRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StreamingDetectIntentRequest.Builder>

    • mergeFrom

      public StreamingDetectIntentRequest.Builder mergeFrom(StreamingDetectIntentRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<StreamingDetectIntentRequest.Builder>

    • mergeFrom

      public StreamingDetectIntentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StreamingDetectIntentRequest.Builder>
      Throws:
      IOException

    • getSession

      public 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) = { ... }
      Specified by:
      getSession in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The session.

    • getSessionBytes

      public 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) = { ... }
      Specified by:
      getSessionBytes in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The bytes for session.

    • setSession

      public StreamingDetectIntentRequest.Builder setSession(String value)
       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) = { ... }
      Parameters:
      value - The session to set.
      Returns:
      This builder for chaining.

    • clearSession

      public StreamingDetectIntentRequest.Builder clearSession()
       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:
      This builder for chaining.

    • setSessionBytes

      public StreamingDetectIntentRequest.Builder setSessionBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for session to set.
      Returns:
      This builder for chaining.

    • hasQueryParams

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

    • getQueryParams

      public QueryParameters getQueryParams()
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
      Specified by:
      getQueryParams in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The queryParams.

    • setQueryParams

      public StreamingDetectIntentRequest.Builder setQueryParams(QueryParameters value)
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;

    • setQueryParams

      public StreamingDetectIntentRequest.Builder setQueryParams(QueryParameters.Builder builderForValue)
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;

    • mergeQueryParams

      public StreamingDetectIntentRequest.Builder mergeQueryParams(QueryParameters value)
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;

    • clearQueryParams

      public StreamingDetectIntentRequest.Builder clearQueryParams()
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;

    • getQueryParamsBuilder

      public QueryParameters.Builder getQueryParamsBuilder()
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;

    • getQueryParamsOrBuilder

      public QueryParametersOrBuilder getQueryParamsOrBuilder()
       The parameters of this query.
      .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
      Specified by:
      getQueryParamsOrBuilder in interface StreamingDetectIntentRequestOrBuilder

    • hasQueryInput

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

    • getQueryInput

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

    • setQueryInput

      public StreamingDetectIntentRequest.Builder setQueryInput(QueryInput value)
       Required. The input specification.
      .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • setQueryInput

      public StreamingDetectIntentRequest.Builder setQueryInput(QueryInput.Builder builderForValue)
       Required. The input specification.
      .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • mergeQueryInput

      public StreamingDetectIntentRequest.Builder mergeQueryInput(QueryInput value)
       Required. The input specification.
      .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • clearQueryInput

      public StreamingDetectIntentRequest.Builder clearQueryInput()
       Required. The input specification.
      .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • getQueryInputBuilder

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

    • getQueryInputOrBuilder

      public QueryInputOrBuilder getQueryInputOrBuilder()
       Required. The input specification.
      .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryInputOrBuilder in interface StreamingDetectIntentRequestOrBuilder

    • hasOutputAudioConfig

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

    • getOutputAudioConfig

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

    • setOutputAudioConfig

      public StreamingDetectIntentRequest.Builder setOutputAudioConfig(OutputAudioConfig value)
       Instructs the speech synthesizer how to generate the output audio.
      .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;

    • setOutputAudioConfig

      public StreamingDetectIntentRequest.Builder setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)
       Instructs the speech synthesizer how to generate the output audio.
      .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;

    • mergeOutputAudioConfig

      public StreamingDetectIntentRequest.Builder mergeOutputAudioConfig(OutputAudioConfig value)
       Instructs the speech synthesizer how to generate the output audio.
      .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;

    • clearOutputAudioConfig

      public StreamingDetectIntentRequest.Builder clearOutputAudioConfig()
       Instructs the speech synthesizer how to generate the output audio.
      .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;

    • getOutputAudioConfigBuilder

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

    • getOutputAudioConfigOrBuilder

      public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
       Instructs the speech synthesizer how to generate the output audio.
      .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
      Specified by:
      getOutputAudioConfigOrBuilder in interface StreamingDetectIntentRequestOrBuilder

    • getEnablePartialResponse

      public 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;
      Specified by:
      getEnablePartialResponse in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The enablePartialResponse.

    • setEnablePartialResponse

      public StreamingDetectIntentRequest.Builder setEnablePartialResponse(boolean value)
       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;
      Parameters:
      value - The enablePartialResponse to set.
      Returns:
      This builder for chaining.

    • clearEnablePartialResponse

      public StreamingDetectIntentRequest.Builder clearEnablePartialResponse()
       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:
      This builder for chaining.

    • getEnableDebuggingInfo

      public boolean getEnableDebuggingInfo()
       If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
      bool enable_debugging_info = 8;
      Specified by:
      getEnableDebuggingInfo in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The enableDebuggingInfo.

    • setEnableDebuggingInfo

      public StreamingDetectIntentRequest.Builder setEnableDebuggingInfo(boolean value)
       If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
      bool enable_debugging_info = 8;
      Parameters:
      value - The enableDebuggingInfo to set.
      Returns:
      This builder for chaining.

    • clearEnableDebuggingInfo

      public StreamingDetectIntentRequest.Builder clearEnableDebuggingInfo()
       If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
      bool enable_debugging_info = 8;
      Returns:
      This builder for chaining.

    • getResponseViewValue

      public 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];
      Specified by:
      getResponseViewValue in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The enum numeric value on the wire for responseView.

    • setResponseViewValue

      public StreamingDetectIntentRequest.Builder setResponseViewValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for responseView to set.
      Returns:
      This builder for chaining.

    • getResponseView

      public 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];
      Specified by:
      getResponseView in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The responseView.

    • setResponseView

      public StreamingDetectIntentRequest.Builder setResponseView(DetectIntentResponseView value)
       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];
      Parameters:
      value - The responseView to set.
      Returns:
      This builder for chaining.

    • clearResponseView

      public StreamingDetectIntentRequest.Builder clearResponseView()
       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:
      This builder for chaining.