Class SearchKnowledgeRequest (2.36.0) 

SearchKnowledgeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for Conversations.SearchKnowledge.

Attributes
Name Description
parent str
Required. The parent resource contains the conversation profile Format: 'projects/' or projects/.
query google.cloud.dialogflow_v2.types.TextInput
Required. The natural language text query for knowledge search.
conversation_profile str
Required. The conversation profile used to configure the search. Format: projects/.
session_id str
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.
conversation str
Optional. The conversation (between human agent and end user) where the search request is triggered. Format: projects/.
latest_message str
Optional. The name of the latest conversation message when the request is triggered. Format: projects/.
query_source google.cloud.dialogflow_v2.types.SearchKnowledgeRequest.QuerySource
Optional. The source of the query in the request.
end_user_metadata google.protobuf.struct_pb2.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: .. code:: json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] }
search_config google.cloud.dialogflow_v2.types.SearchKnowledgeRequest.SearchConfig
Optional. Configuration specific to search queries with data stores.
exact_search bool
Optional. Whether to search the query exactly without query rewrite.

Classes

QuerySource

QuerySource(value)

The source of the query. We use QuerySource to distinguish queries directly entered by agents and suggested queries from Participants.SuggestKnowledgeAssist. If SUGGESTED_QUERY source is specified, we will treat it as a continuation of a SuggestKnowledgeAssist call.

SearchConfig

SearchConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration specific to search queries with data stores.