Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class Instruction.
Instruction of how to perform the labeling task for human operators.
Currently only PDF instruction is supported.
Generated from protobuf message google.cloud.datalabeling.v1beta1.Instruction
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
↳ display_name
string
Required. The display name of the instruction. Maximum of 64 characters.
↳ description
string
Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
↳ create_time
↳ update_time
↳ data_type
int
Required. The data type of this instruction.
↳ csv_instruction
Google\Cloud\DataLabeling\V1beta1\CsvInstruction
Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * The first column is labeled data, such as an image reference, text. * The second column is comma separated labels associated with data.
↳ pdf_instruction
Google\Cloud\DataLabeling\V1beta1\PdfInstruction
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
↳ blocking_resources
array
Output only. The names of any related resources that are blocking changes to the instruction.
getName
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
string
setName
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
var
string
$this
getDisplayName
Required. The display name of the instruction. Maximum of 64 characters.
string
setDisplayName
Required. The display name of the instruction. Maximum of 64 characters.
var
string
$this
getDescription
Optional. User-provided description of the instruction.
The description can be up to 10000 characters long.
string
setDescription
Optional. User-provided description of the instruction.
The description can be up to 10000 characters long.
var
string
$this
getCreateTime
Output only. Creation time of instruction.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time of instruction.
$this
getUpdateTime
Output only. Last update time of instruction.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update time of instruction.
$this
getDataType
Required. The data type of this instruction.
int
setDataType
Required. The data type of this instruction.
var
int
$this
getCsvInstruction
Deprecated: this instruction format is not supported any more.
Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format:
- The first column is labeled data, such as an image reference, text.
- The second column is comma separated labels associated with data.
hasCsvInstruction
clearCsvInstruction
setCsvInstruction
Deprecated: this instruction format is not supported any more.
Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format:
- The first column is labeled data, such as an image reference, text.
- The second column is comma separated labels associated with data.
$this
getPdfInstruction
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
hasPdfInstruction
clearPdfInstruction
setPdfInstruction
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
$this
getBlockingResources
Output only. The names of any related resources that are blocking changes to the instruction.
setBlockingResources
Output only. The names of any related resources that are blocking changes to the instruction.
var
string[]
$this
