Struct Thread 

pub struct Thread { /* private fields */ }

Represents a thread of conversation with the agent.

Implementations

impl Thread

pub fn id(&self) -> Option<String>

Returns the current thread id, if available.

Example

use codex::Codex;

let codex = Codex::new(None)?;
let thread = codex.start_thread(None);
let _id = thread.id();

pub async fn run_streamed( &self, input: impl Into<Input>, turn_options: Option<TurnOptions>, ) -> Result<RunStreamedResult>

Provides input to the agent and streams events as they are produced.

Example

use codex::{Codex, ThreadEvent};
use futures::StreamExt;

let codex = Codex::new(None)?;
let thread = codex.start_thread(None);
let mut events = thread.run_streamed("Review this code", None).await?.events;

while let Some(event) = events.next().await {
    if let ThreadEvent::TurnCompleted { usage } = event? {
        println!("{usage:?}");
    }
}

pub async fn run( &self, input: impl Into<Input>, turn_options: Option<TurnOptions>, ) -> Result<Turn>

Provides input to the agent and returns the completed turn.

Example

use codex::Codex;

let codex = Codex::new(None)?;
let thread = codex.start_thread(None);
let turn = thread.run("Summarize current repository state", None).await?;
println!("{}", turn.final_response);

Trait Implementations

impl Clone for Thread

fn clone(&self) -> Thread

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Thread

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

Formats the value using the given formatter.