Skip to main content

Threads

Struct Threads 

Source
pub struct Threads<'c, C: Config> { /* private fields */ }
๐Ÿ‘ŽDeprecated: Assistants API is deprecated and will be removed in August 2026. Use the Responses API.
Available on crate feature assistant only.
Expand description

Create threads that assistants can interact with.

Related guide: Assistants

Implementationsยง

Sourceยง

impl<'c, C: Config> Threads<'c, C>

Source

pub fn new(client: &'c Client<C>) -> Self

Source

pub fn messages(&self, thread_id: &str) -> Messages<'_, C>

Call Messages group API to manage message in thread_id thread.

Source

pub fn runs(&self, thread_id: &str) -> Runs<'_, C>

Call Runs group API to manage runs in thread_id thread.

Source

pub async fn create_and_run( &self, request: CreateThreadAndRunRequest, ) -> Result<RunObject, OpenAIError>

Create a thread and run it in one request.

Source

pub async fn create_and_run_byot<T0: Serialize, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

Create a thread and run it in one request.

Source

pub async fn create_and_run_stream( &self, request: CreateThreadAndRunRequest, ) -> Result<AssistantEventStream, OpenAIError>

Create a thread and run it in one request (streaming).

byot: You must ensure โ€œstream: trueโ€ in serialized request

Source

pub async fn create_and_run_stream_byot<T0: Serialize, R>( &self, request: T0, ) -> Result<Pin<Box<dyn Stream<Item = Result<R, OpenAIError>> + Send>>, OpenAIError>
where R: Send + 'static + TryFrom<Event, Error = OpenAIError> + DeserializeOwned,

Create a thread and run it in one request (streaming).

byot: You must ensure โ€œstream: trueโ€ in serialized request

Source

pub async fn create( &self, request: CreateThreadRequest, ) -> Result<ThreadObject, OpenAIError>

Create a thread.

Source

pub async fn create_byot<T0: Serialize, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

Create a thread.

Source

pub async fn retrieve( &self, thread_id: &str, ) -> Result<ThreadObject, OpenAIError>

Retrieves a thread.

Source

pub async fn retrieve_byot<T0: Display, R: DeserializeOwned>( &self, thread_id: T0, ) -> Result<R, OpenAIError>

Retrieves a thread.

Source

pub async fn update( &self, thread_id: &str, request: ModifyThreadRequest, ) -> Result<ThreadObject, OpenAIError>

Modifies a thread.

Source

pub async fn update_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, thread_id: T0, request: T1, ) -> Result<R, OpenAIError>

Modifies a thread.

Source

pub async fn delete( &self, thread_id: &str, ) -> Result<DeleteThreadResponse, OpenAIError>

Delete a thread.

Source

pub async fn delete_byot<T0: Display, R: DeserializeOwned>( &self, thread_id: T0, ) -> Result<R, OpenAIError>

Delete a thread.

Trait Implementationsยง

Sourceยง

impl<'c, C: Config> RequestOptionsBuilder for Threads<'c, C>

Available on crate feature _api only.
Sourceยง

fn options_mut(&mut self) -> &mut RequestOptions

Get mutable reference to RequestOptions (for building)
Sourceยง

fn options(&self) -> &RequestOptions

Get reference to RequestOptions
Sourceยง

fn headers(self, headers: HeaderMap) -> Self

Add headers to RequestOptions
Sourceยง

fn header<K, V>(self, key: K, value: V) -> Result<Self, OpenAIError>

Add a single header to RequestOptions
Sourceยง

fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Self, OpenAIError>

Add query parameters to RequestOptions
Sourceยง

fn path<P: Into<String>>(self, path: P) -> Result<Self, OpenAIError>

Add a path to RequestOptions

Auto Trait Implementationsยง

ยง

impl<'c, C> Freeze for Threads<'c, C>

ยง

impl<'c, C> !RefUnwindSafe for Threads<'c, C>

ยง

impl<'c, C> Send for Threads<'c, C>

ยง

impl<'c, C> Sync for Threads<'c, C>

ยง

impl<'c, C> Unpin for Threads<'c, C>

ยง

impl<'c, C> UnsafeUnpin for Threads<'c, C>

ยง

impl<'c, C> !UnwindSafe for Threads<'c, C>

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> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Sourceยง

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Sourceยง

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Sourceยง

impl<T> Same for T

Sourceยง

type Output = T

Should always be Self
Sourceยง

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

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Sourceยง

fn vzip(self) -> V

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
Sourceยง

impl<T> ErasedDestructor for T
where T: 'static,

Sourceยง

impl<T> MaybeSendSync for T