Google Cloud Dialogflow V2 Client - Class SuggestConversationSummaryRequest (1.6.0)

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
NameDescription
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
TypeDescription
string

setConversation

Required. The conversation to fetch suggestion for.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getAssistQueryParams

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

Returns
TypeDescription
Google\Cloud\Dialogflow\V2\AssistQueryParameters|null

hasAssistQueryParams

clearAssistQueryParams

setAssistQueryParams

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

Parameter
NameDescription
var Google\Cloud\Dialogflow\V2\AssistQueryParameters
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\Dialogflow\V2\SuggestConversationSummaryRequest