instructions

Creates, updates, deletes, gets or lists a instructions resource.

Overview

Name	instructions
Type	Resource
Id	google.datalabeling.instructions

Fields

Name	Datatype	Description
name	string	Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
description	string	Optional. User-provided description of the instruction. The description can be up to 10000 characters long.
blockingResources	array	Output only. The names of any related resources that are blocking changes to the instruction.
createTime	string	Output only. Creation time of instruction.
csvInstruction	object	Deprecated: this instruction format is not supported any more. Instruction from a CSV file.
dataType	string	Required. The data type of this instruction.
displayName	string	Required. The display name of the instruction. Maximum of 64 characters.
pdfInstruction	object	Instruction from a PDF file.
updateTime	string	Output only. Last update time of instruction.

Methods

Name	Accessible by	Required Params	Description
projects_instructions_get	SELECT	instructionsId, projectsId	Gets an instruction by resource name.
projects_instructions_list	SELECT	projectsId	Lists instructions for a project. Pagination is supported.
projects_instructions_create	INSERT	projectsId	Creates an instruction for how data should be labeled.
projects_instructions_delete	DELETE	instructionsId, projectsId	Deletes an instruction object by resource name.

SELECT examples

Lists instructions for a project. Pagination is supported.

SELECT
name,
description,
blockingResources,
createTime,
csvInstruction,
dataType,
displayName,
pdfInstruction,
updateTime
FROM google.datalabeling.instructions
WHERE projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new instructions resource.

All Properties

/*+ create */
INSERT INTO google.datalabeling.instructions (
projectsId,
instruction
)
SELECT 
'{{ projectsId }}',
'{{ instruction }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: instruction
      value:
        - name: name
          value: string
        - name: displayName
          value: string
        - name: description
          value: string
        - name: createTime
          value: string
        - name: updateTime
          value: string
        - name: dataType
          value: string
        - name: csvInstruction
          value:
            - name: gcsFileUri
              value: string
        - name: pdfInstruction
          value:
            - name: gcsFileUri
              value: string
        - name: blockingResources
          value:
            - string

DELETE example

Deletes the specified instructions resource.

/*+ delete */
DELETE FROM google.datalabeling.instructions
WHERE instructionsId = '{{ instructionsId }}'
AND projectsId = '{{ projectsId }}';