Method: projects.conversations.participants.suggestions.suggestFaqAnswers

Gets suggested faq answers for a participant based on specific historical messages.

HTTP request

POST https://{endpoint}/v2/{parent=projects/*/conversations/*/participants/*}/suggestions:suggestFaqAnswers

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 suggestion 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,
  "assistQueryParams": {
    object (AssistQueryParameters)
  }
}
Fields
latestMessage

string

Optional. The name of the latest conversation message to compile suggestion 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. By default 20 and at most 50.

assistQueryParams

object (AssistQueryParameters)

Parameters for a human assist query.

Response body

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

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.