Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Tool (v1.13.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Tool.

Represents a tool.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#action_confirmation_requirement

def action_confirmation_requirement() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Tool::ConfirmationRequirement}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Tool::ConfirmationRequirement}) — Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

#action_confirmation_requirement=

def action_confirmation_requirement=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Tool::ConfirmationRequirement}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Tool::ConfirmationRequirement}) — Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Tool::ConfirmationRequirement}) — Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

#connector_spec

def connector_spec() -> ::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool
Returns
  • (::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool) — Integration connectors tool specification.

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

#connector_spec=

def connector_spec=(value) -> ::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool
Parameter
  • value (::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool) — Integration connectors tool specification.

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

Returns
  • (::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool) — Integration connectors tool specification.

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

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. A human readable description of the tool.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A human readable description of the tool.
Returns
  • (::String) — Optional. A human readable description of the tool.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. A human readable short name of the tool, to be shown on the UI.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. A human readable short name of the tool, to be shown on the UI.
Returns
  • (::String) — Optional. A human readable short name of the tool, to be shown on the UI.

#extension_spec

def extension_spec() -> ::Google::Cloud::Dialogflow::V2::Tool::ExtensionTool
Returns
  • (::Google::Cloud::Dialogflow::V2::Tool::ExtensionTool) — Vertex extension tool specification.

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

#extension_spec=

def extension_spec=(value) -> ::Google::Cloud::Dialogflow::V2::Tool::ExtensionTool
Parameter
  • value (::Google::Cloud::Dialogflow::V2::Tool::ExtensionTool) — Vertex extension tool specification.

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

Returns
  • (::Google::Cloud::Dialogflow::V2::Tool::ExtensionTool) — Vertex extension tool specification.

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

#function_spec

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

    Note: The following fields are mutually exclusive: function_spec, extension_spec, connector_spec, open_api_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::V2::Tool::FunctionTool
Parameter
  • value (::Google::Cloud::Dialogflow::V2::Tool::FunctionTool) — Client side executed function specification.

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

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

    Note: The following fields are mutually exclusive: function_spec, extension_spec, connector_spec, open_api_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) — Output only. Identifier. The resource name of the tool. Format: projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>.

#open_api_spec

def open_api_spec() -> ::Google::Cloud::Dialogflow::V2::Tool::OpenApiTool
Returns
  • (::Google::Cloud::Dialogflow::V2::Tool::OpenApiTool) — OpenAPI tool.

    Note: The following fields are mutually exclusive: open_api_spec, extension_spec, function_spec, connector_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::V2::Tool::OpenApiTool
Parameter
  • value (::Google::Cloud::Dialogflow::V2::Tool::OpenApiTool) — OpenAPI tool.

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

Returns
  • (::Google::Cloud::Dialogflow::V2::Tool::OpenApiTool) — OpenAPI tool.

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

#satisfies_pzi

def satisfies_pzi() -> ::Boolean
Returns
  • (::Boolean) — Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.

#tool_key

def tool_key() -> ::String
Returns
  • (::String) — Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.

#tool_key=

def tool_key=(value) -> ::String
Parameter
  • value (::String) — Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.
Returns
  • (::String) — Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns