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
@Generated public interface SearchKnowledgeRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParent

      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];
      Returns:
      The parent.

    • getParentBytes

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

    • getSessionIdBytes

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

    • getConversation

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

    • getConversationBytes

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

    • getLatestMessage

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

    • getLatestMessageBytes

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

    • getQuerySourceValue

      int getQuerySourceValue()
       Optional. The source of the query in the request.
      .google.cloud.dialogflow.v2.SearchKnowledgeRequest.QuerySource query_source = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for querySource.

    • getQuerySource

      SearchKnowledgeRequest.QuerySource getQuerySource()
       Optional. The source of the query in the request.
      .google.cloud.dialogflow.v2.SearchKnowledgeRequest.QuerySource query_source = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The querySource.

    • hasEndUserMetadata

      boolean hasEndUserMetadata()
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the endUserMetadata field is set.

    • getEndUserMetadata

      com.google.protobuf.Struct getEndUserMetadata()
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The endUserMetadata.

    • getEndUserMetadataOrBuilder

      com.google.protobuf.StructOrBuilder getEndUserMetadataOrBuilder()
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 9 [(.google.api.field_behavior) = OPTIONAL];

    • hasSearchConfig

      boolean hasSearchConfig()
       Optional. Configuration specific to search queries with data stores.
      .google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig search_config = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the searchConfig field is set.

    • getSearchConfig

      SearchKnowledgeRequest.SearchConfig getSearchConfig()
       Optional. Configuration specific to search queries with data stores.
      .google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig search_config = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The searchConfig.

    • getSearchConfigOrBuilder

      SearchKnowledgeRequest.SearchConfigOrBuilder getSearchConfigOrBuilder()
       Optional. Configuration specific to search queries with data stores.
      .google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig search_config = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getExactSearch

      boolean getExactSearch()
       Optional. Whether to search the query exactly without query rewrite.
      bool exact_search = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The exactSearch.