Enum Include 

#[non_exhaustive]
pub enum Include {
    WebSearchCall,
    CodeInterpreterCall,
    ImageUrlInComputerCallOutput,
    FileSearchCall,
    ImageUrlInInputMessages,
    LogprobsInOutput,
    ReasoningEncryptedContent,
}

Specifies additional data to include in the response output

This enum defines various types of additional information that can be included in the API response output, such as web search results, code interpreter outputs, image URLs, and other metadata.

API Reference

Corresponds to the include parameter in the OpenAI Responses API: https://platform.openai.com/docs/api-reference/responses/create

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

WebSearchCall

Include web search call results in the output

When included, the response will contain information about web search results that were used during the response generation process.

CodeInterpreterCall

Include code interpreter call outputs in the output

When included, the response will contain outputs from any code that was executed during the response generation process.

ImageUrlInComputerCallOutput

Include computer call output image URLs in the output

When included, the response will contain image URLs from any computer interaction calls that were made.

FileSearchCall

Include file search call results in the output

When included, the response will contain results from any file search operations that were performed.

ImageUrlInInputMessages

Include image URLs from input messages in the output

When included, the response will contain image URLs that were present in the input messages.

LogprobsInOutput

Include log probabilities in the output

When included, the response will contain log probability information for the generated text tokens.

ReasoningEncryptedContent

Include reasoning encrypted content in the output

When included, the response will contain encrypted reasoning content that shows the model’s internal reasoning process.

Trait Implementations

impl Clone for Include

fn clone(&self) -> Include

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Include

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

Formats the value using the given formatter.

impl Display for Include

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

Formats the value using the given formatter.

impl FromStr for Include

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Include, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Include

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Include

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 Include

impl TryFrom<&str> for Include

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Include, <Self as TryFrom<&str>>::Error>

Performs the conversion.