com.google.cloud.dialogflow.v2beta1.DetectIntentRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-v2beta1 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2beta1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2beta1/session.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.v2beta1;
public interface DetectIntentRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2beta1.DetectIntentRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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) = { ... }
*
*
* @return The session.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for session.
*/
com.google.protobuf.ByteString getSessionBytes();
/**
*
*
*
* The parameters of this query.
*
*
* .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 2;
*
* @return Whether the queryParams field is set.
*/
boolean hasQueryParams();
/**
*
*
*
* The parameters of this query.
*
*
* .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 2;
*
* @return The queryParams.
*/
com.google.cloud.dialogflow.v2beta1.QueryParameters getQueryParams();
/**
*
*
*
* The parameters of this query.
*
*
* .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 2;
*/
com.google.cloud.dialogflow.v2beta1.QueryParametersOrBuilder getQueryParamsOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the queryInput field is set.
*/
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];
*
*
* @return The queryInput.
*/
com.google.cloud.dialogflow.v2beta1.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];
*
*/
com.google.cloud.dialogflow.v2beta1.QueryInputOrBuilder getQueryInputOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the outputAudioConfig field is set.
*/
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;
*
* @return The outputAudioConfig.
*/
com.google.cloud.dialogflow.v2beta1.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;
*/
com.google.cloud.dialogflow.v2beta1.OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the outputAudioConfigMask field is set.
*/
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;
*
* @return The outputAudioConfigMask.
*/
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;
*/
com.google.protobuf.FieldMaskOrBuilder getOutputAudioConfigMaskOrBuilder();
/**
*
*
*
* 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;
*
* @return The inputAudio.
*/
com.google.protobuf.ByteString getInputAudio();
}