com.google.cloud.dialogflow.v2.StreamingDetectIntentRequestOrBuilder 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-v2 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2
/*
* 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/v2/session.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dialogflow.v2;
public interface StreamingDetectIntentRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.StreamingDetectIntentRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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) = { ... }
*
*
* @return The session.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for session.
*/
com.google.protobuf.ByteString getSessionBytes();
/**
*
*
*
* The parameters of this query.
*
*
* .google.cloud.dialogflow.v2.QueryParameters query_params = 2;
*
* @return Whether the queryParams field is set.
*/
boolean hasQueryParams();
/**
*
*
*
* The parameters of this query.
*
*
* .google.cloud.dialogflow.v2.QueryParameters query_params = 2;
*
* @return The queryParams.
*/
com.google.cloud.dialogflow.v2.QueryParameters getQueryParams();
/**
*
*
*
* The parameters of this query.
*
*
* .google.cloud.dialogflow.v2.QueryParameters query_params = 2;
*/
com.google.cloud.dialogflow.v2.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.v2.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.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The queryInput.
*/
com.google.cloud.dialogflow.v2.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];
*
*/
com.google.cloud.dialogflow.v2.QueryInputOrBuilder getQueryInputOrBuilder();
/**
*
*
*
* 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];
*
* @deprecated google.cloud.dialogflow.v2.StreamingDetectIntentRequest.single_utterance is
* deprecated. See google/cloud/dialogflow/v2/session.proto;l=469
* @return The singleUtterance.
*/
@java.lang.Deprecated
boolean getSingleUtterance();
/**
*
*
*
* 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;
*
* @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.v2.OutputAudioConfig output_audio_config = 5;
*
* @return The outputAudioConfig.
*/
com.google.cloud.dialogflow.v2.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;
*/
com.google.cloud.dialogflow.v2.OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the outputAudioConfigMask field is set.
*/
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;
*
* @return The outputAudioConfigMask.
*/
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;
*/
com.google.protobuf.FieldMaskOrBuilder getOutputAudioConfigMaskOrBuilder();
/**
*
*
*
* 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;
*
* @return The inputAudio.
*/
com.google.protobuf.ByteString getInputAudio();
/**
*
*
*
* if true, `StreamingDetectIntentResponse.debugging_info` will get populated.
*
*
* bool enable_debugging_info = 8;
*
* @return The enableDebuggingInfo.
*/
boolean getEnableDebuggingInfo();
}