Package com.google.cloud.dialogflow.v2

Class SearchKnowledgeRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.SearchKnowledgeRequest
All Implemented Interfaces:
SearchKnowledgeRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchKnowledgeRequest extends com.google.protobuf.GeneratedMessage implements SearchKnowledgeRequestOrBuilder
 The request message for
 [Conversations.SearchKnowledge][google.cloud.dialogflow.v2.Conversations.SearchKnowledge].
Protobuf type google.cloud.dialogflow.v2.SearchKnowledgeRequest
See Also:

  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • CONVERSATION_PROFILE_FIELD_NUMBER

      public static final int CONVERSATION_PROFILE_FIELD_NUMBER
      See Also:

    • SESSION_ID_FIELD_NUMBER

      public static final int SESSION_ID_FIELD_NUMBER
      See Also:

    • CONVERSATION_FIELD_NUMBER

      public static final int CONVERSATION_FIELD_NUMBER
      See Also:

    • LATEST_MESSAGE_FIELD_NUMBER

      public static final int LATEST_MESSAGE_FIELD_NUMBER
      See Also:

    • QUERY_SOURCE_FIELD_NUMBER

      public static final int QUERY_SOURCE_FIELD_NUMBER
      See Also:

    • END_USER_METADATA_FIELD_NUMBER

      public static final int END_USER_METADATA_FIELD_NUMBER
      See Also:

    • SEARCH_CONFIG_FIELD_NUMBER

      public static final int SEARCH_CONFIG_FIELD_NUMBER
      See Also:

    • EXACT_SEARCH_FIELD_NUMBER

      public static final int EXACT_SEARCH_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getParent

      public 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];
      Specified by:
      getParent in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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];
      Specified by:
      getParentBytes in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The bytes for parent.

    • hasQuery

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

    • getQuery

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

    • getQueryOrBuilder

      public TextInputOrBuilder getQueryOrBuilder()
       Required. The natural language text query for knowledge search.
      .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryOrBuilder in interface SearchKnowledgeRequestOrBuilder

    • getConversationProfile

      public 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) = { ... }
      Specified by:
      getConversationProfile in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The conversationProfile.

    • getConversationProfileBytes

      public 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) = { ... }
      Specified by:
      getConversationProfileBytes in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The bytes for conversationProfile.

    • getSessionId

      public 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];
      Specified by:
      getSessionId in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The sessionId.

    • getSessionIdBytes

      public 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];
      Specified by:
      getSessionIdBytes in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The bytes for sessionId.

    • getConversation

      public 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) = { ... }
      Specified by:
      getConversation in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The conversation.

    • getConversationBytes

      public 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) = { ... }
      Specified by:
      getConversationBytes in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The bytes for conversation.

    • getLatestMessage

      public 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) = { ... }
      Specified by:
      getLatestMessage in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The latestMessage.

    • getLatestMessageBytes

      public 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) = { ... }
      Specified by:
      getLatestMessageBytes in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The bytes for latestMessage.

    • getQuerySourceValue

      public 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];
      Specified by:
      getQuerySourceValue in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The enum numeric value on the wire for querySource.

    • getQuerySource

      public 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];
      Specified by:
      getQuerySource in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The querySource.

    • hasEndUserMetadata

      public 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];
      Specified by:
      hasEndUserMetadata in interface SearchKnowledgeRequestOrBuilder
      Returns:
      Whether the endUserMetadata field is set.

    • getEndUserMetadata

      public 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];
      Specified by:
      getEndUserMetadata in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The endUserMetadata.

    • getEndUserMetadataOrBuilder

      public 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];
      Specified by:
      getEndUserMetadataOrBuilder in interface SearchKnowledgeRequestOrBuilder

    • hasSearchConfig

      public 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];
      Specified by:
      hasSearchConfig in interface SearchKnowledgeRequestOrBuilder
      Returns:
      Whether the searchConfig field is set.

    • getSearchConfig

      public 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];
      Specified by:
      getSearchConfig in interface SearchKnowledgeRequestOrBuilder
      Returns:
      The searchConfig.

    • getSearchConfigOrBuilder

      public 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];
      Specified by:
      getSearchConfigOrBuilder in interface SearchKnowledgeRequestOrBuilder

    • getExactSearch

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchKnowledgeRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchKnowledgeRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchKnowledgeRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchKnowledgeRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchKnowledgeRequest.Builder newBuilder()

    • newBuilder

      public static SearchKnowledgeRequest.Builder newBuilder(SearchKnowledgeRequest prototype)

    • toBuilder

      public SearchKnowledgeRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchKnowledgeRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchKnowledgeRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchKnowledgeRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchKnowledgeRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchKnowledgeRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder