Method: projects.locations.datasets.import

Imports data into a Dataset.

HTTP request

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

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

Path parameters

Parameters
name

string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

Request body

The request body contains data with the following structure:

JSON representation
{
  "importConfigs": [
    {
      object (ImportDataConfig)
    }
  ]
}
Fields
importConfigs[]

object (ImportDataConfig)

Required. The desired input locations. The contents of all input locations will be imported in one batch.

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.import

For more information, see the IAM documentation.

ImportDataConfig

Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.

JSON representation
{
  "dataItemLabels": {
    string: string,
    ...
  },
  "importSchemaUri": string,
  "gcsSource": {
    object (GcsSource)
  }
}
Fields
dataItemLabels

map (key: string, value: string)

Labels that will be applied to newly imported DataItems. If an identical DataItem as one being imported already exists in the Dataset, then these labels will be appended to these of the already existing one, and if labels with identical key is imported before, the old label value will be overwritten. If two DataItems are identical in the same import data operation, the labels will be combined and if key collision happens in this case, one of the values will be picked randomly. Two DataItems are considered identical if their content bytes are identical (e.g. image bytes or pdf bytes). These labels will be overridden by Annotation labels specified inside index file referenced by importSchemaUri, e.g. jsonl file.

importSchemaUri

string

Required. Points to a YAML file stored on Google Cloud Storage describing the import format. Validation will be done against the schema. The schema is defined as an OpenAPI 3.0.2 Schema Object.

gcsSource

object (GcsSource)

The Google Cloud Storage location for the input content.