Skip to main content

OutputCap

Enum OutputCap 

Source
pub enum OutputCap {
    Tokens(usize),
    WindowPercent(f64),
    RegionPercent {
        percent: f64,
        region: String,
    },
}
Expand description

How large one reply may be, as a stage’s parameters.max_output_tokens says it.

A bare number is the classic form and is sent as written. The other two are relative, because a fixed number is the wrong shape for the question: a stage that rewrites a whole report needs “as much as this model can give”, and a stage that fills a region needs “as much as the region holds”. A fixed 24000 on the report stage was smaller than the report, and every reply was cut off. A relative cap is clamped to the model’s own maximum, since asking for more than that is refused by the provider.

parameters = { max_output_tokens = 8000 }              # tokens
parameters = { max_output_tokens = "40%" }             # of the model's context window
parameters = { max_output_tokens = "100% of claims" }  # of the `claims` region's budget
parameters = { max_output_tokens = { percent = 100, of = "claims" } }

Variants§

§

Tokens(usize)

A fixed number of output tokens, sent as written.

§

WindowPercent(f64)

A fraction (0.0..=1.0) of the model’s context window.

§

RegionPercent

A fraction (0.0..=1.0) of a named region’s token budget.

Fields

§percent: f64

The fraction.

§region: String

The region whose budget it is a fraction of.

Implementations§

Source§

impl OutputCap

Source

pub fn parse(value: &Value) -> Result<Self, String>

Read the cap from the parameter’s JSON value. Err carries the reason in the words a blueprint author needs, for the manifest loader to surface: a cap that does not parse must fail the load, because the alternative (no cap) is exactly the silent no-op that hides a typo.

Source

pub fn resolve( &self, model_window: usize, model_max_output: usize, region_budget: impl Fn(&str) -> Option<usize>, ) -> usize

The cap in tokens for one request.

model_window and model_max_output are the model’s own limits; region_budget answers “how many tokens may region X hold” for the window the request is built from. A relative cap is clamped to the model’s maximum. A region cap naming a region the stage does not carry falls back to the model’s maximum, which is the same “as much as you can” the author was reaching for; the loader already warned about the name.

Trait Implementations§

Source§

impl Clone for OutputCap

Source§

fn clone(&self) -> OutputCap

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 Debug for OutputCap

Source§

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

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

impl PartialEq for OutputCap

Source§

fn eq(&self, other: &OutputCap) -> 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 OutputCap

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more