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> !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