File size: 6,667 Bytes
d5883a5
 
dc7d8aa
36ad68b
dc7d8aa
 
 
 
 
 
 
 
 
d5883a5
 
 
 
dc7d8aa
 
 
 
 
 
 
 
 
 
36ad68b
dc7d8aa
 
 
 
 
 
 
 
 
 
 
 
36ad68b
dc7d8aa
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d5883a5
dc7d8aa
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
---
license: apache-2.0
library_name: transformers
base_model: Qwen/Qwen3.5-9B
pipeline_tag: image-text-to-text
tags:
- clairic
- cloudflare
- systemone
- multimodal
- structured-output
- information-extraction
- custom-code
---

# Clairic Flash

Clairic Flash is a 9B multimodal model that turns a state and a schema of typed fields
into structured answers. It supports text and image inputs, extraction, numerical
estimation, and forecasting. Each field has its own value and scoring information;
the response also reports input truncation and token usage.

See [Clairic](https://huggingface.co/Cloudflare/clairic) for the other model
in the Clairic family.

## Model

- **Base model:** [Qwen3.5-9B](https://huggingface.co/Qwen/Qwen3.5-9B).
- **Inputs:** a text or JSON state, optional images, and a mapping of field names to specifications.
- **Outputs:** typed values, lists, nulls, estimates, and forecast paths.
- **Scoring:** extraction confidence and null probabilities, plus optional quantiles for estimates.
- **Runtime:** PyTorch and Transformers, with local Python request helpers.

## Usage

Use Python 3.11 or later and install the packages listed in `requirements.txt`. Inference uses PyTorch and
Transformers; `xgrammar` supplies schema constraints through a Transformers logits
processor.

Download the repository, load the model and processor, and call `systemone` with a
System One: Extract request.

```python
import sys

from huggingface_hub import snapshot_download

path = snapshot_download("Cloudflare/clairic-flash")
sys.path.insert(0, path)
from clairic_model import load_release_model, systemone

model, processor = load_release_model(path, device="cuda")

response = systemone(
    model,
    processor,
    {
        "state": (
            "Invoice from Northwind Supply. Issued 2026-09-02. "
            "Items: Pens; Paper. Total: $1080.00."
        ),
        "fields": {
            "vendor": {"type": "text", "instructions": "The invoice vendor."},
            "total": {"type": "number", "decimals": 2},
            "issued": {"type": "date"},
            "items": {
                "type": "list",
                "items": "text",
                "instructions": "The purchased item names, in order.",
            },
        },
    },
)
print(response["answers"])
```

### Images

Pass PIL images alongside the state. Embedded base64 image inputs are also accepted.

```python
from PIL import Image

response = systemone(
    model,
    processor,
    {
        "state": "Read the attached receipt.",
        "images": [Image.open("receipt.png")],
        "fields": {
            "merchant": {"type": "text", "instructions": "The merchant name."},
            "total": {"type": "number", "decimals": 2},
        },
    },
)
print(response["answers"])
```

### Estimates and forecasts

Declare a range for estimated values. Forecasts also specify a horizon and interval.
Set `include_quantiles` to return the available quantiles.

```python
response = systemone(
    model,
    processor,
    {
        "state": "Daily demand for the last seven days: 41, 45, 43, 47, 49, 46, 48.",
        "fields": {
            "next_day": {"type": "estimate", "min": 0, "max": 100},
            "next_three_days": {
                "type": "forecast",
                "min": 0,
                "max": 100,
                "horizon": 3,
                "interval": "day",
            },
        },
        "options": {"include_quantiles": True},
    },
)
print(response["answers"])
```

## Input format

| Field | Description |
|---|---|
| `model` | Optional `clairic-flash` or `@cf/cloudflare/clairic-flash` |
| `state` | Source text; the Python helper serializes JSON values to text |
| `images` | Optional PIL images or embedded base64 images |
| `documents` | Optional embedded PDF data URIs or `content_type` / `base64` objects |
| `fields` | Mapping of output field names to typed specifications |
| `reference_date` | Optional ISO date for relative date instructions |
| `options.include_quantiles` | Include available estimate and forecast quantiles |
| `options.return_state_text` | Include the retained source text in the response |

Field specifications support `text`, `number`, `date`, `time`, `datetime`, `duration`,
`boolean`, `enum`, `object`, `list`, `compute`, `estimate`, and `forecast`.
`instructions` describes what to return. Numeric fields can specify units and
rounding; lists declare their item schema; estimates and forecasts require bounds.
`nullable` defaults to true. `source_only: true` selects literal printed numbers,
dates, times, datetimes, or number/date lists. `knowledge: true` permits knowledge
answers for text, numbers, and supported list children. `compute` selects the typed
numeric head. Unsupported options and invalid combinations are rejected.

Embedded inputs are limited to 4 MiB each and 8 MiB combined. Images and rendered
PDF pages share a four-image/page limit. Image `rotation` accepts 0, 90, 180, or 270
clockwise degrees after EXIF orientation. Remote media URLs are not accepted.

## Response

`systemone` returns a dictionary with `model`, `answers`, `truncated`, and `usage`.
Answers are keyed by the requested field names. Generated scalar extraction answers
retain `valid`, `complete`, full-sequence `confidence`, and independently scored `p_null`.
Uniquely matched text evidence includes character spans in `state`; image-only or
ambiguous evidence has null spans. Lists preserve item order and duplicates.
Estimates and forecasts include their typed values and, when requested, quantiles.

Scores are model probabilities and should be evaluated for the application's own
acceptance thresholds. Inspect `truncated` and any answer completeness indicators
before relying on a result.

Usage includes retries and supplemental work. The response model ID is `clairic-flash`.
The Python API raises validation or request errors for invalid inputs, a queue-full
error for simultaneous requests, and an inference error for failed generation.
Use `await model.predict_async(request)` in an async application; cancellation
drains owned work before admitting another request.

## Files

| File | Purpose |
|---|---|
| `model*.safetensors`, `model.safetensors.index.json`, `config.json` | Model weights and configuration |
| `clair_head.safetensors`, `clair_head_config.json` | Typed output components |
| `clairic_model.py` and supporting Python modules | Transformers loading and request handling |
| Tokenizer and processor files | Text and image preprocessing |
| `requirements.txt` | Python dependencies |
| `LICENSE` | Apache-2.0 license |

## License

Released under the Apache-2.0 license.