Schema field reference

This reference enumerates every field of the create-collection form, the create-Taxonomy (Learner) dialog, and the create-Label field editor — including all six advanced accordions and the bulk label import. The concepts and the narrative walkthrough live in Collections & schema; open this page when you need the full list.

Vocabulary reminder. A Collection is a typed home for one kind of record (the code calls it Entity/RelationalEntity). A Learner is the trainable extractor that owns a set of fields (the UI/old docs also call it a Taxonomy or Data Capture group). A Label is one extractable field (the UI calls it a Field). A Schema is “a Learner plus its Labels” — it is not a separate object.

Create-collection / General-tab form

The same form is the Create Collection modal and (when the collectionsUnified flag is on) the inline General tab. Top to bottom:

#	Field	Type	Required	Notes
1	Purpose	radio (create-only)	—	Knowledge vs Processing. On edit it is a read-only Knowledge/Processing chip — category is immutable after create.
2	Knowledge settings	accordion	—	Only when Purpose = Knowledge. Embedding model (text; blank = project default), Chunk size (number, default 2000), Chunk overlap (number, default 10). Collapsed, defaults fine.
3	Collection Name	text	yes	The display name.
4	Description	textarea	yes	What this collection holds.
5	Allowed Ingestion Types	multi-select (grouped)	—	Whitelists which source types may feed this collection — Upload, Cloud, Connector kinds, dynamically-loaded connectors, and Form Templates (shown as `FT_<id>`).
6	Default View	select	—	Appears only if column-view templates exist. None or a named column view.
7	Parent Collection	select	—	Permission-gated (`Parent Collection`). None or another collection → makes this a child collection. Disabled once set (no re-parenting). Reveals the mapping accordions below.
8	Enrich Collection Configuration	accordion	—	Enrich Xflow (select: None + project xflows); Enrich Labels (`+` rows: Learner + Label); Flow Trigger Conditional (`+` rows: Learner + Label + Value) — fires the enrich xflow only when the label equals the value.
9	Collection Dashboards	accordion	—	Per-collection dashboard configuration.
10	Independent Queue	accordion (edit-only)	—	If not configured → Create IQ Request link; else shows status (Enabled / Disabled / Request Pending / Request Denied) with Enable/Disable buttons.
11	Set as Primary	slide-toggle	—	Exactly one Primary collection per project — the default ingestion target.

Flag. The Purpose radio (row 1) is gated by the knowledgeCollections flag.

Under the hood — where intake assignment went. The old “Assign to” / Intake-Agent picker was removed from this form. You now pick the worker agent on the Agents tab. Internally the picked agent is written to SecondaryXflowIds[0] while PrimaryXflowId stays a hidden system seed (__bm_default_ingestion__).

Child-collection mapping (revealed when a Parent Collection is chosen)

Dependant Configuration ▸ Primary Mapping — a Source (parent Learner + parent Label) => Target (this collection’s Learner + Label) row. Auto-populated/disabled when parented. This wires how a parent’s extracted Label becomes a child record.
Additional Label Mappings (sub-accordion, + adds rows) — more Source => Target Learner/Label pairs; each row deletable.

Create-Taxonomy (Learner) dialog

Opened from the + Taxonomy header button or the Schema tab’s footer Taxonomy button.

Field	Type	Required	Notes
Taxonomy Name	text	yes	Non-empty; duplicate names rejected.
Description	text	yes
Type (`LearnerKind`)	select	yes	What this Learner classifies/extracts — see below.
Entity	select	yes	Which Collection this Learner belongs to.

Submit is disabled until valid.

Learner Type (`LearnerKind`) values selectable in the dialog

SectionClassification · PageClassification · DocumentClassification · TableClassification · TableRelationExtraction · HtmlRelevancy · CellIdentification · RowClassification · ColumnIdentification · ImageAnnotation · CellContext

Note. Segmentation and QuestionGeneration are valid kinds in the model but are excluded from this picker — you will not see them. For most extraction work you want DocumentClassification (one Learner per document type) and let its Labels do the field work.

