Local File Sink

Class: LocalFileSinkBlockV1

Source: inference.core.workflows.core_steps.sinks.local_file.v1.LocalFileSinkBlockV1

The Local File Sink block saves workflow data as files on a local file system. It allows users to configure how the data is stored, either:

• aggregating multiple entries into a single file

• or saving each entry as a separate file.

This block is useful for logging, data export, or preparing files for subsequent processing.

File Content, File Type and Output Mode

content is expected to be the output from another block producing string values of specific types denoted by file_type.

output_mode set into append_log will make the block appending single file with consecutive entries passed to content input up to max_entries_per_file. In this mode it is important that

file_type in append_log mode

Contrary to separate_files output mode, append_log mode may introduce subtle changes into the structure of the content to properly append it into existing file, hence setting proper file_type is crucial:

• file_type=json: in append_log mode, the block will create *.jsonl file in JSON Lines format - for that to be possible, each JSON document will be parsed and dumped to ensure that it will fit into single line.

• file_type=csv: in append_log mode, the block will deduct the first line from the content (making it required for CSV content to always be shipped with header row) of consecutive updates into the content of already created file.

Security considerations

The block has an ability to write to the file system. If you find this unintended in your system, you can disable the block setting environmental variable ALLOW_WORKFLOW_BLOCKS_ACCESSING_LOCAL_STORAGE=False in the environment which host Workflows Execution Engine.

If you want to restrict the directory which may be used to write data - set environmental variable WORKFLOW_BLOCKS_WRITE_DIRECTORY to the absolute path of directory which you allow to be used.

Type identifier

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

Properties

Name	Type	Description	Refs
name	str	Enter a unique identifier for this step..	❌
file_type	str	Type of the file.	❌
output_mode	str	Decides how to organise the content of the file.	❌
target_directory	str	Target directory.	✅
file_name_prefix	str	File name prefix.	✅
max_entries_per_file	int	Defines how many datapoints can be appended to a single file.	✅

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 Local File Sink in version v1.

• inputs: CogVLM, VLM as Detector, Slack Notification, Local File Sink, Instance Segmentation Model, Roboflow Custom Metadata, OpenAI, Twilio SMS Notification, OCR Model, Multi-Label Classification Model, Google Vision OCR, Clip Comparison, Stitch OCR Detections, OpenAI, Single-Label Classification Model, Webhook Sink, Google Gemini, Roboflow Dataset Upload, Florence-2 Model, Email Notification, Object Detection Model, LMM, LMM For Classification, Roboflow Dataset Upload, CSV Formatter, Florence-2 Model, Model Monitoring Inference Aggregator, Keypoint Detection Model, Llama 3.2 Vision, Anthropic Claude, VLM as Classifier
• outputs: Line Counter, Single-Label Classification Model, Polygon Zone Visualization, Slack Notification, Time in Zone, Local File Sink, YOLO-World Model, Instance Segmentation Model, Trace Visualization, Roboflow Custom Metadata, Perspective Correction, OpenAI, Distance Measurement, Circle Visualization, Clip Comparison, OpenAI, Triangle Visualization, Halo Visualization, Gaze Detection, Line Counter, Size Measurement, Corner Visualization, Email Notification, Object Detection Model, Template Matching, LMM, Detections Consensus, Roboflow Dataset Upload, Dynamic Crop, Cache Set, Model Monitoring Inference Aggregator, Cache Get, Segment Anything 2 Model, Object Detection Model, Llama 3.2 Vision, Model Comparison Visualization, Anthropic Claude, Keypoint Detection Model, Crop Visualization, Blur Visualization, CLIP Embedding Model, CogVLM, Image Threshold, Stability AI Inpainting, Image Preprocessing, Keypoint Visualization, Background Color Visualization, Path Deviation, Pixel Color Count, Color Visualization, Twilio SMS Notification, Multi-Label Classification Model, Classification Label Visualization, Google Vision OCR, Pixelate Visualization, Label Visualization, Time in Zone, Reference Path Visualization, Webhook Sink, Single-Label Classification Model, Google Gemini, Roboflow Dataset Upload, Line Counter Visualization, Multi-Label Classification Model, Image Blur, Florence-2 Model, SIFT Comparison, LMM For Classification, Instance Segmentation Model, Polygon Visualization, Florence-2 Model, Ellipse Visualization, Mask Visualization, Keypoint Detection Model, Detections Stitch, Bounding Box Visualization, Dot Visualization, Stability AI Image Generation, Path Deviation

Input and Output Bindings

The available connections depend on its binding kinds. Check what binding kinds Local File Sink in version v1 has.

Bindings

• input

  • content (string): Content of the file to save.
  • target_directory (string): Target directory.
  • file_name_prefix (string): File name prefix.
  • max_entries_per_file (string): Defines how many datapoints can be appended to a single file.

• output

  • error_status (boolean): Boolean flag.
  • message (string): String value.

Example JSON definition of step Local File Sink in version v1

{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/local_file_sink@v1",
    "content": "$steps.csv_formatter.csv_content",
    "file_type": "csv",
    "output_mode": "append_log",
    "target_directory": "some/location",
    "file_name_prefix": "my_file",
    "max_entries_per_file": 1024
}