Class Tool (2.43.0) 

Tool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a tool.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
name str
Output only. Identifier. The resource name of the tool. Format: projects/.
tool_key str
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.
display_name str
Optional. A human readable short name of the tool, to be shown on the UI.
description str
Optional. A human readable description of the tool.
action_confirmation_requirement MutableMapping[str, google.cloud.dialogflow_v2beta1.types.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.
extension_spec google.cloud.dialogflow_v2beta1.types.Tool.ExtensionTool
Vertex extension tool specification. This field is a member of oneof_ specification.
function_spec google.cloud.dialogflow_v2beta1.types.Tool.FunctionTool
Client side executed function specification. This field is a member of oneof_ specification.
connector_spec google.cloud.dialogflow_v2beta1.types.Tool.ConnectorTool
Integration connectors tool specification. This field is a member of oneof_ specification.
open_api_spec google.cloud.dialogflow_v2beta1.types.Tool.OpenApiTool
OpenAPI tool. This field is a member of oneof_ specification.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Creation time of this tool.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Update time of this tool.
satisfies_pzs bool
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. This field is a member of oneof_ _satisfies_pzs.
satisfies_pzi bool
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. This field is a member of oneof_ _satisfies_pzi.

Classes

ActionConfirmationRequirementEntry

ActionConfirmationRequirementEntry(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Authentication

Authentication(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Authentication information required for API calls

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConfirmationRequirement

ConfirmationRequirement(value)

Types of confirmation requirement.

ConnectorTool

ConnectorTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A ConnectorTool enabling using Integration Connectors Connections as tools.

ExtensionTool

ExtensionTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An ExtensionTool is a way to use Vertex Extensions as a tool.

FunctionTool

FunctionTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Function tool describes the functions to be invoked on the client side.

MethodType

MethodType(value)

The method type of the function.

OpenApiTool

OpenApiTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ServiceDirectoryConfig

ServiceDirectoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for tools using Service Directory.

TLSConfig

TLSConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The TLS configuration.