Method: projects.conversations.participants.suggestions.list

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01.

Retrieves suggestions for live agents.

This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the nextPageToken field to fetch the next batch of suggestions. suggestions are sorted by createTime in descending order. To fetch latest suggestion, just set pageSize to 1. To fetch new suggestions without duplication, send request with filter create_time_epoch_microseconds > [first item's createTime of previous request] and empty pageToken.

HTTP request

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

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

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return in a single page. The default value is 100; the maximum value is 1000.

pageToken

string

Optional. The nextPageToken value returned from a previous list request.

filter

string

Optional. Filter on suggestions fields. Currently predicates on createTime and create_time_epoch_microseconds are supported. createTime only support milliseconds accuracy. E.g., create_time_epoch_microseconds > 1551790877964485 or createTime > "2017-01-15T01:30:15.01Z"

For more information about filtering, see API Filtering.

Request body

The request body must be empty.

Response body

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

The response message for Participants.ListSuggestions.

JSON representation
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "nextPageToken": string
}
Fields
suggestions[]

object (Suggestion)

Required. The list of suggestions. There will be a maximum number of items returned based on the pageSize field in the request. suggestions is sorted by createTime in descending order.

nextPageToken

string

Optional. Token to retrieve the next page of results or empty if there are no more results in the list.

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.