Method: projects.locations.models.export

Exports a trained, exportable, Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.

HTTP request

POST https://{service-endpoint}/v1/{name}:export

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

Path parameters

Parameters
name

string

Required. The resource name of the Model to export. Format: projects/{project}/locations/{location}/models/{model}

Request body

The request body contains data with the following structure:

JSON representation
{
  "outputConfig": {
    object (OutputConfig)
  }
}
Fields
outputConfig

object (OutputConfig)

Required. The desired output location and configuration.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.models.export

For more information, see the IAM documentation.

OutputConfig

Output configuration for the Model export.

JSON representation
{
  "exportFormatId": string,
  "artifactDestination": {
    object (GcsDestination)
  },
  "imageDestination": {
    object (ContainerRegistryDestination)
  }
}
Fields
exportFormatId

string

The ID of the format in which the Model must be exported. Each Model lists the export formats it supports. If no value is provided here, then the first from the list of the Model's supported formats is used by default.

artifactDestination

object (GcsDestination)

The Cloud Storage location where the Model artifact is to be written to. Under the directory given as the destination a new one with name "model-export-<model-display-name>-<timestamp-of-export-call>", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format, will be created. Inside, the Model and any of its supporting files will be written. This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains ARTIFACT.

imageDestination

object (ContainerRegistryDestination)

The Google Container Registry or Artifact Registry uri where the Model container image will be copied to. This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains IMAGE.

ContainerRegistryDestination

The Container Registry location for the container image.

JSON representation
{
  "outputUri": string
}
Fields
outputUri

string

Required. Container Registry URI of a container image. Only Google Container Registry and Artifact Registry are supported now. Accepted forms:

  • Google Container Registry path. For example: gcr.io/projectId/imageName:tag.

  • Artifact Registry path. For example: us-central1-docker.pkg.dev/projectId/repoName/imageName:tag.

If a tag is not specified, "latest" will be used as the default tag.