Struct NarrationConfig 

#[non_exhaustive]
pub struct NarrationConfig {
    pub enabled: bool,
    pub budget: Budget,
    pub tone: ToneProfile,
    pub max_answer_chars: Option<usize>,
    pub default_source_policy: SourcePolicy,
    pub allow_retry_after_commit: bool,
    pub steps: bool,
}

How the assistant is allowed to talk (spec §18, §19).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Whether a model writes the answer and transition blocks at all. With narration off the turn is receipts, notices and cards only.

budget: Budget

What the narration tasks of one turn may spend.

tone: ToneProfile

Voice the narrator should use.

max_answer_chars: Option<usize>

Cap on one written block, in characters; None, the default, is no cap. A longer block is refused whole and reported, never cut mid-sentence.

default_source_policy: SourcePolicy

Source requirement for answers resting on general domain knowledge. Answers resting on case state are always AuthoritativeOnly.

allow_retry_after_commit: bool

Whether narration may be regenerated after commands committed. This is the only retry I17 permits once effects may exist.

steps: bool

Whether each understanding step is also said in the turn’s language, as a TurnEvent::StepSaid: one small model call per step. Off by default.

Implementations

impl NarrationConfig

pub const fn conservative() -> Self

Narration on, neutral tone, no cap on answer length, any source, post-commit narration retries allowed.

pub const fn with_enabled(self, enabled: bool) -> Self

Returns a copy with narration switched on or off.

With narration off the turn is receipts, notices and cards only, and every question still gets a block — an explicitly unsupported one (spec §19.4). Silence is never how a question disappears.

pub const fn with_budget(self, budget: Budget) -> Self

Returns a copy with another budget for the narration tasks.

pub const fn with_steps(self, steps: bool) -> Self

Returns a copy that says, or stops saying, each understanding step.

pub const fn with_tone(self, tone: ToneProfile) -> Self

Returns a copy with another tone.

pub const fn with_default_source_policy(self, policy: SourcePolicy) -> Self

Returns a copy with another source policy for general-knowledge answers.

pub const fn with_max_answer_chars( self, max_answer_chars: Option<usize>, ) -> Self

Returns a copy with a cap on one generated answer, or with none.

Trait Implementations

impl Clone for NarrationConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NarrationConfig

impl Debug for NarrationConfig

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

Formats the value using the given formatter.

impl Default for NarrationConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NarrationConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for NarrationConfig

impl PartialEq for NarrationConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for NarrationConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NarrationConfig