Skip to content

OCR Model

Class: OCRModelBlockV1

Source: inference.core.workflows.core_steps.models.foundation.ocr.v1.OCRModelBlockV1

Retrieve the characters in an image using DocTR Optical Character Recognition (OCR).

This block returns the text within an image.

You may want to use this block in combination with a detections-based block (i.e. ObjectDetectionBlock). An object detection model could isolate specific regions from an image (i.e. a shipping container ID in a logistics use case) for further processing. You can then use a DynamicCropBlock to crop the region of interest before running OCR.

Using a detections model then cropping detections allows you to isolate your analysis on particular regions of an image.

Type identifier

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

Properties

Name Type Description Refs
name str Unique name of step in workflows. ❌

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

Available Connections

Compatible Blocks

Check what blocks you can connect to OCR Model in version v1.

Input and Output Bindings

The available connections depend on its binding kinds. Check what binding kinds OCR Model in version v1 has.

Bindings

  • input

    • images (image): The image to infer on..

  • output

    • result (string): String value.
    • predictions (object_detection_prediction): Prediction with detected bounding boxes in form of sv.Detections(...) object.
    • parent_id (parent_id): Identifier of parent for step output.
    • root_parent_id (parent_id): Identifier of parent for step output.
    • prediction_type (prediction_type): String value with type of prediction.
Example JSON definition of step OCR Model in version v1 
{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/ocr_model@v1",
    "images": "$inputs.image"
}