Try Gemini 1.5 Pro, our most advanced multimodal model in Vertex AI, and see what you can build with a 1M token context window. Try Gemini 1.5 Pro, our most advanced multimodal model in Vertex AI, and see what you can build with a 1M token context window.

Method: projects.locations.agents.entityTypes.export

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization scopes
DataFormat
Try it!

Exports the selected entity types.

HTTP request

POST https://{endpoint}/v3beta1/{parent=projects/*/locations/*/agents/*}/entityTypes:export

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters

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

parent

string

Required. The name of the parent agent to export entity types. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

dialogflow.entityTypes.get

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "entityTypes": [ string ], "dataFormat": enum (`DataFormat`), "languageCode": string, // Union field `destination` can be only one of the following: "entityTypesUri": string, "entityTypesContentInline": boolean // End of list of possible types for union field `destination`. }

{
  "entityTypes": [
    string
  ],
  "dataFormat": enum (DataFormat),
  "languageCode": string,

  // Union field destination can be only one of the following:
  "entityTypesUri": string,
  "entityTypesContentInline": boolean
  // End of list of possible types for union field destination.
}

Fields
`entityTypes[]`	`string` Required. The name of the entity types to export. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<EntityType ID>`.
`dataFormat`	`enum (DataFormat)` Optional. The data format of the exported entity types. If not specified, `BLOB` is assumed.
`languageCode`	`string` Optional. The language to retrieve the entity type for. The following fields are language dependent: `EntityType.entities.value` `EntityType.entities.synonyms` `EntityType.excluded_phrases.value` If not specified, all language dependent fields will be retrieved. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
Union field `destination`. The destination to export. `destination` can be only one of the following:
`entityTypesUri`	`string` Optional. The Google Cloud Storage URI to export the entity types to. The format of this URI must be `gs://<bucket-name>/<object-name>`. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.
`entityTypesContentInline`	`boolean` Optional. The option to return the serialized entity types inline.

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.

DataFormat

Data format of the exported entity types.

Enums
`DATA_FORMAT_UNSPECIFIED`	Unspecified format. Treated as `BLOB`.
`BLOB`	EntityTypes will be exported as raw bytes.
`JSON_PACKAGE`	EntityTypes will be exported in JSON Package format.