Required. The natural language text query for knowledge search.
conversationProfile
string
Required. The conversation profile used to configure the search. Format:projects/<Project ID>/locations/<Location
ID>/conversationProfiles/<Conversation Profile ID>.
sessionId
string
Required. The ID of the search session. The sessionId 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 appropriateSession ID. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.
conversation
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>.
latestMessage
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>.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis document outlines how to use the \u003ccode\u003esearchKnowledge\u003c/code\u003e method via a POST HTTP request to the specified endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter indicating the project location, and the body should contain data including a natural language text \u003ccode\u003equery\u003c/code\u003e, a \u003ccode\u003econversationProfile\u003c/code\u003e, and a \u003ccode\u003esessionId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSeveral fields are optional in the request body, such as \u003ccode\u003econversation\u003c/code\u003e, \u003ccode\u003elatestMessage\u003c/code\u003e, \u003ccode\u003equerySource\u003c/code\u003e, \u003ccode\u003eendUserMetadata\u003c/code\u003e, \u003ccode\u003esearchConfig\u003c/code\u003e, and \u003ccode\u003eexactSearch\u003c/code\u003e, providing flexibility in the data sent.\u003c/p\u003e\n"],["\u003cp\u003eA successful request will return a response body as an instance of \u003ccode\u003eSearchKnowledgeResponse\u003c/code\u003e, and authorization requires one of two specified OAuth scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe URL uses gRPC Transcoding syntax and will be directed to one of the supported service endpoints.\u003c/p\u003e\n"]]],[],null,["# Method: projects.suggestions.searchKnowledge\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGet answers for the given query based on knowledge documents.\n\n### HTTP request\n\n`POST https://{endpoint}/v2/{parent=projects/*}/suggestions:searchKnowledge`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/dialogflow/es/docs/reference/rest#rest_endpoints).\n\nThe URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [SearchKnowledgeResponse](/dialogflow/es/docs/reference/rest/v2/SearchKnowledgeResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/dialogflow`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
