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

Class StreamingDetectIntentRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest
All Implemented Interfaces:
StreamingDetectIntentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class StreamingDetectIntentRequest extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • SESSION_FIELD_NUMBER

      public static final int SESSION_FIELD_NUMBER
      See Also:

    • QUERY_PARAMS_FIELD_NUMBER

      public static final int QUERY_PARAMS_FIELD_NUMBER
      See Also:

    • QUERY_INPUT_FIELD_NUMBER

      public static final int QUERY_INPUT_FIELD_NUMBER
      See Also:

    • OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

      public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
      See Also:

    • ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER

      public static final int ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER
      See Also:

    • ENABLE_DEBUGGING_INFO_FIELD_NUMBER

      public static final int ENABLE_DEBUGGING_INFO_FIELD_NUMBER
      See Also:

    • RESPONSE_VIEW_FIELD_NUMBER

      public static final int RESPONSE_VIEW_FIELD_NUMBER
      See Also:

  • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static StreamingDetectIntentRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamingDetectIntentRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamingDetectIntentRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamingDetectIntentRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static StreamingDetectIntentRequest.Builder newBuilder()

    • newBuilder

      public static StreamingDetectIntentRequest.Builder newBuilder(StreamingDetectIntentRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected StreamingDetectIntentRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StreamingDetectIntentRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StreamingDetectIntentRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<StreamingDetectIntentRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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