Google Cloud Dialogflow V2 Client - Class SuggestSmartRepliesRequest (1.5.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class SuggestSmartRepliesRequest.

The request message for Participants.SuggestSmartReplies.

Generated from protobuf message google.cloud.dialogflow.v2.SuggestSmartRepliesRequest

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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>`.
`↳ current_text_input`	`Google\Cloud\Dialogflow\V2\TextInput` The current natural language text segment to compile suggestion for. This provides a way for user to get follow up smart reply suggestion after a smart reply selection, without sending a text message.
`↳ latest_message`	`string` 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>`.
`↳ context_size`	`int` Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.

getParent

Required. The name of the participant to fetch suggestion for.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns
Type	Description
`string`

setParent

Required. The name of the participant to fetch suggestion for.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCurrentTextInput

The current natural language text segment to compile suggestion for. This provides a way for user to get follow up smart reply suggestion after a smart reply selection, without sending a text message.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\TextInput\|null`

hasCurrentTextInput

clearCurrentTextInput

setCurrentTextInput

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\TextInput`

Returns
Type	Description
`$this`

getLatestMessage

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>.

Returns
Type	Description
`string`

setLatestMessage

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>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getContextSize

Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.

Returns
Type	Description
`int`

setContextSize

Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`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>`. Please see Google\Cloud\Dialogflow\V2\ParticipantsClient::participantName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\SuggestSmartRepliesRequest`