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

Successful response

Name	Datatype	Description
name	string	The unique identifier of the Tool. Format: projects//locations//agents//tools/.
dataStoreSpec	object	Data store search tool specification. (id: GoogleCloudDialogflowCxV3ToolDataStoreTool)
description	string	Required. High level description of the Tool and its usage.
displayName	string	Required. The human-readable name of the Tool, unique within an agent.
functionSpec	object	Client side executed function specification. (id: GoogleCloudDialogflowCxV3ToolFunctionTool)
openApiSpec	object	OpenAPI specification of the Tool. (id: GoogleCloudDialogflowCxV3ToolOpenApiTool)
toolType	string	Output only. The tool type.

projects_locations_agents_tools_list

Successful response

Name	Datatype	Description
name	string	The unique identifier of the Tool. Format: projects//locations//agents//tools/.
dataStoreSpec	object	Data store search tool specification. (id: GoogleCloudDialogflowCxV3ToolDataStoreTool)
description	string	Required. High level description of the Tool and its usage.
displayName	string	Required. The human-readable name of the Tool, unique within an agent.
functionSpec	object	Client side executed function specification. (id: GoogleCloudDialogflowCxV3ToolFunctionTool)
openApiSpec	object	OpenAPI specification of the Tool. (id: GoogleCloudDialogflowCxV3ToolOpenApiTool)
toolType	string	Output only. The tool type.

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		Retrieves the specified Tool.
projects_locations_agents_tools_list	select	projectsId, locationsId, agentsId	pageSize, pageToken	Returns a list of Tools in the specified agent.
projects_locations_agents_tools_create	insert	projectsId, locationsId, agentsId		Creates a Tool in the specified agent.
projects_locations_agents_tools_patch	update	projectsId, locationsId, agentsId, toolsId	updateMask	Update the specified Tool.
projects_locations_agents_tools_delete	delete	projectsId, locationsId, agentsId, toolsId	force	Deletes a specified Tool.

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

Retrieves the specified Tool.

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

Returns a list of Tools in the specified agent.

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

Creates a Tool in the specified agent.

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

Manifest

# Description fields are for documentation purposes
- name: tools
  props:
    - name: projectsId
      value: string
      description: Required parameter for the tools resource.
    - name: locationsId
      value: string
      description: Required parameter for the tools resource.
    - name: agentsId
      value: string
      description: Required parameter for the tools resource.
    - name: name
      value: string
      description: >
        The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
        
    - name: displayName
      value: string
      description: >
        Required. The human-readable name of the Tool, unique within an agent.
        
    - name: description
      value: string
      description: >
        Required. High level description of the Tool and its usage.
        
    - name: openApiSpec
      value: object
      description: >
        OpenAPI specification of the Tool.
        
    - name: dataStoreSpec
      value: object
      description: >
        Data store search tool specification.
        
    - name: functionSpec
      value: object
      description: >
        Client side executed function specification.
        

UPDATE examples

projects_locations_agents_tools_patch

Update the specified Tool.

UPDATE google.dialogflow.tools
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__openApiSpec = '{{ openApiSpec }}',
data__dataStoreSpec = '{{ dataStoreSpec }}',
data__functionSpec = '{{ functionSpec }}'
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

Deletes a specified Tool.

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