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 message google.cloud.datalabeling.v1beta1.HumanAnnotationConfig
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 |
↳ language_code |
string
Optional. The Language of this question, as a BCP-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. |
↳ question_duration |
Google\Protobuf\Duration
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 field string 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 field string 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 a BCP-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 a BCP-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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasQuestionDuration
clearQuestionDuration
setQuestionDuration
Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContributorEmails
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/
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setContributorEmails
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |