Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Tool (v1.11.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#data_store_spec

def data_store_spec() -> ::Google::Cloud::Dialogflow::CX::V3::Tool::DataStoreTool
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::Tool::DataStoreTool) — Data store search tool specification.

    Note: The following fields are mutually exclusive: data_store_spec, open_api_spec, function_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_store_spec=

def data_store_spec=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Tool::DataStoreTool
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::Tool::DataStoreTool) — Data store search tool specification.

    Note: The following fields are mutually exclusive: data_store_spec, open_api_spec, function_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::CX::V3::Tool::DataStoreTool) — Data store search tool specification.

    Note: The following fields are mutually exclusive: data_store_spec, open_api_spec, function_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#description

def description() -> ::String
Returns
  • (::String) — Required. High level description of the Tool and its usage.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Required. High level description of the Tool and its usage.
Returns
  • (::String) — Required. High level description of the Tool and its usage.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The human-readable name of the Tool, unique within an agent.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The human-readable name of the Tool, unique within an agent.
Returns
  • (::String) — Required. The human-readable name of the Tool, unique within an agent.

#function_spec

def function_spec() -> ::Google::Cloud::Dialogflow::CX::V3::Tool::FunctionTool
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::Tool::FunctionTool) — Client side executed function specification.

    Note: The following fields are mutually exclusive: function_spec, open_api_spec, data_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#function_spec=

def function_spec=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Tool::FunctionTool
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::Tool::FunctionTool) — Client side executed function specification.

    Note: The following fields are mutually exclusive: function_spec, open_api_spec, data_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::CX::V3::Tool::FunctionTool) — Client side executed function specification.

    Note: The following fields are mutually exclusive: function_spec, open_api_spec, data_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String
Returns
  • (::String) — The unique identifier of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique identifier of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
Returns
  • (::String) — The unique identifier of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

#open_api_spec

def open_api_spec() -> ::Google::Cloud::Dialogflow::CX::V3::Tool::OpenApiTool
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::Tool::OpenApiTool) — OpenAPI specification of the Tool.

    Note: The following fields are mutually exclusive: open_api_spec, data_store_spec, function_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#open_api_spec=

def open_api_spec=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Tool::OpenApiTool
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::Tool::OpenApiTool) — OpenAPI specification of the Tool.

    Note: The following fields are mutually exclusive: open_api_spec, data_store_spec, function_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::CX::V3::Tool::OpenApiTool) — OpenAPI specification of the Tool.

    Note: The following fields are mutually exclusive: open_api_spec, data_store_spec, function_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool_type

def tool_type() -> ::Google::Cloud::Dialogflow::CX::V3::Tool::ToolType
Returns