Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest (v1.5.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>.

#end_user_metadata

def end_user_metadata() -> ::Google::Protobuf::Struct

Returns

(::Google::Protobuf::Struct) — 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"} ] }

#end_user_metadata=

def end_user_metadata=(value) -> ::Google::Protobuf::Struct

Parameter

value (::Google::Protobuf::Struct) — 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"} ] }

Returns

(::Google::Protobuf::Struct) — 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"} ] }

#exact_search

def exact_search() -> ::Boolean

Returns

(::Boolean) — Optional. Whether to search the query exactly without query rewrite.

#exact_search=

def exact_search=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. Whether to search the query exactly without query rewrite.

Returns

(::Boolean) — Optional. Whether to search the query exactly without query rewrite.

#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

(::Google::Cloud::Dialogflow::V2::TextInput) — Required. The natural language text query for knowledge search.

#query=

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

Parameter

value (::Google::Cloud::Dialogflow::V2::TextInput) — Required. The natural language text query for knowledge search.

Returns

(::Google::Cloud::Dialogflow::V2::TextInput) — Required. The natural language text query for knowledge search.

#query_source

def query_source() -> ::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::QuerySource

Returns

(::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::QuerySource) — Optional. The source of the query in the request.

#query_source=

def query_source=(value) -> ::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::QuerySource

Parameter

value (::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::QuerySource) — Optional. The source of the query in the request.

Returns

(::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::QuerySource) — Optional. The source of the query in the request.

#search_config

def search_config() -> ::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig

Returns

(::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig) — Optional. Configuration specific to search queries with data stores.

#search_config=

def search_config=(value) -> ::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig) — Optional. Configuration specific to search queries with data stores.

Returns

(::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig) — Optional. Configuration specific to search queries with data stores.

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