com.google.cloud.dialogflow.cx.v3beta1.DetectIntentResponseOrBuilder 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-cx-v3beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3beta1
The 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/cx/v3beta1/session.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;

public interface DetectIntentResponseOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Output only. The unique identifier of the response. It can be used to
   * locate a response in the training example set or for reporting issues.
   * 
   *
   * string response_id = 1;
   *
   * @return The responseId.
   */
  java.lang.String getResponseId();
  /**
   *
   *
   *    * Output only. The unique identifier of the response. It can be used to
   * locate a response in the training example set or for reporting issues.
   * 
   *
   * string response_id = 1;
   *
   * @return The bytes for responseId.
   */
  com.google.protobuf.ByteString getResponseIdBytes();

  /**
   *
   *
   *    * The result of the conversational query.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.QueryResult query_result = 2;
   *
   * @return Whether the queryResult field is set.
   */
  boolean hasQueryResult();
  /**
   *
   *
   *    * The result of the conversational query.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.QueryResult query_result = 2;
   *
   * @return The queryResult.
   */
  com.google.cloud.dialogflow.cx.v3beta1.QueryResult getQueryResult();
  /**
   *
   *
   *    * The result of the conversational query.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.QueryResult query_result = 2;
   */
  com.google.cloud.dialogflow.cx.v3beta1.QueryResultOrBuilder getQueryResultOrBuilder();

  /**
   *
   *
   *    * The audio data bytes encoded as specified in the request.
   * Note: The output audio is generated based on the values of default platform
   * text responses found in the
   * [`query_result.response_messages`][google.cloud.dialogflow.cx.v3beta1.QueryResult.response_messages]
   * field. If multiple default text responses exist, they will be concatenated
   * when generating audio. If no default platform text responses exist, the
   * generated audio content will be empty.
   *
   * In some scenarios, multiple output audio fields may be present in the
   * response structure. In these cases, only the top-most-level audio output
   * has content.
   * 
   *
   * bytes output_audio = 4;
   *
   * @return The outputAudio.
   */
  com.google.protobuf.ByteString getOutputAudio();

  /**
   *
   *
   *    * The config used by the speech synthesizer to generate the output audio.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 5;
   *
   * @return Whether the outputAudioConfig field is set.
   */
  boolean hasOutputAudioConfig();
  /**
   *
   *
   *    * The config used by the speech synthesizer to generate the output audio.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 5;
   *
   * @return The outputAudioConfig.
   */
  com.google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig getOutputAudioConfig();
  /**
   *
   *
   *    * The config used by the speech synthesizer to generate the output audio.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 5;
   */
  com.google.cloud.dialogflow.cx.v3beta1.OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder();

  /**
   *
   *
   *    * Response type.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse.ResponseType response_type = 6;
   * 
   *
   * @return The enum numeric value on the wire for responseType.
   */
  int getResponseTypeValue();
  /**
   *
   *
   *    * Response type.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse.ResponseType response_type = 6;
   * 
   *
   * @return The responseType.
   */
  com.google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse.ResponseType getResponseType();

  /**
   *
   *
   *    * Indicates whether the partial response can be cancelled when a later
   * response arrives. e.g. if the agent specified some music as partial
   * response, it can be cancelled.
   * 
   *
   * bool allow_cancellation = 7;
   *
   * @return The allowCancellation.
   */
  boolean getAllowCancellation();
}