Google Cloud Dialogflow V2 Client - Class SuggestConversationSummaryRequest (1.17.2)

Version latest

• 1.17.2 (latest)
• 1.17.1
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.3
• 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 Optional. 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 Optional. 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	AssistQueryParameters Optional. 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

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

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

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

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

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

Returns
Type	Description
AssistQueryParameters|null

hasAssistQueryParams

clearAssistQueryParams

setAssistQueryParams

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

Parameter
Name	Description
var	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 ConversationsClient::conversationName() for help formatting this field.

Returns
Type	Description
SuggestConversationSummaryRequest