In order to customize your Label queue, you need to specify the labeling parameters. For an overview of queue prioritization, see our docs on the Queue system.

Set parameter overrides

Use setLabelingParameterOverrides to set all parameter overrides in one mutation. Then, you need to rebuild the queue. For more information on how to do this programmatically, contact our support team.

dataRow.id

WhereUniqueIdInput

ID of the data row you wish to set priority for. Max number of data rows you can include is 1000. Note: externalId not supported.

priority

Int

Place in the label queue

numLabels

Int

Number of times the asset should be labeled. This number should not exceed the number of labelers in the project.

Returns:

Field

Type

Description

success

Boolean

Returns false and gives you an error if the request was not properly received and processed. Will still return true if you submit one or more data rows that do not exist.

mutation SetLabelingParameterOverrides {
    project (where: { id: "<PROJECT_ID>" }) {
        setLabelingParameterOverrides (data:[
            { 
                dataRow: { id: "<DATA_ROW_ID>" }, 
                priority: 1, 
                numLabels: 2 
            },
            { 
                dataRow: { id: "<DATA_ROW_ID>" }, 
                priority: 2, 
                numLabels: 3 
            }
        ]) {
            success
        }
    }
}

Fetch parameter overrides

Use the project query to fetch any existing labeling parameter overrides.

query PullLabelingParameters {
    project (where: {id:"<PROJECT_ID>"}) {
        labelingParameterOverrides {
            id
            priority
        }
    }
}

Unset parameter overrides

Use the unsetLabelingParameterOverrides mutation to unset the prioritization for a set of Data Rows. Using this mutation will automatically result in the rebuild of the Label queue.

Field

Type

Description

dataRowId

ID

Data rows to remove parameter overrides from. The max number of data rows you may include in this mutation is 1000.

mutation UnsetLabelingParameterOverrides {
    project (where: { id: "<PROJECT_ID>" }) {
        unsetLabelingParameterOverrides (data:[
            { 
                dataRowId: "<DATA_ROW_ID>" 
            },
            { 
                dataRowId: "<DATA_ROW_ID>" 
            }
        ]) {
            success
        }
    }
}

Unset all parameter overrides

Use the unsetAllLabelingParameterOverrides to unset the labeling parameter overrides for all data rows in a project.

mutation UnsetAllParameterOverrides {
    project (where: {id: "<PROJECT_ID>"}) {
        unsetAllLabelingParameterOverrides {
            success
            deletedCount
        }
    }
}