Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/representations.rb

Overview

The request message for Conversations.SearchKnowledge.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2SearchKnowledgeRequest

Returns a new instance of GoogleCloudDialogflowV2SearchKnowledgeRequest.



14784
14785
14786
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14784

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#conversation ⇒ String

Optional. The conversation (between human agent and end user) where the search request is triggered. Format: projects//locations//conversations/. Corresponds to the JSON property conversation

Returns:

  • (String) 


14723
14724
14725
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14723

def conversation
  @conversation
end

#conversation_profile ⇒ String

Required. The conversation profile used to configure the search. Format: projects//locations//conversationProfiles/. Corresponds to the JSON property conversationProfile

Returns:

  • (String) 


14729
14730
14731
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14729

def conversation_profile
  @conversation_profile
end

#end_user_metadata ⇒ Hash<String,Object>

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"` ] ` Corresponds to the JSON property endUserMetadata

Returns:

  • (Hash<String,Object>) 


14739
14740
14741
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14739

def end_user_metadata
  @end_user_metadata
end

#exact_search ⇒ Boolean Also known as: exact_search?

Optional. Whether to search the query exactly without query rewrite. Corresponds to the JSON property exactSearch

Returns:

  • (Boolean) 


14744
14745
14746
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14744

def exact_search
  @exact_search
end

#latest_message ⇒ String

Optional. The name of the latest conversation message when the request is triggered. Format: projects//locations//conversations//messages/. Corresponds to the JSON property latestMessage

Returns:

  • (String) 


14751
14752
14753
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14751

def latest_message
  @latest_message
end

#parent ⇒ String

Required. The parent resource contains the conversation profile Format: ' projects/' or projects//locations/. Corresponds to the JSON property parent

Returns:

  • (String) 


14757
14758
14759
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14757

def parent
  @parent
end

#query ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput

Auxiliary proto messages. Represents the natural language text to be processed. Corresponds to the JSON property query

Returns:



14762
14763
14764
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14762

def query
  @query
end

#query_source ⇒ String

Optional. The source of the query in the request. Corresponds to the JSON property querySource

Returns:

  • (String) 


14767
14768
14769
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14767

def query_source
  @query_source
end

#search_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig

Configuration specific to search queries with data stores. Corresponds to the JSON property searchConfig

Returns:



14772
14773
14774
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14772

def search_config
  @search_config
end

#session_id ⇒ String

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. Corresponds to the JSON property sessionId

Returns:

  • (String) 


14782
14783
14784
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14782

def session_id
  @session_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14789

def update!(**args)
  @conversation = args[:conversation] if args.key?(:conversation)
  @conversation_profile = args[:conversation_profile] if args.key?(:conversation_profile)
  @end_user_metadata = args[:end_user_metadata] if args.key?(:end_user_metadata)
  @exact_search = args[:exact_search] if args.key?(:exact_search)
  @latest_message = args[:latest_message] if args.key?(:latest_message)
  @parent = args[:parent] if args.key?(:parent)
  @query = args[:query] if args.key?(:query)
  @query_source = args[:query_source] if args.key?(:query_source)
  @search_config = args[:search_config] if args.key?(:search_config)
  @session_id = args[:session_id] if args.key?(:session_id)
end