REST Resource: projects.instructions

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 (DataType),
  "csvInstruction": {
    object (CsvInstruction)
  },
  "pdfInstruction": {
    object (PdfInstruction)
  },
  "blockingResources": [
    string
  ]
}
Fields
name

string

Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

displayName

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.

createTime

string (Timestamp format)

Output only. Creation time of instruction.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Last update time of instruction.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
dataType

enum (DataType)

Required. The data type of this instruction.

csvInstruction
(deprecated)

object (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.
pdfInstruction

object (PdfInstruction)

Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.

blockingResources[]

string

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

string

CSV file for the instruction. Only gcs path is allowed.

PdfInstruction

Instruction from a PDF file.

JSON representation 
{
  "gcsFileUri": string
}
Fields
gcsFileUri

string

PDF file for the instruction. Only gcs path is allowed.

Methods

create

 Creates an instruction for how data should be labeled.

delete

 Deletes an instruction object by resource name.

get

 Gets an instruction by resource name.

list

 Lists instructions for a project.