Resource: Instruction
Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.
JSON representation | |
---|---|
{ "name": string, "displayName": string, "description": string, "createTime": string, "updateTime": string, "dataType": enum ( |
Fields | |
---|---|
name |
Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} |
displayName |
Required. The display name of the instruction. Maximum of 64 characters. |
description |
Optional. User-provided description of the instruction. The description can be up to 10000 characters long. |
createTime |
Output only. Creation time of instruction. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
updateTime |
Output only. Last update time of instruction. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
dataType |
Required. The data type of this instruction. |
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:
|
pdfInstruction |
Instruction from a PDF document. The PDF should be in a Cloud Storage bucket. |
blockingResources[] |
Output only. The names of any related resources that are blocking changes to the instruction. |
CsvInstruction
Deprecated: this instruction format is not supported any more. Instruction from a CSV file.
JSON representation | |
---|---|
{ "gcsFileUri": string } |
Fields | |
---|---|
gcsFileUri |
CSV file for the instruction. Only gcs path is allowed. |
PdfInstruction
Instruction from a PDF file.
JSON representation | |
---|---|
{ "gcsFileUri": string } |
Fields | |
---|---|
gcsFileUri |
PDF file for the instruction. Only gcs path is allowed. |
Methods |
|
---|---|
|
Creates an instruction for how data should be labeled. |
|
Deletes an instruction object by resource name. |
|
Gets an instruction by resource name. |
|
Lists instructions for a project. |