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.
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.
End-user authentication configuration used for Connection calls. The
field values can either be hardcoded authentication values or the
names of session
parameters <https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref>
or request
parameters <https://cloud.google.com/dialogflow/cx/docs/concept/parameter#request-scoped>.
If parameter names are provided, then those parameters can be used
to pass the authentication values dynamically, through
$session.params.param-id or $request.payload.param-id.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class Tool (1.42.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.42.0 (latest)](/python/docs/reference/dialogflow-cx/latest/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3beta1.types.Tool)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3beta1.types.Tool) \n\n Tool(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA tool provides a list of actions which are available to the\nPlaybook to attain\nits goal. A Tool consists of a description of the tool's usage and a\nspecification of the tool which contains the schema and\nauthentication information.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### Authentication\n\n Authentication(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nAuthentication information required for API calls\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\n### ConnectorTool\n\n ConnectorTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA ConnectorTool enabling using Integration Connectors\nConnections as tools.\n\n### DataStoreTool\n\n DataStoreTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA DataStoreTool is a way to provide specifications needed to\nsearch a list of data stores.\n\n### EndUserAuthConfig\n\n EndUserAuthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nEnd-user authentication configuration used for Connection calls. The\nfield values can either be hardcoded authentication values or the\nnames of `session\nparameters \u003chttps://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref\u003e`**or `request\nparameters \u003chttps://cloud.google.com/dialogflow/cx/docs/concept/parameter#request-scoped\u003e`**.\n\nIf parameter names are provided, then those parameters can be used\nto pass the authentication values dynamically, through\n`$session.params.param-id` or `$request.payload.param-id`.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\n### ExtensionTool\n\n ExtensionTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nAn ExtensionTool is a way to use Vertex Extensions as a tool.\n\n### FunctionTool\n\n FunctionTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA Function tool describes the functions to be invoked on the\nclient side.\n\n### OpenApiTool\n\n OpenApiTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nAn OpenAPI tool is a way to provide the Tool specifications\nin the Open API schema format.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\n### ServiceDirectoryConfig\n\n ServiceDirectoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nConfiguration for tools using Service Directory.\n\n### TLSConfig\n\n TLSConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe TLS configuration.\n\n### ToolType\n\n ToolType(value)\n\nRepresents the type of the tool."]]