Create-Label — the field editor

The dialog has two tabs: Add label and Import labels.

Core fields

Field	Type	Required	Notes
Label Name	text	yes	The field’s name.
Description	text	yes	What this field captures (guides the extraction agent).

A Show Advanced Settings disclosure reveals six accordions (all optional). Footer: Add (saves, keeps the dialog open for the next field) and Add and exit (saves and closes).

Field “type” — how a Label becomes text vs number vs table

There is no single “data type” dropdown the way a spreadsheet has one. A Label’s behaviour is shaped by a combination of its validation rule (in View Config), its Record Config (whether it is a record / table), and Toggles. The common shapes a builder produces:

You want…	Configure it as	Where
Plain text	a Label with no special validation	default
Number	Label + a numeric validation rule	View Config ▸ Validation
Currency / amount	numeric validation + (optionally) Enable Total Field	View Config
Date	a date validation rule	View Config ▸ Validation
Boolean / yes-no	a validation rule constraining to two values	View Config ▸ Validation
Single-select / enum	a validation rule listing allowed values	View Config ▸ Validation
Table / line-items	turn on Is Record and add child Labels as columns	Record Config
Masked / sensitive	Mask Values toggle	Toggles
Derived / looked-up	Lookup Config (Meta Label, Dependent Label Auto Update)	Lookup Config

Tip. For a builder starting out, 90% of fields are “a Label + a validation rule”. Tables (line-items) are the one shape that needs Is Record plus child Labels. Everything in the six accordions below is refinement on top of those two ideas.

The six advanced accordions — every control

1. Table Styling — visual styling for table/record output:

Header background colour, header text colour, body background colour, body text colour (each a colour-picker + hex field).

2. Contextual Insights — relationships and derived widgets:

Is Dependent Entity document (toggle)
Enable RTD operation (toggle) — real-time derivation
Learner + Label + Aggregation Type picker — what to aggregate and how
Widget label filter

3. Record Config — table / line-item behaviour:

Is Record (toggle) — makes this Label a table; its child Labels become columns
Freeze Rows
Label Grouping (shown when validation Type = 4)
Group By (ProximityKind)
Minimum Column Width (px)
Child-only toggles: Duplicate Label, Add Default Column, Unique Label per record, Include Top Extraction, Include Segment Grouping, Enable Filter

4. Toggles / Features:

Mask Values (hide sensitive values in the UI)
Expand Label Values
Enrich Label

5. Lookup Config — derive/refresh values from another source:

Meta Label
Skip Automation Lookup
Disable Manual Refresh
Dependent Label Auto Update (+ Learner / Label picker)
Consolidated Derivation Label
Show Default Recordview

6. View Config — display, ordering, and validation (the most-used accordion):

Top Extraction Count
Sort Using (e.g. by confidence)
Doc Meta Property
Is Data Entry
Enable Total Field (requires Is Record)
Add / Edit Validation rules — this is where number/date/boolean/enum shapes are defined
Auto Resolve On Edit
Ignore Errors On Stage Movement

Import labels (bulk)

Tab Import labels: drag-and-drop or Choose File. Accepts .txt, .xlsx, .tsv, .csv.
Shows a text example and an Excel/CSV format example — parent/child nesting is expressed by indentation (text) or by columns (spreadsheet), so you can import a whole table-with-columns in one go.
Upload & Create creates every Label in one action.

Tip. Importing is the fastest way to stand up a large schema. Build the field list in a spreadsheet (one column per nesting level), then Import labels ▸ Upload & Create.

Schema tab — Learner list controls

The Schema tab is a master-detail surface:

Left list — every Learner with Name + Description; a star marks the Primary Learner. A type filter (All · Custom · Default · Imported) and a search icon narrow the list. Footer buttons Taxonomy (create a Learner) and Import (import a Learner).
Right pane (a Learner selected) — top-right + Label (Labels sub-tab only) and an action menu with Edit (edit the Learner). Two sub-tabs: Labels (a hierarchical label tree) and Details.