Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class SuggestionInput.
Represents the action to take for a tool call that requires confirmation.
Generated from protobuf message google.cloud.dialogflow.v2.SuggestionInput
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ answer_record |
string
Required. Format: |
↳ parameters |
Google\Protobuf\Struct
Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters. |
↳ action |
int
Optional. The type of action to take with the tool. |
↳ send_time |
Google\Protobuf\Timestamp
Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified. |
getAnswerRecord
Required. Format: projects/<Project ID>/locations/<Location
ID>/answerRecords/<Answer Record ID>
The answer record associated with the tool call.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAnswerRecord
Required. Format: projects/<Project ID>/locations/<Location
ID>/answerRecords/<Answer Record ID>
The answer record associated with the tool call.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParameters
Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasParameters
clearParameters
setParameters
Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAction
Optional. The type of action to take with the tool.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Action. |
setAction
Optional. The type of action to take with the tool.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Action. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSendTime
Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasSendTime
clearSendTime
setSendTime
Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|