Google Cloud Dialogflow V2 Client - Class SuggestConversationSummaryRequest (1.6.0)

Version 1.6.0

• 1.12.2 (latest)
• 1.12.1
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.0
• 1.7.2
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.1

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

The request message for Conversations.SuggestConversationSummary.

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

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ conversation	string Required. The conversation to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.
↳ latest_message	string The name of the latest conversation message used as context for compiling suggestion. If empty, the latest message of the conversation will be used. 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 500 and at most 1000.
↳ assist_query_params	Google\Cloud\Dialogflow\V2\AssistQueryParameters Parameters for a human assist query. Only used for POC/demo purpose.

getConversation

Required. The conversation to fetch suggestion for.

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

Returns
Type	Description
string

setConversation

Required. The conversation to fetch suggestion for.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLatestMessage

The name of the latest conversation message used as context for compiling suggestion. If empty, the latest message of the conversation will be used.

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 used as context for compiling suggestion. If empty, the latest message of the conversation will be used.

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 500 and at most 1000.

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 500 and at most 1000.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getAssistQueryParams

Parameters for a human assist query. Only used for POC/demo purpose.

Returns
Type	Description
Google\Cloud\Dialogflow\V2\AssistQueryParameters|null

hasAssistQueryParams

clearAssistQueryParams

setAssistQueryParams

Parameters for a human assist query. Only used for POC/demo purpose.

Parameter
Name	Description
var	Google\Cloud\Dialogflow\V2\AssistQueryParameters

Returns
Type	Description
$this

static::build

Parameter
Name	Description
conversation	string Required. The conversation to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>. Please see Google\Cloud\Dialogflow\V2\ConversationsClient::conversationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Dialogflow\V2\SuggestConversationSummaryRequest