Skip to main content

Turn

Struct Turn 

Source
#[non_exhaustive]
pub struct Turn { pub role: Role, pub content: String, pub parts: Vec<Part>, pub tool_calls: Vec<ToolCall>, pub tool_results: Vec<ToolResult>, }
Expand description

One message of the conversation a Prompt carries.

#[non_exhaustive]: a turn grew its tool fields in issue #665 and its image Parts in issue #628 and will grow again, so it is built with Turn::user, Turn::user_parts, Turn::assistant, Turn::assistant_tool_calls or Turn::tool_results rather than a struct literal.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§role: Role§content: String§parts: Vec<Part>

The turn’s content as ordered Parts, where it carries any (issue #628). When non-empty it is the whole content, in order, and content is empty; a text-only turn keeps it empty so it serialises exactly as before images existed.

§tool_calls: Vec<ToolCall>

The calls an assistant turn asked for. Carried on a Role::Assistant turn; empty on every other turn.

§tool_results: Vec<ToolResult>

The results a user turn carries back for the previous assistant turn’s calls. Carried on a Role::User turn; empty otherwise.

Implementations§

Source§

impl Turn

Source

pub fn user(content: impl Into<String>) -> Self

A turn spoken by the Role::User side.

Source

pub fn user_parts(parts: impl IntoIterator<Item = Part>) -> Self

A user turn carrying parts — text and images in order — with an empty content (issue #628). The way a prompt sends an image: providers expect text and image in one message, so the parts travel together rather than across two turns.

Source

pub fn assistant(content: impl Into<String>) -> Self

A turn spoken by the Role::Assistant side — a previous completion, quoted back as context.

Source

pub fn assistant_tool_calls( content: impl Into<String>, calls: Vec<ToolCall>, ) -> Self

An assistant turn that asked to call calls. content is the text the model wrote alongside the calls (often empty).

Source

pub fn tool_results(results: Vec<ToolResult>) -> Self

A user turn carrying the results of the previous assistant turn’s tool calls — the shape a provider expects the tool answers back in.

Trait Implementations§

Source§

impl Clone for Turn

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 Turn

Source§

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

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

impl PartialEq for Turn

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 Turn

Auto Trait Implementations§

§

impl Freeze for Turn

§

impl RefUnwindSafe for Turn

§

impl Send for Turn

§

impl Sync for Turn

§

impl Unpin for Turn

§

impl UnsafeUnpin for Turn

§

impl UnwindSafe for Turn

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> Same for T

Source§

type Output = T

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