com.google.cloud.dialogflow.v2.SearchKnowledgeRequestOrBuilder 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/conversation.proto

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

public interface SearchKnowledgeRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.SearchKnowledgeRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The parent resource contains the conversation profile
   * Format: 'projects/<Project ID>' or `projects/<Project
   * ID>/locations/<Location ID>`.
   * 
   *
   * string parent = 6 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. The parent resource contains the conversation profile
   * Format: 'projects/<Project ID>' or `projects/<Project
   * ID>/locations/<Location ID>`.
   * 
   *
   * string parent = 6 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Required. The natural language text query for knowledge search.
   * 
   *
   * 
   * .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the query field is set.
   */
  boolean hasQuery();
  /**
   *
   *
   *    * Required. The natural language text query for knowledge search.
   * 
   *
   * 
   * .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The query.
   */
  com.google.cloud.dialogflow.v2.TextInput getQuery();
  /**
   *
   *
   *    * Required. The natural language text query for knowledge search.
   * 
   *
   * 
   * .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.dialogflow.v2.TextInputOrBuilder getQueryOrBuilder();

  /**
   *
   *
   *    * Required. The conversation profile used to configure the search.
   * Format: `projects/<Project ID>/locations/<Location
   * ID>/conversationProfiles/<Conversation Profile ID>`.
   * 
   *
   * 
   * string conversation_profile = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The conversationProfile.
   */
  java.lang.String getConversationProfile();
  /**
   *
   *
   *    * Required. The conversation profile used to configure the search.
   * Format: `projects/<Project ID>/locations/<Location
   * ID>/conversationProfiles/<Conversation Profile ID>`.
   * 
   *
   * 
   * string conversation_profile = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for conversationProfile.
   */
  com.google.protobuf.ByteString getConversationProfileBytes();

  /**
   *
   *
   *    * Required. The ID of the search session.
   * The session_id can be combined with Dialogflow V3 Agent ID retrieved from
   * conversation profile or on its own to identify a search session. The search
   * history of the same session will impact the search result. It's up to the
   * API caller to choose an appropriate `Session ID`. It can be a random number
   * or some type of session identifiers (preferably hashed). The length must
   * not exceed 36 characters.
   * 
   *
   * string session_id = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The sessionId.
   */
  java.lang.String getSessionId();
  /**
   *
   *
   *    * Required. The ID of the search session.
   * The session_id can be combined with Dialogflow V3 Agent ID retrieved from
   * conversation profile or on its own to identify a search session. The search
   * history of the same session will impact the search result. It's up to the
   * API caller to choose an appropriate `Session ID`. It can be a random number
   * or some type of session identifiers (preferably hashed). The length must
   * not exceed 36 characters.
   * 
   *
   * string session_id = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for sessionId.
   */
  com.google.protobuf.ByteString getSessionIdBytes();

  /**
   *
   *
   *    * Optional. The conversation (between human agent and end user) where the
   * search request is triggered. Format: `projects/<Project
   * ID>/locations/<Location ID>/conversations/<Conversation ID>`.
   * 
   *
   * 
   * string conversation = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The conversation.
   */
  java.lang.String getConversation();
  /**
   *
   *
   *    * Optional. The conversation (between human agent and end user) where the
   * search request is triggered. Format: `projects/<Project
   * ID>/locations/<Location ID>/conversations/<Conversation ID>`.
   * 
   *
   * 
   * string conversation = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for conversation.
   */
  com.google.protobuf.ByteString getConversationBytes();

  /**
   *
   *
   *    * Optional. The name of the latest conversation message when the request is
   * triggered.
   * Format: `projects/<Project ID>/locations/<Location
   * ID>/conversations/<Conversation ID>/messages/<Message ID>`.
   * 
   *
   * 
   * string latest_message = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The latestMessage.
   */
  java.lang.String getLatestMessage();
  /**
   *
   *
   *    * Optional. The name of the latest conversation message when the request is
   * triggered.
   * Format: `projects/<Project ID>/locations/<Location
   * ID>/conversations/<Conversation ID>/messages/<Message ID>`.
   * 
   *
   * 
   * string latest_message = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for latestMessage.
   */
  com.google.protobuf.ByteString getLatestMessageBytes();
}