com.google.cloud.dialogflow.v2.AnalyzeContentRequestOrBuilder 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
PROTO library for proto-google-cloud-dialogflow-v2
There is a newer version: 4.59.0
Show newest version
/*
 * 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 AnalyzeContentRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.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.v2.TextInput text_input = 6;
   *
   * @return Whether the textInput field is set.
   */
  boolean hasTextInput();
  /**
   *
   *
   *    * The natural language text to be processed.
   * 
   *
   * .google.cloud.dialogflow.v2.TextInput text_input = 6;
   *
   * @return The textInput.
   */
  com.google.cloud.dialogflow.v2.TextInput getTextInput();
  /**
   *
   *
   *    * The natural language text to be processed.
   * 
   *
   * .google.cloud.dialogflow.v2.TextInput text_input = 6;
   */
  com.google.cloud.dialogflow.v2.TextInputOrBuilder getTextInputOrBuilder();

  /**
   *
   *
   *    * An input event to send to Dialogflow.
   * 
   *
   * .google.cloud.dialogflow.v2.EventInput event_input = 8;
   *
   * @return Whether the eventInput field is set.
   */
  boolean hasEventInput();
  /**
   *
   *
   *    * An input event to send to Dialogflow.
   * 
   *
   * .google.cloud.dialogflow.v2.EventInput event_input = 8;
   *
   * @return The eventInput.
   */
  com.google.cloud.dialogflow.v2.EventInput getEventInput();
  /**
   *
   *
   *    * An input event to send to Dialogflow.
   * 
   *
   * .google.cloud.dialogflow.v2.EventInput event_input = 8;
   */
  com.google.cloud.dialogflow.v2.EventInputOrBuilder getEventInputOrBuilder();

  /**
   *
   *
   *    * An input representing the selection of a suggestion.
   * 
   *
   * .google.cloud.dialogflow.v2.SuggestionInput suggestion_input = 12;
   *
   * @return Whether the suggestionInput field is set.
   */
  boolean hasSuggestionInput();
  /**
   *
   *
   *    * An input representing the selection of a suggestion.
   * 
   *
   * .google.cloud.dialogflow.v2.SuggestionInput suggestion_input = 12;
   *
   * @return The suggestionInput.
   */
  com.google.cloud.dialogflow.v2.SuggestionInput getSuggestionInput();
  /**
   *
   *
   *    * An input representing the selection of a suggestion.
   * 
   *
   * .google.cloud.dialogflow.v2.SuggestionInput suggestion_input = 12;
   */
  com.google.cloud.dialogflow.v2.SuggestionInputOrBuilder getSuggestionInputOrBuilder();

  /**
   *
   *
   *    * 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.v2.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.v2.OutputAudioConfig reply_audio_config = 5;
   *
   * @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
   * AnalyzeContent. If this configuration is not supplied, speech synthesis
   * is disabled.
   * 
   *
   * .google.cloud.dialogflow.v2.OutputAudioConfig reply_audio_config = 5;
   */
  com.google.cloud.dialogflow.v2.OutputAudioConfigOrBuilder getReplyAudioConfigOrBuilder();

  /**
   *
   *
   *    * Parameters for a Dialogflow virtual-agent query.
   * 
   *
   * .google.cloud.dialogflow.v2.QueryParameters query_params = 9;
   *
   * @return Whether the queryParams field is set.
   */
  boolean hasQueryParams();
  /**
   *
   *
   *    * Parameters for a Dialogflow virtual-agent query.
   * 
   *
   * .google.cloud.dialogflow.v2.QueryParameters query_params = 9;
   *
   * @return The queryParams.
   */
  com.google.cloud.dialogflow.v2.QueryParameters getQueryParams();
  /**
   *
   *
   *    * Parameters for a Dialogflow virtual-agent query.
   * 
   *
   * .google.cloud.dialogflow.v2.QueryParameters query_params = 9;
   */
  com.google.cloud.dialogflow.v2.QueryParametersOrBuilder getQueryParamsOrBuilder();

  /**
   *
   *
   *    * Parameters for a human assist query.
   * 
   *
   * .google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 14;
   *
   * @return Whether the assistQueryParams field is set.
   */
  boolean hasAssistQueryParams();
  /**
   *
   *
   *    * Parameters for a human assist query.
   * 
   *
   * .google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 14;
   *
   * @return The assistQueryParams.
   */
  com.google.cloud.dialogflow.v2.AssistQueryParameters getAssistQueryParams();
  /**
   *
   *
   *    * Parameters for a human assist query.
   * 
   *
   * .google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 14;
   */
  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 = 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();

  /**
   *
   *
   *    * 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();

  com.google.cloud.dialogflow.v2.AnalyzeContentRequest.InputCase getInputCase();
}