Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class AnnotatedDataset.
AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.
Generated from protobuf message google.cloud.datalabeling.v1beta1.AnnotatedDataset
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id} |
↳ display_name |
string
Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters. |
↳ description |
string
Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters. |
↳ annotation_source |
int
Output only. Source of the annotation. |
↳ annotation_type |
int
Output only. Type of the annotation. It is specified when starting labeling task. |
↳ example_count |
int|string
Output only. Number of examples in the annotated dataset. |
↳ completed_example_count |
int|string
Output only. Number of examples that have annotation in the annotated dataset. |
↳ label_stats |
Google\Cloud\DataLabeling\V1beta1\LabelStats
Output only. Per label statistics. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time the AnnotatedDataset was created. |
↳ metadata |
Google\Cloud\DataLabeling\V1beta1\AnnotatedDatasetMetadata
Output only. Additional information about AnnotatedDataset. |
↳ blocking_resources |
array
Output only. The names of any related resources that are blocking changes to the annotated dataset. |
getName
Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotationSource
Output only. Source of the annotation.
| Returns | |
|---|---|
| Type | Description |
int | |
setAnnotationSource
Output only. Source of the annotation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotationType
Output only. Type of the annotation. It is specified when starting labeling task.
| Returns | |
|---|---|
| Type | Description |
int | |
setAnnotationType
Output only. Type of the annotation. It is specified when starting labeling task.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExampleCount
Output only. Number of examples in the annotated dataset.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setExampleCount
Output only. Number of examples in the annotated dataset.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompletedExampleCount
Output only. Number of examples that have annotation in the annotated dataset.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setCompletedExampleCount
Output only. Number of examples that have annotation in the annotated dataset.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabelStats
Output only. Per label statistics.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DataLabeling\V1beta1\LabelStats|null | |
hasLabelStats
clearLabelStats
setLabelStats
Output only. Per label statistics.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DataLabeling\V1beta1\LabelStats
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time the AnnotatedDataset was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time the AnnotatedDataset was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetadata
Output only. Additional information about AnnotatedDataset.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DataLabeling\V1beta1\AnnotatedDatasetMetadata|null | |
hasMetadata
clearMetadata
setMetadata
Output only. Additional information about AnnotatedDataset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DataLabeling\V1beta1\AnnotatedDatasetMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBlockingResources
Output only. The names of any related resources that are blocking changes to the annotated dataset.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setBlockingResources
Output only. The names of any related resources that are blocking changes to the annotated dataset.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |