1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
//! OpenAI Responses API client implementation.
use super::config::{OpenAIResponsesConfig, ReasoningEffort, ReasoningSummary};
use super::responses_convert;
use crate::retry::{RetryConfig, execute_with_retry, is_retryable_model_error};
use adk_core::{
AdkError, Content, ErrorCategory, ErrorComponent, Llm, LlmRequest, LlmResponse,
LlmResponseStream, Part,
};
use async_stream::try_stream;
use async_trait::async_trait;
use futures::StreamExt;
/// Client for the OpenAI Responses API (`/responses` endpoint).
///
/// Wraps `async-openai`'s typed `Responses` client and implements `adk_core::Llm`.
/// Supports reasoning summaries, conversation state via `previous_response_id`,
/// and built-in tools (web search, file search, code interpreter).
///
/// # Example
///
/// ```rust,ignore
/// use adk_model::openai::{OpenAIResponsesClient, OpenAIResponsesConfig};
///
/// let config = OpenAIResponsesConfig::new("sk-...", "o3");
/// let client = OpenAIResponsesClient::new(config)?;
/// ```
pub struct OpenAIResponsesClient {
client: async_openai::Client<async_openai::config::OpenAIConfig>,
model: String,
reasoning_effort: Option<ReasoningEffort>,
reasoning_summary: Option<ReasoningSummary>,
retry_config: RetryConfig,
/// HTTP client for direct API calls (compaction, polling, etc.).
http: reqwest::Client,
/// API key for direct HTTP requests.
api_key: String,
/// Base URL for the API (defaults to `https://api.openai.com/v1`).
base_url: String,
/// Whether Open Responses mode is enabled for third-party compatibility.
///
/// When `true`, relaxes strict OpenAI field validation and allows
/// connecting to Open Responses-compatible endpoints without an OpenAI API key.
open_responses_mode: bool,
}
impl OpenAIResponsesClient {
/// Create a new Responses API client from the given config.
///
/// # Errors
///
/// Returns `AdkError` with `InvalidInput` if `api_key` is empty and
/// Open Responses mode is not enabled with a custom base URL.
pub fn new(config: OpenAIResponsesConfig) -> Result<Self, AdkError> {
let open_responses_mode = config.open_responses_mode.unwrap_or(false);
// In Open Responses mode with a custom base URL, allow empty API keys
// since third-party providers (LM Studio, Ollama, vLLM) may not require
// OpenAI-specific authentication.
let has_custom_base_url = config.base_url.is_some();
if config.api_key.is_empty() && !(open_responses_mode && has_custom_base_url) {
return Err(AdkError::new(
ErrorComponent::Model,
ErrorCategory::InvalidInput,
"model.openai_responses.invalid_config",
"OpenAI Responses API key must not be empty",
)
.with_provider("openai-responses"));
}
// Use a placeholder API key for Open Responses mode when no key is provided.
// This satisfies the async-openai client requirement for a non-empty key
// while the actual endpoint may not validate it.
let effective_api_key = if config.api_key.is_empty() && open_responses_mode {
"open-responses-no-key".to_string()
} else {
config.api_key.clone()
};
let mut openai_config =
async_openai::config::OpenAIConfig::new().with_api_key(&effective_api_key);
if let Some(org_id) = &config.organization_id {
openai_config = openai_config.with_org_id(org_id);
}
if let Some(base_url) = &config.base_url {
openai_config = openai_config.with_api_base(base_url);
}
let client = async_openai::Client::with_config(openai_config);
let base_url =
config.base_url.clone().unwrap_or_else(|| "https://api.openai.com/v1".to_string());
Ok(Self {
client,
model: config.model,
reasoning_effort: config.reasoning_effort,
reasoning_summary: config.reasoning_summary,
retry_config: RetryConfig::default(),
http: reqwest::Client::new(),
api_key: config.api_key,
base_url,
open_responses_mode,
})
}
/// Set the retry configuration, consuming self.
#[must_use]
pub fn with_retry_config(mut self, retry_config: RetryConfig) -> Self {
self.retry_config = retry_config;
self
}
/// Set the retry configuration by mutable reference.
pub fn set_retry_config(&mut self, retry_config: RetryConfig) {
self.retry_config = retry_config;
}
/// Get a reference to the current retry configuration.
pub fn retry_config(&self) -> &RetryConfig {
&self.retry_config
}
/// Get a reference to the underlying async-openai client.
pub(crate) fn openai_client(
&self,
) -> &async_openai::Client<async_openai::config::OpenAIConfig> {
&self.client
}
/// Get the HTTP client for direct API calls.
pub(crate) fn http_client(&self) -> &reqwest::Client {
&self.http
}
/// Get the API key.
pub(crate) fn api_key(&self) -> &str {
&self.api_key
}
/// Get the base URL.
pub(crate) fn base_url(&self) -> &str {
&self.base_url
}
/// Whether Open Responses mode is enabled.
///
/// When `true`, the client relaxes strict OpenAI field validation for
/// compatibility with third-party Open Responses-compatible endpoints.
pub fn is_open_responses_mode(&self) -> bool {
self.open_responses_mode
}
}
/// Map an `async_openai::error::OpenAIError` to an `AdkError`.
pub(super) fn map_openai_error(e: async_openai::error::OpenAIError) -> AdkError {
let error_string = e.to_string();
if let async_openai::error::OpenAIError::ApiError(ref api_err) = e {
// Try to extract status code from the error code or message
let (category, code, status) = if api_err.code.as_deref().is_some_and(|c| c.contains("401"))
|| error_string.contains("401")
{
(ErrorCategory::Unauthorized, "model.openai_responses.unauthorized", Some(401u16))
} else if api_err.code.as_deref().is_some_and(|c| c.contains("429"))
|| error_string.contains("429")
|| error_string.contains("rate")
{
(ErrorCategory::RateLimited, "model.openai_responses.rate_limited", Some(429u16))
} else if error_string.contains("500")
|| error_string.contains("502")
|| error_string.contains("503")
|| error_string.contains("504")
|| error_string.contains("529")
{
(ErrorCategory::Unavailable, "model.openai_responses.unavailable", None)
} else {
(ErrorCategory::Internal, "model.openai_responses.api_error", None)
};
let mut err = AdkError::new(
ErrorComponent::Model,
category,
code,
format!("OpenAI Responses API error: {api_err}"),
)
.with_provider("openai-responses");
if let Some(sc) = status {
err = err.with_upstream_status(sc);
}
return err;
}
// Reqwest / network errors → Unavailable (retryable)
if let async_openai::error::OpenAIError::Reqwest(_) = e {
return AdkError::new(
ErrorComponent::Model,
ErrorCategory::Unavailable,
"model.openai_responses.request",
format!("OpenAI Responses API network error: {error_string}"),
)
.with_provider("openai-responses");
}
// Stream errors → Unavailable
if let async_openai::error::OpenAIError::StreamError(_) = e {
return AdkError::new(
ErrorComponent::Model,
ErrorCategory::Unavailable,
"model.openai_responses.stream",
format!("OpenAI Responses API stream error: {error_string}"),
)
.with_provider("openai-responses");
}
// JSON deserialization → Internal
if let async_openai::error::OpenAIError::JSONDeserialize(_, _) = e {
return AdkError::new(
ErrorComponent::Model,
ErrorCategory::Internal,
"model.openai_responses.parse",
format!("OpenAI Responses API parse error: {error_string}"),
)
.with_provider("openai-responses");
}
// Fallback
AdkError::new(
ErrorComponent::Model,
ErrorCategory::Internal,
"model.openai_responses.unknown",
format!("OpenAI Responses API error: {error_string}"),
)
.with_provider("openai-responses")
}
#[async_trait]
impl Llm for OpenAIResponsesClient {
fn name(&self) -> &str {
&self.model
}
async fn generate_content(
&self,
request: LlmRequest,
stream: bool,
) -> Result<LlmResponseStream, AdkError> {
let usage_span = adk_telemetry::llm_generate_span("openai-responses", &self.model, stream);
let create_request = responses_convert::build_create_response(
&self.model,
&request,
self.reasoning_effort,
self.reasoning_summary,
)?;
let uses_native_tools = responses_convert::request_uses_native_tools(&request);
if stream && !uses_native_tools {
// Explicitly set stream=true — async-openai's create_stream() does NOT
// set this field automatically, causing the server to return JSON instead
// of text/event-stream, which triggers an InvalidContentType error.
let mut create_request = create_request;
create_request.stream = Some(true);
let event_stream = self
.client
.responses()
.create_stream(create_request)
.await
.map_err(map_openai_error)?;
let response_stream = event_stream.filter_map(|event_result| async {
match event_result {
Ok(event) => {
use async_openai::types::responses::ResponseStreamEvent;
match event {
ResponseStreamEvent::ResponseOutputTextDelta(evt) => {
Some(Ok(LlmResponse {
content: Some(Content {
role: "model".to_string(),
parts: vec![Part::Text { text: evt.delta }],
}),
partial: true,
turn_complete: false,
..Default::default()
}))
}
ResponseStreamEvent::ResponseReasoningSummaryTextDelta(evt) => {
Some(Ok(LlmResponse {
content: Some(Content {
role: "model".to_string(),
parts: vec![Part::Thinking {
thinking: evt.delta,
signature: None,
}],
}),
partial: true,
turn_complete: false,
..Default::default()
}))
}
// ResponseCompleted carries the authoritative response with
// correct function call names, usage, and finish reason.
// We extract only function calls (text was already streamed
// via delta events) and mark the turn complete.
ResponseStreamEvent::ResponseCompleted(evt) => {
let full = responses_convert::from_response(&evt.response);
// Extract only non-textual protocol parts (text/thinking were already
// streamed via delta events, but tool protocol items need to survive).
let trailing_parts: Vec<Part> = full
.content
.as_ref()
.map(|c| {
c.parts
.iter()
.filter(|part| {
!matches!(
part,
Part::Text { .. } | Part::Thinking { .. }
)
})
.cloned()
.collect()
})
.unwrap_or_default();
let content = if trailing_parts.is_empty() {
None
} else {
Some(Content {
role: "model".to_string(),
parts: trailing_parts,
})
};
Some(Ok(LlmResponse {
content,
usage_metadata: full.usage_metadata,
finish_reason: full.finish_reason,
provider_metadata: full.provider_metadata,
partial: false,
turn_complete: true,
..Default::default()
}))
}
ResponseStreamEvent::ResponseFailed(evt) => {
let (error_code, error_message) =
if let Some(err) = &evt.response.error {
(Some(err.code.clone()), Some(err.message.clone()))
} else {
(
Some("unknown".to_string()),
Some("Response failed".to_string()),
)
};
Some(Ok(LlmResponse {
error_code,
error_message,
turn_complete: true,
..Default::default()
}))
}
ResponseStreamEvent::ResponseError(evt) => Some(Ok(LlmResponse {
error_code: evt.code.or_else(|| Some("error".to_string())),
error_message: Some(evt.message),
turn_complete: true,
..Default::default()
})),
// Skip all other events
_ => None,
}
}
Err(e) => Some(Err(map_openai_error(e))),
}
});
Ok(crate::usage_tracking::with_usage_tracking(Box::pin(response_stream), usage_span))
} else {
if stream && uses_native_tools {
adk_telemetry::debug!(
"OpenAI native tools detected; using non-streaming responses path to avoid upstream SSE item parsing drift"
);
}
// Non-streaming path
let client = self.client.clone();
let retry_config = self.retry_config.clone();
let response_stream = try_stream! {
let response = execute_with_retry(
&retry_config,
is_retryable_model_error,
|| {
let client = client.clone();
let req = create_request.clone();
async move {
client
.responses()
.create(req)
.await
.map_err(map_openai_error)
}
},
)
.await?;
let mut adk_response = responses_convert::from_response(&response);
adk_response.turn_complete = true;
adk_response.partial = false;
yield adk_response;
};
Ok(crate::usage_tracking::with_usage_tracking(Box::pin(response_stream), usage_span))
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::openai::config::OpenAIResponsesConfig;
#[test]
fn test_new_rejects_empty_api_key_without_open_responses_mode() {
let config = OpenAIResponsesConfig::new("", "gpt-4o");
let result = OpenAIResponsesClient::new(config);
match result {
Err(err) => assert_eq!(err.code, "model.openai_responses.invalid_config"),
Ok(_) => panic!("expected error for empty API key"),
}
}
#[test]
fn test_new_rejects_empty_api_key_with_open_responses_mode_but_no_base_url() {
// Open Responses mode alone is not enough — a custom base URL is also required
let config = OpenAIResponsesConfig::new("", "local-model").with_open_responses_mode(true);
let result = OpenAIResponsesClient::new(config);
match result {
Err(err) => assert_eq!(err.code, "model.openai_responses.invalid_config"),
Ok(_) => panic!("expected error for empty API key without base URL"),
}
}
#[test]
fn test_new_allows_empty_api_key_with_open_responses_mode_and_base_url() {
// Open Responses mode + custom base URL should allow empty API key
let config = OpenAIResponsesConfig::new("", "local-model")
.with_open_responses_mode(true)
.with_base_url("http://localhost:1234/v1");
let result = OpenAIResponsesClient::new(config);
assert!(result.is_ok());
}
#[test]
fn test_open_responses_mode_stored_on_client() {
let config = OpenAIResponsesConfig::new("", "local-model")
.with_open_responses_mode(true)
.with_base_url("http://localhost:1234/v1");
let client = OpenAIResponsesClient::new(config).unwrap();
assert!(client.is_open_responses_mode());
assert_eq!(client.base_url(), "http://localhost:1234/v1");
}
#[test]
fn test_new_with_api_key_and_open_responses_mode() {
// Even with Open Responses mode, providing an API key should work fine
let config = OpenAIResponsesConfig::new("sk-test", "local-model")
.with_open_responses_mode(true)
.with_base_url("http://localhost:1234/v1");
let client = OpenAIResponsesClient::new(config).unwrap();
assert!(client.is_open_responses_mode());
assert_eq!(client.api_key(), "sk-test");
}
#[test]
fn test_new_without_open_responses_mode_stores_false() {
let config = OpenAIResponsesConfig::new("sk-test", "gpt-4o");
let client = OpenAIResponsesClient::new(config).unwrap();
assert!(!client.is_open_responses_mode());
}
#[test]
fn test_custom_base_url_without_open_responses_mode_still_requires_api_key() {
// Custom base URL alone doesn't bypass the API key requirement
let config =
OpenAIResponsesConfig::new("", "local-model").with_base_url("http://localhost:1234/v1");
let result = OpenAIResponsesClient::new(config);
assert!(result.is_err());
}
#[test]
fn test_custom_base_url_with_api_key_works_without_open_responses_mode() {
let config = OpenAIResponsesConfig::new("sk-test", "local-model")
.with_base_url("http://localhost:1234/v1");
let client = OpenAIResponsesClient::new(config).unwrap();
assert!(!client.is_open_responses_mode());
assert_eq!(client.base_url(), "http://localhost:1234/v1");
}
}