Skip to main content

Conversation

Struct Conversation 

Source
pub struct Conversation { /* private fields */ }
Expand description

The messages of one conversation.

Implementations§

Source§

impl Conversation

Source

pub fn messages(&self) -> &[Value]

The messages, oldest first.

Source

pub fn view(&self, budget: usize) -> Vec<Value>

The messages as they go out in a request that is at most budget bytes: the conversation as it is when it fits, and a trimmed view of it when it does not. What is kept is kept whole, and nothing is asked of the model to make the view smaller.

Three parts are never shortened: the first message, which usually holds the task; the newest message, which holds the tool results the model is waiting for an answer to; and the shape of a call and its result, so that every call still has its answer. What is shortened first is the tool results of the turns in between, oldest first, since they are the biggest part of an old turn and the least needed of it; the text of those turns follows in the same order, only if the results alone are not enough. Wherever something is left out, an English note stands in its place saying what was left out, and the conversation kept here is not touched.

Source

pub fn is_empty(&self) -> bool

Whether nothing has been said yet.

Source

pub fn say(&mut self, text: &str)

Adds what the person wrote. Right after another user message (a reply that was stopped before it said anything) the text joins that message, since the API wants the roles to take turns.

Source

pub fn reply(&mut self, content: Vec<Value>)

Adds the model’s reply. Nothing is added for a reply with no content.

Source

pub fn results(&mut self, results: Vec<Value>)

Adds the results of tool calls, each a tool_result block.

Source

pub fn open_calls(&self) -> Vec<Call>

The tool calls of the last message that have no result yet, in the order they were made.

Source

pub fn to_json(&self) -> Value

The conversation as it is saved.

Source

pub fn holds(value: &Value) -> bool

Whether value is a conversation as this program keeps one. A file that is not one holds somebody’s thread in a shape this program cannot show, which is not the same as a file that holds nothing.

Source

pub fn from_json(value: &Value) -> Self

A saved conversation. Anything that is not a message is left out, and calls that were waiting when the program closed are answered as not done, so the conversation can go on.

Trait Implementations§

Source§

impl Clone for Conversation

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

Source§

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

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

impl Default for Conversation

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Conversation

Source§

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

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.