Skip to main content

Summarizer

Struct Summarizer 

Source
pub struct Summarizer<'a> {
    pub model: &'a Model,
    pub apis: Apis,
    pub auth: Auth,
    pub thinking_level: ThinkingLevel,
    pub retry: RetryPolicy,
    pub request: Result<StreamOptions, String>,
    pub cancel: CancellationToken,
    pub on_retry: Box<dyn Fn(SummaryRetry) + Send + Sync + 'a>,
    pub hooks: RequestHooks,
}
Expand description

What summary requests need besides the messages.

Fields§

§model: &'a Model

The model to summarize with.

§apis: Apis

Wire APIs.

§auth: Auth

Credentials for the model.

§thinking_level: ThinkingLevel

The session’s thinking level, used when the model reasons.

§retry: RetryPolicy

Retries for transient failures.

§request: Result<StreamOptions, String>

The settings every request carries, as the session’s requests carry them, or the error an invalid one raises.

§cancel: CancellationToken

Cancels the requests.

§on_retry: Box<dyn Fn(SummaryRetry) + Send + Sync + 'a>

Hears about retries.

§hooks: RequestHooks

Observers of the requests.

Implementations§

Source§

impl Summarizer<'_>

Source

pub async fn generate_summary( &self, messages: &[Message], reserve_tokens: u64, custom_instructions: Option<&str>, previous: Option<&str>, ) -> Result<Summary, String>

Summarizes messages, updating previous when given.

Source

pub async fn compact( &self, preparation: &Preparation, custom_instructions: Option<&str>, ) -> Result<CompactionResult, String>

Generates the compaction summary for a preparation.

Source§

impl Summarizer<'_>

Source

pub async fn branch_summary( &self, entries: &[FileEntry], custom_instructions: Option<&str>, replace: bool, reserve_tokens: u64, ) -> Result<BranchSummary, String>

Summarizes abandoned branch entries (chronological). replace makes custom_instructions the whole instruction instead of an addition.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Summarizer<'a>

§

impl<'a> !UnwindSafe for Summarizer<'a>

§

impl<'a> Freeze for Summarizer<'a>

§

impl<'a> Send for Summarizer<'a>

§

impl<'a> Sync for Summarizer<'a>

§

impl<'a> Unpin for Summarizer<'a>

§

impl<'a> UnsafeUnpin for Summarizer<'a>

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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