versions

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

Overview

Name	versions
Type	Resource
Id	google.dialogflow.versions

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_flows_versions_get

Successful response

Name	Datatype	Description
name	string	Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
createTime	string (google-datetime)	Output only. Create time of the version.
description	string	The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
displayName	string	Required. The human-readable name of the version. Limit of 64 characters.
nluSettings	object	Output only. The NLU settings of the flow at version creation. (id: GoogleCloudDialogflowCxV3NluSettings)
state	string	Output only. The state of this version. This field is read-only and cannot be set by create and update methods.

projects_locations_agents_playbooks_versions_get

Successful response

Name	Datatype	Description
name	string	The unique identifier of the playbook version. Format: projects//locations//agents//playbooks//versions/.
description	string	Optional. The description of the playbook version.
examples	array	Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
playbook	object	Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. (id: GoogleCloudDialogflowCxV3Playbook)
updateTime	string (google-datetime)	Output only. Last time the playbook version was created or modified.

projects_locations_agents_tools_versions_get

Successful response

Name	Datatype	Description
name	string	Identifier. The unique identifier of the tool version. Format: projects//locations//agents//tools//versions/.
createTime	string (google-datetime)	Output only. Last time the tool version was created or modified.
displayName	string	Required. The display name of the tool version.
tool	object	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. (id: GoogleCloudDialogflowCxV3Tool)
updateTime	string (google-datetime)	Output only. Last time the tool version was created or modified.

projects_locations_agents_flows_versions_list

Successful response

Name	Datatype	Description
name	string	Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
createTime	string (google-datetime)	Output only. Create time of the version.
description	string	The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
displayName	string	Required. The human-readable name of the version. Limit of 64 characters.
nluSettings	object	Output only. The NLU settings of the flow at version creation. (id: GoogleCloudDialogflowCxV3NluSettings)
state	string	Output only. The state of this version. This field is read-only and cannot be set by create and update methods.

projects_locations_agents_playbooks_versions_list

Successful response

Name	Datatype	Description
name	string	The unique identifier of the playbook version. Format: projects//locations//agents//playbooks//versions/.
description	string	Optional. The description of the playbook version.
examples	array	Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
playbook	object	Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. (id: GoogleCloudDialogflowCxV3Playbook)
updateTime	string (google-datetime)	Output only. Last time the playbook version was created or modified.

projects_locations_agents_tools_versions_list

Successful response

Name	Datatype	Description
name	string	Identifier. The unique identifier of the tool version. Format: projects//locations//agents//tools//versions/.
createTime	string (google-datetime)	Output only. Last time the tool version was created or modified.
displayName	string	Required. The display name of the tool version.
tool	object	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. (id: GoogleCloudDialogflowCxV3Tool)
updateTime	string (google-datetime)	Output only. Last time the tool version was created or modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_flows_versions_get	select	projectsId, locationsId, agentsId, flowsId, versionsId		Retrieves the specified Version.
projects_locations_agents_playbooks_versions_get	select	projectsId, locationsId, agentsId, playbooksId, versionsId		Retrieves the specified version of the Playbook.
projects_locations_agents_tools_versions_get	select	projectsId, locationsId, agentsId, toolsId, versionsId		Retrieves the specified version of the Tool.
projects_locations_agents_flows_versions_list	select	projectsId, locationsId, agentsId, flowsId	pageSize, pageToken	Returns the list of all versions in the specified Flow.
projects_locations_agents_playbooks_versions_list	select	projectsId, locationsId, agentsId, playbooksId	pageSize, pageToken	Lists versions for the specified Playbook.
projects_locations_agents_tools_versions_list	select	projectsId, locationsId, agentsId, toolsId	pageSize, pageToken	List versions of the specified Tool.
projects_locations_agents_flows_versions_create	insert	projectsId, locationsId, agentsId, flowsId		Creates a Version in the specified Flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateVersionOperationMetadata - response: Version
projects_locations_agents_playbooks_versions_create	insert	projectsId, locationsId, agentsId, playbooksId		Creates a version for the specified Playbook.
projects_locations_agents_tools_versions_create	insert	projectsId, locationsId, agentsId, toolsId		Creates a version for the specified Tool.
projects_locations_agents_flows_versions_patch	update	projectsId, locationsId, agentsId, flowsId, versionsId	updateMask	Updates the specified Version.
projects_locations_agents_flows_versions_delete	delete	projectsId, locationsId, agentsId, flowsId, versionsId		Deletes the specified Version.
projects_locations_agents_playbooks_versions_delete	delete	projectsId, locationsId, agentsId, playbooksId, versionsId		Deletes the specified version of the Playbook.
projects_locations_agents_tools_versions_delete	delete	projectsId, locationsId, agentsId, toolsId, versionsId	force	Deletes the specified version of the Tool.
projects_locations_agents_flows_versions_load	exec	projectsId, locationsId, agentsId, flowsId, versionsId		Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message
projects_locations_agents_flows_versions_compare_versions	exec	projectsId, locationsId, agentsId, flowsId, versionsId		Compares the specified base version with target version.
projects_locations_agents_playbooks_versions_restore	exec	projectsId, locationsId, agentsId, playbooksId, versionsId		Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.
projects_locations_agents_tools_versions_restore	exec	projectsId, locationsId, agentsId, toolsId, versionsId		Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.

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
flowsId	string
locationsId	string
playbooksId	string
projectsId	string
toolsId	string
versionsId	string
force	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_flows_versions_get

Retrieves the specified Version.

SELECT
name,
createTime,
description,
displayName,
nluSettings,
state
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND flowsId = '{{ flowsId }}' -- required
AND versionsId = '{{ versionsId }}' -- required;

projects_locations_agents_playbooks_versions_get

Retrieves the specified version of the Playbook.

SELECT
name,
description,
examples,
playbook,
updateTime
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND playbooksId = '{{ playbooksId }}' -- required
AND versionsId = '{{ versionsId }}' -- required;

projects_locations_agents_tools_versions_get

Retrieves the specified version of the Tool.

SELECT
name,
createTime,
displayName,
tool,
updateTime
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND toolsId = '{{ toolsId }}' -- required
AND versionsId = '{{ versionsId }}' -- required;

projects_locations_agents_flows_versions_list

Returns the list of all versions in the specified Flow.

SELECT
name,
createTime,
description,
displayName,
nluSettings,
state
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND flowsId = '{{ flowsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_locations_agents_playbooks_versions_list

Lists versions for the specified Playbook.

SELECT
name,
description,
examples,
playbook,
updateTime
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND playbooksId = '{{ playbooksId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_locations_agents_tools_versions_list

List versions of the specified Tool.

SELECT
name,
createTime,
displayName,
tool,
updateTime
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND toolsId = '{{ toolsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_agents_flows_versions_create

Creates a Version in the specified Flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateVersionOperationMetadata - response: Version

INSERT INTO google.dialogflow.versions (
data__name,
data__displayName,
data__description,
projectsId,
locationsId,
agentsId,
flowsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ flowsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

projects_locations_agents_playbooks_versions_create

Creates a version for the specified Playbook.

INSERT INTO google.dialogflow.versions (
data__name,
data__description,
projectsId,
locationsId,
agentsId,
playbooksId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ playbooksId }}'
RETURNING
name,
description,
examples,
playbook,
updateTime
;

projects_locations_agents_tools_versions_create

Creates a version for the specified Tool.

INSERT INTO google.dialogflow.versions (
data__name,
data__displayName,
data__tool,
projectsId,
locationsId,
agentsId,
toolsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ tool }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ toolsId }}'
RETURNING
name,
createTime,
displayName,
tool,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: versions
  props:
    - name: projectsId
      value: string
      description: Required parameter for the versions resource.
    - name: locationsId
      value: string
      description: Required parameter for the versions resource.
    - name: agentsId
      value: string
      description: Required parameter for the versions resource.
    - name: flowsId
      value: string
      description: Required parameter for the versions resource.
    - name: playbooksId
      value: string
      description: Required parameter for the versions resource.
    - name: toolsId
      value: string
      description: Required parameter for the versions resource.
    - name: name
      value: string
      description: >
        Identifier. The unique identifier of the tool version. Format: `projects//locations//agents//tools//versions/`.
        
    - name: displayName
      value: string
      description: >
        Required. The display name of the tool version.
        
    - name: description
      value: string
      description: >
        Optional. The description of the playbook version.
        
    - name: tool
      value: object
      description: >
        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.
        

UPDATE examples

projects_locations_agents_flows_versions_patch

Updates the specified Version.

UPDATE google.dialogflow.versions
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND flowsId = '{{ flowsId }}' --required
AND versionsId = '{{ versionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
nluSettings,
state;

DELETE examples

projects_locations_agents_flows_versions_delete

Deletes the specified Version.

DELETE FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND flowsId = '{{ flowsId }}' --required
AND versionsId = '{{ versionsId }}' --required;

projects_locations_agents_playbooks_versions_delete

Deletes the specified version of the Playbook.

DELETE FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND playbooksId = '{{ playbooksId }}' --required
AND versionsId = '{{ versionsId }}' --required;

projects_locations_agents_tools_versions_delete

Deletes the specified version of the Tool.

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

Lifecycle Methods

projects_locations_agents_flows_versions_load

Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message

EXEC google.dialogflow.versions.projects_locations_agents_flows_versions_load 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@flowsId='{{ flowsId }}' --required, 
@versionsId='{{ versionsId }}' --required 
@@json=
'{
"allowOverrideAgentResources": {{ allowOverrideAgentResources }}
}';

projects_locations_agents_flows_versions_compare_versions

Compares the specified base version with target version.

EXEC google.dialogflow.versions.projects_locations_agents_flows_versions_compare_versions 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@flowsId='{{ flowsId }}' --required, 
@versionsId='{{ versionsId }}' --required 
@@json=
'{
"targetVersion": "{{ targetVersion }}", 
"languageCode": "{{ languageCode }}"
}';

projects_locations_agents_playbooks_versions_restore

Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.

EXEC google.dialogflow.versions.projects_locations_agents_playbooks_versions_restore 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@playbooksId='{{ playbooksId }}' --required, 
@versionsId='{{ versionsId }}' --required;

projects_locations_agents_tools_versions_restore

Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.

EXEC google.dialogflow.versions.projects_locations_agents_tools_versions_restore 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@toolsId='{{ toolsId }}' --required, 
@versionsId='{{ versionsId }}' --required;