Struct OpenAIReasoningConfig 

pub struct OpenAIReasoningConfig { /* private fields */ }

Exact OpenAI reasoning and closely related response controls.

Every field is optional. Self::new therefore preserves the model’s server-side defaults until a builder is called.

Implementations

impl OpenAIReasoningConfig

pub const fn new() -> Self

Create a config that preserves every model/API default.

pub const fn with_effort(self, effort: OpenAIReasoningEffort) -> Self

Set the exact reasoning effort.

pub const fn with_mode(self, mode: OpenAIReasoningMode) -> Self

Set the GPT-5.6 reasoning execution mode.

pub const fn with_context(self, context: OpenAIReasoningContext) -> Self

Select which persisted reasoning context the Responses API may reuse.

pub const fn with_summary(self, summary: OpenAIReasoningSummary) -> Self

Request a user-visible reasoning summary.

pub const fn with_verbosity(self, verbosity: OpenAITextVerbosity) -> Self

Set final-answer verbosity.

pub const fn with_api_surface(self, api_surface: OpenAIApiSurface) -> Self

Select the API surface used by the general OpenAI provider.

pub const fn with_prompt_cache_mode( self, prompt_cache_mode: OpenAIPromptCacheMode, ) -> Self

Select implicit or explicit prompt-cache breakpoint creation.

pub const fn with_prompt_cache_ttl( self, prompt_cache_ttl: OpenAIPromptCacheTtl, ) -> Self

Set GPT-5.6’s exact prompt-cache retention window.

pub const fn with_store(self, store: bool) -> Self

Select whether OpenAI stores the response as application state.

pub const fn with_parallel_tool_calls(self, enabled: bool) -> Self

Enable or disable parallel function calls.

pub fn with_tool_choice(self, tool_choice: OpenAIToolChoice) -> Self

Set the complete OpenAI function-tool choice policy.

pub fn with_safety_identifier( self, safety_identifier: impl Into<String>, ) -> Self

Set a stable, privacy-preserving identifier for end-user safety controls.

pub const fn effort(&self) -> Option<OpenAIReasoningEffort>

Configured exact reasoning effort, if any.

pub const fn mode(&self) -> Option<OpenAIReasoningMode>

Configured reasoning execution mode, if any.

pub const fn context(&self) -> Option<OpenAIReasoningContext>

Configured persisted-reasoning context policy, if any.

pub const fn summary(&self) -> Option<OpenAIReasoningSummary>

Configured reasoning summary detail, if any.

pub const fn verbosity(&self) -> Option<OpenAITextVerbosity>

Configured final-answer verbosity, if any.

pub const fn api_surface(&self) -> OpenAIApiSurface

Selected API surface.

pub const fn prompt_cache_mode(&self) -> Option<OpenAIPromptCacheMode>

Configured prompt-cache mode, if any.

pub const fn prompt_cache_ttl(&self) -> Option<OpenAIPromptCacheTtl>

Configured exact prompt-cache TTL, if any.

pub const fn store(&self) -> Option<bool>

Explicit response-storage preference, if configured.

pub const fn parallel_tool_calls(&self) -> Option<bool>

Explicit parallel-tool preference, if configured.

pub const fn tool_choice(&self) -> Option<&OpenAIToolChoice>

Provider-owned tool-choice policy, if configured.

pub fn safety_identifier(&self) -> Option<&str>

Stable safety identifier, if configured.

pub const fn requires_responses_api(&self) -> bool

Whether this config uses controls that only the Responses API accepts.

Trait Implementations

impl Clone for OpenAIReasoningConfig

fn clone(&self) -> OpenAIReasoningConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIReasoningConfig

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

Formats the value using the given formatter.

impl Default for OpenAIReasoningConfig

fn default() -> OpenAIReasoningConfig

Returns the “default value” for a type.

impl Eq for OpenAIReasoningConfig

impl PartialEq for OpenAIReasoningConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OpenAIReasoningConfig