Cloud AI Platform v1 API - Class ExportDataConfig (3.12.0) 

public sealed class ExportDataConfig : IMessage<ExportDataConfig>, IEquatable<ExportDataConfig>, IDeepCloneable<ExportDataConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class ExportDataConfig.

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

Inheritance

object > ExportDataConfig

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ExportDataConfig()

public ExportDataConfig()

ExportDataConfig(ExportDataConfig)

public ExportDataConfig(ExportDataConfig other)
Parameter
Name Description
other ExportDataConfig

Properties

AnnotationSchemaUri

public string AnnotationSchemaUri { get; set; }

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 [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the Dataset specified by [ExportDataRequest.name][google.cloud.aiplatform.v1.ExportDataRequest.name].

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 [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter], the Annotations used for training are filtered by both [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter] and [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri].

Property Value
Type Description
string

AnnotationsFilter

public string AnnotationsFilter { get; set; }

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 [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].

Property Value
Type Description
string

DestinationCase

public ExportDataConfig.DestinationOneofCase DestinationCase { get; }
Property Value
Type Description
ExportDataConfigDestinationOneofCase

ExportUse

public ExportDataConfig.Types.ExportUse ExportUse { get; set; }

Indicates the usage of the exported files.

Property Value
Type Description
ExportDataConfigTypesExportUse

FilterSplit

public ExportFilterSplit FilterSplit { get; set; }

Split based on the provided filters for each set.

Property Value
Type Description
ExportFilterSplit

FractionSplit

public ExportFractionSplit FractionSplit { get; set; }

Split based on fractions defining the size of each set.

Property Value
Type Description
ExportFractionSplit

GcsDestination

public GcsDestination GcsDestination { get; set; }

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: export-data-<dataset-display-name>-<timestamp-of-export-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format.

Property Value
Type Description
GcsDestination

SavedQueryId

public string SavedQueryId { get; set; }

The ID of a SavedQuery (annotation set) under the Dataset specified by [ExportDataRequest.name][google.cloud.aiplatform.v1.ExportDataRequest.name] 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 [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter], the Annotations used for training are filtered by both [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id] and [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter].

Only one of [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id] and [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri] should be specified as both of them represent the same thing: problem type.

Property Value
Type Description
string

SplitCase

public ExportDataConfig.SplitOneofCase SplitCase { get; }
Property Value
Type Description
ExportDataConfigSplitOneofCase