Exports data from a Dataset.
HTTP request
POST https://{service-endpoint}/v1/{name}:export
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the Dataset resource. Format: |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"exportConfig": {
object ( |
Fields | |
---|---|
exportConfig |
Required. The desired output location. |
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.datasets.export
For more information, see the IAM documentation.
ExportDataConfig
Describes what part of the Dataset is to be exported, the destination of the export and how to export.
JSON representation |
---|
{ "annotationsFilter": string, "savedQueryId": string, "annotationSchemaUri": string, "exportUse": enum ( |
Fields | |
---|---|
annotationsFilter |
An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in |
savedQueryId |
The ID of a SavedQuery (annotation set) under the Dataset specified by [datasetId][] used for filtering Annotations for training. Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with Only one of |
annotationSchemaUri |
The Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with |
exportUse |
Indicates the usage of the exported files. |
Union field destination . The destination of the output. destination can be only one of the following: |
|
gcsDestination |
The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: |
Union field split . The instructions how the export data should be split between the training, validation and test sets. split can be only one of the following: |
|
fractionSplit |
Split based on fractions defining the size of each set. |
filterSplit |
Split based on the provided filters for each set. |
ExportFractionSplit
Assigns the input data to training, validation, and test sets as per the given fractions. Any of trainingFraction
, validationFraction
and testFraction
may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test.
JSON representation |
---|
{ "trainingFraction": number, "validationFraction": number, "testFraction": number } |
Fields | |
---|---|
trainingFraction |
The fraction of the input data that is to be used to train the Model. |
validationFraction |
The fraction of the input data that is to be used to validate the Model. |
testFraction |
The fraction of the input data that is to be used to evaluate the Model. |
ExportFilterSplit
Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign).
Supported only for unstructured Datasets.
JSON representation |
---|
{ "trainingFilter": string, "validationFilter": string, "testFilter": string } |
Fields | |
---|---|
trainingFilter |
Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to train the Model. A filter with same syntax as the one used in |
validationFilter |
Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to validate the Model. A filter with same syntax as the one used in |
testFilter |
Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to test the Model. A filter with same syntax as the one used in |
ExportUse
ExportUse indicates the usage of the exported files. It restricts file destination, format, annotations to be exported, whether to allow unannotated data to be exported and whether to clone files to temp Cloud Storage bucket.
Enums | |
---|---|
EXPORT_USE_UNSPECIFIED |
Regular user export. |
CUSTOM_CODE_TRAINING |
Export for custom code training. |