Skip to content

Seg Preview

Class: SegPreviewBlockV1

Source: inference.core.workflows.core_steps.models.foundation.seg_preview.v1.SegPreviewBlockV1

Seg Preview

Type identifier

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

Properties

Name Type Description Refs
name str Enter a unique identifier for this step..
class_names Union[List[str], str] List of classes to recognise.
threshold float Threshold for predicted mask scores.

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

Runtime compatibility

requires_internet — air-gapped / offline deployments
This block depends on a service that is not reachable from fully offline / air-gapped deployments.
hard — runtime self_hosted_cpu, self_hosted_gpu, inference_pipeline
Seg Preview calls the Roboflow-internal API_BASE_URL/inferenceproxy/seg-preview endpoint, which is only reachable from Roboflow-hosted runtimes (HOSTED_SERVERLESS, DEDICATED_DEPLOYMENT). Self-hosted deployments cannot run this block.

Available Connections

Compatible Blocks

Check what blocks you can connect to Seg Preview in version v1.

Input and Output Bindings

The available connections depend on its binding kinds. Check what binding kinds Seg Preview in version v1 has.

Bindings
  • input

    • images (image): The image to infer on..
    • class_names (Union[string, list_of_values]): List of classes to recognise.
    • threshold (float): Threshold for predicted mask scores.
  • output

Example JSON definition of step Seg Preview in version v1
{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/seg-preview@v1",
    "images": "$inputs.image",
    "class_names": [
        "car",
        "person"
    ],
    "threshold": 0.3
}