@nvisy/sdk 0.16.0 → 0.18.0

package/dist/{index-Cd74EvDw.d.ts → index-BJIDRs4m.d.ts}

@@ -7505,40 +7505,6 @@ interface components {
       /** @description The JWT token string (only shown once on creation). */
       token: string;
     };
-    /** @description Response type for a pipeline artifact. */
-    Artifact: {
-      /** @description Type of artifact (input, output, intermediate). */
-      artifactType: components["schemas"]["ArtifactType"];
-      /**
-       * Format: date-time
-       * @description When the artifact was created.
-       */
-      createdAt: string;
-      /**
-       * Format: uuid
-       * @description File storing the artifact data.
-       */
-      fileId: string;
-      /**
-       * Format: uuid
-       * @description Unique artifact identifier.
-       */
-      id: string;
-      /** @description Extended metadata (checksums, counts, etc.). */
-      metadata: unknown;
-      /**
-       * Format: uuid
-       * @description Pipeline run that produced this artifact.
-       */
-      runId: string;
-    };
-    /**
-     * @description Classification of pipeline run artifacts.
-     *
-     *     This enumeration corresponds to the `ARTIFACT_TYPE` PostgreSQL enum and is used
-     *     to categorize artifacts produced during pipeline runs.
-     */
-    ArtifactType: "input" | "output" | "intermediate";
     /**
      * @description Author-supplied rationale for a redaction: a policy name and an optional
      *     description.
@@ -8025,6 +7991,18 @@ interface components {
        *     output audience. See elide's [`ScopeMetadata`].
        */
       metadata?: components["schemas"]["ScopeMetadata"];
+      /**
+       * @description OCR mode the analyze call decoded with. Recorded so the
+       *     anonymize call re-decodes the same document under the same
+       *     codec configuration — otherwise entity offsets stored in
+       *     the audit wouldn't line up against a differently-rendered
+       *     second decode. Defaults to [`OcrMode::Auto`] (the codec's
+       *     built-in behaviour) when omitted.
+       * @default {
+       *       "kind": "auto"
+       *     }
+       */
+      ocrMode: components["schemas"]["OcrMode"];
     };
     /** @description Response returned after successful authentication (login/signup). */
     AuthToken: {
@@ -8415,6 +8393,11 @@ interface components {
       description?: string;
       /** @description Pipeline display name (2-128 characters). */
       displayName: string;
+      /**
+       * @description Optional per-scope data-retention override for this pipeline. Each unset
+       *     scope inherits the workspace retention.
+       */
+      retention?: components["schemas"]["RetentionOverride"];
       /** @description URL slug, unique within the workspace and immutable after creation. */
       slug: components["schemas"]["Handle"];
     };
@@ -8499,8 +8482,11 @@ interface components {
       description?: string;
       /** @description Display name of the workspace (2-32 characters). */
       displayName: string;
-      /** @description Whether approval is required for processed files to be visible. */
-      requireApproval?: boolean;
+      /**
+       * @description Workspace settings (approval requirement, data-retention rules). Defaults
+       *     to requiring approval and keeping everything when omitted.
+       */
+      settings?: components["schemas"]["WorkspaceSettings"];
       /** @description Optional URL slug. Derived from the display name when omitted. */
       slug?: components["schemas"]["Handle"];
     };
@@ -8524,156 +8510,6 @@ interface components {
        */
       limit?: number;
     };
-    /**
-     * @description One caller-supplied dictionary for the pattern recognizer.
-     *
-     *     Mirrors `elide_pattern::Dictionary`. Literal-term matching via
-     *     Aho-Corasick; faster and safer than regex for closed sets.
-     */
-    CustomDictionary: {
-      /**
-       * @description Context keywords lifting confidence near matches.
-       *
-       *     Consumed only when the analyzer's
-       *     [`PatternRecognizerParams`]`.context_enhanced` is `true`.
-       *
-       *     [`PatternRecognizerParams`]: super::PatternRecognizerParams
-       */
-      context?: components["schemas"]["CustomPatternContext"];
-      /**
-       * @description ISO 3166-1 alpha-2 country codes scoping the dictionary.
-       *
-       *     Empty means "any country"; otherwise the recognizer skips
-       *     the dictionary when the per-call jurisdiction hint is not
-       *     in the list.
-       */
-      countries?: components["schemas"]["CountryCode"][];
-      /** @description Entity label every match emits. */
-      label: components["schemas"]["LabelRef"];
-      /**
-       * @description BCP-47 language tags scoping the dictionary.
-       *
-       *     Empty means "any language"; otherwise the recognizer skips
-       *     the dictionary when the per-call language hint is not in
-       *     the list.
-       */
-      languages?: components["schemas"]["LanguageTag"][];
-      /** @description Human-readable identifier surfaced in provenance. */
-      name: string;
-      /**
-       * @description Default confidence stamped on matches when a term has no
-       *     per-term override.
-       *
-       *     Defaults to [`Confidence::MAX`].
-       * @default 1
-       */
-      score: components["schemas"]["Confidence"];
-      /**
-       * @description Literal terms + per-term confidence overrides.
-       *
-       *     At least one required; the recognizer skips dictionaries
-       *     with an empty term list at compile time.
-       */
-      terms: components["schemas"]["CustomDictionaryTerm"][];
-    };
-    /** @description One term inside a [`CustomDictionary`]. */
-    CustomDictionaryTerm: {
-      /**
-       * @description Per-term score override.
-       *
-       *     `None` falls back to the parent dictionary's `score`.
-       */
-      score?: components["schemas"]["Confidence"];
-      /** @description The literal scanned for. */
-      term: string;
-    };
-    /**
-     * @description Context keywords for a custom rule.
-     *
-     *     Either a flat list applied regardless of language, or a
-     *     per-language map. Matches the shape of `elide_pattern`'s
-     *     `Context` — untagged so the wire looks like either
-     *     `["kw1", "kw2"]` or `{ "en": ["kw1"], "es": ["kw2"] }`.
-     */
-    CustomPatternContext: string[] | {
-      [key: string]: string[];
-    };
-    /**
-     * @description One caller-supplied regex rule for the pattern recognizer.
-     *
-     *     Mirrors `elide_pattern::Regex`. Serialize + Deserialize +
-     *     JsonSchema end-to-end so SDK callers can inline rules on the
-     *     wire; the engine converts each rule to an elide `Regex` at
-     *     analyzer-compile time.
-     */
-    CustomPatternRule: {
-      /**
-       * @description Context keywords lifting confidence when they appear near
-       *     a match.
-       *
-       *     Either a flat list (any language) or a per-language map.
-       *     Consumed only when the analyzer's
-       *     [`PatternRecognizerParams`]`.context_enhanced` is `true`.
-       *
-       *     [`PatternRecognizerParams`]: super::PatternRecognizerParams
-       */
-      context?: components["schemas"]["CustomPatternContext"];
-      /**
-       * @description ISO 3166-1 alpha-2 country codes scoping the rule.
-       *
-       *     Empty means "any country"; otherwise the recognizer skips
-       *     the rule when the per-call jurisdiction hint is not in the
-       *     list.
-       */
-      countries?: components["schemas"]["CountryCode"][];
-      /** @description Entity label every variant emits. */
-      label: components["schemas"]["LabelRef"];
-      /**
-       * @description BCP-47 language tags scoping the rule.
-       *
-       *     Empty means "any language"; otherwise the recognizer skips
-       *     the rule when the per-call language hint is not in the
-       *     list.
-       */
-      languages?: components["schemas"]["LanguageTag"][];
-      /** @description Human-readable identifier surfaced in provenance. */
-      name: string;
-      /**
-       * @description Regex sources + per-variant confidence + optional
-       *     validator.
-       *
-       *     At least one required; the recognizer skips rules with an
-       *     empty variant list at compile time.
-       */
-      variants: components["schemas"]["CustomPatternVariant"][];
-    };
-    /** @description One regex variant inside a [`CustomPatternRule`]. */
-    CustomPatternVariant: {
-      /**
-       * @description Regex source.
-       *
-       *     Capped at [`MAX_REGEX_SOURCE_LEN`] bytes; longer sources
-       *     reject at deserialize. Compiled by the engine at
-       *     analyzer-compile time.
-       */
-      regex: string;
-      /**
-       * @description Confidence stamped on every match, before any
-       *     post-recognition keyword boost.
-       *
-       *     Defaults to [`Confidence::MAX`].
-       * @default 1
-       */
-      score: components["schemas"]["Confidence"];
-      /**
-       * @description Optional validator name.
-       *
-       *     Resolved against elide's `ValidatorRegistry` at compile
-       *     time (e.g. `"ssn"`, `"credit_card"`, `"iban"`). Unknown
-       *     names error at compile. `None` means "no validation".
-       */
-      validator?: string;
-    };
     /**
      * @description The coarseness a [`GeneralizeDate`] reduces a date/timestamp to.
      *
@@ -8715,6 +8551,19 @@ interface components {
        */
       width: number;
     };
