Skip to main content

Customer Overlays

Define your own document types and field concepts as a versioned Customer Overlay on the Ontology. List and create overlays, then author and publish them.

The Ontology is the document-type taxonomy the platform classifies against: a Talonic-maintained base plus, per organization, an optional Customer Overlay. A Customer Overlay (the customer-ontologies API resource) is a versioned container of custom document types and field concepts specific to your domain. You define the doctypes you care about (a "Lieferschein", a "Rahmenvertrag") and the fields that matter on them, anchor each doctype to a type in the Talonic base, and publish. Publishing projects your authored fields and doctypes into the field registry and the classifier, so extraction and classification start recognizing your vocabulary.

Overlays are versioned with a draft/publish lifecycle. Editing a published overlay auto-forks a new draft, so the published overlay your pipelines read never changes underneath them mid-run. The overlay is additive: an empty or unpublished overlay leaves capture and classification byte-identical to the Talonic-base-only path, so adopting overlays never regresses existing behavior.

Publishing is a write operation with side effects: it pins fields into your registry (protected from cleanup) and adds custom doctypes the classifier will assign. Unpublishing or deleting reverses the projection.
GET/v1/customer-ontologies
POST/v1/customer-ontologies

Body parameters

name*stringA name for the overlay.
descriptionstringOptional description.

curl

Response (201 Created)

{
  "id": "onto-uuid-1",
  "version": 1
}

A typical adoption path: create an overlay (or import one top-down), author its doctypes and fields, use the mapping endpoints to anchor each doctype to a type in the Talonic base, then publish. From that point, newly ingested documents can classify under your custom doctypes and extraction targets your authored fields.