com.google.cloud.dialogflow.cx.v3beta1.MatchIntentResponseOrBuilder 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 MatchIntentResponseOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
   * was provided as input, this field will contain a copy of the text.
   * 
   *
   * string text = 1;
   *
   * @return Whether the text field is set.
   */
  boolean hasText();
  /**
   *
   *
   *    * If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
   * was provided as input, this field will contain a copy of the text.
   * 
   *
   * string text = 1;
   *
   * @return The text.
   */
  java.lang.String getText();
  /**
   *
   *
   *    * If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
   * was provided as input, this field will contain a copy of the text.
   * 
   *
   * string text = 1;
   *
   * @return The bytes for text.
   */
  com.google.protobuf.ByteString getTextBytes();

  /**
   *
   *
   *    * If an [intent][google.cloud.dialogflow.cx.v3beta1.IntentInput] was
   * provided as input, this field will contain a copy of the intent
   * identifier. Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
   * 
   *
   * string trigger_intent = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return Whether the triggerIntent field is set.
   */
  boolean hasTriggerIntent();
  /**
   *
   *
   *    * If an [intent][google.cloud.dialogflow.cx.v3beta1.IntentInput] was
   * provided as input, this field will contain a copy of the intent
   * identifier. Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
   * 
   *
   * string trigger_intent = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The triggerIntent.
   */
  java.lang.String getTriggerIntent();
  /**
   *
   *
   *    * If an [intent][google.cloud.dialogflow.cx.v3beta1.IntentInput] was
   * provided as input, this field will contain a copy of the intent
   * identifier. Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
   * 
   *
   * string trigger_intent = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for triggerIntent.
   */
  com.google.protobuf.ByteString getTriggerIntentBytes();

  /**
   *
   *
   *    * If [natural language speech
   * audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
   * input, this field will contain the transcript for the audio.
   * 
   *
   * string transcript = 3;
   *
   * @return Whether the transcript field is set.
   */
  boolean hasTranscript();
  /**
   *
   *
   *    * If [natural language speech
   * audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
   * input, this field will contain the transcript for the audio.
   * 
   *
   * string transcript = 3;
   *
   * @return The transcript.
   */
  java.lang.String getTranscript();
  /**
   *
   *
   *    * If [natural language speech
   * audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
   * input, this field will contain the transcript for the audio.
   * 
   *
   * string transcript = 3;
   *
   * @return The bytes for transcript.
   */
  com.google.protobuf.ByteString getTranscriptBytes();

  /**
   *
   *
   *    * If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
   * as input, this field will contain a copy of the event name.
   * 
   *
   * string trigger_event = 6;
   *
   * @return Whether the triggerEvent field is set.
   */
  boolean hasTriggerEvent();
  /**
   *
   *
   *    * If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
   * as input, this field will contain a copy of the event name.
   * 
   *
   * string trigger_event = 6;
   *
   * @return The triggerEvent.
   */
  java.lang.String getTriggerEvent();
  /**
   *
   *
   *    * If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
   * as input, this field will contain a copy of the event name.
   * 
   *
   * string trigger_event = 6;
   *
   * @return The bytes for triggerEvent.
   */
  com.google.protobuf.ByteString getTriggerEventBytes();

  /**
   *
   *
   *    * Match results, if more than one, ordered descendingly by the confidence
   * we have that the particular intent matches the query.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.Match matches = 4;
   */
  java.util.List getMatchesList();
  /**
   *
   *
   *    * Match results, if more than one, ordered descendingly by the confidence
   * we have that the particular intent matches the query.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.Match matches = 4;
   */
  com.google.cloud.dialogflow.cx.v3beta1.Match getMatches(int index);
  /**
   *
   *
   *    * Match results, if more than one, ordered descendingly by the confidence
   * we have that the particular intent matches the query.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.Match matches = 4;
   */
  int getMatchesCount();
  /**
   *
   *
   *    * Match results, if more than one, ordered descendingly by the confidence
   * we have that the particular intent matches the query.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.Match matches = 4;
   */
  java.util.List
      getMatchesOrBuilderList();
  /**
   *
   *
   *    * Match results, if more than one, ordered descendingly by the confidence
   * we have that the particular intent matches the query.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3beta1.Match matches = 4;
   */
  com.google.cloud.dialogflow.cx.v3beta1.MatchOrBuilder getMatchesOrBuilder(int index);

  /**
   *
   *
   *    * The current [Page][google.cloud.dialogflow.cx.v3beta1.Page]. Some, not all
   * fields are filled in this message, including but not limited to `name` and
   * `display_name`.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Page current_page = 5;
   *
   * @return Whether the currentPage field is set.
   */
  boolean hasCurrentPage();
  /**
   *
   *
   *    * The current [Page][google.cloud.dialogflow.cx.v3beta1.Page]. Some, not all
   * fields are filled in this message, including but not limited to `name` and
   * `display_name`.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Page current_page = 5;
   *
   * @return The currentPage.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Page getCurrentPage();
  /**
   *
   *
   *    * The current [Page][google.cloud.dialogflow.cx.v3beta1.Page]. Some, not all
   * fields are filled in this message, including but not limited to `name` and
   * `display_name`.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Page current_page = 5;
   */
  com.google.cloud.dialogflow.cx.v3beta1.PageOrBuilder getCurrentPageOrBuilder();

  com.google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse.QueryCase getQueryCase();
}