Method: projects.locations.conversations.participants.suggestions.suggestKnowledgeAssist

Gets knowledge assist suggestions based on historical messages.

HTTP request

POST https://{endpoint}/v2beta1/{parent=projects/*/locations/*/conversations/*/participants/*}/suggestions:suggestKnowledgeAssist

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the participant to fetch suggestions for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.suggestions.list

Request body

The request body contains data with the following structure:

JSON representation 
{
  "latestMessage": string,
  "contextSize": integer,
  "previousSuggestedQuery": string
}
Fields
latestMessage

string

Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.
contextSize

integer

Optional. Max number of messages prior to and including latestMessage to use as context when compiling the suggestion. The context size is by default 100 and at most 100.
previousSuggestedQuery

string

Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation.

Response body

If successful, the response body contains an instance of SuggestKnowledgeAssistResponse.

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.