Method: projects.locations.agents.restore

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization Scopes
RestoreOption
Try it!

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

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

Note: You should always train a flow prior to sending it queries. See the training documentation.

HTTP request

POST https://{endpoint}/v3beta1/{name=projects/*/locations/*/agents/*}:restore

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` Required. The name of the agent to restore into. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Authorization requires the following IAM permission on the specified resource `name`: `dialogflow.agents.restore`

name

string

Required. The name of the agent to restore into. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Authorization requires the following IAM permission on the specified resource name:

dialogflow.agents.restore

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "restoreOption": enum (`RestoreOption`), // Union field `agent` can be only one of the following: "agentUri": string, "agentContent": string // End of list of possible types for union field `agent`. }

{
  "restoreOption": enum (RestoreOption),

  // Union field agent can be only one of the following:
  "agentUri": string,
  "agentContent": string
  // End of list of possible types for union field agent.
}

Fields
`restoreOption`	`enum (RestoreOption)` Agent restore mode. If not specified, `KEEP` is assumed.
Union field `agent`. Required. The agent to restore. `agent` can be only one of the following:
`agentUri`	`string` The Google Cloud Storage URI to restore agent from. The format of this URI must be `gs://<bucket-name>/<object-name>`.
`agentContent`	`string (bytes format)` Uncompressed raw byte content for agent. A base64-encoded string.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

RestoreOption

Restore option.

Enums
`RESTORE_OPTION_UNSPECIFIED`	Unspecified. Treated as KEEP.
`KEEP`	Always respect the settings from the exported agent file. It may cause a restoration failure if some settings (e.g. model type) are not supported in the target agent.
`FALLBACK`	Fallback to default settings if some settings are not supported in the target agent.