Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class Annotation.
Annotation for Example. Each example may have one or more annotations. For
example in image classification problem, each image might have one or more
labels. We call labels binded with this image an Annotation.
Generated from protobuf messagegoogle.cloud.datalabeling.v1beta1.Annotation
Namespace
Google \ Cloud \ DataLabeling \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
Output only. Annotation metadata, including information like votes for labels.
↳ annotation_sentiment
int
Output only. Sentiment for this annotation.
getName
Output only. Unique name of this annotation, format is:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
Returns
Type
Description
string
setName
Output only. Unique name of this annotation, format is:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAnnotationSource
Output only. The source of the annotation.
Returns
Type
Description
int
setAnnotationSource
Output only. The source of the annotation.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getAnnotationValue
Output only. This is the actual annotation value, e.g classification,
bounding box values are stored here.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Datalabeling V1beta1 Client - Class Annotation (0.6.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.3 (latest)](/php/docs/reference/cloud-datalabeling/latest/V1beta1.Annotation)\n- [0.6.2](/php/docs/reference/cloud-datalabeling/0.6.2/V1beta1.Annotation)\n- [0.5.7](/php/docs/reference/cloud-datalabeling/0.5.7/V1beta1.Annotation)\n- [0.4.2](/php/docs/reference/cloud-datalabeling/0.4.2/V1beta1.Annotation)\n- [0.3.1](/php/docs/reference/cloud-datalabeling/0.3.1/V1beta1.Annotation)\n- [0.2.0](/php/docs/reference/cloud-datalabeling/0.2.0/V1beta1.Annotation)\n- [0.1.14](/php/docs/reference/cloud-datalabeling/0.1.14/V1beta1.Annotation) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class Annotation.\n\nAnnotation for Example. Each example may have one or more annotations. For\nexample in image classification problem, each image might have one or more\nlabels. We call labels binded with this image an Annotation.\n\nGenerated from protobuf message `google.cloud.datalabeling.v1beta1.Annotation`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataLabeling \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Unique name of this annotation, format is:\nprojects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}\n\n### setName\n\nOutput only. Unique name of this annotation, format is:\nprojects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}\n\n### getAnnotationSource\n\nOutput only. The source of the annotation.\n\n### setAnnotationSource\n\nOutput only. The source of the annotation.\n\n### getAnnotationValue\n\nOutput only. This is the actual annotation value, e.g classification,\nbounding box values are stored here.\n\n### hasAnnotationValue\n\n### clearAnnotationValue\n\n### setAnnotationValue\n\nOutput only. This is the actual annotation value, e.g classification,\nbounding box values are stored here.\n\n### getAnnotationMetadata\n\nOutput only. Annotation metadata, including information like votes\nfor labels.\n\n### hasAnnotationMetadata\n\n### clearAnnotationMetadata\n\n### setAnnotationMetadata\n\nOutput only. Annotation metadata, including information like votes\nfor labels.\n\n### getAnnotationSentiment\n\nOutput only. Sentiment for this annotation.\n\n### setAnnotationSentiment\n\nOutput only. Sentiment for this annotation."]]
