Reference documentation and code samples for the AI Platform Data Labeling Service V1beta1 API class Google::Cloud::DataLabeling::V1beta1::Instruction.
Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#blocking_resources
def blocking_resources() -> ::Array<::String>
Returns
- (::Array<::String>) — Output only. The names of any related resources that are blocking changes to the instruction.
#blocking_resources=
def blocking_resources=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Output only. The names of any related resources that are blocking changes to the instruction.
Returns
- (::Array<::String>) — Output only. The names of any related resources that are blocking changes to the instruction.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Creation time of instruction.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Output only. Creation time of instruction.
Returns
- (::Google::Protobuf::Timestamp) — Output only. Creation time of instruction.
#csv_instruction
def csv_instruction() -> ::Google::Cloud::DataLabeling::V1beta1::CsvInstruction
Returns
-
(::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.
#csv_instruction=
def csv_instruction=(value) -> ::Google::Cloud::DataLabeling::V1beta1::CsvInstruction
Parameter
-
value (::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.
Returns
-
(::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.
#data_type
def data_type() -> ::Google::Cloud::DataLabeling::V1beta1::DataType
Returns
- (::Google::Cloud::DataLabeling::V1beta1::DataType) — Required. The data type of this instruction.
#data_type=
def data_type=(value) -> ::Google::Cloud::DataLabeling::V1beta1::DataType
Parameter
- value (::Google::Cloud::DataLabeling::V1beta1::DataType) — Required. The data type of this instruction.
Returns
- (::Google::Cloud::DataLabeling::V1beta1::DataType) — Required. The data type of this instruction.
#description
def description() -> ::String
Returns
- (::String) — Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
Returns
- (::String) — Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. The display name of the instruction. Maximum of 64 characters.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. The display name of the instruction. Maximum of 64 characters.
Returns
- (::String) — Required. The display name of the instruction. Maximum of 64 characters.
#name
def name() -> ::String
Returns
- (::String) — Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Returns
- (::String) — Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
#pdf_instruction
def pdf_instruction() -> ::Google::Cloud::DataLabeling::V1beta1::PdfInstruction
Returns
- (::Google::Cloud::DataLabeling::V1beta1::PdfInstruction) — Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
#pdf_instruction=
def pdf_instruction=(value) -> ::Google::Cloud::DataLabeling::V1beta1::PdfInstruction
Parameter
- value (::Google::Cloud::DataLabeling::V1beta1::PdfInstruction) — Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
Returns
- (::Google::Cloud::DataLabeling::V1beta1::PdfInstruction) — Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Last update time of instruction.
#update_time=
def update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Output only. Last update time of instruction.
Returns
- (::Google::Protobuf::Timestamp) — Output only. Last update time of instruction.