Package com.google.cloud.dialogflow.v2

Class StreamingDetectIntentRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.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
 [StreamingDetectIntent][] method.

 Multiple request messages should be sent in order:

 1.  The first message must contain
 [session][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.session],
 [query_input][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_input]
 plus optionally
 [query_params][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_params].
 If the client wants to receive an audio response, it should also contain
 [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config].
 The message must not contain
 [input_audio][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_audio].
 2.  If
 [query_input][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_input]
 was set to
 [query_input.audio_config][google.cloud.dialogflow.v2.InputAudioConfig],
 all subsequent messages must contain
 [input_audio][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_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.v2.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.v2.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:

    • SINGLE_UTTERANCE_FIELD_NUMBER

      public static final int SINGLE_UTTERANCE_FIELD_NUMBER
      See Also:

    • OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

      public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
      See Also:

    • OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER

      public static final int OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER
      See Also:

    • INPUT_AUDIO_FIELD_NUMBER

      public static final int INPUT_AUDIO_FIELD_NUMBER
      See Also:

    • ENABLE_DEBUGGING_INFO_FIELD_NUMBER

      public static final int ENABLE_DEBUGGING_INFO_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()
       Required. The name of the session the query is sent to.
 Format of the session name:
 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 default 'draft' environment. If `User ID` is not specified, we are using
 "-". It's up to the API caller to choose an appropriate `Session ID` and
 `User Id`. They can be a random number or some type of user and session
 identifiers (preferably hashed). The length of the `Session ID` and
 `User ID` must not exceed 36 characters.

 For more information, see the [API interactions
 guide](https://cloud.google.com/dialogflow/docs/api-overview).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getSession in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The session.

    • getSessionBytes

      public com.google.protobuf.ByteString getSessionBytes()
       Required. The name of the session the query is sent to.
 Format of the session name:
 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 default 'draft' environment. If `User ID` is not specified, we are using
 "-". It's up to the API caller to choose an appropriate `Session ID` and
 `User Id`. They can be a random number or some type of user and session
 identifiers (preferably hashed). The length of the `Session ID` and
 `User ID` must not exceed 36 characters.

 For more information, see the [API interactions
 guide](https://cloud.google.com/dialogflow/docs/api-overview).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.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.v2.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.v2.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.v2.QueryParameters query_params = 2;
      Specified by:
      getQueryParamsOrBuilder in interface StreamingDetectIntentRequestOrBuilder

    • hasQueryInput

      public boolean hasQueryInput()
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.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. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.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. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryInputOrBuilder in interface StreamingDetectIntentRequestOrBuilder

    • getSingleUtterance

      @Deprecated public boolean getSingleUtterance()
      Deprecated.
      google.cloud.dialogflow.v2.StreamingDetectIntentRequest.single_utterance is deprecated. See google/cloud/dialogflow/v2/session.proto;l=467
       Please use
 [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2.InputAudioConfig.single_utterance]
 instead. If `false` (default), recognition does not cease until the client
 closes the stream. If `true`, the recognizer will detect a single spoken
 utterance in input audio. Recognition ceases when it detects the audio's
 voice has stopped or paused. In this case, once a detected intent is
 received, the client should close the stream and start a new request with a
 new stream as needed. This setting is ignored when `query_input` is a piece
 of text or an event.
      bool single_utterance = 4 [deprecated = true];
      Specified by:
      getSingleUtterance in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The singleUtterance.

    • hasOutputAudioConfig

      public boolean hasOutputAudioConfig()
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 5;
      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. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 5;
      Specified by:
      getOutputAudioConfig in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The outputAudioConfig.

    • getOutputAudioConfigOrBuilder

      public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 5;
      Specified by:
      getOutputAudioConfigOrBuilder in interface StreamingDetectIntentRequestOrBuilder

    • hasOutputAudioConfigMask

      public boolean hasOutputAudioConfigMask()
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;
      Specified by:
      hasOutputAudioConfigMask in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      Whether the outputAudioConfigMask field is set.

    • getOutputAudioConfigMask

      public com.google.protobuf.FieldMask getOutputAudioConfigMask()
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;
      Specified by:
      getOutputAudioConfigMask in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The outputAudioConfigMask.

    • getOutputAudioConfigMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getOutputAudioConfigMaskOrBuilder()
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;
      Specified by:
      getOutputAudioConfigMaskOrBuilder in interface StreamingDetectIntentRequestOrBuilder

    • getInputAudio

      public com.google.protobuf.ByteString getInputAudio()
       The input audio content to be recognized. Must be sent if
 `query_input` was set to a streaming input audio config. The complete audio
 over all streaming messages must not exceed 1 minute.
      bytes input_audio = 6;
      Specified by:
      getInputAudio in interface StreamingDetectIntentRequestOrBuilder
      Returns:
      The inputAudio.

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

    • 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