tools

Creates, updates, deletes, gets or lists a tools resource.

Overview

Name	tools
Type	Resource
Id	google.dialogflow.tools

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_tools_get

Name	Datatype	Description
name	string
dataStoreSpec	object	(id: GoogleCloudDialogflowCxV3ToolDataStoreTool)
description	string
displayName	string
functionSpec	object	(id: GoogleCloudDialogflowCxV3ToolFunctionTool)
openApiSpec	object	(id: GoogleCloudDialogflowCxV3ToolOpenApiTool)
toolType	string	(TOOL_TYPE_UNSPECIFIED, CUSTOMIZED_TOOL, BUILTIN_TOOL)

projects_locations_agents_tools_list

Name	Datatype	Description
name	string
dataStoreSpec	object	(id: GoogleCloudDialogflowCxV3ToolDataStoreTool)
description	string
displayName	string
functionSpec	object	(id: GoogleCloudDialogflowCxV3ToolFunctionTool)
openApiSpec	object	(id: GoogleCloudDialogflowCxV3ToolOpenApiTool)
toolType	string	(TOOL_TYPE_UNSPECIFIED, CUSTOMIZED_TOOL, BUILTIN_TOOL)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_tools_get	select	projectsId, locationsId, agentsId, toolsId
projects_locations_agents_tools_list	select	projectsId, locationsId, agentsId	pageSize, pageToken
projects_locations_agents_tools_create	insert	projectsId, locationsId, agentsId
projects_locations_agents_tools_patch	update	projectsId, locationsId, agentsId, toolsId	updateMask
projects_locations_agents_tools_delete	delete	projectsId, locationsId, agentsId, toolsId	force

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
locationsId	string
projectsId	string
toolsId	string
force	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_tools_get

Successful response

SELECT
name,
dataStoreSpec,
description,
displayName,
functionSpec,
openApiSpec,
toolType
FROM google.dialogflow.tools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND toolsId = '{{ toolsId }}' -- required
;

projects_locations_agents_tools_list

Successful response

SELECT
name,
dataStoreSpec,
description,
displayName,
functionSpec,
openApiSpec,
toolType
FROM google.dialogflow.tools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_agents_tools_create

No description available.

INSERT INTO google.dialogflow.tools (
data__displayName,
data__functionSpec,
data__openApiSpec,
data__name,
data__description,
data__dataStoreSpec,
projectsId,
locationsId,
agentsId
)
SELECT 
'{{ displayName }}',
'{{ functionSpec }}',
'{{ openApiSpec }}',
'{{ name }}',
'{{ description }}',
'{{ dataStoreSpec }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}'
RETURNING
name,
dataStoreSpec,
description,
displayName,
functionSpec,
openApiSpec,
toolType
;

Manifest

# Description fields are for documentation purposes
- name: tools
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the tools resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the tools resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the tools resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: functionSpec
    value:
      inputSchema: "{{ inputSchema }}"
      outputSchema: "{{ outputSchema }}"
  - name: openApiSpec
    value:
      authentication:
        bearerTokenConfig:
          secretVersionForToken: "{{ secretVersionForToken }}"
          token: "{{ token }}"
        serviceAccountAuthConfig:
          serviceAccount: "{{ serviceAccount }}"
        apiKeyConfig:
          keyName: "{{ keyName }}"
          apiKey: "{{ apiKey }}"
          secretVersionForApiKey: "{{ secretVersionForApiKey }}"
          requestLocation: "{{ requestLocation }}"
        serviceAgentAuthConfig:
          serviceAgentAuth: "{{ serviceAgentAuth }}"
        oauthConfig:
          secretVersionForClientSecret: "{{ secretVersionForClientSecret }}"
          oauthGrantType: "{{ oauthGrantType }}"
          scopes:
            - "{{ scopes }}"
          clientSecret: "{{ clientSecret }}"
          clientId: "{{ clientId }}"
          tokenEndpoint: "{{ tokenEndpoint }}"
      textSchema: "{{ textSchema }}"
      tlsConfig:
        caCerts:
          - displayName: "{{ displayName }}"
            cert: "{{ cert }}"
      serviceDirectoryConfig:
        service: "{{ service }}"
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: dataStoreSpec
    value:
      dataStoreConnections:
        - dataStore: "{{ dataStore }}"
          documentProcessingMode: "{{ documentProcessingMode }}"
          dataStoreType: "{{ dataStoreType }}"
      fallbackPrompt: "{{ fallbackPrompt }}"

UPDATE examples

projects_locations_agents_tools_patch

No description available.

UPDATE google.dialogflow.tools
SET 
data__displayName = '{{ displayName }}',
data__functionSpec = '{{ functionSpec }}',
data__openApiSpec = '{{ openApiSpec }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__dataStoreSpec = '{{ dataStoreSpec }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND toolsId = '{{ toolsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
dataStoreSpec,
description,
displayName,
functionSpec,
openApiSpec,
toolType;

DELETE examples

projects_locations_agents_tools_delete

No description available.

DELETE FROM google.dialogflow.tools
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND toolsId = '{{ toolsId }}' --required
AND force = '{{ force }}'
;