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
defblocking_resources()->::Array<::String>
Returns
(::Array<::String>) โ Output only. The names of any related resources that are blocking changes
to the instruction.
#blocking_resources=
defblocking_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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# AI Platform Data Labeling Service V1beta1 API - Class Google::Cloud::DataLabeling::V1beta1::Instruction (v0.11.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.11.1 (latest)](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/latest/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.11.0](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.11.0/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.10.1](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.10.1/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.9.0](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.9.0/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.8.1](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.8.1/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.7.2](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.7.2/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.6.0](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.6.0/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.5.0](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.5.0/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.4.0](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.4.0/Google-Cloud-DataLabeling-V1beta1-Instruction)\n- [0.3.5](/ruby/docs/reference/google-cloud-data_labeling-v1beta1/0.3.5/Google-Cloud-DataLabeling-V1beta1-Instruction) \nReference documentation and code samples for the AI Platform Data Labeling Service V1beta1 API class Google::Cloud::DataLabeling::V1beta1::Instruction.\n\nInstruction of how to perform the labeling task for human operators.\nCurrently only PDF instruction is supported. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #blocking_resources\n\n def blocking_resources() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Output only. The names of any related resources that are blocking changes to the instruction.\n\n### #blocking_resources=\n\n def blocking_resources=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Output only. The names of any related resources that are blocking changes to the instruction. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Output only. The names of any related resources that are blocking changes to the instruction.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Creation time of instruction.\n\n### #create_time=\n\n def create_time=(value) -\u003e ::Google::Protobuf::Timestamp\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Creation time of instruction. \n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Creation time of instruction.\n\n### #csv_instruction\n\n def csv_instruction() -\u003e ::Google::Cloud::DataLabeling::V1beta1::CsvInstruction\n\n**Returns**\n\n- ([::Google::Cloud::DataLabeling::V1beta1::CsvInstruction](./Google-Cloud-DataLabeling-V1beta1-CsvInstruction)) ---\n\n Deprecated: this instruction format is not supported any more.\n Instruction from a CSV file, such as for classification task.\n The CSV file should have exact two columns, in the following format:\n - The first column is labeled data, such as an image reference, text.\n - The second column is comma separated labels associated with data.\n\n### #csv_instruction=\n\n def csv_instruction=(value) -\u003e ::Google::Cloud::DataLabeling::V1beta1::CsvInstruction\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DataLabeling::V1beta1::CsvInstruction](./Google-Cloud-DataLabeling-V1beta1-CsvInstruction)) ---\n\n Deprecated: this instruction format is not supported any more.\n Instruction from a CSV file, such as for classification task.\n The CSV file should have exact two columns, in the following format:\n - The first column is labeled data, such as an image reference, text.\n- The second column is comma separated labels associated with data. \n**Returns**\n\n- ([::Google::Cloud::DataLabeling::V1beta1::CsvInstruction](./Google-Cloud-DataLabeling-V1beta1-CsvInstruction)) ---\n\n Deprecated: this instruction format is not supported any more.\n Instruction from a CSV file, such as for classification task.\n The CSV file should have exact two columns, in the following format:\n - The first column is labeled data, such as an image reference, text.\n - The second column is comma separated labels associated with data.\n\n### #data_type\n\n def data_type() -\u003e ::Google::Cloud::DataLabeling::V1beta1::DataType\n\n**Returns**\n\n- ([::Google::Cloud::DataLabeling::V1beta1::DataType](./Google-Cloud-DataLabeling-V1beta1-DataType)) --- Required. The data type of this instruction.\n\n### #data_type=\n\n def data_type=(value) -\u003e ::Google::Cloud::DataLabeling::V1beta1::DataType\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DataLabeling::V1beta1::DataType](./Google-Cloud-DataLabeling-V1beta1-DataType)) --- Required. The data type of this instruction. \n**Returns**\n\n- ([::Google::Cloud::DataLabeling::V1beta1::DataType](./Google-Cloud-DataLabeling-V1beta1-DataType)) --- Required. The data type of this instruction.\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. User-provided description of the instruction. The description can be up to 10000 characters long.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. User-provided description of the instruction. The description can be up to 10000 characters long. \n**Returns**\n\n- (::String) --- Optional. User-provided description of the instruction. The description can be up to 10000 characters long.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The display name of the instruction. Maximum of 64 characters.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The display name of the instruction. Maximum of 64 characters. \n**Returns**\n\n- (::String) --- Required. The display name of the instruction. Maximum of 64 characters.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} \n**Returns**\n\n- (::String) --- Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}\n\n### #pdf_instruction\n\n def pdf_instruction() -\u003e ::Google::Cloud::DataLabeling::V1beta1::PdfInstruction\n\n**Returns**\n\n- ([::Google::Cloud::DataLabeling::V1beta1::PdfInstruction](./Google-Cloud-DataLabeling-V1beta1-PdfInstruction)) --- Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.\n\n### #pdf_instruction=\n\n def pdf_instruction=(value) -\u003e ::Google::Cloud::DataLabeling::V1beta1::PdfInstruction\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DataLabeling::V1beta1::PdfInstruction](./Google-Cloud-DataLabeling-V1beta1-PdfInstruction)) --- Instruction from a PDF document. The PDF should be in a Cloud Storage bucket. \n**Returns**\n\n- ([::Google::Cloud::DataLabeling::V1beta1::PdfInstruction](./Google-Cloud-DataLabeling-V1beta1-PdfInstruction)) --- Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Last update time of instruction.\n\n### #update_time=\n\n def update_time=(value) -\u003e ::Google::Protobuf::Timestamp\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Last update time of instruction. \n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Last update time of instruction."]]
