Skip to main content

StructuredOutputModel

Struct StructuredOutputModel 

Source
pub struct StructuredOutputModel<M, T>
where M: Clone,
{ /* private fields */ }
Expand description

Wrapper for structured output from LLMs

Uses function calling to force the model to output JSON matching the schema of type T.

Trait Implementations§

Source§

impl<M, T> ChatModel for StructuredOutputModel<M, T>
where M: ChatModel, T: JsonSchema + DeserializeOwned + Serialize + Send + Sync + 'static,

Source§

fn invoke<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, messages: &'life1 [Message], options: Option<&'life2 CallOptions>, ) -> Pin<Box<dyn Future<Output = Result<Message, LlmError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Invoke the model with messages Read more
Source§

fn stream<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, messages: &'life1 [Message], options: Option<&'life2 CallOptions>, ) -> Pin<Box<dyn Future<Output = Result<BoxStream<'_, Result<MessageChunk, LlmError>>, LlmError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Stream the model’s response Read more
Source§

fn bind_tools(&self, tools: Vec<ToolDefinition>) -> Self

Bind tools to this model instance Read more
Source§

fn with_structured_output<U: JsonSchema + DeserializeOwned + Serialize>( self, ) -> StructuredOutputModel<Self, U>
where Self: Sized,

Convert to structured output model Read more
Source§

fn model_name(&self) -> &str

Get the model name
Source§

impl<M: Clone, T> Clone for StructuredOutputModel<M, T>

Source§

fn clone(&self) -> Self

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<M, T> Debug for StructuredOutputModel<M, T>
where M: Clone,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<M, T> Freeze for StructuredOutputModel<M, T>
where M: Freeze,

§

impl<M, T> RefUnwindSafe for StructuredOutputModel<M, T>

§

impl<M, T> Send for StructuredOutputModel<M, T>
where M: Send, T: Send,

§

impl<M, T> Sync for StructuredOutputModel<M, T>
where M: Sync, T: Sync,

§

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

§

impl<M, T> UnsafeUnpin for StructuredOutputModel<M, T>
where M: UnsafeUnpin,

§

impl<M, T> UnwindSafe for StructuredOutputModel<M, T>
where M: UnwindSafe, T: UnwindSafe,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

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

Source§

fn vzip(self) -> V

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