Class: Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/conversation.rb

Overview

The request message for Conversations.SearchKnowledge.

Instance Attribute Summary collapse

Instance Attribute Details

#conversation ⇒ ::String

Returns 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>.



499
500
501
502
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 499

class SearchKnowledgeRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#conversation_profile ⇒ ::String

Returns 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>.



499
500
501
502
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 499

class SearchKnowledgeRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#latest_message ⇒ ::String

Returns 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>.



499
500
501
502
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 499

class SearchKnowledgeRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The parent resource contains the conversation profile Format: 'projects/' or projects/<Project ID>/locations/<Location ID>.

Returns:

  • (::String) —

    Required. The parent resource contains the conversation profile Format: 'projects/' or projects/<Project ID>/locations/<Location ID>.



499
500
501
502
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 499

class SearchKnowledgeRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::Google::Cloud::Dialogflow::V2::TextInput

Returns Required. The natural language text query for knowledge search.

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 499

class SearchKnowledgeRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#session_id ⇒ ::String

Returns 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.



499
500
501
502
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 499

class SearchKnowledgeRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end