Object Detection Model¶
v2¶
Class: RoboflowObjectDetectionModelBlockV2 (there are multiple versions of this block)
Warning: This block has multiple versions. Please refer to the specific version for details. You can learn more about how versions work here: Versioning
Run inference on a object-detection model hosted on or uploaded to Roboflow.
You can query any model that is private to your account, or any public model available on Roboflow Universe.
You will need to set your Roboflow API key in your Inference environment to use this block. To learn more about setting your Roboflow API key, refer to the Inference documentation.
Type identifier¶
Use the following identifier in step "type" field: roboflow_core/roboflow_object_detection_model@v2to add the block as
as step in your workflow.
Properties¶
| Name | Type | Description | Refs |
|---|---|---|---|
name |
str |
Enter a unique identifier for this step.. | ❌ |
model_id |
str |
Roboflow model identifier.. | ✅ |
confidence |
float |
Confidence threshold for predictions.. | ✅ |
class_filter |
List[str] |
List of accepted classes. Classes must exist in the model's training set.. | ✅ |
iou_threshold |
float |
Minimum overlap threshold between boxes to combine them into a single detection, used in NMS. Learn more.. | ✅ |
max_detections |
int |
Maximum number of detections to return.. | ✅ |
class_agnostic_nms |
bool |
Boolean flag to specify if NMS is to be used in class-agnostic mode.. | ✅ |
max_candidates |
int |
Maximum number of candidates as NMS input to be taken into account.. | ✅ |
disable_active_learning |
bool |
Boolean flag to disable project-level active learning for this block.. | ✅ |
active_learning_target_dataset |
str |
Target dataset for active learning, if enabled.. | ✅ |
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 Object Detection Model in version v2.
- inputs:
Image Slicer,Stability AI Inpainting,Clip Comparison,Perspective Correction,Roboflow Custom Metadata,Object Detection Model,SIFT Comparison,Grid Visualization,Ellipse Visualization,SIFT,VLM as Detector,Image Contours,Multi-Label Classification Model,Absolute Static Crop,Camera Focus,Polygon Visualization,Trace Visualization,VLM as Detector,Dot Visualization,Clip Comparison,Identify Changes,Polygon Zone Visualization,Identify Outliers,Roboflow Dataset Upload,VLM as Classifier,Classification Label Visualization,Corner Visualization,Llama 3.2 Vision,Dynamic Crop,Reference Path Visualization,Line Counter,Label Visualization,Mask Visualization,Triangle Visualization,Line Counter Visualization,Template Matching,Dynamic Zone,Model Monitoring Inference Aggregator,Blur Visualization,Line Counter,Anthropic Claude,Instance Segmentation Model,Webhook Sink,SIFT Comparison,Slack Notification,Pixelate Visualization,Relative Static Crop,Detections Consensus,Twilio SMS Notification,Dimension Collapse,VLM as Classifier,Keypoint Detection Model,Roboflow Dataset Upload,Google Gemini,Model Comparison Visualization,Halo Visualization,JSON Parser,Crop Visualization,Image Blur,Distance Measurement,Circle Visualization,Buffer,Image Preprocessing,Background Color Visualization,Pixel Color Count,Size Measurement,Florence-2 Model,Single-Label Classification Model,Bounding Box Visualization,Florence-2 Model,Local File Sink,Image Slicer,Stitch Images,Stability AI Image Generation,Image Threshold,Keypoint Visualization,Email Notification,Color Visualization,Image Convert Grayscale,OpenAI - outputs:
Segment Anything 2 Model,Detections Filter,Stitch OCR Detections,Pixelate Visualization,Perspective Correction,Instance Segmentation Model,Object Detection Model,Path Deviation,Roboflow Custom Metadata,Detections Consensus,Object Detection Model,Detection Offset,Roboflow Dataset Upload,Keypoint Detection Model,Ellipse Visualization,Model Comparison Visualization,Multi-Label Classification Model,Crop Visualization,Qwen2.5-VL,Byte Tracker,Trace Visualization,Distance Measurement,Circle Visualization,Velocity,Keypoint Detection Model,Multi-Label Classification Model,Background Color Visualization,Dot Visualization,Roboflow Dataset Upload,Size Measurement,Florence-2 Model,Single-Label Classification Model,Byte Tracker,Corner Visualization,Florence-2 Model,Byte Tracker,Bounding Box Visualization,Dynamic Crop,Line Counter,Detections Stabilizer,Label Visualization,Triangle Visualization,Detections Stitch,Detections Transformation,Model Monitoring Inference Aggregator,Color Visualization,Path Deviation,Time in Zone,Blur Visualization,Line Counter,Single-Label Classification Model,Webhook Sink,Time in Zone,Instance Segmentation Model,Detections Classes Replacement
Input and Output Bindings¶
The available connections depend on its binding kinds. Check what binding kinds
Object Detection Model in version v2 has.
Bindings
-
input
images(image): The image to infer on..model_id(roboflow_model_id): Roboflow model identifier..confidence(float_zero_to_one): Confidence threshold for predictions..class_filter(list_of_values): List of accepted classes. Classes must exist in the model's training set..iou_threshold(float_zero_to_one): Minimum overlap threshold between boxes to combine them into a single detection, used in NMS. Learn more..max_detections(integer): Maximum number of detections to return..class_agnostic_nms(boolean): Boolean flag to specify if NMS is to be used in class-agnostic mode..max_candidates(integer): Maximum number of candidates as NMS input to be taken into account..disable_active_learning(boolean): Boolean flag to disable project-level active learning for this block..active_learning_target_dataset(roboflow_project): Target dataset for active learning, if enabled..
-
output
inference_id(inference_id): Inference identifier.predictions(object_detection_prediction): Prediction with detected bounding boxes in form of sv.Detections(...) object.model_id(roboflow_model_id): Roboflow model id.
Example JSON definition of step Object Detection Model in version v2
{
"name": "<your_step_name_here>",
"type": "roboflow_core/roboflow_object_detection_model@v2",
"images": "$inputs.image",
"model_id": "my_project/3",
"confidence": 0.3,
"class_filter": [
"a",
"b",
"c"
],
"iou_threshold": 0.4,
"max_detections": 300,
"class_agnostic_nms": true,
"max_candidates": 3000,
"disable_active_learning": true,
"active_learning_target_dataset": "my_project"
}
v1¶
Class: RoboflowObjectDetectionModelBlockV1 (there are multiple versions of this block)
Warning: This block has multiple versions. Please refer to the specific version for details. You can learn more about how versions work here: Versioning
Run inference on a object-detection model hosted on or uploaded to Roboflow.
You can query any model that is private to your account, or any public model available on Roboflow Universe.
You will need to set your Roboflow API key in your Inference environment to use this block. To learn more about setting your Roboflow API key, refer to the Inference documentation.
Type identifier¶
Use the following identifier in step "type" field: roboflow_core/roboflow_object_detection_model@v1to add the block as
as step in your workflow.
Properties¶
| Name | Type | Description | Refs |
|---|---|---|---|
name |
str |
Enter a unique identifier for this step.. | ❌ |
model_id |
str |
Roboflow model identifier.. | ✅ |
confidence |
float |
Confidence threshold for predictions.. | ✅ |
class_filter |
List[str] |
List of accepted classes. Classes must exist in the model's training set.. | ✅ |
iou_threshold |
float |
Minimum overlap threshold between boxes to combine them into a single detection, used in NMS. Learn more.. | ✅ |
max_detections |
int |
Maximum number of detections to return.. | ✅ |
class_agnostic_nms |
bool |
Boolean flag to specify if NMS is to be used in class-agnostic mode.. | ✅ |
max_candidates |
int |
Maximum number of candidates as NMS input to be taken into account.. | ✅ |
disable_active_learning |
bool |
Boolean flag to disable project-level active learning for this block.. | ✅ |
active_learning_target_dataset |
str |
Target dataset for active learning, if enabled.. | ✅ |
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 Object Detection Model in version v1.
- inputs:
Image Slicer,Stability AI Inpainting,Clip Comparison,Perspective Correction,Roboflow Custom Metadata,Object Detection Model,SIFT Comparison,Grid Visualization,Ellipse Visualization,SIFT,VLM as Detector,Image Contours,Multi-Label Classification Model,Absolute Static Crop,Camera Focus,Polygon Visualization,Trace Visualization,VLM as Detector,Dot Visualization,Clip Comparison,Identify Changes,Polygon Zone Visualization,Identify Outliers,Roboflow Dataset Upload,VLM as Classifier,Classification Label Visualization,Corner Visualization,Llama 3.2 Vision,Dynamic Crop,Reference Path Visualization,Line Counter,Label Visualization,Mask Visualization,Triangle Visualization,Line Counter Visualization,Template Matching,Dynamic Zone,Model Monitoring Inference Aggregator,Blur Visualization,Line Counter,Anthropic Claude,Instance Segmentation Model,Webhook Sink,SIFT Comparison,Slack Notification,Pixelate Visualization,Relative Static Crop,Detections Consensus,Twilio SMS Notification,Dimension Collapse,VLM as Classifier,Keypoint Detection Model,Roboflow Dataset Upload,Google Gemini,Model Comparison Visualization,Halo Visualization,JSON Parser,Crop Visualization,Image Blur,Distance Measurement,Circle Visualization,Buffer,Image Preprocessing,Background Color Visualization,Pixel Color Count,Size Measurement,Florence-2 Model,Single-Label Classification Model,Bounding Box Visualization,Florence-2 Model,Local File Sink,Image Slicer,Stitch Images,Stability AI Image Generation,Image Threshold,Keypoint Visualization,Email Notification,Color Visualization,Image Convert Grayscale,OpenAI - outputs:
Segment Anything 2 Model,Cache Get,Stability AI Inpainting,Clip Comparison,Perspective Correction,Cache Set,Roboflow Custom Metadata,SIFT Comparison,Detection Offset,CogVLM,Ellipse Visualization,OpenAI,Polygon Visualization,Trace Visualization,CLIP Embedding Model,Dot Visualization,Google Vision OCR,Polygon Zone Visualization,Roboflow Dataset Upload,Llama 3.2 Vision,Classification Label Visualization,Corner Visualization,Byte Tracker,Line Counter,Dynamic Crop,Reference Path Visualization,Label Visualization,Detections Stabilizer,Mask Visualization,Triangle Visualization,Line Counter Visualization,Detections Transformation,Model Monitoring Inference Aggregator,Time in Zone,Blur Visualization,Line Counter,Anthropic Claude,Instance Segmentation Model,Webhook Sink,Time in Zone,Instance Segmentation Model,Slack Notification,Detections Filter,Stitch OCR Detections,Pixelate Visualization,Path Deviation,Detections Consensus,Twilio SMS Notification,Roboflow Dataset Upload,Google Gemini,Model Comparison Visualization,Halo Visualization,Crop Visualization,Byte Tracker,Image Blur,Distance Measurement,Circle Visualization,Velocity,Image Preprocessing,Background Color Visualization,Pixel Color Count,Size Measurement,Florence-2 Model,Bounding Box Visualization,Florence-2 Model,Local File Sink,Byte Tracker,LMM For Classification,Stability AI Image Generation,Image Threshold,Detections Stitch,LMM,Keypoint Visualization,Email Notification,Color Visualization,Path Deviation,YOLO-World Model,Detections Classes Replacement,OpenAI
Input and Output Bindings¶
The available connections depend on its binding kinds. Check what binding kinds
Object Detection Model in version v1 has.
Bindings
-
input
images(image): The image to infer on..model_id(roboflow_model_id): Roboflow model identifier..confidence(float_zero_to_one): Confidence threshold for predictions..class_filter(list_of_values): List of accepted classes. Classes must exist in the model's training set..iou_threshold(float_zero_to_one): Minimum overlap threshold between boxes to combine them into a single detection, used in NMS. Learn more..max_detections(integer): Maximum number of detections to return..class_agnostic_nms(boolean): Boolean flag to specify if NMS is to be used in class-agnostic mode..max_candidates(integer): Maximum number of candidates as NMS input to be taken into account..disable_active_learning(boolean): Boolean flag to disable project-level active learning for this block..active_learning_target_dataset(roboflow_project): Target dataset for active learning, if enabled..
-
output
inference_id(string): String value.predictions(object_detection_prediction): Prediction with detected bounding boxes in form of sv.Detections(...) object.
Example JSON definition of step Object Detection Model in version v1
{
"name": "<your_step_name_here>",
"type": "roboflow_core/roboflow_object_detection_model@v1",
"images": "$inputs.image",
"model_id": "my_project/3",
"confidence": 0.3,
"class_filter": [
"a",
"b",
"c"
],
"iou_threshold": 0.4,
"max_detections": 300,
"class_agnostic_nms": true,
"max_candidates": 3000,
"disable_active_learning": true,
"active_learning_target_dataset": "my_project"
}