Skip to main content

Extractor

Struct Extractor 

Source
pub struct Extractor<M, T>{ /* private fields */ }
Expand description

Extractor for structured data from text

Implementations§

Source§

impl<M, T> Extractor<M, T>

Source

pub async fn extract( &self, text: impl Into<Message> + WasmCompatSend, ) -> Result<T, ExtractionError>

Attempts to extract data from the given text with a number of retries.

The function will retry the extraction if the initial attempt fails or if the model does not call the submit tool.

The number of retries is determined by the retries field on the Extractor struct.

Source

pub async fn extract_with_chat_history( &self, text: impl Into<Message> + WasmCompatSend, chat_history: Vec<Message>, ) -> Result<T, ExtractionError>

Attempts to extract data from the given text with a number of retries.

The function will retry the extraction if the initial attempt fails or if the model does not call the submit tool.

The number of retries is determined by the retries field on the Extractor struct.

Source

pub async fn extract_with_usage( &self, text: impl Into<Message> + WasmCompatSend, ) -> Result<ExtractionResponse<T>, ExtractionError>

Attempts to extract data from the given text with a number of retries, returning both the extracted data and accumulated token usage.

The function will retry the extraction if the initial attempt fails or if the model does not call the submit tool.

The number of retries is determined by the retries field on the Extractor struct.

Usage accumulates across all retry attempts, including attempts that received a billed response but failed extraction (e.g. the model never called submit). Attempts whose completion call itself returned an error (e.g. network failures or unparseable provider responses) contribute no usage, and when every attempt fails the returned error carries no usage information at all.

Source

pub async fn extract_with_chat_history_with_usage( &self, text: impl Into<Message> + WasmCompatSend, chat_history: Vec<Message>, ) -> Result<ExtractionResponse<T>, ExtractionError>

Attempts to extract data from the given text with a number of retries, providing chat history context, and returning both the extracted data and accumulated token usage.

The function will retry the extraction if the initial attempt fails or if the model does not call the submit tool.

The number of retries is determined by the retries field on the Extractor struct.

Usage accumulates across all retry attempts, including attempts that received a billed response but failed extraction (e.g. the model never called submit). Attempts whose completion call itself returned an error (e.g. network failures or unparseable provider responses) contribute no usage, and when every attempt fails the returned error carries no usage information at all.

Auto Trait Implementations§

§

impl<M, T> !RefUnwindSafe for Extractor<M, T>

§

impl<M, T> !UnwindSafe for Extractor<M, T>

§

impl<M, T> Freeze for Extractor<M, T>

§

impl<M, T> Send for Extractor<M, T>

§

impl<M, T> Sync for Extractor<M, T>

§

impl<M, T> Unpin for Extractor<M, T>
where T: Unpin,

§

impl<M, T> UnsafeUnpin for Extractor<M, T>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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
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