Google Cloud Dialogflow V2 Client - Class SuggestFaqAnswersRequest (1.6.0)

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

The request message for Participants.SuggestFaqAnswers.

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

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

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

getAssistQueryParams

Parameters for a human assist query.

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

hasAssistQueryParams

clearAssistQueryParams

setAssistQueryParams

Parameters for a human assist query.

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

static::build

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