Google Cloud Dialogflow V2 Client - Class ToolCall (2.3.0)

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

Represents a call of a specific tool's action with the specified inputs.

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

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ tool
string

Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID> .

↳ tool_display_name
string

Optional. A human readable short name of the tool, to be shown on the UI.

↳ tool_display_details
string

Optional. A human readable description of the tool.

↳ action
string

Optional. The name of the tool's action associated with this call.

↳ input_parameters
Google\Protobuf\Struct

Optional. The action's input parameters.

↳ create_time
Google\Protobuf\Timestamp

Output only. Create time of the tool call.

↳ answer_record
string

Optional. The answer record associated with this tool call.

↳ state
int

Output only. State of the tool call.

getTool

Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID> .

Returns
Type
Description
string

hasTool

setTool

Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getToolDisplayName

Optional. A human readable short name of the tool, to be shown on the UI.

Returns
Type
Description
string

setToolDisplayName

Optional. A human readable short name of the tool, to be shown on the UI.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getToolDisplayDetails

Optional. A human readable description of the tool.

Returns
Type
Description
string

setToolDisplayDetails

Optional. A human readable description of the tool.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAction

Optional. The name of the tool's action associated with this call.

Returns
Type
Description
string

setAction

Optional. The name of the tool's action associated with this call.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInputParameters

Optional. The action's input parameters.

Returns
Type
Description

hasInputParameters

clearInputParameters

setInputParameters

Optional. The action's input parameters.

Parameter
Name
Description
Returns
Type
Description
$this

getCreateTime

Output only. Create time of the tool call.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create time of the tool call.

Parameter
Name
Description
Returns
Type
Description
$this

getAnswerRecord

Optional. The answer record associated with this tool call.

Returns
Type
Description
string

setAnswerRecord

Optional. The answer record associated with this tool call.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. State of the tool call.

Returns
Type
Description
int
Enum of type State .

setState

Output only. State of the tool call.

Parameter
Name
Description
var
int

Enum of type State .

Returns
Type
Description
$this

getSource

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: