You can export and restore agents in the JSON package file format. This format is ideal for agent source control versioning, because the version differences can easily be reviewed and compared.
Limitations
The JSON package format is only available for export and restore of an agent, not export and restore of individual flows.
Directory structure
An agent export is a zip file that contains a hierarchy of directories and JSON files. The following describes the directory structure:
entityTypes: This directory contains your entity types.<entity type name>: One or more of these directories exist, and the directory names correspond to entity type display names.entities: This directory contains entity entry files.<language tag>.json: One or more of these files exist, and the file names correspond to language tags. Each file contains language-specific entity entries.
<excludedPhrases>: This directory contains excluded phrase files.<language tag>.json: One or more of these files exist, and the file names correspond to language tags. Each file contains language-specific phrase exclusions.
<entity type name>.json: This file name corresponds to an entity type display name. The file contains entity-type-specific data not found in other files.
flows: This directory contains your flow data.<flow name>: One or more of these directories exist, and the directory names correspond to flow display names.pages: This directory contains the page data for the flow.<page name>.json: One or more of these files exist, and the file names correspond to page display names. Each file contains page-specific data.
transitionRouteGroups: This directory contains your route group data for the flow.<route group name>: One or more of these files exist, and the file names correspond to route group display names. Each file contains route-group-specific data.
<flow name>.json: This file name corresponds to a flow display name. The file contains flow-specific data not found in other files.
intents: This directory contains your intent data.<intent name>: One or more of these directories exist, and the directory names correspond to intent display names.trainingPhrases: This directory contains training phrase data.<language tag>.json: One or more of these files exist, and the file names correspond to language tags. Each file contains language-specific training phrases for the intent.
<intent name>.json: This file name corresponds to an intent display name. The file contains intent-specific data not found in other files.
testCases: This directory contains your test case data.<test case name>.json: One or more of these files exist, and the file names correspond to test case display names. Each file contains test-case-specific data.
webhooks: This directory contains your webhook data.<webhook name>.json: One or more of these files exist, and the file names correspond to webhook display names. Each file contains webhook-specific data.
agentTransitionRouteGroups: This directory contains your agent-level transition route group data.<agent transition route group name>.json: One or more of these files exist, and the file names correspond to agent transition route group display names. Each file contains agent-transition-route-group-specific data.
agent.json: This file contains agent-specific data not found in other files.
For example:
entityTypes ⤷ Entity Type A ⤷ entities ⤷ en.json ⤷ en-gb.json ⤷ en-ca.json ⤷ excludedPhrases ⤷ en.json ⤷ en-gb.json ⤷ en-ca.json ⤷ Entity Type A.json ⤷ Entity Type B ⤷ entities ⤷ en.json ⤷ en-gb.json ⤷ en-ca.json ⤷ excludedPhrases ⤷ en.json ⤷ en-gb.json ⤷ en-ca.json ⤷ Entity Type B.json flows ⤷ Flow A ⤷ pages ⤷ Page A.json ⤷ Page B.json ⤷ Page C.json ⤷ transitionRouteGroups ⤷ Route Group A.json ⤷ Route Group B.json ⤷ Route Group C.json ⤷ Flow A.json ⤷ Flow B ⤷ pages ⤷ Page D.json ⤷ Page E.json ⤷ Page F.json ⤷ transitionRouteGroups ⤷ Route Group D.json ⤷ Route Group E.json ⤷ Route Group F.json ⤷ Flow B.json intents ⤷ Intent A ⤷ trainingPhrases ⤷ en.json ⤷ en-gb.json ⤷ en-ca.json ⤷ Intent A.json ⤷ Intent B ⤷ trainingPhrases ⤷ en.json ⤷ en-gb.json ⤷ en-ca.json ⤷ Intent B.json testCases ⤷ Test Case A.json ⤷ Test Case B.json webhooks ⤷ Webhook A.json ⤷ Webhook B.json agentTransitionRouteGroups ⤷ Agent Transition Route Group A.json ⤷ Agent Transition Route Group B.json agent.json
Agent restore guidance
When restoring an agent,
you must provide a zip file as described above.
Be sure that the agent.json and other top-level directories described above
are at the root directory of the zip file.
For example:
| Good | Bad |
|---|---|
/agent.json |
/xxx/agent.json |
/entityTypes |
/xxx/entityTypes |
Resource names
Some folder and JSON file names correspond to resource display names.
If a display name contains characters that are not allowed in file names
($, <, >, and so on),
these characters are
URL encoded
for the directory or file name.
Any JSON field that contains a resource reference is set to the
corresponding resource display name,
rather than the full resource name that includes the resource ID.
For example,
Parameter.entityType is set to the display name of an entity type,
rather than
projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
If you edit a JSON file to change the display name of any referenced resource, be sure to update all the references to the resource as well.
JSON content format
Each JSON file mentioned above has a representation that corresponds to a
Dialogflow REST API resource in JSON form.
For example,
Webhook A.json contains a JSON representation of the
JSON form of the webhook resource
with a display name of Webhook A.