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
.
Endpoint
posthttps://{endpoint}/v1/{name}:export
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
name
string
Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.
Request body
The request body contains data with the following structure:
Required. The desired output location and configuration.
Response body
If successful, the response body contains an instance of Operation
.
OutputConfig
Output configuration for the Model export.
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.
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
.
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
.
JSON representation |
---|
{ "exportFormatId": string, "artifactDestination": { object ( |
ContainerRegistryDestination
The Container Registry location for the container image.
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.
JSON representation |
---|
{ "outputUri": string } |