Cloud AutoML V1 Client - Class Dataset (1.5.4)

Reference documentation and code samples for the Cloud AutoML V1 Client class Dataset.

A workspace for solving a single, particular machine learning (ML) problem.

A workspace contains examples that may be annotated.

Generated from protobuf message google.cloud.automl.v1.Dataset

Namespace

Google \ Cloud \ AutoMl \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ translation_dataset_metadata`	`Google\Cloud\AutoMl\V1\TranslationDatasetMetadata` Metadata for a dataset used for translation.
`↳ image_classification_dataset_metadata`	`Google\Cloud\AutoMl\V1\ImageClassificationDatasetMetadata` Metadata for a dataset used for image classification.
`↳ text_classification_dataset_metadata`	`Google\Cloud\AutoMl\V1\TextClassificationDatasetMetadata` Metadata for a dataset used for text classification.
`↳ image_object_detection_dataset_metadata`	`Google\Cloud\AutoMl\V1\ImageObjectDetectionDatasetMetadata` Metadata for a dataset used for image object detection.
`↳ text_extraction_dataset_metadata`	`Google\Cloud\AutoMl\V1\TextExtractionDatasetMetadata` Metadata for a dataset used for text extraction.
`↳ text_sentiment_dataset_metadata`	`Google\Cloud\AutoMl\V1\TextSentimentDatasetMetadata` Metadata for a dataset used for text sentiment.
`↳ name`	`string` Output only. The resource name of the dataset. Form: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`
`↳ display_name`	`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.
`↳ example_count`	`int` Output only. The number of examples in the dataset.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this dataset was created.
`↳ etag`	`string` Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` 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.

getTranslationDatasetMetadata

Metadata for a dataset used for translation.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\TranslationDatasetMetadata\|null`

hasTranslationDatasetMetadata

setTranslationDatasetMetadata

Metadata for a dataset used for translation.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1\TranslationDatasetMetadata`

Returns
Type	Description
`$this`

getImageClassificationDatasetMetadata

Metadata for a dataset used for image classification.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\ImageClassificationDatasetMetadata\|null`

hasImageClassificationDatasetMetadata

setImageClassificationDatasetMetadata

Metadata for a dataset used for image classification.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1\ImageClassificationDatasetMetadata`

Returns
Type	Description
`$this`

getTextClassificationDatasetMetadata

Metadata for a dataset used for text classification.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\TextClassificationDatasetMetadata\|null`

hasTextClassificationDatasetMetadata

setTextClassificationDatasetMetadata

Metadata for a dataset used for text classification.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1\TextClassificationDatasetMetadata`

Returns
Type	Description
`$this`

getImageObjectDetectionDatasetMetadata

Metadata for a dataset used for image object detection.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\ImageObjectDetectionDatasetMetadata\|null`

hasImageObjectDetectionDatasetMetadata

setImageObjectDetectionDatasetMetadata

Metadata for a dataset used for image object detection.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1\ImageObjectDetectionDatasetMetadata`

Returns
Type	Description
`$this`

getTextExtractionDatasetMetadata

Metadata for a dataset used for text extraction.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\TextExtractionDatasetMetadata\|null`

hasTextExtractionDatasetMetadata

setTextExtractionDatasetMetadata

Metadata for a dataset used for text extraction.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1\TextExtractionDatasetMetadata`

Returns
Type	Description
`$this`

getTextSentimentDatasetMetadata

Metadata for a dataset used for text sentiment.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\TextSentimentDatasetMetadata\|null`

hasTextSentimentDatasetMetadata

setTextSentimentDatasetMetadata

Metadata for a dataset used for text sentiment.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1\TextSentimentDatasetMetadata`

Returns
Type	Description
`$this`

getName

Output only. The resource name of the dataset.

Form: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}

Returns
Type	Description
`string`

setName

Output only. The resource name of the dataset.

Form: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

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.

Returns
Type	Description
`string`

setDisplayName

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExampleCount

Output only. The number of examples in the dataset.

Returns
Type	Description
`int`

setExampleCount

Output only. The number of examples in the dataset.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCreateTime

Output only. Timestamp when this dataset was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this dataset was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEtag

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

Returns
Type	Description
`string`

setEtag

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

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.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

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

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getDatasetMetadata

Returns
Type	Description
`string`