Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest (v1.1.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest.

The request message for Conversations.SearchKnowledge.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#conversation

def conversation() -> ::String
Returns
  • (::String) — 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>.

#conversation=

def conversation=(value) -> ::String
Parameter
  • value (::String) — 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>.
Returns
  • (::String) — 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>.

#conversation_profile

def conversation_profile() -> ::String
Returns
  • (::String) — Required. The conversation profile used to configure the search. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

#conversation_profile=

def conversation_profile=(value) -> ::String
Parameter
  • value (::String) — Required. The conversation profile used to configure the search. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.
Returns
  • (::String) — Required. The conversation profile used to configure the search. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

#latest_message

def latest_message() -> ::String
Returns
  • (::String) — 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>.

#latest_message=

def latest_message=(value) -> ::String
Parameter
  • value (::String) — 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>.
Returns
  • (::String) — 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>.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent resource contains the conversation profile Format: 'projects/

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent resource contains the conversation profile Format: 'projects/
Returns
  • (::String) — Required. The parent resource contains the conversation profile Format: 'projects/

#query

def query() -> ::Google::Cloud::Dialogflow::V2::TextInput
Returns

#query=

def query=(value) -> ::Google::Cloud::Dialogflow::V2::TextInput
Parameter
Returns

#session_id

def session_id() -> ::String
Returns
  • (::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.

#session_id=

def session_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.