Skip to main content

ChatModelRunOptions

ai_ui_core::adapter

Struct ChatModelRunOptions

pub struct ChatModelRunOptions {
    pub messages: Arc<[Arc<ThreadMessage>]>,
    pub run_config: RunConfig,
    pub abort_signal: AbortSignal,
    pub context: ModelContext,
    pub assistant_message_id: MessageId,
    pub thread_id: Option<String>,
    pub parent_id: Option<MessageId>,
    pub message: AssistantMessage,
}

Expand description

Everything an adapter receives for one step (ChatModelRunOptions).

Fields§

§messages: Arc<[Arc<ThreadMessage>]>

The selected path up to and including the message being answered.

§run_config: RunConfig

The run’s configuration.

§abort_signal: AbortSignal

Fires when the run is cancelled; stop work and end the stream.

§context: ModelContext

The app’s system prompt, tools and settings.

§assistant_message_id: MessageId

Id of the assistant message this step fills.

§thread_id: Option<String>

The thread’s remote id, when it has one.

§parent_id: Option<MessageId>

The message being answered.

§message: AssistantMessage

The assistant message being answered, as it was when this step started (unstable_getMessage() upstream). Its content is non-empty when a run continues after tool results; its metadata holds the thread state.

Trait Implementations§

impl Clone for ChatModelRunOptions

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

impl Debug for ChatModelRunOptions

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Forget for ChatModelRunOptions

impl Freeze for ChatModelRunOptions

impl Move for ChatModelRunOptions

impl RefUnwindSafe for ChatModelRunOptions

impl Send for ChatModelRunOptions

impl Sync for ChatModelRunOptions

impl Unpin for ChatModelRunOptions

impl UnsafeUnpin for ChatModelRunOptions

impl UnwindSafe for ChatModelRunOptions

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.