REST Resource: projects.locations.datasets

Resource: Dataset

A workspace for solving a single, particular machine learning (ML) problem. A workspace contains examples that may be annotated.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "exampleCount": integer,
  "createTime": string,
  "etag": string,
  "labels": {
    string: string,
    ...
  },

  // Union field dataset_metadata can be only one of the following:
  "translationDatasetMetadata": {
    object (TranslationDatasetMetadata)
  },
  "imageClassificationDatasetMetadata": {
    object (ImageClassificationDatasetMetadata)
  },
  "textClassificationDatasetMetadata": {
    object (TextClassificationDatasetMetadata)
  },
  "imageObjectDetectionDatasetMetadata": {
    object (ImageObjectDetectionDatasetMetadata)
  },
  "textExtractionDatasetMetadata": {
    object (TextExtractionDatasetMetadata)
  },
  "textSentimentDatasetMetadata": {
    object (TextSentimentDatasetMetadata)
  }
  // End of list of possible types for union field dataset_metadata.
}
Fields
name

string

Output only. The resource name of the dataset. Form: projects/{project_id}/locations/{locationId}/datasets/{datasetId}
displayName

string

Required. The name of the dataset to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9.
description

string

User-provided description of the dataset. The description can be up to 25000 characters long.
exampleCount

integer

Output only. The number of examples in the dataset.
createTime

string (Timestamp format)

Output only. Timestamp when this dataset was created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
etag

string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels

map (key: string, value: string)

Optional. The labels with user-defined metadata to organize your dataset.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

See https://goo.gl/xmQnxf for more information on and examples of labels.
Union field dataset_metadata. Required. The dataset metadata that is specific to the problem type. dataset_metadata can be only one of the following:
translationDatasetMetadata

object (TranslationDatasetMetadata)

Metadata for a dataset used for translation.
imageClassificationDatasetMetadata

object (ImageClassificationDatasetMetadata)

Metadata for a dataset used for image classification.
textClassificationDatasetMetadata

object (TextClassificationDatasetMetadata)

Metadata for a dataset used for text classification.
imageObjectDetectionDatasetMetadata

object (ImageObjectDetectionDatasetMetadata)

Metadata for a dataset used for image object detection.
textExtractionDatasetMetadata

object (TextExtractionDatasetMetadata)

Metadata for a dataset used for text extraction.
textSentimentDatasetMetadata

object (TextSentimentDatasetMetadata)

Metadata for a dataset used for text sentiment.

TranslationDatasetMetadata

Dataset metadata that is specific to translation.

JSON representation 
{
  "sourceLanguageCode": string,
  "targetLanguageCode": string
}
Fields
sourceLanguageCode

string

Required. The BCP-47 language code of the source language.
targetLanguageCode

string

Required. The BCP-47 language code of the target language.

ImageClassificationDatasetMetadata

Dataset metadata that is specific to image classification.

JSON representation 
{
  "classificationType": enum (ClassificationType)
}
Fields
classificationType

enum (ClassificationType)

Required. Type of the classification problem.

TextClassificationDatasetMetadata

Dataset metadata for classification.

JSON representation 
{
  "classificationType": enum (ClassificationType)
}
Fields
classificationType

enum (ClassificationType)

Required. Type of the classification problem.

ImageObjectDetectionDatasetMetadata

Dataset metadata specific to image object detection.

TextExtractionDatasetMetadata

Dataset metadata that is specific to text extraction

TextSentimentDatasetMetadata

Dataset metadata for text sentiment.

JSON representation 
{
  "sentimentMax": integer
}
Fields
sentimentMax

integer

Required. A sentiment is expressed as an integer ordinal, where higher value means a more positive sentiment. The range of sentiments that will be used is between 0 and sentimentMax (inclusive on both ends), and all the values in the range must be represented in the dataset before a model can be created. sentimentMax value must be between 1 and 10 (inclusive).

Methods

create

 Creates a dataset.

delete

 Deletes a dataset and all of its contents.

exportData

 Exports dataset's data to the provided output location.

get

 Gets a dataset.

getIamPolicy

 Gets the access control policy for a resource.

importData

 Imports data into a dataset.

list

 Lists datasets in a project.

patch

 Updates a dataset.

setIamPolicy

 Sets the access control policy on the specified resource.