Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Tool.
A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Tool
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique identifier of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>
.
↳ display_name
string
Required. The human-readable name of the Tool, unique within an agent.
↳ description
string
Required. High level description of the Tool and its usage.
↳ open_api_spec
↳ data_store_spec
↳ function_spec
↳ tool_type
int
Output only. The tool type.
getName
The unique identifier of the Tool.
Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>
.
string
setName
The unique identifier of the Tool.
Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>
.
var
string
$this
getDisplayName
Required. The human-readable name of the Tool, unique within an agent.
string
setDisplayName
Required. The human-readable name of the Tool, unique within an agent.
var
string
$this
getDescription
Required. High level description of the Tool and its usage.
string
setDescription
Required. High level description of the Tool and its usage.
var
string
$this
getOpenApiSpec
OpenAPI specification of the Tool.
hasOpenApiSpec
setOpenApiSpec
OpenAPI specification of the Tool.
$this
getDataStoreSpec
Data store search tool specification.
hasDataStoreSpec
setDataStoreSpec
Data store search tool specification.
$this
getFunctionSpec
Client side executed function specification.
hasFunctionSpec
setFunctionSpec
Client side executed function specification.
$this
getToolType
Output only. The tool type.
setToolType
Output only. The tool type.
$this
getSpecification
string
