Package com.google.cloud.dialogflow.v2

Interface SearchKnowledgeRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SearchKnowledgeRequest, SearchKnowledgeRequest.Builder
    public interface SearchKnowledgeRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getConversation()
      The conversation (between human agent and end user) where the search request is triggered.
      com.google.protobuf.ByteString getConversationBytes()
      The conversation (between human agent and end user) where the search request is triggered.
      String getConversationProfile()
      Required.
      com.google.protobuf.ByteString getConversationProfileBytes()
      Required.
      String getLatestMessage()
      The name of the latest conversation message when the request is triggered.
      com.google.protobuf.ByteString getLatestMessageBytes()
      The name of the latest conversation message when the request is triggered.
      String getParent()
      The parent resource contains the conversation profile Format: 'projects/<Project ID>' or `projects/<Project ID>/locations/<Location ID>`.
      com.google.protobuf.ByteString getParentBytes()
      The parent resource contains the conversation profile Format: 'projects/<Project ID>' or `projects/<Project ID>/locations/<Location ID>`.
      TextInput getQuery()
      Required.
      TextInputOrBuilder getQueryOrBuilder()
      Required.
      String getSessionId()
      The ID of the search session.
      com.google.protobuf.ByteString getSessionIdBytes()
      The ID of the search session.
      boolean hasQuery()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         The parent resource contains the conversation profile
 Format: 'projects/<Project ID>' or `projects/<Project
 ID>/locations/<Location ID>`.
        string parent = 6;
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         The parent resource contains the conversation profile
 Format: 'projects/<Project ID>' or `projects/<Project
 ID>/locations/<Location ID>`.
        string parent = 6;
        Returns:
        The bytes for parent.

      • hasQuery

        boolean hasQuery()
         Required. The natural language text query for knowledge search.
        .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the query field is set.

      • getQuery

        TextInput getQuery()
         Required. The natural language text query for knowledge search.
        .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The query.

      • getQueryOrBuilder

        TextInputOrBuilder getQueryOrBuilder()
         Required. The natural language text query for knowledge search.
        .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];

      • getConversationProfile

        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) = { ... }
        Returns:
        The conversationProfile.

      • getConversationProfileBytes

        com.google.protobuf.ByteString getConversationProfileBytes()
         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) = { ... }
        Returns:
        The bytes for conversationProfile.

      • getSessionId

        String getSessionId()
         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;
        Returns:
        The sessionId.

      • getSessionIdBytes

        com.google.protobuf.ByteString getSessionIdBytes()
         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;
        Returns:
        The bytes for sessionId.

      • getConversation

        String getConversation()
         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.resource_reference) = { ... }
        Returns:
        The conversation.

      • getConversationBytes

        com.google.protobuf.ByteString getConversationBytes()
         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.resource_reference) = { ... }
        Returns:
        The bytes for conversation.

      • getLatestMessage

        String getLatestMessage()
         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.resource_reference) = { ... }
        Returns:
        The latestMessage.

      • getLatestMessageBytes

        com.google.protobuf.ByteString getLatestMessageBytes()
         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.resource_reference) = { ... }
        Returns:
        The bytes for latestMessage.