Struct ModelTurn 

#[non_exhaustive]
pub struct ModelTurn {
    pub message_id: Option<String>,
    pub choice: OneOrMany<AssistantContent>,
    pub usage: Usage,
    pub executable_tool_names: BTreeSet<String>,
    pub allowed_tool_names: BTreeSet<String>,
}

A completed model turn fed back to AgentRun::model_response.

Fields (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.

message_id: Option<String>

Provider-assigned assistant message ID, when available.

choice: OneOrMany<AssistantContent>

The assistant content returned by the model.

usage: Usage

Token usage reported by the provider for this completion request.

executable_tool_names: BTreeSet<String>

Executable Rig tools advertised to the provider for this turn.

allowed_tool_names: BTreeSet<String>

Tools allowed by the active ToolChoice for this turn.

Implementations

impl ModelTurn

pub fn new( message_id: Option<String>, choice: OneOrMany<AssistantContent>, usage: Usage, executable_tool_names: BTreeSet<String>, allowed_tool_names: BTreeSet<String>, ) -> Self

Create a model turn from response parts and the tool names advertised for the turn.

Trait Implementations

impl Clone for ModelTurn

fn clone(&self) -> ModelTurn

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelTurn

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelTurn

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ModelTurn

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.