Struct OpenAIResponsesConfig 

pub struct OpenAIResponsesConfig {
    pub api_key: String,
    pub model: String,
    pub organization_id: Option<String>,
    pub project_id: Option<String>,
    pub base_url: Option<String>,
    pub reasoning_effort: Option<ReasoningEffort>,
    pub reasoning_summary: Option<ReasoningSummary>,
    pub transport: Option<ResponsesTransport>,
    pub service_tier: Option<ServiceTier>,
    pub prompt_cache_retention: Option<PromptCacheRetention>,
    pub open_responses_mode: Option<bool>,
}

Available on crate features models and openai only.

Configuration for the OpenAI Responses API client.

Example

use adk_model::openai::{OpenAIResponsesConfig, ReasoningEffort, ReasoningSummary};

let config = OpenAIResponsesConfig::new("sk-...", "o3")
    .with_reasoning_effort(ReasoningEffort::High)
    .with_reasoning_summary(ReasoningSummary::Concise);

Fields

api_key: String

OpenAI API key.

model: String

Model name (e.g., “o3”, “o4-mini”, “gpt-4.1”).

organization_id: Option<String>

Optional organization ID.

project_id: Option<String>

Optional project ID.

base_url: Option<String>

Optional custom base URL.

reasoning_effort: Option<ReasoningEffort>

Reasoning effort for o-series models.

reasoning_summary: Option<ReasoningSummary>

Reasoning summary mode for o-series models.

transport: Option<ResponsesTransport>

Transport mode (HTTP or WebSocket).

service_tier: Option<ServiceTier>

Default service tier for processing priority.

prompt_cache_retention: Option<PromptCacheRetention>

Default prompt cache retention policy.

open_responses_mode: Option<bool>

Enable Open Responses mode for third-party compatibility.

When enabled, relaxes strict OpenAI field validation to support Open Responses-compatible endpoints (LM Studio, Ollama, vLLM).

Implementations

impl OpenAIResponsesConfig

pub fn new( api_key: impl Into<String>, model: impl Into<String>, ) -> OpenAIResponsesConfig

Create a new Responses API config with the given API key and model.

pub fn with_organization( self, org_id: impl Into<String>, ) -> OpenAIResponsesConfig

Set the organization ID.

pub fn with_project( self, project_id: impl Into<String>, ) -> OpenAIResponsesConfig

Set the project ID.

pub fn with_base_url(self, base_url: impl Into<String>) -> OpenAIResponsesConfig

Set the base URL.

pub fn with_reasoning_effort( self, effort: ReasoningEffort, ) -> OpenAIResponsesConfig

Set the reasoning effort for o-series models.

pub fn with_reasoning_summary( self, summary: ReasoningSummary, ) -> OpenAIResponsesConfig

Set the reasoning summary mode for o-series models.

pub fn with_transport( self, transport: ResponsesTransport, ) -> OpenAIResponsesConfig

Set the transport mode (HTTP or WebSocket).

Defaults to HTTP when not set. WebSocket requires the openai-ws feature.

pub fn with_service_tier(self, tier: ServiceTier) -> OpenAIResponsesConfig

Set the default service tier for processing priority.

Priority tier provides lower latency and more consistent token generation.

pub fn with_prompt_cache_retention( self, retention: PromptCacheRetention, ) -> OpenAIResponsesConfig

Set the default prompt cache retention policy.

Controls how long prompt prefixes are cached for cost optimization.

pub fn with_open_responses_mode(self, enabled: bool) -> OpenAIResponsesConfig

Enable or disable Open Responses mode.

When enabled, relaxes strict OpenAI field validation for compatibility with third-party Open Responses-compatible endpoints.

Trait Implementations

impl Clone for OpenAIResponsesConfig

fn clone(&self) -> OpenAIResponsesConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIResponsesConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenAIResponsesConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<OpenAIResponsesConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenAIResponsesConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.