Google Cloud Dialogflow V2 Client - Class SuggestKnowledgeAssistResponse (2.5.0)

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

The response message for Participants.SuggestKnowledgeAssist.

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

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ knowledge_assist_answer KnowledgeAssistAnswer

Output only. Knowledge Assist suggestion.

↳ latest_message string

The name of the latest conversation message used to compile suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

↳ context_size int

Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.

↳ additional_suggested_query_results array<KnowledgeAssistAnswer\AdditionalSuggestedQueryResult>

Optional. The list of additional suggested queries based on the context. This is used for the cases when we want to generate multiple queries for a single request.

getKnowledgeAssistAnswer

Output only. Knowledge Assist suggestion.

Returns
Type Description
KnowledgeAssistAnswer|null

hasKnowledgeAssistAnswer

clearKnowledgeAssistAnswer

setKnowledgeAssistAnswer

Output only. Knowledge Assist suggestion.

Parameter
Name Description
var KnowledgeAssistAnswer
Returns
Type Description
$this

getLatestMessage

The name of the latest conversation message used to compile suggestion for.

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 to compile suggestion for.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getContextSize

Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.

Returns
Type Description
int

setContextSize

Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.

Parameter
Name Description
var int
Returns
Type Description
$this

getAdditionalSuggestedQueryResults

Optional. The list of additional suggested queries based on the context.

This is used for the cases when we want to generate multiple queries for a single request.

Returns
Type Description
Google\Protobuf\RepeatedField<KnowledgeAssistAnswer\AdditionalSuggestedQueryResult>

setAdditionalSuggestedQueryResults

Optional. The list of additional suggested queries based on the context.

This is used for the cases when we want to generate multiple queries for a single request.

Parameter
Name Description
var array<KnowledgeAssistAnswer\AdditionalSuggestedQueryResult>
Returns
Type Description
$this