Package com.google.cloud.dialogflow.v2beta1

Interface DetectIntentRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DetectIntentRequest, DetectIntentRequest.Builder
    public interface DetectIntentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getSession

        String getSession()
         Required. The name of the session this query is sent to. Supported formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>,
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>`,
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>`,
 - `projects/<Project ID>/locations/<Location
   ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
   ID>`,

 If `Location ID` is not specified we assume default 'us' location. If
 `Environment ID` is not specified, we assume default 'draft' environment
 (`Environment ID` might be referred to as environment name at some places).
 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) = { ... }
        Returns:
        The session.

      • getSessionBytes

        com.google.protobuf.ByteString getSessionBytes()
         Required. The name of the session this query is sent to. Supported formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>,
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>`,
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>`,
 - `projects/<Project ID>/locations/<Location
   ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
   ID>`,

 If `Location ID` is not specified we assume default 'us' location. If
 `Environment ID` is not specified, we assume default 'draft' environment
 (`Environment ID` might be referred to as environment name at some places).
 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) = { ... }
        Returns:
        The bytes for session.

      • hasQueryParams

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

      • getQueryParams

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

      • getQueryParamsOrBuilder

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

      • hasQueryInput

        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.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the queryInput field is set.

      • getQueryInput

        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.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The queryInput.

      • getQueryInputOrBuilder

        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.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

      • hasOutputAudioConfig

        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.v2beta1.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. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
        .google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 4;
        Returns:
        The outputAudioConfig.

      • getOutputAudioConfigOrBuilder

        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.v2beta1.OutputAudioConfig output_audio_config = 4;

      • hasOutputAudioConfigMask

        boolean hasOutputAudioConfigMask()
         Mask for
 [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.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.v2beta1.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
        .google.protobuf.FieldMask output_audio_config_mask = 7;
        Returns:
        Whether the outputAudioConfigMask field is set.

      • getOutputAudioConfigMask

        com.google.protobuf.FieldMask getOutputAudioConfigMask()
         Mask for
 [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.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.v2beta1.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
        .google.protobuf.FieldMask output_audio_config_mask = 7;
        Returns:
        The outputAudioConfigMask.

      • getOutputAudioConfigMaskOrBuilder

        com.google.protobuf.FieldMaskOrBuilder getOutputAudioConfigMaskOrBuilder()
         Mask for
 [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.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.v2beta1.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
        .google.protobuf.FieldMask output_audio_config_mask = 7;

      • getInputAudio

        com.google.protobuf.ByteString getInputAudio()
         The natural language speech audio to be processed. This field
 should be populated iff `query_input` is set to an input audio config.
 A single request can contain up to 1 minute of speech audio data.
        bytes input_audio = 5;
        Returns:
        The inputAudio.