Method: projects.conversations.participants.suggestions.compile

Deprecated. use suggestions.suggestArticles and suggestions.suggestFaqAnswers instead.

Gets suggestions for a participant based on specific historical messages.

Note that suggestions.list will only list the auto-generated suggestions, while suggestions.compile will try to compile suggestion based on the provided conversation context in the real time.

HTTP request

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

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
}
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. If zero or less than zero, 20 is used.

Response body

The response message for Participants.CompileSuggestion.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "suggestion": {
    object (Suggestion)
  },
  "latestMessage": string,
  "contextSize": integer
}
Fields
suggestion

object (Suggestion)

The compiled suggestion.
latestMessage

string

The name of the latest conversation message used to compile suggestion for.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.
contextSize

integer

Number of messages prior to and including latestMessage to compile the suggestion. It may be smaller than the CompileSuggestionRequest.context_size field in the request if there aren't that many messages in the conversation.

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.