Skip to main content

ResponseObject

Struct ResponseObject 

Source
#[non_exhaustive]
pub struct ResponseObject {
Show 38 fields pub id: String, pub created_at: u64, pub background: Option<bool>, pub completed_at: Option<u64>, pub conversation: Option<ResponseConversationParam>, pub error: Option<ResponseError>, pub incomplete_details: Option<IncompleteDetails>, pub instructions: Option<ResponseInput>, pub max_output_tokens: Option<u32>, pub max_tool_calls: Option<u32>, pub metadata: Option<Metadata>, pub model: Option<OpenAiModelId>, pub moderation: Option<ResponseModeration>, pub multi_agent: Option<Value>, pub object: ResponseObjectType, pub output: Vec<ResponseOutputItem>, pub output_text: Option<String>, pub parallel_tool_calls: Option<bool>, pub prompt: Option<PromptRef>, pub prompt_cache_key: Option<String>, pub prompt_cache_options: Option<PromptCacheOptions>, pub prompt_cache_retention: Option<PromptCacheRetention>, pub previous_response_id: Option<String>, pub reasoning: Option<ReasoningConfig>, pub safety_identifier: Option<String>, pub service_tier: Option<ServiceTier>, pub status: Option<ResponseStatus>, pub store: Option<bool>, pub temperature: Option<f64>, pub text: Option<TextConfig>, pub tool_choice: Option<ResponseToolChoice>, pub tools: Option<Vec<ResponseTool>>, pub top_logprobs: Option<u32>, pub top_p: Option<f64>, pub truncation: Option<TruncationStrategy>, pub usage: Option<ResponseUsage>, pub user: Option<String>, pub extra: Extra,
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: String§created_at: u64§background: Option<bool>§completed_at: Option<u64>§conversation: Option<ResponseConversationParam>§error: Option<ResponseError>§incomplete_details: Option<IncompleteDetails>§instructions: Option<ResponseInput>§max_output_tokens: Option<u32>§max_tool_calls: Option<u32>§metadata: Option<Metadata>§model: Option<OpenAiModelId>§moderation: Option<ResponseModeration>§multi_agent: Option<Value>§object: ResponseObjectType§output: Vec<ResponseOutputItem>§output_text: Option<String>§parallel_tool_calls: Option<bool>§prompt: Option<PromptRef>§prompt_cache_key: Option<String>§prompt_cache_options: Option<PromptCacheOptions>§prompt_cache_retention: Option<PromptCacheRetention>§previous_response_id: Option<String>§reasoning: Option<ReasoningConfig>§safety_identifier: Option<String>§service_tier: Option<ServiceTier>§status: Option<ResponseStatus>§store: Option<bool>§temperature: Option<f64>§text: Option<TextConfig>§tool_choice: Option<ResponseToolChoice>§tools: Option<Vec<ResponseTool>>§top_logprobs: Option<u32>§top_p: Option<f64>§truncation: Option<TruncationStrategy>§usage: Option<ResponseUsage>§user: Option<String>§extra: Extra

Implementations§

Source§

impl ResponseObject

Source

pub fn builder() -> WireResponseObjectBuilder

Trait Implementations§

Source§

impl Clone for ResponseObject

Source§

fn clone(&self) -> ResponseObject

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResponseObject

Source§

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

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

impl<'de> Deserialize<'de> for ResponseObject

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 ResponseObject

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ResponseObject

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 ResponseObject

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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