Get answers for the given query based on knowledge documents.
HTTP request
POST https://{endpoint}/v2/{parent=projects/*/locations/*}/suggestions:searchKnowledge
Where {endpoint}
is one of the supported service endpoints.
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent resource contains the conversation profile Format: 'projects/ |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"query": {
object ( |
Fields | |
---|---|
query |
Required. The natural language text query for knowledge search. |
conversationProfile |
Required. The conversation profile used to configure the search. Format: |
sessionId |
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 appropriate |
conversation |
Optional. The conversation (between human agent and end user) where the search request is triggered. Format: |
latestMessage |
Optional. The name of the latest conversation message when the request is triggered. Format: |
Response body
If successful, the response body contains an instance of SearchKnowledgeResponse
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/dialogflow
For more information, see the Authentication Overview.