Struct Reasoning 

pub struct Reasoning {
    pub effort: Option<ReasoningEffort>,
    pub summary: Option<ReasoningSummaryLevel>,
    pub mode: Option<ReasoningMode>,
    pub context: Option<ReasoningContext>,
}

Add reasoning to a CompletionRequest.

Example

use rig_core::providers::openai::responses_api::{
    Reasoning, ReasoningContext, ReasoningEffort, ReasoningMode,
};

// GPT-5.6 reasoning controls: effort, pro mode, and persisted-reasoning context.
let reasoning = Reasoning::new()
    .with_effort(ReasoningEffort::Max)
    .with_mode(ReasoningMode::Pro)
    .with_context(ReasoningContext::AllTurns);

Fields

effort: Option<ReasoningEffort>

How much effort you want the model to put into thinking/reasoning.

summary: Option<ReasoningSummaryLevel>

How much effort you want the model to put into writing the reasoning summary.

mode: Option<ReasoningMode>

The reasoning mode. Independent from effort; the standard mode is represented by omitting the field. Supported by the GPT-5.6 model family.

context: Option<ReasoningContext>

How persisted reasoning is carried across turns. Supported by the GPT-5.6 model family.

Implementations

impl Reasoning

pub fn new() -> Self

Creates a new Reasoning instantiation (with empty values).

pub fn with_effort(self, reasoning_effort: ReasoningEffort) -> Self

Adds reasoning effort.

pub fn with_summary_level( self, reasoning_summary_level: ReasoningSummaryLevel, ) -> Self

Adds summary level (how detailed the reasoning summary will be).

pub fn with_mode(self, reasoning_mode: ReasoningMode) -> Self

Sets the reasoning mode (e.g. pro mode on GPT-5.6 models).

pub fn with_context(self, reasoning_context: ReasoningContext) -> Self

Sets how persisted reasoning is carried across turns (GPT-5.6 models).

Trait Implementations

impl Clone for Reasoning

fn clone(&self) -> Reasoning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reasoning

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

Formats the value using the given formatter.

impl Default for Reasoning

fn default() -> Reasoning

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Reasoning

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Reasoning

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

where __S: Serializer,

Serialize this value into the given Serde serializer.