Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class GenerateCompanionSuggestionsResponse.
Represents the response message for GenerateCompanionSuggestions.
Generated from protobuf message google.cloud.dialogflow.v2.GenerateCompanionSuggestionsResponse
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ companion_suggestion |
CompanionSuggestion
Contains the core suggestion generated by the Companion Agent. |
↳ answer_record |
string
Answer record that uniquely identifies the suggestion. Format: |
↳ latest_message |
string
The name of the latest conversation message used to compile suggestion for. Format: |
↳ suggestion_index |
int
Output only. The 1-based sequential index of the suggestion generated in this session. |
getCompanionSuggestion
Contains the core suggestion generated by the Companion Agent.
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion|null |
|
hasCompanionSuggestion
clearCompanionSuggestion
setCompanionSuggestion
Contains the core suggestion generated by the Companion Agent.
| Parameter | |
|---|---|
| Name | Description |
var |
CompanionSuggestion
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnswerRecord
Answer record that uniquely identifies the suggestion.
Format: projects/<Project ID>/locations/<Location
ID>/answerRecords/<Answer Record ID>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAnswerRecord
Answer record that uniquely identifies the suggestion.
Format: projects/<Project ID>/locations/<Location
ID>/answerRecords/<Answer Record ID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 |
|
getSuggestionIndex
Output only. The 1-based sequential index of the suggestion generated in this session.
| Returns | |
|---|---|
| Type | Description |
int |
|
setSuggestionIndex
Output only. The 1-based sequential index of the suggestion generated in this session.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|