Struct ResponseMetadata

#[non_exhaustive]
pub struct ResponseMetadata {

    pub id: String,
    pub object: Option<String>,
    pub created_at: u64,
    pub status: Status,
    pub model: Option<String>,
    pub usage: Option<Usage>,
    pub error: Option<ErrorObject>,
    pub incomplete_details: Option<IncompleteDetails>,
    pub input: Option<Input>,
    pub instructions: Option<String>,
    pub max_output_tokens: Option<u32>,
    pub background: Option<bool>,
    pub service_tier: Option<ServiceTier>,
    pub top_logprobs: Option<u32>,
    pub max_tool_calls: Option<u32>,
    pub output: Option<Vec<OutputItem>>,
    pub parallel_tool_calls: Option<bool>,
    pub previous_response_id: Option<String>,
    pub reasoning: Option<ReasoningConfig>,
    pub store: Option<bool>,
    pub temperature: Option<f32>,
    pub text: Option<TextConfig>,
    pub tool_choice: Option<ToolChoice>,
    pub tools: Option<Vec<ToolDefinition>>,
    pub top_p: Option<f32>,
    pub truncation: Option<Truncation>,
    pub user: Option<String>,
    pub metadata: Option<HashMap<String, String>>,
    pub prompt_cache_key: Option<String>,
    pub safety_identifier: Option<String>,
}

Response metadata

Fields (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

object: Option<String>

created_at: u64

status: Status

model: Option<String>

usage: Option<Usage>

error: Option<ErrorObject>

incomplete_details: Option<IncompleteDetails>

input: Option<Input>

instructions: Option<String>

max_output_tokens: Option<u32>

background: Option<bool>

Whether the model was run in background mode

service_tier: Option<ServiceTier>

The service tier that was actually used

top_logprobs: Option<u32>

The effective value of top_logprobs parameter

max_tool_calls: Option<u32>

The effective value of max_tool_calls parameter

output: Option<Vec<OutputItem>>

parallel_tool_calls: Option<bool>

previous_response_id: Option<String>

reasoning: Option<ReasoningConfig>

store: Option<bool>

temperature: Option<f32>

text: Option<TextConfig>

tool_choice: Option<ToolChoice>

tools: Option<Vec<ToolDefinition>>

top_p: Option<f32>

truncation: Option<Truncation>

user: Option<String>

metadata: Option<HashMap<String, String>>

prompt_cache_key: Option<String>

Prompt cache key for improved performance

safety_identifier: Option<String>

Safety identifier for content filtering

Trait Implementations

impl Clone for ResponseMetadata

fn clone(&self) -> ResponseMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponseMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ResponseMetadata

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 ResponseMetadata