/*
* Copyright 2020 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/participant.proto
package com.google.cloud.dialogflow.v2beta1;
public interface AnalyzeContentRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2beta1.AnalyzeContentRequest)
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();
/**
*
*
*
* The natural language text to be processed.
*
*
* .google.cloud.dialogflow.v2beta1.TextInput text_input = 6;
*
* @return Whether the textInput field is set.
*/
boolean hasTextInput();
/**
*
*
*
* The natural language text to be processed.
*
*
* .google.cloud.dialogflow.v2beta1.TextInput text_input = 6;
*
* @return The textInput.
*/
com.google.cloud.dialogflow.v2beta1.TextInput getTextInput();
/**
*
*
*
* The natural language text to be processed.
*
*
* .google.cloud.dialogflow.v2beta1.TextInput text_input = 6;
*/
com.google.cloud.dialogflow.v2beta1.TextInputOrBuilder getTextInputOrBuilder();
/**
*
*
*
* The natural language speech audio to be processed.
*
*
* .google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;
*
* @return Whether the audioInput field is set.
*/
boolean hasAudioInput();
/**
*
*
*
* The natural language speech audio to be processed.
*
*
* .google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;
*
* @return The audioInput.
*/
com.google.cloud.dialogflow.v2beta1.AudioInput getAudioInput();
/**
*
*
*
* The natural language speech audio to be processed.
*
*
* .google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;
*/
com.google.cloud.dialogflow.v2beta1.AudioInputOrBuilder getAudioInputOrBuilder();
/**
*
*
*
* An input event to send to Dialogflow.
*
*
* .google.cloud.dialogflow.v2beta1.EventInput event_input = 8;
*
* @return Whether the eventInput field is set.
*/
boolean hasEventInput();
/**
*
*
*
* An input event to send to Dialogflow.
*
*
* .google.cloud.dialogflow.v2beta1.EventInput event_input = 8;
*
* @return The eventInput.
*/
com.google.cloud.dialogflow.v2beta1.EventInput getEventInput();
/**
*
*
*
* An input event to send to Dialogflow.
*
*
* .google.cloud.dialogflow.v2beta1.EventInput event_input = 8;
*/
com.google.cloud.dialogflow.v2beta1.EventInputOrBuilder getEventInputOrBuilder();
/**
*
*
*
* 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
* AnalyzeContent. If this configuration is not supplied, speech synthesis
* is disabled.
*
*
* .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;
*
* @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
* AnalyzeContent. If this configuration is not supplied, speech synthesis
* is disabled.
*
*
* .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;
*
* @return The replyAudioConfig.
*/
com.google.cloud.dialogflow.v2beta1.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
* AnalyzeContent. If this configuration is not supplied, speech synthesis
* is disabled.
*
*
* .google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;
*/
com.google.cloud.dialogflow.v2beta1.OutputAudioConfigOrBuilder getReplyAudioConfigOrBuilder();
/**
*
*
*
* Parameters for a Dialogflow virtual-agent query.
*
*
* .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;
*
* @return Whether the queryParams field is set.
*/
boolean hasQueryParams();
/**
*
*
*
* Parameters for a Dialogflow virtual-agent query.
*
*
* .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;
*
* @return The queryParams.
*/
com.google.cloud.dialogflow.v2beta1.QueryParameters getQueryParams();
/**
*
*
*
* Parameters for a Dialogflow virtual-agent query.
*
*
* .google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;
*/
com.google.cloud.dialogflow.v2beta1.QueryParametersOrBuilder getQueryParamsOrBuilder();
/**
*
*
*
* Parameters for a human assist query.
*
*
* .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;
*
* @return Whether the assistQueryParams field is set.
*/
boolean hasAssistQueryParams();
/**
*
*
*
* Parameters for a human assist query.
*
*
* .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;
*
* @return The assistQueryParams.
*/
com.google.cloud.dialogflow.v2beta1.AssistQueryParameters getAssistQueryParams();
/**
*
*
*
* Parameters for a human assist query.
*
*
* .google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;
*/
com.google.cloud.dialogflow.v2beta1.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 = 18;
*
* @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 = 18;
*
* @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 = 18;
*/
com.google.protobuf.StructOrBuilder getCxParametersOrBuilder();
/**
*
*
*
* The unique identifier of the CX page to override the `current_page` in the
* session.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/pages/<Page ID>`.
* If `cx_current_page` is specified, the previous state of the session will
* be ignored by Dialogflow CX, including the [previous
* page][QueryResult.current_page] and the [previous session
* parameters][QueryResult.parameters]. In most cases, `cx_current_page` and
* `cx_parameters` should be configured together to direct a session to a
* specific state.
* Note: this field should only be used if you are connecting to a Dialogflow
* CX agent.
*
*
* string cx_current_page = 20;
*
* @return The cxCurrentPage.
*/
java.lang.String getCxCurrentPage();
/**
*
*
*
* The unique identifier of the CX page to override the `current_page` in the
* session.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/pages/<Page ID>`.
* If `cx_current_page` is specified, the previous state of the session will
* be ignored by Dialogflow CX, including the [previous
* page][QueryResult.current_page] and the [previous session
* parameters][QueryResult.parameters]. In most cases, `cx_current_page` and
* `cx_parameters` should be configured together to direct a session to a
* specific state.
* Note: this field should only be used if you are connecting to a Dialogflow
* CX agent.
*
*
* string cx_current_page = 20;
*
* @return The bytes for cxCurrentPage.
*/
com.google.protobuf.ByteString getCxCurrentPageBytes();
/**
*
*
*
* Optional. The send time of the message from end user or human agent's
* perspective. It is used for identifying the same message under one
* participant.
* Given two messages under the same participant:
* - If send time are different regardless of whether the content of the
* messages are exactly the same, the conversation will regard them as
* two distinct messages sent by the participant.
* - If send time is the same regardless of whether the content of the
* messages are exactly the same, the conversation will regard them as
* same message, and ignore the message received later.
* If the value is not provided, a new request will always be regarded as a
* new message without any de-duplication.
*
*
* .google.protobuf.Timestamp message_send_time = 10;
*
* @return Whether the messageSendTime field is set.
*/
boolean hasMessageSendTime();
/**
*
*
*
* Optional. The send time of the message from end user or human agent's
* perspective. It is used for identifying the same message under one
* participant.
* Given two messages under the same participant:
* - If send time are different regardless of whether the content of the
* messages are exactly the same, the conversation will regard them as
* two distinct messages sent by the participant.
* - If send time is the same regardless of whether the content of the
* messages are exactly the same, the conversation will regard them as
* same message, and ignore the message received later.
* If the value is not provided, a new request will always be regarded as a
* new message without any de-duplication.
*
*
* .google.protobuf.Timestamp message_send_time = 10;
*
* @return The messageSendTime.
*/
com.google.protobuf.Timestamp getMessageSendTime();
/**
*
*
*
* Optional. The send time of the message from end user or human agent's
* perspective. It is used for identifying the same message under one
* participant.
* Given two messages under the same participant:
* - If send time are different regardless of whether the content of the
* messages are exactly the same, the conversation will regard them as
* two distinct messages sent by the participant.
* - If send time is the same regardless of whether the content of the
* messages are exactly the same, the conversation will regard them as
* same message, and ignore the message received later.
* If the value is not provided, a new request will always be regarded as a
* new message without any de-duplication.
*
*
* .google.protobuf.Timestamp message_send_time = 10;
*/
com.google.protobuf.TimestampOrBuilder getMessageSendTimeOrBuilder();
/**
*
*
*
* A unique identifier for this request. Restricted to 36 ASCII characters.
* A random UUID is recommended.
* This request is only idempotent if a `request_id` is provided.
*
*
* string request_id = 11;
*
* @return The requestId.
*/
java.lang.String getRequestId();
/**
*
*
*
* A unique identifier for this request. Restricted to 36 ASCII characters.
* A random UUID is recommended.
* This request is only idempotent if a `request_id` is provided.
*
*
* string request_id = 11;
*
* @return The bytes for requestId.
*/
com.google.protobuf.ByteString getRequestIdBytes();
public com.google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.InputCase getInputCase();
}