Re-export schema types from nvisy-engine

crates/elide-bento/src/lib.rs

@@ -11,8 +11,3 @@ pub mod ner;
 #[cfg(feature = "ocr")]
 #[cfg_attr(docsrs, doc(cfg(feature = "ocr")))]
 pub mod ocr;
-
-#[cfg(feature = "ner")]
-pub use self::ner::BentoNer;
-#[cfg(feature = "ocr")]
-pub use self::ocr::BentoOcr;

crates/elide-bento/src/ner/mod.rs

@@ -1,4 +1,4 @@
-//! [`BentoNer`]: an [`elide_ner::backend::NerBackend`] backed by the
+//! [`BentoNer`]: an [`NerBackend`] backed by the
 //! `nvisy-inference-ner` BentoML service.
 //!
 //! Wire contract: `POST /recognize` accepts a batched list of
@@ -11,6 +11,8 @@
 //! Wire types live in the private `request` (outgoing) and
 //! `response` (incoming) submodules; only the public
 //! [`BentoNer`] backend is part of this crate's API.
+//!
+//! [`NerBackend`]: elide_ner::backend::NerBackend
 
 mod request;
 mod response;

crates/elide-bento/src/ocr/mod.rs

@@ -1,4 +1,4 @@
-//! [`BentoOcr`]: an [`elide_ocr::OcrBackend`] backed by the
+//! [`BentoOcr`]: an [`OcrBackend`] backed by the
 //! `nvisy-inference-ocr` BentoML service.
 //!
 //! Wire contract: `POST /recognize` accepts a batched list of
@@ -15,6 +15,7 @@
 //! `response` (incoming) submodules; only the public
 //! [`BentoOcr`] backend is part of this crate's API.
 //!
+//! [`OcrBackend`]: elide_ocr::OcrBackend
 //! [`LayoutBlock`]: elide_core::modality::image::LayoutBlock
 //! [`LayoutWord`]: elide_core::modality::image::LayoutWord
 

crates/nvisy-engine/src/analyzer/enricher/ocr.rs

@@ -9,7 +9,7 @@ use elide::detection::Analyzer;
 #[cfg(feature = "test-utils")]
 use elide::enrichment::ocr::MockBackend as MockOcrBackend;
 use elide::enrichment::ocr::OcrEnricher;
-use elide_bento::BentoOcr;
+use elide_bento::ocr::BentoOcr;
 use elide_core::modality::image::Image;
 use elide_core::{Error, ErrorKind};
 use nvisy_schema::plan::{OcrBackendParams, OcrEnricherParams};

crates/nvisy-engine/src/analyzer/recognizer/ner.rs

@@ -12,7 +12,7 @@
 
 use elide::detection::Analyzer;
 use elide::recognition::ner::NerRecognizer;
-use elide_bento::BentoNer;
+use elide_bento::ner::BentoNer;
 use elide_core::modality::TextRecognizable;
 use elide_core::recognition::Recognizer;
 use elide_core::{Error, ErrorKind};

crates/nvisy-engine/src/analyzer/recognizer/pattern.rs

@@ -15,8 +15,10 @@
 //!   [`elide_pattern::Dictionary`] / [`Term`].
 //!
 //! [`PatternGuardrails`] bounds runaway compile cost from any of
-//! those slots. See [`guardrails`](super::guardrails) for the
-//! per-request budget shape.
+//! those slots. See [`guardrails`] for the per-request budget
+//! shape.
+//!
+//! [`guardrails`]: super::guardrails
 
 use std::collections::HashMap;
 

crates/nvisy-engine/src/lib.rs

@@ -25,11 +25,17 @@ mod pipeline;
 mod provider;
 
 #[doc(inline)]
-pub use elide::recognition::Scope;
+pub use elide::codec::FormatRegistry;
 #[doc(inline)]
-pub use elide_core::entity::Entity;
+pub use elide::recognition::Scope;
 #[doc(inline)]
 pub use elide_core::{Error, ErrorKind, Result};
