Tool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
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.
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
The unique identifier of the Tool. Format: projects/ .
|
display_name |
str
Required. The human-readable name of the Tool, unique within an agent. |
description |
str
Required. High level description of the Tool and its usage. |
actions |
MutableSequence[str]
The list of derived action names for the tool. |
schemas |
MutableSequence[str]
The list of derived type schemas for the tool. |
open_api_spec |
google.cloud.dialogflowcx_v3beta1.types.Tool.OpenApiTool
OpenAPI specification of the Tool. This field is a member of oneof _ specification .
|
data_store_spec |
google.cloud.dialogflowcx_v3beta1.types.Tool.DataStoreTool
Data store search tool specification. This field is a member of oneof _ specification .
|
extension_spec |
google.cloud.dialogflowcx_v3beta1.types.Tool.ExtensionTool
Vertex extension tool specification. This field is a member of oneof _ specification .
|
function_spec |
google.cloud.dialogflowcx_v3beta1.types.Tool.FunctionTool
Client side executed function specification. This field is a member of oneof _ specification .
|
tool_type |
google.cloud.dialogflowcx_v3beta1.types.Tool.ToolType
Output only. The tool type. |
Classes
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
DataStoreTool
DataStoreTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A DataStoreTool is a way to provide specifications needed to search a list of data stores.
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.
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
TLSConfig
TLSConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The TLS configuration.
ToolType
ToolType(value)
Represents the type of the tool.
Values: TOOL_TYPE_UNSPECIFIED (0): Default value. This value is unused. CUSTOMIZED_TOOL (1): Customer provided tool. BUILTIN_TOOL (2): First party built-in tool created by Dialogflow which cannot be modified.