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
NameDescription
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
TypeDescription
Google\Cloud\AutoMl\V1\TranslationDatasetMetadata|null

hasTranslationDatasetMetadata

setTranslationDatasetMetadata

Metadata for a dataset used for translation.

Parameter
NameDescription
var Google\Cloud\AutoMl\V1\TranslationDatasetMetadata
Returns
TypeDescription
$this

getImageClassificationDatasetMetadata

Metadata for a dataset used for image classification.

Returns
TypeDescription
Google\Cloud\AutoMl\V1\ImageClassificationDatasetMetadata|null

hasImageClassificationDatasetMetadata

setImageClassificationDatasetMetadata

Metadata for a dataset used for image classification.

Parameter
NameDescription
var Google\Cloud\AutoMl\V1\ImageClassificationDatasetMetadata
Returns
TypeDescription
$this

getTextClassificationDatasetMetadata

Metadata for a dataset used for text classification.

Returns
TypeDescription
Google\Cloud\AutoMl\V1\TextClassificationDatasetMetadata|null

hasTextClassificationDatasetMetadata

setTextClassificationDatasetMetadata

Metadata for a dataset used for text classification.

Parameter
NameDescription
var Google\Cloud\AutoMl\V1\TextClassificationDatasetMetadata
Returns
TypeDescription
$this

getImageObjectDetectionDatasetMetadata

Metadata for a dataset used for image object detection.

Returns
TypeDescription
Google\Cloud\AutoMl\V1\ImageObjectDetectionDatasetMetadata|null

hasImageObjectDetectionDatasetMetadata

setImageObjectDetectionDatasetMetadata

Metadata for a dataset used for image object detection.

Parameter
NameDescription
var Google\Cloud\AutoMl\V1\ImageObjectDetectionDatasetMetadata
Returns
TypeDescription
$this

getTextExtractionDatasetMetadata

Metadata for a dataset used for text extraction.

Returns
TypeDescription
Google\Cloud\AutoMl\V1\TextExtractionDatasetMetadata|null

hasTextExtractionDatasetMetadata

setTextExtractionDatasetMetadata

Metadata for a dataset used for text extraction.

Parameter
NameDescription
var Google\Cloud\AutoMl\V1\TextExtractionDatasetMetadata
Returns
TypeDescription
$this

getTextSentimentDatasetMetadata

Metadata for a dataset used for text sentiment.

Returns
TypeDescription
Google\Cloud\AutoMl\V1\TextSentimentDatasetMetadata|null

hasTextSentimentDatasetMetadata

setTextSentimentDatasetMetadata

Metadata for a dataset used for text sentiment.

Parameter
NameDescription
var Google\Cloud\AutoMl\V1\TextSentimentDatasetMetadata
Returns
TypeDescription
$this

getName

Output only. The resource name of the dataset.

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

Returns
TypeDescription
string

setName

Output only. The resource name of the dataset.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDescription

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

Returns
TypeDescription
string

setDescription

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getExampleCount

Output only. The number of examples in the dataset.

Returns
TypeDescription
int

setExampleCount

Output only. The number of examples in the dataset.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. Timestamp when this dataset was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this dataset was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEtag

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

Returns
TypeDescription
string

setEtag

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getDatasetMetadata

Returns
TypeDescription
string