Skip to main content

AssistantObject

async_openai::types::assistants

Struct AssistantObject 

Source 
pub struct AssistantObject {
Show 13 fields
    pub id: String,
    pub object: String,
    pub created_at: u64,
    pub name: Option<String>,
    pub description: Option<String>,
    pub model: String,
    pub instructions: Option<String>,
    pub tools: Vec<AssistantTools>,
    pub tool_resources: Option<AssistantToolResources>,
    pub metadata: Option<HashMap<String, String>>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub response_format: Option<AssistantsApiResponseFormatOption>,

}
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

Available on crate feature assistant-types only.
Expand description

Represents an assistant that can call the model and use tools.

Fields§

§id: String
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

The identifier, which can be referenced in API endpoints.

§object: String
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

The object type, which is always assistant.

§created_at: u64
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

The Unix timestamp (in seconds) for when the assistant was created.

§name: Option<String>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

The name of the assistant. The maximum length is 256 characters.

§description: Option<String>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

The description of the assistant. The maximum length is 512 characters.

§model: String
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

§instructions: Option<String>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

The system instructions that the assistant uses. The maximum length is 256,000 characters.

§tools: Vec<AssistantTools>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

§tool_resources: Option<AssistantToolResources>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

A set of resources that are used by the assistant’s tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

§metadata: Option<HashMap<String, String>>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

§temperature: Option<f32>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

§top_p: Option<f32>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

§response_format: Option<AssistantsApiResponseFormatOption>
👎Deprecated:

Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

Trait Implementations§

Source§

impl Clone for AssistantObject

Source§

fn clone(&self) -> AssistantObject

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AssistantObject

Source§

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

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

impl<'de> Deserialize<'de> for AssistantObject

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for AssistantObject

Source§

fn eq(&self, other: &AssistantObject) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for AssistantObject

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AssistantObject

Auto Trait Implementations§

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> 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> 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 = 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

impl<T> MaybeSendSync for T