Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class HumanAnnotationConfig.
Configuration for how human labeling task should be done.
Generated from protobuf messagegoogle.cloud.datalabeling.v1beta1.HumanAnnotationConfig
Namespace
Google \ Cloud \ DataLabeling \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ instruction
string
Required. Instruction resource name.
↳ annotated_dataset_display_name
string
Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .
↳ annotated_dataset_description
string
Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.
↳ label_group
string
Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression[a-zA-Z\\d_-]{0,128}.
↳ language_code
string
Optional. The Language of this question, as aBCP-47. Default value is en-US. Only need to set this when task is language related. For example, French text classification.
↳ replica_count
int
Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.
Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.
↳ contributor_emails
array
Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI:https://crowd-compute.appspot.com/
↳ user_email_address
string
Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.
getInstruction
Required. Instruction resource name.
Returns
Type
Description
string
setInstruction
Required. Instruction resource name.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAnnotatedDatasetDisplayName
Required. A human-readable name for AnnotatedDataset defined by
users. Maximum of 64 characters
.
Generated from protobuf fieldstring annotated_dataset_display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
string
setAnnotatedDatasetDisplayName
Required. A human-readable name for AnnotatedDataset defined by
users. Maximum of 64 characters
.
Generated from protobuf fieldstring annotated_dataset_display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAnnotatedDatasetDescription
Optional. A human-readable description for AnnotatedDataset.
The description can be up to 10000 characters long.
Returns
Type
Description
string
setAnnotatedDatasetDescription
Optional. A human-readable description for AnnotatedDataset.
The description can be up to 10000 characters long.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLabelGroup
Optional. A human-readable label used to logically group labeling tasks.
This string must match the regular expression[a-zA-Z\\d_-]{0,128}.
Returns
Type
Description
string
setLabelGroup
Optional. A human-readable label used to logically group labeling tasks.
This string must match the regular expression[a-zA-Z\\d_-]{0,128}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLanguageCode
Optional. The Language of this question, as aBCP-47.
Default value is en-US.
Only need to set this when task is language related. For example, French
text classification.
Returns
Type
Description
string
setLanguageCode
Optional. The Language of this question, as aBCP-47.
Default value is en-US.
Only need to set this when task is language related. For example, French
text classification.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getReplicaCount
Optional. Replication of questions. Each question will be sent to up to
this number of contributors to label. Aggregated answers will be returned.
Default is set to 1.
For image related labeling, valid values are 1, 3, 5.
Returns
Type
Description
int
setReplicaCount
Optional. Replication of questions. Each question will be sent to up to
this number of contributors to label. Aggregated answers will be returned.
Default is set to 1.
For image related labeling, valid values are 1, 3, 5.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getQuestionDuration
Optional. Maximum duration for contributors to answer a question. Maximum
is 3600 seconds. Default is 3600 seconds.
Optional. If you want your own labeling contributors to manage and work on
this labeling request, you can set these contributors here. We will give
them access to the question types in crowdcompute. Note that these
emails must be registered in crowdcompute worker UI:https://crowd-compute.appspot.com/
Optional. If you want your own labeling contributors to manage and work on
this labeling request, you can set these contributors here. We will give
them access to the question types in crowdcompute. Note that these
emails must be registered in crowdcompute worker UI:https://crowd-compute.appspot.com/
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getUserEmailAddress
Email of the user who started the labeling task and should be notified by
email. If empty no notification will be sent.
Returns
Type
Description
string
setUserEmailAddress
Email of the user who started the labeling task and should be notified by
email. If empty no notification will be sent.
[[["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 HumanAnnotationConfig (0.6.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.3 (latest)](/php/docs/reference/cloud-datalabeling/latest/V1beta1.HumanAnnotationConfig)\n- [0.6.2](/php/docs/reference/cloud-datalabeling/0.6.2/V1beta1.HumanAnnotationConfig)\n- [0.5.7](/php/docs/reference/cloud-datalabeling/0.5.7/V1beta1.HumanAnnotationConfig)\n- [0.4.2](/php/docs/reference/cloud-datalabeling/0.4.2/V1beta1.HumanAnnotationConfig)\n- [0.3.1](/php/docs/reference/cloud-datalabeling/0.3.1/V1beta1.HumanAnnotationConfig)\n- [0.2.0](/php/docs/reference/cloud-datalabeling/0.2.0/V1beta1.HumanAnnotationConfig)\n- [0.1.14](/php/docs/reference/cloud-datalabeling/0.1.14/V1beta1.HumanAnnotationConfig) \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 HumanAnnotationConfig.\n\nConfiguration for how human labeling task should be done.\n\nGenerated from protobuf message `google.cloud.datalabeling.v1beta1.HumanAnnotationConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataLabeling \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getInstruction\n\nRequired. Instruction resource name.\n\n### setInstruction\n\nRequired. Instruction resource name.\n\n### getAnnotatedDatasetDisplayName\n\nRequired. A human-readable name for AnnotatedDataset defined by\nusers. Maximum of 64 characters\n.\n\nGenerated from protobuf field `string annotated_dataset_display_name = 2 [(.google.api.field_behavior) = REQUIRED];`\n\n### setAnnotatedDatasetDisplayName\n\nRequired. A human-readable name for AnnotatedDataset defined by\nusers. Maximum of 64 characters\n.\n\nGenerated from protobuf field `string annotated_dataset_display_name = 2 [(.google.api.field_behavior) = REQUIRED];`\n\n### getAnnotatedDatasetDescription\n\nOptional. A human-readable description for AnnotatedDataset.\n\nThe description can be up to 10000 characters long.\n\n### setAnnotatedDatasetDescription\n\nOptional. A human-readable description for AnnotatedDataset.\n\nThe description can be up to 10000 characters long.\n\n### getLabelGroup\n\nOptional. A human-readable label used to logically group labeling tasks.\n\nThis string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.\n\n### setLabelGroup\n\nOptional. A human-readable label used to logically group labeling tasks.\n\nThis string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.\n\n### getLanguageCode\n\nOptional. The Language of this question, as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).\n\nDefault value is en-US.\nOnly need to set this when task is language related. For example, French\ntext classification.\n\n### setLanguageCode\n\nOptional. The Language of this question, as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).\n\nDefault value is en-US.\nOnly need to set this when task is language related. For example, French\ntext classification.\n\n### getReplicaCount\n\nOptional. Replication of questions. Each question will be sent to up to\nthis number of contributors to label. Aggregated answers will be returned.\n\nDefault is set to 1.\nFor image related labeling, valid values are 1, 3, 5.\n\n### setReplicaCount\n\nOptional. Replication of questions. Each question will be sent to up to\nthis number of contributors to label. Aggregated answers will be returned.\n\nDefault is set to 1.\nFor image related labeling, valid values are 1, 3, 5.\n\n### getQuestionDuration\n\nOptional. Maximum duration for contributors to answer a question. Maximum\nis 3600 seconds. Default is 3600 seconds.\n\n### hasQuestionDuration\n\n### clearQuestionDuration\n\n### setQuestionDuration\n\nOptional. Maximum duration for contributors to answer a question. Maximum\nis 3600 seconds. Default is 3600 seconds.\n\n### getContributorEmails\n\nOptional. If you want your own labeling contributors to manage and work on\nthis labeling request, you can set these contributors here. We will give\nthem access to the question types in crowdcompute. Note that these\nemails must be registered in crowdcompute worker UI:\n\u003chttps://crowd-compute.appspot.com/\u003e\n\n### setContributorEmails\n\nOptional. If you want your own labeling contributors to manage and work on\nthis labeling request, you can set these contributors here. We will give\nthem access to the question types in crowdcompute. Note that these\nemails must be registered in crowdcompute worker UI:\n\u003chttps://crowd-compute.appspot.com/\u003e\n\n### getUserEmailAddress\n\nEmail of the user who started the labeling task and should be notified by\nemail. If empty no notification will be sent.\n\n### setUserEmailAddress\n\nEmail of the user who started the labeling task and should be notified by\nemail. If empty no notification will be sent."]]
