Google Cloud Dialogflow V2 Client - Class SuggestArticlesRequest (1.15.1)

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

The request message for Participants.SuggestArticles.

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

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>.
↳ latest_message string

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

Optional. 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.
↳ assist_query_params Google\Cloud\Dialogflow\V2\AssistQueryParameters

Parameters for a human assist query.

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

getLatestMessage

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

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

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

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

getAssistQueryParams

Parameters for a human assist query.

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

hasAssistQueryParams

clearAssistQueryParams

setAssistQueryParams

Parameters for a human assist query.

Parameter
Name Description
var Google\Cloud\Dialogflow\V2\AssistQueryParameters
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\SuggestArticlesRequest