Struct async_openai::types::AssistantObject

pub struct AssistantObject {

    pub id: String,
    pub object: String,
    pub created_at: i32,
    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, Value>>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub response_format: Option<AssistantsApiResponseFormatOption>,
}

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

Fields

id: String

The identifier, which can be referenced in API endpoints.

object: String

The object type, which is always assistant.

created_at: i32

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

name: Option<String>

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

description: Option<String>

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

model: String

instructions: Option<String>

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

tools: Vec<AssistantTools>

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>

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, Value>>

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 maxium of 512 characters long.

temperature: Option<f32>

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>

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>

Trait Implementations

impl Clone for AssistantObject

fn clone(&self) -> AssistantObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssistantObject

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AssistantObject

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AssistantObject

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AssistantObject