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