+    /**
+     * Format: uint16
+     * @description Dots-per-inch resolution for rasterizing vector content.
+     *
+     *     Used e.g. for rendering PDF pages to images for OCR.
+     *
+     *     PDF coordinates are in points (1 pt = 1/72 in), so
+     *     [`scale_factor`] gives the multiplier from points to
+     *     pixels at this resolution.
+     *
+     *     [`scale_factor`]: Self::scale_factor
+     */
+    Dpi: number;
     /**
      * @description Coreference identifier shared by entities that denote the same
      *     real-world thing.
@@ -8790,6 +8639,8 @@ interface components {
       displayName: string;
       /** @description File extension (without dot). */
       fileExtension: string;
+      /** @description The file's role (original, redacted, audit). */
+      fileKind: components["schemas"]["FileKind"];
       /**
        * Format: int64
        * @description File size in bytes.
@@ -8800,8 +8651,6 @@ interface components {
        * @description Unique file identifier.
        */
       id: string;
-      /** @description MIME type. */
-      mimeType?: string;
       /** @description Original filename when uploaded. */
       originalFilename: string;
       /**
@@ -8809,10 +8658,6 @@ interface components {
        * @description Parent file ID if this is a newer version.
        */
       parentId?: string;
-      /** @description How the file was created (uploaded, imported, generated). */
-      source: components["schemas"]["FileSource"];
-      /** @description Classification tags. */
-      tags: string[];
       /**
        * Format: date-time
        * @description Last update timestamp.
@@ -8828,6 +8673,15 @@ interface components {
       /** @description Handle of the workspace this file belongs to. */
       workspaceSlug: components["schemas"]["Handle"];
     };
+    /**
+     * @description The role a file plays, which drives its data-retention scope and whether it
+     *     is a user-facing document.
+     *
+     *     Corresponds to the `FILE_KIND` PostgreSQL enum. Orthogonal to the `parent_id`
+     *     version chain (lineage); import origin (connection and remote key) lives in
+     *     the `workspace_file_imports` satellite.
+     */
+    FileKind: "original" | "redacted" | "audit";
     /**
      * @description Generic paginated response wrapper.
      *
@@ -8846,14 +8700,6 @@ interface components {
        */
       total?: number;
     };
-    /**
-     * @description Defines how a file was created in the system.
-     *
-     *     This enumeration corresponds to the `FILE_SOURCE` PostgreSQL enum and is used
-     *     to track the origin of files - whether they were uploaded by users, imported
-     *     from external sources, or generated by the system.
-     */
-    FileSource: "uploaded" | "imported" | "generated";
     /**
      * @description A supported file extension.
      * @enum {string}
@@ -9413,8 +9259,6 @@ interface components {
       expiresAt: string;
       /** @description Role the user will have if they join. */
       invitedRole: components["schemas"]["WorkspaceRole"];
