1#[doc(hidden)]
32pub mod convert;
33pub mod embeddings;
34
35pub mod responses;
36pub use embeddings::OpenAIEmbeddingClient;
37pub use responses::OpenAIChatClient;
38
39use std::collections::{HashMap, VecDeque};
40use std::sync::Arc;
41
42use agent_framework_core::client::{ChatClient, ChatStream};
43use agent_framework_core::error::{ContentFilterCategory, ContentFilterDetail, Error, Result};
44use agent_framework_core::streaming::Utf8StreamDecoder;
45use agent_framework_core::types::{
46 ChatOptions, ChatResponse, ChatResponseUpdate, Content, FinishReason, FunctionArguments,
47 FunctionCallContent, Message, Role, TextContent, UsageContent,
48};
49use futures::StreamExt;
50use serde_json::{json, Map, Value};
51
52pub(crate) const DEFAULT_BASE_URL: &str = "https://api.openai.com/v1";
53
54pub(crate) fn parse_retry_after(headers: &reqwest::header::HeaderMap) -> Option<f64> {
62 headers
63 .get(reqwest::header::RETRY_AFTER)
64 .and_then(|v| v.to_str().ok())
65 .and_then(|s| s.trim().parse::<f64>().ok())
66 .filter(|s| s.is_finite() && *s >= 0.0)
67}
68
69pub fn classify_service_error(
109 status: u16,
110 body: &str,
111 message: impl Into<String>,
112 retry_after: Option<f64>,
113) -> Error {
114 let message = message.into();
115 match status {
116 401 | 403 => Error::service_invalid_auth(message),
117 400 | 404 | 422 => {
118 if body_signals_content_filter(body) {
119 match parse_content_filter_detail(body) {
120 Some(detail) => Error::service_content_filter_with_detail(message, detail),
121 None => Error::service_content_filter(message),
122 }
123 } else {
124 Error::service_invalid_request(message)
125 }
126 }
127 _ => Error::service_status(status, message, retry_after),
128 }
129}
130
131fn body_signals_content_filter(body: &str) -> bool {
142 let Ok(value) = serde_json::from_str::<Value>(body) else {
143 return false;
144 };
145 let error = value.get("error").unwrap_or(&value);
146 is_content_filter_marker(error)
147 || error
148 .get("innererror")
149 .is_some_and(is_content_filter_marker)
150}
151
152fn parse_content_filter_detail(body: &str) -> Option<ContentFilterDetail> {
168 let value = serde_json::from_str::<Value>(body).ok()?;
169 let error = value.get("error").unwrap_or(&value);
170 let inner = error.get("innererror");
171
172 let code = inner
173 .and_then(|i| i.get("code"))
174 .or_else(|| inner.and_then(|i| i.get("type")))
175 .and_then(Value::as_str)
176 .filter(|c| *c != CONTENT_FILTER_MARKER)
179 .map(String::from);
180 let param = error
181 .get("param")
182 .and_then(Value::as_str)
183 .filter(|p| !p.is_empty())
184 .map(String::from);
185
186 let mut categories = std::collections::BTreeMap::new();
187 let results = inner
188 .and_then(|i| i.get("content_filter_result"))
189 .or_else(|| error.get("content_filter_result"))
190 .and_then(Value::as_object);
191 if let Some(results) = results {
192 for (name, verdict) in results {
193 let Some(verdict) = verdict.as_object() else {
194 continue;
195 };
196 categories.insert(
197 name.clone(),
198 ContentFilterCategory {
199 filtered: verdict
200 .get("filtered")
201 .and_then(Value::as_bool)
202 .unwrap_or(false),
203 detected: verdict.get("detected").and_then(Value::as_bool),
204 severity: verdict
205 .get("severity")
206 .and_then(Value::as_str)
207 .map(String::from),
208 },
209 );
210 }
211 }
212
213 if code.is_none() && param.is_none() && categories.is_empty() {
214 return None;
215 }
216 Some(ContentFilterDetail {
217 code,
218 param,
219 categories,
220 })
221}
222
223const CONTENT_FILTER_MARKER: &str = "content_filter";
226
227fn is_content_filter_marker(v: &Value) -> bool {
228 v.get("code").and_then(Value::as_str) == Some(CONTENT_FILTER_MARKER)
229 || v.get("type").and_then(Value::as_str) == Some(CONTENT_FILTER_MARKER)
230}
231
232#[derive(Clone)]
234pub struct OpenAIChatCompletionClient {
235 inner: Arc<Inner>,
236}
237
238#[derive(Clone)]
239struct Inner {
240 http: reqwest::Client,
241 api_key: String,
242 base_url: String,
243 model: String,
244 organization: Option<String>,
245}
246
247impl OpenAIChatCompletionClient {
248 pub fn new(api_key: impl Into<String>, model: impl Into<String>) -> Self {
250 Self {
251 inner: Arc::new(Inner {
252 http: reqwest::Client::new(),
253 api_key: api_key.into(),
254 base_url: DEFAULT_BASE_URL.to_string(),
255 model: model.into(),
256 organization: None,
257 }),
258 }
259 }
260
261 pub fn from_env(model: impl Into<String>) -> Result<Self> {
264 let key = std::env::var("OPENAI_API_KEY")
265 .map_err(|_| Error::Configuration("OPENAI_API_KEY is not set".into()))?;
266 let mut client = Self::new(key, model);
267 if let Ok(base) = std::env::var("OPENAI_BASE_URL") {
268 client = client.with_base_url(base);
269 }
270 Ok(client)
271 }
272
273 pub fn with_base_url(mut self, base_url: impl Into<String>) -> Self {
275 Arc::make_mut(&mut self.inner).base_url = base_url.into();
276 self
277 }
278
279 pub fn with_organization(mut self, org: impl Into<String>) -> Self {
281 Arc::make_mut(&mut self.inner).organization = Some(org.into());
282 self
283 }
284
285 fn build_body(&self, messages: &[Message], options: &ChatOptions, stream: bool) -> Value {
286 let mut body = Map::new();
287 let model = options
288 .model
289 .clone()
290 .unwrap_or_else(|| self.inner.model.clone());
291 body.insert("model".into(), json!(model));
292 body.insert(
293 "messages".into(),
294 json!(convert::messages_to_openai(messages)),
295 );
296 convert::apply_options(&mut body, options);
297 let (tools, tool_choice) = convert::tools_to_openai(options);
298 if let Some(tools) = tools {
299 body.insert("tools".into(), tools);
300 }
301 if let Some(choice) = tool_choice {
302 body.insert("tool_choice".into(), choice);
303 }
304 if stream {
305 body.insert("stream".into(), json!(true));
306 body.insert("stream_options".into(), json!({ "include_usage": true }));
307 }
308 Value::Object(body)
309 }
310
311 async fn post(&self, body: &Value) -> Result<reqwest::Response> {
312 let url = format!(
313 "{}/chat/completions",
314 self.inner.base_url.trim_end_matches('/')
315 );
316 let mut req = self
317 .inner
318 .http
319 .post(&url)
320 .bearer_auth(&self.inner.api_key)
321 .json(body);
322 if let Some(org) = &self.inner.organization {
323 req = req.header("OpenAI-Organization", org);
324 }
325 let resp = req
326 .send()
327 .await
328 .map_err(|e| Error::service(format!("request failed: {e}")))?;
329 if !resp.status().is_success() {
330 let status = resp.status();
331 let retry_after = parse_retry_after(resp.headers());
332 let text = resp.text().await.unwrap_or_default();
333 return Err(classify_service_error(
334 status.as_u16(),
335 &text,
336 format!("OpenAI API error {status}: {text}"),
337 retry_after,
338 ));
339 }
340 Ok(resp)
341 }
342
343 pub fn model(&self) -> &str {
345 &self.inner.model
346 }
347}
348
349#[async_trait::async_trait]
350impl ChatClient for OpenAIChatCompletionClient {
351 async fn get_response(
352 &self,
353 messages: Vec<Message>,
354 options: ChatOptions,
355 ) -> Result<ChatResponse> {
356 let body = self.build_body(&messages, &options, false);
357 let resp = self.post(&body).await?;
358 let value: Value = resp
359 .json()
360 .await
361 .map_err(|e| Error::service(format!("invalid response json: {e}")))?;
362 Ok(convert::parse_response(&value))
363 }
364
365 async fn get_streaming_response(
366 &self,
367 messages: Vec<Message>,
368 options: ChatOptions,
369 ) -> Result<ChatStream> {
370 let body = self.build_body(&messages, &options, true);
371 let resp = self.post(&body).await?;
372 Ok(parse_sse_stream(resp).boxed())
373 }
374
375 fn model(&self) -> Option<&str> {
376 Some(&self.inner.model)
377 }
378}
379
380type ByteStream =
381 std::pin::Pin<Box<dyn futures::Stream<Item = reqwest::Result<bytes::Bytes>> + Send>>;
382
383#[doc(hidden)]
388pub fn parse_sse_stream(
389 resp: reqwest::Response,
390) -> impl futures::Stream<Item = Result<ChatResponseUpdate>> + Send {
391 let byte_stream: ByteStream = Box::pin(resp.bytes_stream());
392 futures::stream::unfold(
396 SseState {
397 byte_stream,
398 buffer: String::new(),
399 utf8: Utf8StreamDecoder::new(),
400 queued: VecDeque::new(),
401 tool_ids: HashMap::new(),
402 done: false,
403 },
404 |mut state| async move {
405 loop {
406 if let Some(update) = state.queued.pop_front() {
407 return Some((Ok(update), state));
408 }
409 if state.done {
410 return None;
411 }
412 match state.byte_stream.next().await {
413 Some(Ok(bytes)) => {
414 let decoded = state.utf8.push(&bytes);
415 state.buffer.push_str(&decoded);
416 while let Some(pos) = state.buffer.find('\n') {
417 let line = state.buffer[..pos].trim().to_string();
418 state.buffer.drain(..=pos);
419 if let Some(data) = line.strip_prefix("data:") {
420 let data = data.trim();
421 if data == "[DONE]" {
422 return drain_or_end(state);
423 }
424 if let Ok(value) = serde_json::from_str::<Value>(data) {
425 if let Some(err) = value.get("error") {
429 let msg = err
430 .get("message")
431 .and_then(Value::as_str)
432 .unwrap_or("unknown stream error")
433 .to_string();
434 state.done = true;
435 return Some((Err(Error::service(msg)), state));
436 }
437 if let Some(update) = parse_delta(&value, &mut state.tool_ids) {
438 state.queued.push_back(update);
439 }
440 }
441 }
442 }
443 }
444 Some(Err(e)) => {
445 state.done = true;
446 return Some((Err(Error::service(format!("stream error: {e}"))), state));
447 }
448 None => return drain_or_end(state),
449 }
450 }
451 },
452 )
453}
454
455struct SseState {
457 byte_stream: ByteStream,
458 buffer: String,
459 utf8: Utf8StreamDecoder,
460 queued: VecDeque<ChatResponseUpdate>,
461 tool_ids: HashMap<i64, String>,
462 done: bool,
463}
464
465fn drain_or_end(mut state: SseState) -> Option<(Result<ChatResponseUpdate>, SseState)> {
466 match state.queued.pop_front() {
467 Some(update) => {
468 state.done = true;
469 Some((Ok(update), state))
470 }
471 None => None,
472 }
473}
474
475fn parse_delta(value: &Value, tool_ids: &mut HashMap<i64, String>) -> Option<ChatResponseUpdate> {
478 let mut update = ChatResponseUpdate {
479 response_id: value.get("id").and_then(Value::as_str).map(String::from),
480 model: value.get("model").and_then(Value::as_str).map(String::from),
481 ..Default::default()
482 };
483
484 let mut contents: Vec<Content> = Vec::new();
485
486 if let Some(choice) = value
487 .get("choices")
488 .and_then(|c| c.as_array())
489 .and_then(|a| a.first())
490 {
491 if let Some(delta) = choice.get("delta") {
492 if let Some(r) = delta.get("role").and_then(Value::as_str) {
493 update.role = Some(Role::new(r));
494 }
495 if let Some(text) = delta.get("content").and_then(Value::as_str) {
496 if !text.is_empty() {
497 contents.push(Content::Text(TextContent::new(text)));
498 }
499 }
500 if let Some(text) = delta.get("refusal").and_then(Value::as_str) {
507 if !text.is_empty() {
508 contents.push(Content::Text(TextContent::refusal(text)));
509 }
510 }
511 if let Some(reasoning) = crate::convert::parse_reasoning_details(delta) {
514 contents.push(reasoning);
515 }
516 if let Some(calls) = delta.get("tool_calls").and_then(Value::as_array) {
517 for call in calls {
518 let index = call.get("index").and_then(Value::as_i64).unwrap_or(0);
519 let chunk_id = call.get("id").and_then(Value::as_str).unwrap_or_default();
520 let id = if chunk_id.is_empty() {
523 tool_ids.get(&index).cloned().unwrap_or_default()
524 } else {
525 tool_ids.insert(index, chunk_id.to_string());
526 chunk_id.to_string()
527 };
528 let func = call.get("function");
529 let name = func
530 .and_then(|f| f.get("name"))
531 .and_then(Value::as_str)
532 .unwrap_or_default()
533 .to_string();
534 let args = func
535 .and_then(|f| f.get("arguments"))
536 .and_then(Value::as_str)
537 .unwrap_or_default()
538 .to_string();
539 contents.push(Content::FunctionCall(FunctionCallContent::new(
540 id,
541 name,
542 Some(FunctionArguments::Raw(args)),
543 )));
544 }
545 }
546 }
547 if let Some(fr) = choice.get("finish_reason").and_then(Value::as_str) {
548 update.finish_reason = Some(FinishReason::new(fr));
549 }
550 }
551
552 if let Some(usage) = value.get("usage").filter(|u| u.is_object()) {
556 contents.push(Content::Usage(UsageContent {
557 details: convert::parse_usage(usage),
558 }));
559 }
560
561 if update.role.is_none() {
562 update.role = Some(Role::assistant());
563 }
564 update.contents = contents;
565 Some(update)
566}
567
568#[cfg(test)]
569mod tests {
570 use super::*;
571
572 #[test]
579 fn a_streamed_reasoning_payload_survives_to_the_aggregated_response() {
580 let mut ids = HashMap::new();
584 let updates: Vec<_> = [
585 serde_json::json!({"choices": [{"delta": {"role": "assistant",
586 "reasoning_details": [{"type": "reasoning.text", "text": "think"}]}}]}),
587 serde_json::json!({"choices": [{"delta": {"content": "answer"}}]}),
588 ]
589 .iter()
590 .filter_map(|v| parse_delta(v, &mut ids))
591 .collect();
592 let resp = agent_framework_core::types::ChatResponse::from_updates(updates);
593 let wire = crate::convert::messages_to_openai(&resp.messages);
594 assert_eq!(
595 wire[0]["reasoning_details"],
596 serde_json::json!([{"type": "reasoning.text", "text": "think"}])
597 );
598 }
599
600 #[test]
601 fn a_streamed_chat_refusal_is_parsed_and_marked() {
602 let mut ids = HashMap::new();
605 let update = parse_delta(
606 &serde_json::json!({
607 "id": "chatcmpl-1",
608 "choices": [{ "delta": { "role": "assistant", "refusal": "I can't" } }],
609 }),
610 &mut ids,
611 )
612 .expect("a refusal delta must produce an update");
613 assert!(
614 matches!(&update.contents[0], Content::Text(t) if t.refusal && t.text == "I can't")
615 );
616
617 let mut ids = HashMap::new();
619 let updates: Vec<_> = [
620 serde_json::json!({"choices": [{"delta": {"content": "here: "}}]}),
621 serde_json::json!({"choices": [{"delta": {"refusal": "I can't "}}]}),
622 serde_json::json!({"choices": [{"delta": {"refusal": "help"}}]}),
623 ]
624 .iter()
625 .filter_map(|v| parse_delta(v, &mut ids))
626 .collect();
627 let resp = agent_framework_core::types::ChatResponse::from_updates(updates);
628 assert_eq!(
629 resp.messages[0].refusal_text().as_deref(),
630 Some("I can't help")
631 );
632 assert_eq!(resp.text(), "");
634 }
635
636 #[test]
637 fn classifies_401_and_403_as_invalid_auth() {
638 for status in [401, 403] {
639 let err = classify_service_error(status, "", format!("err {status}"), None);
640 assert!(
641 matches!(err, Error::ServiceInvalidAuth { .. }),
642 "status {status}: {err:?}"
643 );
644 }
645 }
646
647 #[test]
648 fn classifies_400_404_422_as_invalid_request_by_default() {
649 for status in [400, 404, 422] {
650 let body = r#"{"error":{"message":"nope","type":"invalid_request_error"}}"#;
651 let err = classify_service_error(status, body, format!("err {status}"), None);
652 assert!(
653 matches!(err, Error::ServiceInvalidRequest { .. }),
654 "status {status}: {err:?}"
655 );
656 }
657 }
658
659 #[test]
660 fn classifies_400_with_content_filter_code_as_content_filter() {
661 let body = r#"{"error":{"message":"flagged","type":"invalid_request_error","code":"content_filter"}}"#;
663 let err = classify_service_error(400, body, "err", None);
664 assert!(matches!(err, Error::ServiceContentFilter { .. }), "{err:?}");
665 }
666
667 #[test]
668 fn classifies_azure_openai_content_filter_shape_with_innererror() {
669 let body = r#"{"error":{"message":"The response was filtered","code":"content_filter","innererror":{"code":"ResponsibleAIPolicyViolation"}}}"#;
676 let err = classify_service_error(400, body, "err", None);
677 assert!(matches!(err, Error::ServiceContentFilter { .. }), "{err:?}");
678
679 let nested_only =
680 r#"{"error":{"message":"filtered","innererror":{"code":"content_filter"}}}"#;
681 let err = classify_service_error(400, nested_only, "err", None);
682 assert!(matches!(err, Error::ServiceContentFilter { .. }), "{err:?}");
683 }
684
685 #[test]
686 fn an_azure_content_filter_error_carries_which_category_fired() {
687 let body = r#"{"error":{"message":"The response was filtered","code":"content_filter",
691 "param":"prompt","innererror":{"code":"ResponsibleAIPolicyViolation",
692 "content_filter_result":{
693 "hate":{"filtered":false,"severity":"safe"},
694 "self_harm":{"filtered":true,"severity":"medium"},
695 "jailbreak":{"filtered":false,"detected":true}}}}}"#;
696 let err = classify_service_error(400, body, "err", None);
697 let detail = err
698 .content_filter_detail()
699 .expect("an Azure content-filter body carries a breakdown");
700 assert_eq!(
701 detail.code.as_deref(),
702 Some(ContentFilterDetail::RESPONSIBLE_AI_POLICY_VIOLATION)
703 );
704 assert_eq!(detail.param.as_deref(), Some("prompt"));
705 assert_eq!(detail.filtered_categories(), vec!["jailbreak", "self_harm"]);
706 assert_eq!(
707 detail.categories["self_harm"].severity.as_deref(),
708 Some("medium")
709 );
710 assert!(!detail.categories["hate"].filtered);
711 }
712
713 #[test]
714 fn an_unrecognized_policy_code_or_severity_is_carried_rather_than_rejected() {
715 let body = r#"{"error":{"code":"content_filter","innererror":{
719 "code":"SomeFutureAzurePolicy",
720 "content_filter_result":{"novel_category":{"filtered":true,"severity":"extreme"}}}}}"#;
721 let err = classify_service_error(400, body, "err", None);
722 let detail = err.content_filter_detail().expect("still classified");
723 assert_eq!(detail.code.as_deref(), Some("SomeFutureAzurePolicy"));
724 assert_eq!(
725 detail.categories["novel_category"].severity.as_deref(),
726 Some("extreme")
727 );
728 }
729
730 #[test]
731 fn a_plain_openai_content_filter_error_grows_no_empty_breakdown() {
732 let body = r#"{"error":{"message":"flagged","code":"content_filter"}}"#;
735 let err = classify_service_error(400, body, "err", None);
736 assert!(matches!(err, Error::ServiceContentFilter { .. }), "{err:?}");
737 assert!(err.content_filter_detail().is_none());
738 }
739
740 #[test]
741 fn the_outer_marker_is_never_read_as_the_policy_code() {
742 let body = r#"{"error":{"code":"content_filter","param":"prompt"}}"#;
746 let err = classify_service_error(400, body, "err", None);
747 let detail = err
748 .content_filter_detail()
749 .expect("param alone is a detail");
750 assert_eq!(detail.code, None);
751 assert_eq!(detail.param.as_deref(), Some("prompt"));
752 }
753
754 #[test]
755 fn non_json_or_unmarked_body_does_not_trigger_content_filter() {
756 let err = classify_service_error(400, "not json", "err", None);
757 assert!(
758 matches!(err, Error::ServiceInvalidRequest { .. }),
759 "{err:?}"
760 );
761
762 let err = classify_service_error(400, r#"{"error":{"code":"other"}}"#, "err", None);
763 assert!(
764 matches!(err, Error::ServiceInvalidRequest { .. }),
765 "{err:?}"
766 );
767 }
768
769 #[test]
770 fn leaves_retryable_statuses_as_service_status() {
771 for status in [408, 429, 500, 503] {
774 let err = classify_service_error(status, "", format!("err {status}"), Some(2.0));
775 assert_eq!(err.status(), Some(status), "{err:?}");
776 assert_eq!(err.retry_after(), Some(2.0), "{err:?}");
777 }
778 }
779
780 #[test]
781 fn unclassified_4xx_stays_service_status() {
782 let err = classify_service_error(409, "", "err", None);
786 assert_eq!(err.status(), Some(409), "{err:?}");
787 }
788
789 #[test]
790 fn message_text_is_preserved_verbatim() {
791 let err = classify_service_error(401, "", "OpenAI API error 401: unauthorized", None);
792 assert_eq!(
793 err.to_string(),
794 "service error: OpenAI API error 401: unauthorized"
795 );
796 }
797}