com.google.cloud.dialogflow.v2.StreamingAnalyzeContentRequestOrBuilder 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/participant.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.v2;
public interface StreamingAnalyzeContentRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The name of the participant this text comes from.
* Format: `projects/<Project ID>/locations/<Location
* ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
*
*
*
* string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The participant.
*/
java.lang.String getParticipant();
/**
*
*
*
* Required. The name of the participant this text comes from.
* Format: `projects/<Project ID>/locations/<Location
* ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
*
*
*
* string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for participant.
*/
com.google.protobuf.ByteString getParticipantBytes();
/**
*
*
*
* Instructs the speech recognizer how to process the speech audio.
*
*
* .google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;
*
* @return Whether the audioConfig field is set.
*/
boolean hasAudioConfig();
/**
*
*
*
* Instructs the speech recognizer how to process the speech audio.
*
*
* .google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;
*
* @return The audioConfig.
*/
com.google.cloud.dialogflow.v2.InputAudioConfig getAudioConfig();
/**
*
*
*
* Instructs the speech recognizer how to process the speech audio.
*
*
* .google.cloud.dialogflow.v2.InputAudioConfig audio_config = 2;
*/
com.google.cloud.dialogflow.v2.InputAudioConfigOrBuilder getAudioConfigOrBuilder();
/**
*
*
*
* The natural language text to be processed.
*
*
* .google.cloud.dialogflow.v2.InputTextConfig text_config = 3;
*
* @return Whether the textConfig field is set.
*/
boolean hasTextConfig();
/**
*
*
*
* The natural language text to be processed.
*
*
* .google.cloud.dialogflow.v2.InputTextConfig text_config = 3;
*
* @return The textConfig.
*/
com.google.cloud.dialogflow.v2.InputTextConfig getTextConfig();
/**
*
*
*
* The natural language text to be processed.
*
*
* .google.cloud.dialogflow.v2.InputTextConfig text_config = 3;
*/
com.google.cloud.dialogflow.v2.InputTextConfigOrBuilder getTextConfigOrBuilder();
/**
*
*
*
* Speech synthesis configuration.
* The speech synthesis settings for a virtual agent that may be configured
* for the associated conversation profile are not used when calling
* StreamingAnalyzeContent. If this configuration is not supplied, speech
* synthesis is disabled.
*
*
* .google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;
*
* @return Whether the replyAudioConfig field is set.
*/
boolean hasReplyAudioConfig();
/**
*
*
*
* Speech synthesis configuration.
* The speech synthesis settings for a virtual agent that may be configured
* for the associated conversation profile are not used when calling
* StreamingAnalyzeContent. If this configuration is not supplied, speech
* synthesis is disabled.
*
*
* .google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;
*
* @return The replyAudioConfig.
*/
com.google.cloud.dialogflow.v2.OutputAudioConfig getReplyAudioConfig();
/**
*
*
*
* Speech synthesis configuration.
* The speech synthesis settings for a virtual agent that may be configured
* for the associated conversation profile are not used when calling
* StreamingAnalyzeContent. If this configuration is not supplied, speech
* synthesis is disabled.
*
*
* .google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 4;
*/
com.google.cloud.dialogflow.v2.OutputAudioConfigOrBuilder getReplyAudioConfigOrBuilder();
/**
*
*
*
* The input audio content to be recognized. Must be sent if `audio_config`
* is set in the first message. The complete audio over all streaming
* messages must not exceed 1 minute.
*
*
* bytes input_audio = 5;
*
* @return Whether the inputAudio field is set.
*/
boolean hasInputAudio();
/**
*
*
*
* The input audio content to be recognized. Must be sent if `audio_config`
* is set in the first message. The complete audio over all streaming
* messages must not exceed 1 minute.
*
*
* bytes input_audio = 5;
*
* @return The inputAudio.
*/
com.google.protobuf.ByteString getInputAudio();
/**
*
*
*
* The UTF-8 encoded natural language text to be processed. Must be sent if
* `text_config` is set in the first message. Text length must not exceed
* 256 bytes for virtual agent interactions. The `input_text` field can be
* only sent once, and would cancel the speech recognition if any ongoing.
*
*
* string input_text = 6;
*
* @return Whether the inputText field is set.
*/
boolean hasInputText();
/**
*
*
*
* The UTF-8 encoded natural language text to be processed. Must be sent if
* `text_config` is set in the first message. Text length must not exceed
* 256 bytes for virtual agent interactions. The `input_text` field can be
* only sent once, and would cancel the speech recognition if any ongoing.
*
*
* string input_text = 6;
*
* @return The inputText.
*/
java.lang.String getInputText();
/**
*
*
*
* The UTF-8 encoded natural language text to be processed. Must be sent if
* `text_config` is set in the first message. Text length must not exceed
* 256 bytes for virtual agent interactions. The `input_text` field can be
* only sent once, and would cancel the speech recognition if any ongoing.
*
*
* string input_text = 6;
*
* @return The bytes for inputText.
*/
com.google.protobuf.ByteString getInputTextBytes();
/**
*
*
*
* The DTMF digits used to invoke intent and fill in parameter value.
*
* This input is ignored if the previous response indicated that DTMF input
* is not accepted.
*
*
* .google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;
*
* @return Whether the inputDtmf field is set.
*/
boolean hasInputDtmf();
/**
*
*
*
* The DTMF digits used to invoke intent and fill in parameter value.
*
* This input is ignored if the previous response indicated that DTMF input
* is not accepted.
*
*
* .google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;
*
* @return The inputDtmf.
*/
com.google.cloud.dialogflow.v2.TelephonyDtmfEvents getInputDtmf();
/**
*
*
*
* The DTMF digits used to invoke intent and fill in parameter value.
*
* This input is ignored if the previous response indicated that DTMF input
* is not accepted.
*
*
* .google.cloud.dialogflow.v2.TelephonyDtmfEvents input_dtmf = 9;
*/
com.google.cloud.dialogflow.v2.TelephonyDtmfEventsOrBuilder getInputDtmfOrBuilder();
/**
*
*
*
* Parameters for a Dialogflow virtual-agent query.
*
*
* .google.cloud.dialogflow.v2.QueryParameters query_params = 7;
*
* @return Whether the queryParams field is set.
*/
boolean hasQueryParams();
/**
*
*
*
* Parameters for a Dialogflow virtual-agent query.
*
*
* .google.cloud.dialogflow.v2.QueryParameters query_params = 7;
*
* @return The queryParams.
*/
com.google.cloud.dialogflow.v2.QueryParameters getQueryParams();
/**
*
*
*
* Parameters for a Dialogflow virtual-agent query.
*
*
* .google.cloud.dialogflow.v2.QueryParameters query_params = 7;
*/
com.google.cloud.dialogflow.v2.QueryParametersOrBuilder getQueryParamsOrBuilder();
/**
*
*
*
* Parameters for a human assist query.
*
*
* .google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;
*
* @return Whether the assistQueryParams field is set.
*/
boolean hasAssistQueryParams();
/**
*
*
*
* Parameters for a human assist query.
*
*
* .google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;
*
* @return The assistQueryParams.
*/
com.google.cloud.dialogflow.v2.AssistQueryParameters getAssistQueryParams();
/**
*
*
*
* Parameters for a human assist query.
*
*
* .google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 8;
*/
com.google.cloud.dialogflow.v2.AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder();
/**
*
*
*
* Additional parameters to be put into Dialogflow CX session parameters. To
* remove a parameter from the session, clients should explicitly set the
* parameter value to null.
*
* Note: this field should only be used if you are connecting to a Dialogflow
* CX agent.
*
*
* .google.protobuf.Struct cx_parameters = 13;
*
* @return Whether the cxParameters field is set.
*/
boolean hasCxParameters();
/**
*
*
*
* Additional parameters to be put into Dialogflow CX session parameters. To
* remove a parameter from the session, clients should explicitly set the
* parameter value to null.
*
* Note: this field should only be used if you are connecting to a Dialogflow
* CX agent.
*
*
* .google.protobuf.Struct cx_parameters = 13;
*
* @return The cxParameters.
*/
com.google.protobuf.Struct getCxParameters();
/**
*
*
*
* Additional parameters to be put into Dialogflow CX session parameters. To
* remove a parameter from the session, clients should explicitly set the
* parameter value to null.
*
* Note: this field should only be used if you are connecting to a Dialogflow
* CX agent.
*
*
* .google.protobuf.Struct cx_parameters = 13;
*/
com.google.protobuf.StructOrBuilder getCxParametersOrBuilder();
/**
*
*
*
* Optional. Enable full bidirectional streaming. You can keep streaming the
* audio until timeout, and there's no need to half close the stream to get
* the response.
*
* Restrictions:
*
* - Timeout: 3 mins.
* - Audio Encoding: only supports
* [AudioEncoding.AUDIO_ENCODING_LINEAR_16][google.cloud.dialogflow.v2.AudioEncoding.AUDIO_ENCODING_LINEAR_16]
* and
* [AudioEncoding.AUDIO_ENCODING_MULAW][google.cloud.dialogflow.v2.AudioEncoding.AUDIO_ENCODING_MULAW]
* - Lifecycle: conversation should be in `Assist Stage`, go to
* [Conversation.CreateConversation][] for more information.
*
* InvalidArgument Error will be returned if the one of restriction checks
* failed.
*
* You can find more details in
* https://cloud.google.com/agent-assist/docs/extended-streaming
*
*
* bool enable_extended_streaming = 11 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The enableExtendedStreaming.
*/
boolean getEnableExtendedStreaming();
/**
*
*
*
* Enable partial virtual agent responses. If this flag is not enabled,
* response stream still contains only one final response even if some
* `Fulfillment`s in Dialogflow virtual agent have been configured to return
* partial responses.
*
*
* bool enable_partial_automated_agent_reply = 12;
*
* @return The enablePartialAutomatedAgentReply.
*/
boolean getEnablePartialAutomatedAgentReply();
/**
*
*
*
* If true, `StreamingAnalyzeContentResponse.debugging_info` will get
* populated.
*
*
* bool enable_debugging_info = 19;
*
* @return The enableDebuggingInfo.
*/
boolean getEnableDebuggingInfo();
com.google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.ConfigCase getConfigCase();
com.google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.InputCase getInputCase();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy