Skip to content

Property Definition

Define a field using properties from previous workflow steps.

Example use-cases: * extraction of all class names for object-detection predictions * extraction of class / confidence from classification result * extraction ocr text from OCR result

Type identifier

Use the following identifier in step "type" field: roboflow_core/property_definition@v1to add the block as as step in your workflow.

Properties

Name Type Description Refs
name str Enter a unique identifier for this step..
operations List[Union[ClassificationPropertyExtract, ConvertDictionaryToJSON, ConvertImageToBase64, ConvertImageToJPEG, DetectionsFilter, DetectionsOffset, DetectionsPropertyExtract, DetectionsRename, DetectionsSelection, DetectionsShift, DetectionsToDictionary, Divide, ExtractDetectionProperty, ExtractImageProperty, LookupTable, Multiply, NumberRound, NumericSequenceAggregate, RandomNumber, SequenceAggregate, SequenceApply, SequenceLength, SequenceMap, SortDetections, StringMatches, StringSubSequence, StringToLowerCase, StringToUpperCase, ToBoolean, ToNumber, ToString]] List of operations to perform on data to generate output.

The Refs column marks possibility to parametrise the property with dynamic values available in workflow runtime. See Bindings for more info.

Available Connections

Check what blocks you can connect to Property Definition in version v1.

Input and Output Bindings

The available connections depend on its binding kinds. Check what binding kinds Property Definition in version v1 has.

Bindings
  • input

    • data (*): Reference data to extract property from.
  • output

    • output (*): Equivalent of any element.
Example JSON definition of step Property Definition in version v1
{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/property_definition@v1",
    "data": "$steps.my_step.predictions",
    "operations": [
        {
            "property_name": "class_name",
            "type": "DetectionsPropertyExtract"
        }
    ]
}