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.



14829
14830
14831
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14829

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

Instance Attribute Details

#conversation ⇒ String

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) 


14794
14795
14796
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14794

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) 


14800
14801
14802
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14800

def conversation_profile
  @conversation_profile
end

#latest_message ⇒ String

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) 


14806
14807
14808
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14806

def latest_message
  @latest_message
end

#parent ⇒ String

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

Returns:

  • (String) 


14812
14813
14814
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14812

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:



14817
14818
14819
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14817

def query
  @query
end

#session_id ⇒ String

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) 


14827
14828
14829
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14827

def session_id
  @session_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14834
14835
14836
14837
14838
14839
14840
14841
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 14834

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