Struct CompactResponseRequest 

pub struct CompactResponseRequest {
    pub model: String,
    pub input: Option<InputParam>,
    pub previous_response_id: Option<String>,
    pub instructions: Option<String>,
    pub prompt_cache_key: Option<String>,
    pub prompt_cache_retention: Option<PromptCacheRetention>,
}

Available on crate feature response-types only.

Request to compact a conversation.

Fields

model: String

Model ID used to generate the response, like gpt-5 or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

input: Option<InputParam>

Text, image, or file inputs to the model, used to generate a response

previous_response_id: Option<String>

The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state. Cannot be used in conjunction with conversation.

instructions: Option<String>

A system (or developer) message inserted into the model’s context.

When used along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

prompt_cache_key: Option<String>

A key to use when reading from or writing to the prompt cache.

prompt_cache_retention: Option<PromptCacheRetention>

How long to retain a prompt cache entry created by this request.

Trait Implementations

impl Clone for CompactResponseRequest

fn clone(&self) -> CompactResponseRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompactResponseRequest

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

Formats the value using the given formatter.

impl Default for CompactResponseRequest

fn default() -> CompactResponseRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CompactResponseRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompactResponseRequest

fn eq(&self, other: &CompactResponseRequest) -> 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 CompactResponseRequest

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 CompactResponseRequest