-      /** @description Tags associated with the workspace. */
-      tags: string[];
       /** @description Handle of the workspace. */
       workspaceSlug: components["schemas"]["Handle"];
     };
@@ -9841,13 +9685,6 @@ interface components {
     };
     /** @description Fields available for sorting workspace members. */
     MemberSortField: "name" | "date";
-    /**
-     * @description How the merging reconciler combines same-label overlaps.
-     *
-     *     Picks one entity per overlapping cluster of findings that
-     *     share a label.
-     */
-    MergingStrategyParams: "max" | "noisy_or";
     /**
      * @description Per-modality operator specs carried by a `redact` rule.
      *
@@ -9955,6 +9792,42 @@ interface components {
       /** @description Whether to send email notifications. */
       notifyViaEmail: boolean;
     };
+    /**
+     * @description Policy for turning a document's pages into images for OCR.
+     *
+     *     A born-digital PDF has a selectable text layer and needs no OCR; a
+     *     scanned one is image-only and must be rendered to images first. [`Auto`]
+     *     is the right default — extract text, render only what lacks it — but the
+     *     text-layer parser that drives that decision is not in place yet, so today
+     *     only [`Force`] actually renders.
+     *
+     *     Serializes with an internal `kind` tag (`{"kind": "auto"}`,
+     *     `{"kind": "force", "dpi": 300}`, `{"kind": "never"}`).
+     *
+     *     [`Auto`]: OcrMode::Auto
+     *     [`Force`]: OcrMode::Force
+     */
+    OcrMode: {
+      /** @constant */
+      kind: "auto";
+    } | {
+      /** @description Resolution to render pages at; [`Dpi::OCR`] (300) is typical. */
+      dpi: components["schemas"]["Dpi"];
+      /** @constant */
+      kind: "force";
+    } | {
+      /** @constant */
+      kind: "never";
+    };
+    /**
+     * @description How a workspace's documents are turned into images for OCR during detection.
+     *
+     *     A workspace-level policy over the engine's per-run OCR mode: `Auto` lets the
+     *     engine decide from the text layer, `Force` always renders every page (for
+     *     documents with unreliable text layers — scans, watermarks), and `Never`
+     *     relies on the text layer only.
+     */
+    OcrPolicy: "auto" | "force" | "never";
     /** @description OpenAI API credentials. */
     OpenAiCredentials: {
       /** @description OpenAI API key. */
@@ -9990,46 +9863,6 @@ interface components {
       /** @description Name of the validator that confirmed the match (e.g. `"luhn"`). */
       validator?: string;
     };
-    /** @description Params for the `elide-pattern` recognizer. */
-    PatternRecognizerParams: {
-      /**
-       * @description Load every pattern + dictionary shipped with `elide-pattern`.
-       *
-       *     Implies the country-scoped jurisdictional pattern packs
-       *     are active for the scope's jurisdictions.
-       * @default false
-       */
-      builtins: boolean;
-      /**
-       * @description Enable per-label context-keyword boosting.
-       *
-       *     Wraps the bare pattern recognizer in elide's
-       *     `Enhanced<PatternRecognizer>` layer so per-label context
-       *     keywords boost low-confidence matches before they leave
-       *     the recognizer.
-       * @default false
-       */
-      contextEnhanced: boolean;
-      /**
-       * @description Caller-inlined regex rules.
-       *
-       *     Compiled per-request. See [`CustomPatternRule`] for the
-       *     shape; the engine bounds request-level cost with a rule-
-       *     count cap and a per-regex NFA-size limit at compile time,
-       *     on top of the deserialize-time source-length cap in
-       *     [`MAX_REGEX_SOURCE_LEN`].
-       *
-       *     [`MAX_REGEX_SOURCE_LEN`]: super::MAX_REGEX_SOURCE_LEN
-       */
-      custom?: components["schemas"]["CustomPatternRule"][];
-      /**
-       * @description Caller-inlined literal-term dictionaries.
-       *
-       *     Compiled per-request into a shared Aho-Corasick automaton.
-       *     Same rule-count cap as `custom` applies at compile time.
-       */
-      customDictionaries?: components["schemas"]["CustomDictionary"][];
-    };
     /**
      * @description Which PCI DSS subsection this template addresses.
      *
@@ -10080,8 +9913,6 @@ interface components {
     PciPanRender: "truncate" | "truncate_last_four" | "hmac_sha256" | "hmac_sha512";
     /** @description Pipeline response. */
     Pipeline: {
-      /** @description Artifacts produced by pipeline runs. */
-      artifacts: components["schemas"]["Artifact"][];
       /**
        * Format: date-time
        * @description Timestamp when the pipeline was created.
@@ -10095,6 +9926,8 @@ interface components {
       description?: string;
       /** @description Pipeline display name. */
       displayName: string;
+      /** @description Per-scope data-retention override, when the pipeline sets one. */
+      retention?: components["schemas"]["RetentionOverride"];
       /** @description URL slug of the pipeline, unique within its workspace. */
       slug: components["schemas"]["Handle"];
       /** @description Pipeline lifecycle status. */
@@ -10107,47 +9940,25 @@ interface components {
       /** @description Handle of the workspace this pipeline belongs to. */
       workspaceSlug: components["schemas"]["Handle"];
     };
-    /**
-     * @description A pipeline's deduplication intent.
-     *
-     *     Each field is optional: when a pipeline omits one, it inherits the
-     *     deployment default from the engine config. Per-recognizer calibration is
-     *     operator-only and never set here.
-     */
-    PipelineDeduplication: {
-      /** @description How same-label overlapping findings are merged into one. */
-      merging?: components["schemas"]["MergingStrategyParams"];
-      /** @description Minimum confidence the filter layer admits. */
-      minConfidence?: components["schemas"]["ConfidenceThreshold"];
-      /** @description How cross-label overlaps pick a winner. */
-      tiebreaker?: components["schemas"]["TiebreakerParams"];
-    };
     /**
      * @description A pipeline's detection + governance intent.
      *
-     *     Holds what a pipeline author decides — which recognizers to run, the default
-     *     scope, and the policies to apply. Infrastructure config (enrichment backends,
-     *     deduplication calibration) is server-wide and lives in the engine config, not
-     *     here. Stored as JSON in the pipeline's `definition` column but validated
-     *     against this schema at the API boundary.
+     *     Holds what a pipeline author decides — the default scope and the policies to
+     *     apply. Recognition is entirely server-wide: the built-in pattern set plus the
+     *     deployment's NER/LLM lineups and enrichment backends live in the engine
+     *     config, not here. Stored as JSON in the pipeline's `definition` column but
+     *     validated against this schema at the API boundary.
      *
      *     The label catalog is not part of this: the policies own the label vocabulary,
      *     and the engine derives the detection catalog from them at run time.
      *
      *     The split:
      *
-     *     - `recognizers` / `deduplication` — the detection intent, merged with the
-     *       server-wide engine defaults into an `AnalyzerParams`.
      *     - `default_scope` — optional pipeline-wide scope a document may override.
      *     - `policy_slugs` — references to the workspace's policies, resolved at run
      *       time.
      */
     PipelineDefinition: {
-      /**
-       * @description Post-recognition deduplication behavior.
-       * @default {}
-       */
-      deduplication: components["schemas"]["PipelineDeduplication"];
       /**
        * @description Optional pipeline-wide scope (languages, jurisdictions, document labels).
        *
@@ -10162,12 +9973,6 @@ interface components {
        *     definition; surfaced here so the API exposes one coherent object.
        */
       policySlugs?: components["schemas"]["Handle"][];
-      /**
-       * @description Recognizer lineup: pattern (incl. inline custom rules and
-       *     dictionaries), plus the NER and LLM toggles.
-       * @default {}
-       */
-      recognizers: components["schemas"]["RecognizerParams"];
     };
     /** @description Query parameters for filtering pipelines. */
     PipelineFilter: {
@@ -10193,15 +9998,20 @@ interface components {
        * @description When the run completed.
        */
       completedAt?: string;
+      /** @description Opaque identifier of the run. */
+      id: components["schemas"]["RunId"];
       /**
        * Format: uuid
-       * @description File this run analyzes / redacts.
+       * @description Source document this run analyzes / redacts.
        */
-      fileId: string;
-      /** @description Opaque identifier of the run. */
-      id: components["schemas"]["RunId"];
+      inputFileId: string;
       /** @description Non-encrypted metadata for filtering/display. */
       metadata: unknown;
+      /**
+       * Format: uuid
+       * @description Redacted document produced by the run, once it completes.
+       */
+      outputFileId?: string;
       /** @description Handle of the pipeline this run belongs to. */
       pipelineSlug: components["schemas"]["Handle"];
       /**
@@ -10403,8 +10213,6 @@ interface components {
       labels?: components["schemas"]["Labels"];
       /** @description Human-readable name. Display-only. Does not key anything. */
       name: string;
-      /** @description Lifecycle rules for content under this policy. */
-      retention?: components["schemas"]["RetentionPolicy"][];
       /** @description Ordered rules. First match wins within this policy. */
       rules?: components["schemas"]["PolicyRule"][];
     };
@@ -10618,19 +10426,6 @@ interface components {
       /** @description Negated predicate. */
       not: components["schemas"]["Predicate"];
     };
-    /**
-     * @description How to pick recognizers out of a deployment-configured lineup.
-     *
-     *     Untagged on the wire: `true` / `false` / a list of names.
-     *
-     *     - `All(true)`: explicit opt-in. Attaches every configured
-     *       recognizer; fails the analyzer compile if the lineup is
-     *       empty.
-     *     - `All(false)`: explicit opt-out. Skips the lineup entirely.
-     *     - `Only(names)`: attach only the named recognizers. An empty
-     *       list and any unknown name fail the analyzer compile.
-     */
-    ProviderSelection: boolean | string[];
     /**
      * @description Public view of an account, returned when looking up someone other than the
      *     authenticated caller. Carries only the fields safe to share with a
@@ -10663,39 +10458,6 @@ interface components {
       /** @description NER (named-entity recognition) recognizers. */
       ner: components["schemas"]["RegisteredRecognizer"][];
     };
-    /**
-     * @description Recognizer slots an analyzer can fill.
-     *
-     *     Pattern is at-most-one (per-request); NER and LLM are
-     *     deployment-owned lineups each selected by a
-     *     [`ProviderSelection`].
-     */
-    RecognizerParams: {
-      /**
-       * @description Select which of the deployment's LLM recognizers to run.
-       *
-       *     Same shape as [`ner`]. The lineup is additionally filtered
-       *     by declared modality — only recognizers whose `modalities`
-       *     list contains the analyzer's modality attach.
-       *
-       *     [`ner`]: RecognizerParams::ner
-       */
-      llm?: components["schemas"]["ProviderSelection"];
-      /**
-       * @description Select which of the deployment's NER recognizers to run.
-       *
-       *     See [`ProviderSelection`] for the shape. `None` is the
-       *     softly-on default: attach every configured recognizer if
-       *     the deployment has any, skip silently otherwise.
-       */
-      ner?: components["schemas"]["ProviderSelection"];
-      /**
-       * @description Built-in pattern + dictionary recognizer (`elide-pattern`).
-       *
-       *     At most one per analyzer.
-       */
-      pattern?: components["schemas"]["PatternRecognizerParams"];
-    };
     /**
      * @description Public view of one recognizer in the engine's NER or LLM
      *     lineup.
@@ -10730,40 +10492,73 @@ interface components {
       acceptInvite: boolean;
     };
     /**
-     * @description How long data is retained.
+     * @description How long a class of data is retained.
      *
-     *     Ordered from strictest to laxest: `ZeroRetention <
-     *     Duration { days: N } < Indefinite`, and within `Duration`,
-     *     smaller `days` is stricter (`Duration { days: 7 } <
-     *     Duration { days: 30 }`). The derived [`Ord`] reflects this:
-     *     strictest-wins resolution across multiple policies is just
-     *     `iter.min()`. Variant declaration order is load-bearing;
-     *     don't reorder.
+     *     Wire shape is internally tagged on `mode`: `{ "mode": "forever" }`,
+     *     `{ "mode": "zeroDays" }`, `{ "mode": "days", "days": 30 }`.
      */
     Retention: {
       /** @constant */
-      mode: "zero_retention";
+      mode: "forever";
+    } | {
+      /** @constant */
+      mode: "zeroDays";
     } | {
       /**
-       * Format: uint64
-       * @description Maximum number of days to retain data.
+       * Format: uint32
+       * @description Number of days to retain data.
        */
       days: number;
       /** @constant */
-      mode: "duration";
-    } | {
-      /** @constant */
-      mode: "indefinite";
+      mode: "days";
     };
-    /** @description A single retention rule: scope + duration. */
-    RetentionPolicy: {
-      /** @description How long to retain data. */
-      retention: components["schemas"]["Retention"];
-      /** @description What class of data this applies to. */
-      scope: components["schemas"]["RetentionScope"];
+    /**
+     * @description A pipeline's optional per-scope override of the workspace retention. A `None`
+     *     field inherits the workspace value for that scope.
+     *
+     *     Only scopes a pipeline actually produces are overridable — original documents
+     *     are ingested, not produced by a pipeline, so they have no per-pipeline
+     *     override and always follow the workspace baseline.
+     */
+    RetentionOverride: {
+      /**
+       * @description Overrides audit-blob retention when set.
+       * @default null
+       */
+      auditLogs: components["schemas"]["Retention"];
+      /**
+       * @description Overrides redacted-document retention when set.
+       * @default null
+       */
+      redactedDocuments: components["schemas"]["Retention"];
+    };
+    /**
+     * @description Retention for every scope. Missing fields default to [`Retention::Forever`],
+     *     so an empty settings blob keeps everything.
+     */
+    RetentionSettings: {
+      /**
+       * @description Retention for audit blobs.
+       * @default {
+       *       "mode": "forever"
+       *     }
+       */
+      auditLogs: components["schemas"]["Retention"];
+      /**
+       * @description Retention for uploaded/imported source documents.
+       * @default {
+       *       "mode": "forever"
+       *     }
+       */
+      originalDocuments: components["schemas"]["Retention"];
+      /**
+       * @description Retention for generated redacted documents.
+       * @default {
+       *       "mode": "forever"
+       *     }
+       */
+      redactedDocuments: components["schemas"]["Retention"];
     };
-    /** @description What class of data a retention policy applies to. */
-    RetentionScope: "original_content" | "redacted_output" | "audit_logs";
     /**
      * @description A reviewer-supplied redaction override with the policy
      *     authority it draws from.
@@ -11985,13 +11780,6 @@ interface components {
        */
       style: components["schemas"]["DateStyle"];
     };
-    /**
-     * @description How the structural reconciler picks a winner across labels.
-     *
-     *     Runs after merging when overlapping entities carry different
-     *     labels.
-     */
-    TiebreakerParams: "highest_confidence" | "longest_span";
     /**
      * @description Half-open `[start, end)` stream interval, measured in microseconds.
      *
@@ -12092,8 +11880,6 @@ interface components {
       displayName?: string;
       /** @description Updated metadata. */
       metadata?: unknown;
-      /** @description Updated tags. */
-      tags?: string[];
     };
     /** @description Request to update a member's role. */
     UpdateMember: {
@@ -12122,6 +11908,11 @@ interface components {
       description?: string;
       /** @description New display name for the pipeline (2-128 characters). */
       displayName?: string;
+      /**
+       * @description Replacement per-scope data-retention override. When omitted, the
+       *     pipeline's retention override is left unchanged.
+       */
+      retention?: components["schemas"]["RetentionOverride"];
       /** @description New status for the pipeline. */
       status?: components["schemas"]["PipelineStatus"];
     };
@@ -12169,8 +11960,11 @@ interface components {
       description?: string;
       /** @description New display name for the workspace (2-32 characters). */
       displayName?: string;
-      /** @description Whether approval is required for processed files to be visible. */
-      requireApproval?: boolean;
+      /**
+       * @description Replacement workspace settings (approval requirement, data-retention
+       *     rules). When omitted, settings are left unchanged.
+       */
+      settings?: components["schemas"]["WorkspaceSettings"];
     };
     /** @description Validation error details for field-specific errors. */
     ValidationErrorDetail: {
@@ -12370,12 +12164,10 @@ interface components {
       displayName: string;
       /** @description Role of the member in the workspace. */
       memberRole: components["schemas"]["WorkspaceRole"];
-      /** @description Whether approval is required to processed files to be visible. */
-      requireApproval: boolean;
+      /** @description Workspace settings (approval requirement, data-retention rules). */
+      settings: components["schemas"]["WorkspaceSettings"];
       /** @description URL-safe workspace identifier. */
       slug: components["schemas"]["Handle"];
-      /** @description Tags associated with the workspace. */
-      tags: string[];
       /**
        * Format: date-time
        * @description Timestamp when the workspace was last updated.
@@ -12420,6 +12212,34 @@ interface components {
       /** @description Filter by run status. */
       status?: components["schemas"]["PipelineRunStatus"];
     };
+    /** @description Typed workspace settings, the JSON stored in the `workspaces.settings` column. */
+    WorkspaceSettings: {
+      /**
+       * @description How documents are rendered for OCR during detection.
+       * @default auto
+       */
+      ocr: components["schemas"]["OcrPolicy"];
+      /**
+       * @description Whether approval is required before processed files become visible.
+       * @default true
+       */
+      requireApproval: boolean;
+      /**
+       * @description Data-retention rules for the workspace.
+       * @default {
+       *       "auditLogs": {
+       *         "mode": "forever"
+       *       },
+       *       "originalDocuments": {
+       *         "mode": "forever"
+       *       },
+       *       "redactedDocuments": {
+       *         "mode": "forever"
+       *       }
+       *     }
+       */
+      retention: components["schemas"]["RetentionSettings"];
+    };
     /** @description Query parameters for listing all syncs across a workspace. */
     WorkspaceSyncsQuery: {
       /**
@@ -12468,6 +12288,8 @@ type Schemas$16 = components["schemas"];
 type EntityGroup = Schemas$16["EntityGroup"];
 type AuditContext = Schemas$16["AuditContext"];
 type EntityCoRef = Schemas$16["EntityCoRef"];
+type OcrMode = Schemas$16["OcrMode"];
+type Dpi = Schemas$16["Dpi"];
 type Review = Schemas$16["Review"];
 type Attribution = Schemas$16["Attribution"];
 type LeakProfile = Schemas$16["LeakProfile"];
@@ -12563,7 +12385,7 @@ type ValidationErrorDetail = Schemas$12["ValidationErrorDetail"];
 type Schemas$11 = components["schemas"];
 type File = Schemas$11["File"];
 type UpdateFile = Schemas$11["UpdateFile"];
-type FileSource = Schemas$11["FileSource"];
+type FileKind = Schemas$11["FileKind"];
 type FormatToken = Schemas$11["FormatToken"];
 type ModalityToken = Schemas$11["ModalityToken"];
 type ListFiles = Schemas$11["ListFiles"];
@@ -12644,9 +12466,6 @@ type TextRedaction = Schemas$4["TextRedaction"];
 type ImageRedaction = Schemas$4["ImageRedaction"];
 type AudioRedaction = Schemas$4["AudioRedaction"];
 type TabularRedaction = Schemas$4["TabularRedaction"];
-type RetentionPolicy = Schemas$4["RetentionPolicy"];
-type Retention = Schemas$4["Retention"];
-type RetentionScope = Schemas$4["RetentionScope"];
 type Labels = Schemas$4["Labels"];
 type LabelGroup = Schemas$4["LabelGroup"];
 type LabelEntry = Schemas$4["LabelEntry"];
@@ -12663,37 +12482,24 @@ type LanguageTag = Schemas$4["LanguageTag"];
 type Sha2Algorithm = Schemas$4["Sha2Algorithm"];
 type TerminalFallback = Schemas$4["TerminalFallback"];
 //#endregion
-//#region src/datatypes/recognizer.d.ts
+//#region src/datatypes/run.d.ts
 type Schemas$3 = components["schemas"];
-type RecognizerParams = Schemas$3["RecognizerParams"];
-type PatternRecognizerParams = Schemas$3["PatternRecognizerParams"];
-type ProviderSelection = Schemas$3["ProviderSelection"];
-type CustomPatternRule = Schemas$3["CustomPatternRule"];
-type CustomPatternVariant = Schemas$3["CustomPatternVariant"];
-type CustomPatternContext = Schemas$3["CustomPatternContext"];
-type CustomDictionary = Schemas$3["CustomDictionary"];
-type CustomDictionaryTerm = Schemas$3["CustomDictionaryTerm"];
-type PipelineDeduplication = Schemas$3["PipelineDeduplication"];
-type MergingStrategyParams = Schemas$3["MergingStrategyParams"];
-type TiebreakerParams = Schemas$3["TiebreakerParams"];
-type ScopeParams = Schemas$3["ScopeParams"];
-type ScopeMetadata = Schemas$3["ScopeMetadata"];
-type CountryCode = Schemas$3["CountryCode"];
-type Language = Schemas$3["Language"];
-type Languages = Schemas$3["Languages"];
-type LanguageSpan = Schemas$3["LanguageSpan"];
-type LanguageProvenance = Schemas$3["LanguageProvenance"];
-type Confidence = Schemas$3["Confidence"];
+type PipelineRun = Schemas$3["PipelineRun"];
+type CreatePipelineRun = Schemas$3["CreatePipelineRun"];
+type PipelineRunStatus = Schemas$3["PipelineRunStatus"];
+type PipelineRunPage = Schemas$3["PipelineRunPage"];
+type Audit = Schemas$3["Audit"];
 //#endregion
-//#region src/datatypes/run.d.ts
+//#region src/datatypes/scope.d.ts
 type Schemas$2 = components["schemas"];
-type PipelineRun = Schemas$2["PipelineRun"];
-type CreatePipelineRun = Schemas$2["CreatePipelineRun"];
-type PipelineRunStatus = Schemas$2["PipelineRunStatus"];
-type PipelineRunPage = Schemas$2["PipelineRunPage"];
-type Audit = Schemas$2["Audit"];
-type Artifact = Schemas$2["Artifact"];
-type ArtifactType = Schemas$2["ArtifactType"];
+type ScopeParams = Schemas$2["ScopeParams"];
+type ScopeMetadata = Schemas$2["ScopeMetadata"];
+type CountryCode = Schemas$2["CountryCode"];
+type Language = Schemas$2["Language"];
+type Languages = Schemas$2["Languages"];
+type LanguageSpan = Schemas$2["LanguageSpan"];
+type LanguageProvenance = Schemas$2["LanguageProvenance"];
+type Confidence = Schemas$2["Confidence"];
 //#endregion
 //#region src/datatypes/webhook.d.ts
 type Schemas$1 = components["schemas"];
@@ -12714,6 +12520,11 @@ type CreateWorkspace = Schemas["CreateWorkspace"];
 type UpdateWorkspace = Schemas["UpdateWorkspace"];
 type WorkspaceRole = Schemas["WorkspaceRole"];
 type WorkspacePage = Schemas["WorkspacePage"];
+type WorkspaceSettings = Schemas["WorkspaceSettings"];
+type OcrPolicy = Schemas["OcrPolicy"];
+type Retention = Schemas["Retention"];
+type RetentionSettings = Schemas["RetentionSettings"];
+type RetentionOverride = Schemas["RetentionOverride"];
 //#endregion
-export { LabelGroup as $, AuditContext as $n, InviteStatus as $t, LanguageProvenance as A, SyncConnection as An, TextEntityRecord as Ar, PipelineTriggerType as At, TiebreakerParams as B, RegisteredRecognizer as Bn, ApiTokenWithJWT as Br, Member as Bt, CountryCode as C, ConnectionsQuery as Cn, TabularEvent as Cr, CreatePipeline as Ct, CustomPatternRule as D, OpenAiCredentials as Dn, TabularProvenance as Dr, PipelineStatus as Dt, CustomPatternContext as E, LlmConfig as En, TabularLocation as Er, PipelineFilter as Et, PipelineDeduplication as F, SyncStatus as Fn, TextProvenance as Fr, NotificationPage as Ft, CreatePolicy as G, AudioData as Gn, ActivityPage as Gr, GenerateInviteCode as Gt, ClampBucket as H, Login as Hn, TokenExpiration as Hr, MemberSortField as Ht, ProviderSelection as I, SyncTriggerType as In, TimeSpan as Ir, NotificationSettings as It, GdprArticle9Treatment as J, AudioEvent as Jn, AccountRef as Jr, InviteExpiration as Jt, DateGranularity as K, AudioEntity as Kn, ActivityType as Kr, Invite as Kt, RecognizerParams as L, UpdateConnection as Ln, ApiToken as Lr, UnreadStatus as Lt, Languages as M, SyncMode as Mn, TextEventKind as Mr, CursorPagination as Mt, MergingStrategyParams as N, SyncSchedule as Nn, TextHint as Nr, Notification as Nt, CustomPatternVariant as O, S3Credentials as On, TextData as Or, PipelineSummary as Ot, PatternRecognizerParams as P, SyncScheduleInput as Pn, TextLocation as Pr, NotificationEvent as Pt, LabelEntry as Q, AudioProvenance as Qn, InviteSortField as Qt, ScopeMetadata as R, LabelCatalog as Rn, ApiTokenPage as Rr, UpdateNotificationSettings as Rt, Confidence as S, ConnectionVerification as Sn, TabularEntityRecord as Sr, Waveform as St, CustomDictionaryTerm as T, GcsCredentials as Tn, TabularHint as Tr, PipelineDefinition as Tt, Color as U, Signup as Un, UpdateApiToken as Ur, UpdateMember as Ut, AudioRedaction as V, AuthToken as Vn, CreateApiToken as Vr, MemberPage as Vt, ConfidenceThreshold as W, Attribution as Wn, Activity as Wr, CreateInvite as Wt, ImageRedaction as X, AudioHint as Xn, UpdateAccount as Xr, InvitePreview as Xt, HipaaDeidMethod as Y, AudioEventKind as Yn, PublicAccount as Yr, InvitePage as Yt, Label as Z, AudioLocation as Zn, paths as Zr, InviteSent as Zt, Audit as _, Connection as _n, Polygon as _r, Sha2Algorithm as _t, WorkspaceRole as a, HealthStatus as an, ImageEntity as ar, PciDssPart as at, PipelineRunPage as b, ConnectionSync as bn, RuleMatch as br, TextRedaction as bt, UpdateWebhook as c, FileSource as cn, ImageEventKind as cr, PolicyDefinition as ct, WebhookEvent as d, ModalityToken as dn, ImageProvenance as dr, PolicySummaryPage as dt, ListInvites as en, BoundingBox as er, LabelLocale as et, WebhookPage as f, UpdateFile as fn, LeakProfile as fr, PolicyTemplate as ft, ArtifactType as g, AzureCredentials as gn, Point as gr, RetentionScope as gt, Artifact as h, AnthropicCredentials as hn, PatternEvent as hr, RetentionPolicy as ht, WorkspacePage as i, Health as in, ImageData as ir, ModalityRedactions as it, LanguageSpan as j, SyncDeletionPolicy as jn, TextEvent as jr, UpdatePipeline as jt, Language as k, StorageConfig as kn, TextEntity as kr, PipelineSummaryPage as kt, Webhook as l, FormatToken as ln, ImageHint as lr, PolicyRule as lt, WebhookStatus as m, ValidationErrorDetail as mn, OperatorId as mr, Retention as mt, UpdateWorkspace as n, SortOrder as nn, EntityCoRef as nr, LanguageTag as nt, CreateWebhook as o, File as on, ImageEntityRecord as or, PciPanRender as ot, WebhookResult as p, ErrorResponse as pn, ModelEvent as pr, Predicate as pt, DateStyle as q, AudioEntityRecord as qn, Account as qr, InviteCode as qt, Workspace as r, ComponentHealth as rn, EntityGroup as rr, LocalizedText as rt, TestWebhook as s, FilePage as sn, ImageEvent as sr, Policy as st, CreateWorkspace as t, ReplyInvite as tn, Dimensions as tr, Labels as tt, WebhookCreated as u, ListFiles as un, ImageLocation as ur, PolicySummary as ut, CreatePipelineRun as v, ConnectionConfig as vn, RangeOfUint as vr, TabularRedaction as vt, CustomDictionary as w, CreateConnection as wn, TabularEventKind as wr, Pipeline as wt, PipelineRunStatus as x, ConnectionSyncPage as xn, TabularEntity as xr, UpdatePolicy as xt, PipelineRun as y, ConnectionPage as yn, Review as yr, TerminalFallback as yt, ScopeParams as z, RecognizerCatalog as zn, ApiTokenType as zr, ListMembers as zt };
-//# sourceMappingURL=index-Cd74EvDw.d.ts.map
+export { Policy as $, ImageHint as $n, ListFiles as $t, PipelineRun as A, AuthToken as An, ApiTokenType as Ar, MemberPage as At, GdprArticle9Treatment as B, AudioLocation as Bn, PublicAccount as Br, InviteSent as Bt, LanguageProvenance as C, SyncScheduleInput as Cn, TextEventKind as Cr, NotificationEvent as Ct, ScopeParams as D, LabelCatalog as Dn, TimeSpan as Dr, UpdateNotificationSettings as Dt, ScopeMetadata as E, UpdateConnection as En, TextProvenance as Er, UnreadStatus as Et, Color as F, AudioEntity as Fn, Activity as Fr, Invite as Ft, LabelGroup as G, Dpi as Gn, SortOrder as Gt, ImageRedaction as H, AuditContext as Hn, paths as Hr, InviteStatus as Ht, ConfidenceThreshold as I, AudioEntityRecord as In, ActivityPage as Ir, InviteCode as It, LanguageTag as J, ImageData as Jn, HealthStatus as Jt, LabelLocale as K, EntityCoRef as Kn, ComponentHealth as Kt, CreatePolicy as L, AudioEvent as Ln, ActivityType as Lr, InviteExpiration as Lt, PipelineRunStatus as M, Signup as Mn, CreateApiToken as Mr, UpdateMember as Mt, AudioRedaction as N, Attribution as Nn, TokenExpiration as Nr, CreateInvite as Nt, Audit as O, RecognizerCatalog as On, ApiToken as Or, ListMembers as Ot, ClampBucket as P, AudioData as Pn, UpdateApiToken as Pr, GenerateInviteCode as Pt, PciPanRender as Q, ImageEventKind as Qn, FormatToken as Qt, DateGranularity as R, AudioEventKind as Rn, Account as Rr, InvitePage as Rt, Language as S, SyncSchedule as Sn, TextEvent as Sr, Notification as St, Languages as T, SyncTriggerType as Tn, TextLocation as Tr, NotificationSettings as Tt, Label as U, BoundingBox as Un, ListInvites as Ut, HipaaDeidMethod as V, AudioProvenance as Vn, UpdateAccount as Vr, InviteSortField as Vt, LabelEntry as W, Dimensions as Wn, ReplyInvite as Wt, ModalityRedactions as X, ImageEntityRecord as Xn, FileKind as Xt, LocalizedText as Y, ImageEntity as Yn, File as Yt, PciDssPart as Z, ImageEvent as Zn, FilePage as Zt, WebhookPage as _, S3Credentials as _n, TabularLocation as _r, PipelineSummary as _t, RetentionSettings as a, AzureCredentials as an, OperatorId as ar, Predicate as at, Confidence as b, SyncDeletionPolicy as bn, TextEntity as br, UpdatePipeline as bt, WorkspacePage as c, ConnectionPage as cn, Polygon as cr, TerminalFallback as ct, CreateWebhook as d, ConnectionVerification as dn, RuleMatch as dr, Waveform as dt, ModalityToken as en, ImageLocation as er, PolicyDefinition as et, TestWebhook as f, ConnectionsQuery as fn, TabularEntity as fr, CreatePipeline as ft, WebhookEvent as g, OpenAiCredentials as gn, TabularHint as gr, PipelineStatus as gt, WebhookCreated as h, LlmConfig as hn, TabularEventKind as hr, PipelineFilter as ht, RetentionOverride as i, AnthropicCredentials as in, OcrMode as ir, PolicyTemplate as it, PipelineRunPage as j, Login as jn, ApiTokenWithJWT as jr, MemberSortField as jt, CreatePipelineRun as k, RegisteredRecognizer as kn, ApiTokenPage as kr, Member as kt, WorkspaceRole as l, ConnectionSync as ln, RangeOfUint as lr, TextRedaction as lt, Webhook as m, GcsCredentials as mn, TabularEvent as mr, PipelineDefinition as mt, OcrPolicy as n, ErrorResponse as nn, LeakProfile as nr, PolicySummary as nt, UpdateWorkspace as o, Connection as on, PatternEvent as or, Sha2Algorithm as ot, UpdateWebhook as p, CreateConnection as pn, TabularEntityRecord as pr, Pipeline as pt, Labels as q, EntityGroup as qn, Health as qt, Retention as r, ValidationErrorDetail as rn, ModelEvent as rr, PolicySummaryPage as rt, Workspace as s, ConnectionConfig as sn, Point as sr, TabularRedaction as st, CreateWorkspace as t, UpdateFile as tn, ImageProvenance as tr, PolicyRule as tt, WorkspaceSettings as u, ConnectionSyncPage as un, Review as ur, UpdatePolicy as ut, WebhookResult as v, StorageConfig as vn, TabularProvenance as vr, PipelineSummaryPage as vt, LanguageSpan as w, SyncStatus as wn, TextHint as wr, NotificationPage as wt, CountryCode as x, SyncMode as xn, TextEntityRecord as xr, CursorPagination as xt, WebhookStatus as y, SyncConnection as yn, TextData as yr, PipelineTriggerType as yt, DateStyle as z, AudioHint as zn, AccountRef as zr, InvitePreview as zt };
+//# sourceMappingURL=index-BJIDRs4m.d.ts.map