+/// Authored redaction governance: policies, rules, predicates,
+/// operators, retention.
+#[doc(inline)]
+pub use nvisy_schema::policy;
+#[doc(inline)]
+pub use nvisy_schema::{annotation, entity, file, modality, plan, primitive};
 
 pub use self::analyzer::PatternGuardrails;
 pub use self::pipeline::{

crates/nvisy-engine/src/pipeline/analyzed.rs

@@ -49,9 +49,10 @@ use serde::{Deserialize, Serialize};
 ///
 /// `correlation_id` on the persisted scope is always `None`; the
 /// anonymize call supplies a fresh id from the passed
-/// [`Document`](nvisy_schema::file::Document) so anonymize-side
-/// tracing spans are distinct from the analyze-side ones.
+/// [`Document`] so anonymize-side tracing spans are distinct
+/// from the analyze-side ones.
 ///
+/// [`Document`]: nvisy_schema::file::Document
 /// [`Scope`]: elide::recognition::Scope
 #[derive(Debug, Clone, Default, Serialize, Deserialize, JsonSchema)]
 #[serde(rename_all = "camelCase")]

crates/nvisy-engine/src/provider/llm/prompt.rs

@@ -7,8 +7,10 @@ use serde::{Deserialize, Serialize};
 
 /// Where a recognizer's Jinja2 prompt template comes from.
 ///
-/// Omitted from an [`LlmRecognizer`](super::LlmRecognizer) means
-/// "use elide's default recognition prompt for this modality."
+/// Omitted from an [`LlmRecognizer`] means "use elide's default
+/// recognition prompt for this modality."
+///
+/// [`LlmRecognizer`]: super::LlmRecognizer
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 #[serde(tag = "source", rename_all = "snake_case")]
 pub enum LlmPrompt {

crates/nvisy-policy/src/action/mod.rs

@@ -1,11 +1,11 @@
 //! Actions a rule can trigger when it matches an entity.
 //!
-//! Composed via [`PolicyAction`](super::PolicyAction), which the
-//! engine dispatches on: [`Redact`] runs the per-modality
-//! redaction operator, [`Suppress`] short-circuits redaction
-//! for the entity, [`Audit`] records the match for downstream
-//! reporting without altering the document.
+//! Composed via [`PolicyAction`], which the engine dispatches on:
+//! [`Redact`] runs the per-modality redaction operator, [`Suppress`]
+//! short-circuits redaction for the entity, [`Audit`] records the
+//! match for downstream reporting without altering the document.
 //!
+//! [`PolicyAction`]: super::PolicyAction
 //! [`Redact`]: super::PolicyAction::Redact
 //! [`Suppress`]: super::PolicyAction::Suppress
 //! [`Audit`]: super::PolicyAction::Audit

crates/nvisy-policy/src/rule.rs

@@ -1,11 +1,10 @@
 //! One rule inside a [`Policy`]: shared identity/description
 //! fields, the match predicate, and the action ([`PolicyAction`]).
 //!
-//! The engine compiles a rule's [`predicate`](PolicyRule::predicate)
-//! into an elide anonymizer rule at request time. Three shapes
-//! are recognised as fast paths and route to the matching
-//! [`Anonymizer`] builder method; everything else compiles to a
-//! catalog-aware closure:
+//! The engine compiles a rule's [`predicate`] into an elide
+//! anonymizer rule at request time. Three shapes are recognised
+//! as fast paths and route to the matching [`Anonymizer`] builder
+//! method; everything else compiles to a catalog-aware closure:
 //!
 //! - [`Predicate::LabelOneOf`] with a single label → [`Anonymizer::with_label`]
 //! - [`Predicate::TagOneOf`] with a single tag → [`Anonymizer::with_tag`]
@@ -18,6 +17,7 @@
 //! compiles down to the same fast path.
 //!
 //! [`Policy`]: super::Policy
+//! [`predicate`]: PolicyRule::predicate
 //! [`Anonymizer`]: https://docs.rs/elide/latest/elide/redaction/Anonymizer
 //! [`Anonymizer::with_label`]: https://docs.rs/elide/latest/elide/redaction/Anonymizer::with_label
 //! [`Anonymizer::with_tag`]: https://docs.rs/elide/latest/elide/redaction/Anonymizer::with_tag
@@ -61,15 +61,17 @@ pub struct PolicyRule {
     pub action: PolicyAction,
 }
 
-/// What a rule does when its [`predicate`](PolicyRule::predicate)
-/// matches.
+/// What a rule does when its [`predicate`] matches.
 ///
-/// Three verbs: [`Redact`](PolicyAction::Redact) transforms the
-/// entity with one operator per modality;
-/// [`Suppress`](PolicyAction::Suppress) drops the entity entirely
-/// (false-positive marker) and stamps a reason onto the audit;
-/// [`Audit`](PolicyAction::Audit) flags it for human review without
-/// transforming.
+/// Three verbs: [`Redact`] transforms the entity with one operator
+/// per modality; [`Suppress`] drops the entity entirely (false-positive
+/// marker) and stamps a reason onto the audit; [`Audit`] flags it for
+/// human review without transforming.
+///
+/// [`predicate`]: PolicyRule::predicate
+/// [`Redact`]: PolicyAction::Redact
+/// [`Suppress`]: PolicyAction::Suppress
+/// [`Audit`]: PolicyAction::Audit
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
 #[serde(tag = "kind", rename_all = "camelCase")]
 pub enum PolicyAction {

crates/nvisy-schema/src/annotation.rs

@@ -1,5 +1,4 @@
-//! Caller-supplied region annotations re-exported from
-//! `elide_core::recognition::annotation`.
+//! Caller-supplied region annotations passed to the analyzer.
 //!
 //! Two directions, two types. An [`Inclusion`] adds a candidate
 //! region ("there may be an entity here"); recognizers that

crates/nvisy-schema/src/entity.rs

@@ -1,9 +1,13 @@
-//! Entity-domain types re-exported from `elide_core::entity`.
+//! Detected entities, their labels, and their audit trail.
 //!
-//! Wire types on [`policy`] and [`plan`] carry [`Label`] and
-//! [`LabelRef`] directly.
-//!
-//! [`plan`]: crate::plan
-//! [`policy`]: crate::policy
+//! [`Entity`] is the modality-generic detection record produced
+//! by the analyzer and consumed by the anonymizer. [`Label`] and
+//! [`LabelRef`] name the entity kind; [`LabelCatalog`] holds the
+//! deployment's label vocabulary. [`Provenance`] carries the
+//! audit trail (which rule / model / pattern produced each
+//! detection).
 
-pub use elide_core::entity::{Label, LabelRef};
+pub use elide_core::entity::provenance::{
+    Attribution, Event, EventKind, ModelEvent, PatternEvent, Provenance, RuleMatch,
+};
+pub use elide_core::entity::{Entity, EntityCoRef, EntityRef, Label, LabelCatalog, LabelRef};

crates/nvisy-schema/src/lib.rs

@@ -22,6 +22,9 @@
 //!
 //! [`nvisy-policy`]: https://docs.rs/nvisy-policy
 
+/// Authored redaction governance: policies, rules, predicates,
+/// operators, retention.
+#[doc(inline)]
 pub use nvisy_policy as policy;
 
 pub mod annotation;

crates/nvisy-schema/src/modality.rs

@@ -1,8 +1,15 @@
-//! Modality-specific runtime types re-exported from `elide_core::modality`.
+//! Modality markers and traits parameterising `Entity<M>` and
+//! `EntityRecord<M>`.
 //!
-//! Wire types on [`policy`] (audio redaction operators) carry
-//! [`Waveform`] directly.
+//! [`Modality`] is the trait every marker implements; [`Text`],
+//! [`Tabular`], [`Image`], and [`Audio`] are the four markers.
+//! [`Waveform`] appears directly on audio redaction operators in
+//! [`policy`].
 //!
 //! [`policy`]: crate::policy
 
-pub use elide_core::modality::audio::Waveform;
+pub use elide_core::modality::audio::{Audio, Waveform};
+pub use elide_core::modality::image::Image;
+pub use elide_core::modality::tabular::Tabular;
+pub use elide_core::modality::text::Text;
+pub use elide_core::modality::{Modality, ModalityData, ModalityLocation, ModalityReplacement};

crates/nvisy-schema/src/plan/label.rs

@@ -3,16 +3,17 @@
 //! Two distinct sources the engine unions into one
 //! `elide_core::entity::LabelCatalog` at compile time:
 //!
-//! - [`builtins`](LabelCatalogParams::builtins): names of labels
-//!   from `elide-core`'s shipped builtin set
-//!   (`LabelCatalog::with_builtins`). Engine looks each name up
-//!   against the full builtin catalog and copies the matching
-//!   [`Label`] across; unknown names log a warning and are
-//!   skipped (typos don't fail the request).
-//! - [`custom`](LabelCatalogParams::custom): schemas the caller
-//!   defined inline, beyond the builtin set. Names that collide
-//!   with a builtin replace it (last write wins, matching
-//!   `LabelCatalog::insert` semantics).
+//! - [`builtins`]: names of labels from `elide-core`'s shipped
+//!   builtin set (`LabelCatalog::with_builtins`). Engine looks
+//!   each name up against the full builtin catalog and copies
+//!   the matching [`Label`] across; unknown names log a warning
+//!   and are skipped (typos don't fail the request).
+//! - [`custom`]: schemas the caller defined inline, beyond the
+//!   builtin set. Names that collide with a builtin replace it
+//!   (last write wins, matching `LabelCatalog::insert` semantics).
+//!
+//! [`builtins`]: LabelCatalogParams::builtins
+//! [`custom`]: LabelCatalogParams::custom
 //!
 //! Empty default. Server-side deployments may pre-populate via
 //! the `analyzer` server-default block in the config, but the

crates/nvisy-schema/src/plan/mod.rs

@@ -1,13 +1,11 @@
-//! Analyzer plan.
+//! Authored recognition plan: recognizers, enrichers, dedup, scope.
 //!
-//! Serialisable description of how to build an
-//! `elide::detection::Analyzer` for a request.
-//!
-//! Symmetric with [`policy`]. Where policy describes redaction
-//! governance (which entities to hide and how), the plan
-//! describes recognition (which entities to find and how). Both
-//! are pure data; the engine compiles them into elide runtime
-//! values at request time.
+//! Serialisable description of how to build an analyzer for a
+//! request. Symmetric with [`policy`]. Where policy describes
+//! redaction governance (which entities to hide and how), the
+//! plan describes recognition (which entities to find and how).
+//! Both are pure data; the engine compiles them into elide
+//! runtime values at request time.
 //!
 //! ## Layout
 //!

crates/nvisy-schema/src/primitive.rs

@@ -1,13 +1,14 @@
-//! Primitive value types re-exported from `elide_core::primitive`.
+//! Primitive value types wire schemas carry directly.
 //!
-//! Wire types on [`plan`] and [`policy`] carry these directly.
-//! The re-export means an SDK caller can construct them without
-//! adding `elide-core` as a separate dep.
+//! Bounding boxes, confidence, colors, languages, country codes,
+//! time spans, and friends. Wire types on [`plan`] and [`policy`]
+//! use these as leaf fields.
 //!
 //! [`plan`]: crate::plan
 //! [`policy`]: crate::policy
 
 pub use elide_core::primitive::{
-    BoundingBox, Color, Confidence, ConfidenceThreshold, CountryCode, LanguageTag, Languages,
-    Point, Polygon, TimeSpan,
+    BoundingBox, Color, Confidence, ConfidenceThreshold, CountryCode, Dimensions, Dpi, Language,
+    LanguageProvenance, LanguageSpan, LanguageTag, Languages, PixelRegion, Point, Polygon,
+    TimeSpan, UnitBoundingBox,
 };