Skip to main content

IngestConfig

Struct IngestConfig 

Source
pub struct IngestConfig {
    pub prose: bool,
    pub pdf: bool,
    pub ocr: bool,
    pub vision: bool,
    pub audio: bool,
}
Expand description

Runtime ingestion toggles (ADR-0007 [ingest]). Every toggle defaults to on, and a toggle only gates content within a build that supports it — turning pdf on cannot extract PDF text in a binary built without the pdf-text feature, but turning it off suppresses that content in a binary that has it.

The five toggles split into two groups, and the split is the ADR-0015 boundary:

  • prose, pdf and ocr gate extraction: what is decoded from the bytes into meta.content as a derived fact. They contribute to the extraction cache key, because turning one off changes what extraction produces.
  • vision and audio gate generation: whether roteiro media build may invoke a model at all. They no longer touch extraction, so they contribute nothing to the cache key — a repository that sets audio = false gets exactly the derived facts it would get with it on.

Fields§

§prose: bool

Embed the UTF-8 body of prose files (Markdown, plain text).

§pdf: bool

Extract text from PDF documents (needs the pdf-text feature).

§ocr: bool

OCR literal text from images (needs the image-ocr feature).

§vision: bool

Allow roteiro media build to describe images with a vision model (needs the image-vision feature). Since ADR-0015 this gates generation, not extraction: a description is never written to meta.content.

§audio: bool

Allow roteiro media build to transcribe spoken-word audio (needs the audio-transcribe feature). Gates generation, as vision does.

Implementations§

Source§

impl IngestConfig

Source

pub fn generates(self, kind: MediaKind) -> bool

Whether this configuration permits roteiro media build to run kind. An operator can disable generation outright without touching the graph.

Trait Implementations§

Source§

impl Clone for IngestConfig

Source§

fn clone(&self) -> IngestConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for IngestConfig

Source§

impl Debug for IngestConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for IngestConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for IngestConfig

Source§

impl PartialEq for IngestConfig

Source§

fn eq(&self, other: &IngestConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for IngestConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.