Enum Includable

pub enum Includable {
    CodeInterpreterCallOutputs,
    ComputerCallOutputOutputImageUrl,
    FileSearchCallResults,
    MessageInputImageImageUrl,
    MessageOutputTextLogprobs,
    ReasoningEncryptedContent,
}

Specify additional output data to include in the model response. Currently supported values are:

• code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
• computer_call_output.output.image_url: Include image urls from the computer call output.
• file_search_call.results: Include the search results of the file search tool call.
• message.input_image.image_url: Include image urls from the input message.
• message.output_text.logprobs: Include logprobs with assistant messages.
• reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).

Variants

CodeInterpreterCallOutputs

code_interpreter_call.outputs

ComputerCallOutputOutputImageUrl

computer_call_output.output.image_url

FileSearchCallResults

file_search_call.results

MessageInputImageImageUrl

message.input_image.image_url

MessageOutputTextLogprobs

message.output_text.logprobs

ReasoningEncryptedContent

reasoning.encrypted_content

Trait Implementations

impl Clone for Includable

fn clone(&self) -> Includable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Includable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Includable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Includable

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

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

const 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 Includable

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Includable

impl StructuralPartialEq for Includable