autoagents-llm 0.4.0

Agent Framework for Building Autonomous Agents
Documentation
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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
//! Azure OpenAI API client implementation for chat and completion functionality.
//!
//! This module provides integration with Azure OpenAI's GPT models through their API.

use std::sync::Arc;

use crate::{
    FunctionCall, ToolCall,
    builder::LLMBuilder,
    chat::{ChatResponse, ToolChoice},
    config::resolve_request_timeout,
    embedding::EmbeddingBuilder,
    http::ensure_success,
};
#[cfg(feature = "azure_openai")]
use crate::{
    LLMProvider,
    chat::Tool,
    chat::{ChatMessage, ChatProvider, ChatRole, MessageType, StructuredOutputFormat},
    completion::{CompletionProvider, CompletionRequest, CompletionResponse},
    embedding::EmbeddingProvider,
    error::LLMError,
    models::ModelsProvider,
};
use async_trait::async_trait;
use either::*;
use reqwest::{Client, Url};
use serde::{Deserialize, Serialize};

/// Client for interacting with Azure OpenAI's API.
///
/// Provides methods for chat and completion requests using Azure OpenAI's models.
pub struct AzureOpenAI {
    pub api_key: String,
    pub api_version: String,
    pub base_url: Url,
    pub model: String,
    pub max_tokens: Option<u32>,
    pub temperature: Option<f32>,
    pub timeout_seconds: u64,
    pub top_p: Option<f32>,
    pub top_k: Option<u32>,
    pub tool_choice: Option<ToolChoice>,
    /// Embedding parameters
    pub embedding_encoding_format: Option<String>,
    pub embedding_dimensions: Option<u32>,
    pub reasoning_effort: Option<String>,
    client: Client,
}

/// Individual message in an OpenAI chat conversation.
#[derive(Serialize, Debug)]
struct AzureOpenAIChatMessage<'a> {
    #[allow(dead_code)]
    role: &'a str,
    #[serde(
        skip_serializing_if = "Option::is_none",
        with = "either::serde_untagged_optional"
    )]
    content: Option<Either<Vec<AzureMessageContent<'a>>, String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tool_calls: Option<Vec<AzureOpenAIToolCall<'a>>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tool_call_id: Option<String>,
}

impl<'a> TryFrom<&'a ChatMessage> for AzureOpenAIChatMessage<'a> {
    type Error = LLMError;

    /// Converts a [`ChatMessage`] into Azure OpenAI chat completion format.
    ///
    /// This is the sole conversion path for non-[`MessageType::ToolResult`] messages.
    /// Raw inline images and PDFs return [`LLMError::InvalidRequest`]; image URLs are
    /// encoded as multipart content. [`ChatProvider::chat_with_tools`] does not
    /// pre-process images before calling this conversion.
    fn try_from(chat_msg: &'a ChatMessage) -> Result<Self, Self::Error> {
        let message = Self {
            role: match chat_msg.role {
                ChatRole::User => "user",
                ChatRole::System => "system",
                ChatRole::Assistant => "assistant",
                ChatRole::Tool => "user",
            },
            tool_call_id: None,
            content: match &chat_msg.message_type {
                MessageType::Text => Some(Right(chat_msg.content.clone())),
                MessageType::Image(_) => {
                    return Err(LLMError::invalid_request(
                        "Raw image input is not supported by the Azure OpenAI chat backend"
                            .to_string(),
                    ));
                }
                MessageType::Pdf(_) => {
                    return Err(LLMError::invalid_request(
                        "PDF input is not supported by the Azure OpenAI chat backend".to_string(),
                    ));
                }
                MessageType::ImageURL(url) => {
                    // Clone the URL to create an owned version

                    Some(Left(vec![AzureMessageContent {
                        message_type: Some("image_url"),
                        text: None,
                        image_url: Some(ImageUrlContent { url }),
                        tool_output: None,
                        tool_call_id: None,
                    }]))
                }
                MessageType::ToolUse(_) => None,
                MessageType::ToolResult(_) => None,
            },
            tool_calls: match &chat_msg.message_type {
                MessageType::ToolUse(calls) => {
                    let owned_calls: Vec<AzureOpenAIToolCall> =
                        calls.iter().map(|c| c.into()).collect();
                    Some(owned_calls)
                }
                _ => None,
            },
        };
        Ok(message)
    }
}

#[derive(Serialize, Debug)]
struct AzureOpenAIFunctionCall<'a> {
    name: &'a str,
    arguments: &'a str,
}

impl<'a> From<&'a FunctionCall> for AzureOpenAIFunctionCall<'a> {
    fn from(value: &'a FunctionCall) -> Self {
        Self {
            name: &value.name,
            arguments: &value.arguments,
        }
    }
}

#[derive(Serialize, Debug)]
struct AzureOpenAIToolCall<'a> {
    id: &'a str,
    #[serde(rename = "type")]
    content_type: &'a str,
    function: AzureOpenAIFunctionCall<'a>,
}

impl<'a> From<&'a ToolCall> for AzureOpenAIToolCall<'a> {
    fn from(value: &'a ToolCall) -> Self {
        Self {
            id: &value.id,
            content_type: "function",
            function: AzureOpenAIFunctionCall::from(&value.function),
        }
    }
}

#[derive(Serialize, Debug)]
struct AzureMessageContent<'a> {
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    message_type: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    text: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    image_url: Option<ImageUrlContent<'a>>,
    #[serde(skip_serializing_if = "Option::is_none", rename = "tool_call_id")]
    tool_call_id: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none", rename = "content")]
    tool_output: Option<&'a str>,
}

/// Individual image message in an OpenAI chat conversation.
#[derive(Serialize, Debug)]
struct ImageUrlContent<'a> {
    url: &'a str,
}

#[derive(Serialize)]
struct OpenAIEmbeddingRequest {
    model: String,
    input: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    encoding_format: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    dimensions: Option<u32>,
}

/// Request payload for Azure OpenAI's chat API endpoint.
#[derive(Serialize, Debug)]
struct AzureOpenAIChatRequest<'a> {
    model: &'a str,
    messages: Vec<AzureOpenAIChatMessage<'a>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    max_tokens: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    temperature: Option<f32>,
    stream: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    top_p: Option<f32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    top_k: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tools: Option<Vec<Tool>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tool_choice: Option<ToolChoice>,
    #[serde(skip_serializing_if = "Option::is_none")]
    reasoning_effort: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    response_format: Option<OpenAIResponseFormat>,
}

/// Response from OpenAI's chat API endpoint.
#[derive(Deserialize, Debug)]
struct AzureOpenAIChatResponse {
    choices: Vec<AzureOpenAIChatChoice>,
}

/// Individual choice within an OpenAI chat API response.
#[derive(Deserialize, Debug)]
struct AzureOpenAIChatChoice {
    message: AzureOpenAIChatMsg,
}

/// Message content within an OpenAI chat API response.
#[derive(Deserialize, Debug)]
struct AzureOpenAIChatMsg {
    #[allow(dead_code)]
    role: String,
    content: Option<String>,
    tool_calls: Option<Vec<ToolCall>>,
}

#[derive(Deserialize, Debug)]
struct AzureOpenAIEmbeddingData {
    embedding: Vec<f32>,
}
#[derive(Deserialize, Debug)]
struct OpenAIEmbeddingResponse {
    data: Vec<AzureOpenAIEmbeddingData>,
}

/// An object specifying the format that the model must output.
///Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
/// Setting to `{ "type": "json_object" }` enables the older JSON mode, which ensures the message the model generates is valid JSON. Using `json_schema` is preferred for models that support it.
#[derive(Deserialize, Debug, Serialize)]
enum OpenAIResponseType {
    #[serde(rename = "text")]
    Text,
    #[serde(rename = "json_schema")]
    JsonSchema,
    #[serde(rename = "json_object")]
    JsonObject,
}

#[derive(Deserialize, Debug, Serialize)]
struct OpenAIResponseFormat {
    #[serde(rename = "type")]
    response_type: OpenAIResponseType,
    #[serde(skip_serializing_if = "Option::is_none")]
    json_schema: Option<StructuredOutputFormat>,
}

impl From<StructuredOutputFormat> for OpenAIResponseFormat {
    /// Modify the schema to ensure that it meets OpenAI's requirements.
    fn from(structured_response_format: StructuredOutputFormat) -> Self {
        // It's possible to pass a StructuredOutputJsonSchema without an actual schema.
        // In this case, just pass the StructuredOutputJsonSchema object without modifying it.
        match structured_response_format.schema {
            None => OpenAIResponseFormat {
                response_type: OpenAIResponseType::JsonSchema,
                json_schema: Some(structured_response_format),
            },
            Some(mut schema) => {
                // Although [OpenAI's specifications](https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat#additionalproperties-false-must-always-be-set-in-objects) say that the "additionalProperties" field is required, my testing shows that it is not.
                // Just to be safe, add it to the schema if it is missing.
                schema = if schema.get("additionalProperties").is_none() {
                    schema["additionalProperties"] = serde_json::json!(false);
                    schema
                } else {
                    schema
                };

                OpenAIResponseFormat {
                    response_type: OpenAIResponseType::JsonSchema,
                    json_schema: Some(StructuredOutputFormat {
                        name: structured_response_format.name,
                        description: structured_response_format.description,
                        schema: Some(schema),
                        strict: structured_response_format.strict,
                    }),
                }
            }
        }
    }
}

/// Converts chat messages into Azure OpenAI API request messages.
///
/// [`MessageType::ToolResult`] messages are expanded into one `tool` role message per
/// result. All other message types are converted via [`AzureOpenAIChatMessage::try_from`].
fn build_azure_chat_messages(
    messages: &[ChatMessage],
) -> Result<Vec<AzureOpenAIChatMessage<'_>>, LLMError> {
    let mut openai_msgs = Vec::with_capacity(messages.len());

    for msg in messages {
        if let MessageType::ToolResult(ref results) = msg.message_type {
            for result in results {
                openai_msgs.push(AzureOpenAIChatMessage {
                    role: "tool",
                    tool_call_id: Some(result.id.clone()),
                    tool_calls: None,
                    content: Some(Right(result.function.arguments.clone())),
                });
            }
        } else {
            openai_msgs.push(AzureOpenAIChatMessage::try_from(msg)?);
        }
    }

    Ok(openai_msgs)
}

impl ChatResponse for AzureOpenAIChatResponse {
    fn text(&self) -> Option<String> {
        self.choices.first().and_then(|c| c.message.content.clone())
    }

    fn tool_calls(&self) -> Option<Vec<ToolCall>> {
        self.choices
            .first()
            .and_then(|c| c.message.tool_calls.clone())
    }
}

impl std::fmt::Display for AzureOpenAIChatResponse {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match (
            &self.choices.first().unwrap().message.content,
            &self.choices.first().unwrap().message.tool_calls,
        ) {
            (Some(content), Some(tool_calls)) => {
                for tool_call in tool_calls {
                    write!(f, "{tool_call}")?;
                }
                write!(f, "{content}")
            }
            (Some(content), None) => write!(f, "{content}"),
            (None, Some(tool_calls)) => {
                for tool_call in tool_calls {
                    write!(f, "{tool_call}")?;
                }
                Ok(())
            }
            (None, None) => write!(f, ""),
        }
    }
}

impl AzureOpenAI {
    /// Creates a new OpenAI client with the specified configuration.
    ///
    /// # Arguments
    ///
    /// * `api_key` - OpenAI API key
    /// * `model` - Model to use (defaults to "gpt-3.5-turbo")
    /// * `max_tokens` - Maximum tokens to generate
    /// * `temperature` - Sampling temperature
    /// * `timeout_seconds` - Request timeout in seconds
    /// * `stream` - Whether to stream responses
    /// * `top_p` - Top-p sampling parameter
    /// * `top_k` - Top-k sampling parameter
    /// * `embedding_encoding_format` - Format for embedding outputs
    /// * `embedding_dimensions` - Dimensions for embedding vectors
    /// * `tool_choice` - Determines how the model uses tools
    /// * `reasoning_effort` - Reasoning effort level
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        api_key: impl Into<String>,
        api_version: impl Into<String>,
        deployment_id: impl Into<String>,
        endpoint: impl Into<String>,
        model: Option<String>,
        max_tokens: Option<u32>,
        temperature: Option<f32>,
        timeout_seconds: Option<u64>,
        top_p: Option<f32>,
        top_k: Option<u32>,
        embedding_encoding_format: Option<String>,
        embedding_dimensions: Option<u32>,
        tool_choice: Option<ToolChoice>,
        reasoning_effort: Option<String>,
    ) -> Self {
        let timeout_seconds = resolve_request_timeout(timeout_seconds);
        let client = Client::builder()
            .timeout(std::time::Duration::from_secs(timeout_seconds))
            .build()
            .expect("Failed to build reqwest Client");

        let endpoint = endpoint.into();
        let deployment_id = deployment_id.into();

        Self {
            api_key: api_key.into(),
            api_version: api_version.into(),
            base_url: Url::parse(&format!("{endpoint}/openai/deployments/{deployment_id}/"))
                .expect("Failed to parse base Url"),
            model: model.unwrap_or_else(|| "gpt-3.5-turbo".to_string()),
            max_tokens,
            temperature,
            timeout_seconds,
            top_p,
            top_k,
            tool_choice,
            embedding_encoding_format,
            embedding_dimensions,
            client,
            reasoning_effort,
        }
    }
}

#[async_trait]
impl ChatProvider for AzureOpenAI {
    /// Sends a chat request to OpenAI's API.
    ///
    /// # Arguments
    ///
    /// * `messages` - Slice of chat messages representing the conversation
    /// * `tools` - Optional slice of tools to use in the chat
    /// # Returns
    ///
    /// The model's response text or an error
    async fn chat_with_tools(
        &self,
        messages: &[ChatMessage],
        tools: Option<&[Tool]>,
        json_schema: Option<StructuredOutputFormat>,
    ) -> Result<Box<dyn ChatResponse>, LLMError> {
        if self.api_key.is_empty() {
            return Err(LLMError::missing_api_key(
                "Missing Azure OpenAI API key".to_string(),
            ));
        }

        let openai_msgs = build_azure_chat_messages(messages)?;

        // Build the response format object
        let response_format: Option<OpenAIResponseFormat> = json_schema.clone().map(|s| s.into());

        let request_tools = tools.map(|t| t.to_vec());
        let request_tool_choice = if request_tools.is_some() {
            self.tool_choice.clone()
        } else {
            None
        };

        let body = AzureOpenAIChatRequest {
            model: &self.model,
            messages: openai_msgs,
            max_tokens: self.max_tokens,
            temperature: self.temperature,
            stream: false,
            top_p: self.top_p,
            top_k: self.top_k,
            tools: request_tools,
            tool_choice: request_tool_choice,
            reasoning_effort: self.reasoning_effort.clone(),
            response_format,
        };

        if log::log_enabled!(log::Level::Trace) {
            log::trace!(
                "{}",
                crate::request_diagnostics::summarize_json_request(
                    "Azure OpenAI",
                    "chat request",
                    &body
                )
            );
        }

        let mut url = self
            .base_url
            .join("chat/completions")
            .map_err(|e| LLMError::HttpError(e.to_string()))?;

        url.query_pairs_mut()
            .append_pair("api-version", &self.api_version);

        let request = self
            .client
            .post(url)
            .header("api-key", &self.api_key)
            .json(&body);

        // Send the request
        let response = request.send().await?;

        log::debug!("Azure OpenAI HTTP status: {}", response.status());

        let response = ensure_success(response, "Azure OpenAI").await?;

        // Parse the successful response
        let resp_text = response.text().await?;
        let json_resp: Result<AzureOpenAIChatResponse, serde_json::Error> =
            serde_json::from_str(&resp_text);

        match json_resp {
            Ok(response) => Ok(Box::new(response)),
            Err(e) => Err(LLMError::ResponseFormatError {
                message: format!("Failed to decode Azure OpenAI API response: {e}"),
                raw_response: resp_text,
            }),
        }
    }

    async fn chat(
        &self,
        messages: &[ChatMessage],
        json_schema: Option<StructuredOutputFormat>,
    ) -> Result<Box<dyn ChatResponse>, LLMError> {
        self.chat_with_tools(messages, None, json_schema).await
    }

    fn model(&self) -> &str {
        &self.model
    }
}

#[async_trait]
impl CompletionProvider for AzureOpenAI {
    /// Sends a completion request to OpenAI's API.
    ///
    /// Currently not implemented.
    async fn complete(
        &self,
        _req: &CompletionRequest,
        _json_schema: Option<StructuredOutputFormat>,
    ) -> Result<CompletionResponse, LLMError> {
        Ok(CompletionResponse {
            text: "OpenAI completion not implemented.".into(),
        })
    }
}

impl LLMProvider for AzureOpenAI {}

impl crate::HasConfig for AzureOpenAI {
    type Config = crate::NoConfig;
}

#[cfg(feature = "azure_openai")]
#[async_trait]
impl EmbeddingProvider for AzureOpenAI {
    async fn embed(&self, input: Vec<String>) -> Result<Vec<Vec<f32>>, LLMError> {
        if self.api_key.is_empty() {
            return Err(LLMError::missing_api_key(
                "Missing OpenAI API key".to_string(),
            ));
        }

        let emb_format = self
            .embedding_encoding_format
            .clone()
            .unwrap_or_else(|| "float".to_string());

        let body = OpenAIEmbeddingRequest {
            model: self.model.clone(),
            input,
            encoding_format: Some(emb_format),
            dimensions: self.embedding_dimensions,
        };

        let mut url = self
            .base_url
            .join("embeddings")
            .map_err(|e| LLMError::HttpError(e.to_string()))?;

        url.query_pairs_mut()
            .append_pair("api-version", &self.api_version);

        let resp = self
            .client
            .post(url)
            .header("api-key", &self.api_key)
            .json(&body)
            .send()
            .await?;
        let resp = ensure_success(resp, "Azure OpenAI").await?;

        let json_resp: OpenAIEmbeddingResponse = resp.json().await?;

        let embeddings = json_resp.data.into_iter().map(|d| d.embedding).collect();
        Ok(embeddings)
    }
}

#[async_trait]
impl ModelsProvider for AzureOpenAI {}

impl LLMBuilder<AzureOpenAI> {
    pub fn build(self) -> Result<Arc<AzureOpenAI>, LLMError> {
        let endpoint = self.base_url.ok_or_else(|| {
            LLMError::invalid_request("No API endpoint provided for Azure OpenAI")
        })?;

        let key = self.api_key.ok_or_else(|| {
            LLMError::invalid_request("No API key provided for Azure OpenAI".to_string())
        })?;

        let api_version = self.api_version.ok_or_else(|| {
            LLMError::invalid_request("No API version provided for Azure OpenAI".to_string())
        })?;

        let deployment = self.deployment_id.ok_or_else(|| {
            LLMError::invalid_request("No deployment ID provided for Azure OpenAI")
        })?;

        let provider = AzureOpenAI::new(
            key,
            api_version,
            deployment,
            endpoint,
            self.model,
            self.max_tokens,
            self.temperature,
            self.timeout_seconds,
            self.top_p,
            self.top_k,
            self.embedding_encoding_format,
            self.embedding_dimensions,
            self.tool_choice,
            self.reasoning_effort,
        );

        Ok(Arc::new(provider))
    }
}

impl EmbeddingBuilder<AzureOpenAI> {
    /// Build an Azure OpenAI embedding provider.
    pub fn build(self) -> Result<Arc<AzureOpenAI>, LLMError> {
        let api_key = self.api_key.ok_or_else(|| {
            LLMError::invalid_request("No API key provided for Azure OpenAI".to_string())
        })?;
        let api_version = self.api_version.ok_or_else(|| {
            LLMError::invalid_request("No API version provided for Azure OpenAI".to_string())
        })?;
        let deployment_id = self.deployment_id.ok_or_else(|| {
            LLMError::invalid_request("No deployment ID provided for Azure OpenAI".to_string())
        })?;
        let endpoint = self.base_url.ok_or_else(|| {
            LLMError::invalid_request("No API endpoint provided for Azure OpenAI".to_string())
        })?;

        let provider = AzureOpenAI::new(
            api_key,
            api_version,
            deployment_id,
            endpoint,
            Some(
                self.model
                    .unwrap_or_else(|| "text-embedding-3-small".to_string()),
            ),
            None,
            None,
            self.timeout_seconds,
            None,
            None,
            self.embedding_encoding_format,
            self.embedding_dimensions,
            None,
            None,
        );

        Ok(Arc::new(provider))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::chat::{ChatMessage, ChatRole, ImageMime, MessageType, Tool};
    use crate::{FunctionCall, ToolCall};
    use httpmock::{Method::POST, MockServer};
    use serde_json::json;

    fn sample_tool() -> Tool {
        Tool {
            tool_type: "function".to_string(),
            function: crate::chat::FunctionTool {
                name: "lookup".to_string(),
                description: "desc".to_string(),
                parameters: json!({
                    "type": "object",
                    "properties": {
                        "q": { "type": "string" }
                    }
                }),
            },
        }
    }

    #[test]
    fn test_build_azure_chat_messages_rejects_raw_image() {
        let messages = [ChatMessage {
            role: ChatRole::User,
            message_type: MessageType::Image((ImageMime::PNG, vec![1, 2, 3])),
            content: "describe".to_string(),
        }];

        let err = build_azure_chat_messages(&messages).expect_err("raw image should be rejected");

        assert!(matches!(
            err,
            LLMError::InvalidRequest { message, .. }
                if message == "Raw image input is not supported by the Azure OpenAI chat backend"
        ));
    }

    #[test]
    fn test_azure_chat_message_from_text() {
        let msg = ChatMessage {
            role: ChatRole::User,
            message_type: MessageType::Text,
            content: "hello".to_string(),
        };
        let azure = AzureOpenAIChatMessage::try_from(&msg).expect("text should convert");
        assert_eq!(azure.role, "user");
        assert!(azure.content.is_some());
        assert!(azure.tool_calls.is_none());
    }

    #[test]
    fn test_azure_chat_message_from_image_url() {
        let msg = ChatMessage {
            role: ChatRole::User,
            message_type: MessageType::ImageURL("https://example.com/img.png".to_string()),
            content: "describe".to_string(),
        };
        let azure = AzureOpenAIChatMessage::try_from(&msg).expect("image URL should convert");
        match azure.content.unwrap() {
            Right(_) => panic!("Expected multipart content"),
            Left(parts) => {
                assert_eq!(parts.len(), 1);
                assert_eq!(parts[0].message_type, Some("image_url"));
            }
        }
    }

    #[test]
    fn test_azure_chat_message_rejects_raw_image() {
        let msg = ChatMessage {
            role: ChatRole::User,
            message_type: MessageType::Image((ImageMime::PNG, vec![1, 2, 3])),
            content: "describe".to_string(),
        };

        let err = AzureOpenAIChatMessage::try_from(&msg).expect_err("raw image should be rejected");

        assert!(matches!(
            err,
            LLMError::InvalidRequest { message, .. }
                if message == "Raw image input is not supported by the Azure OpenAI chat backend"
        ));
    }

    #[test]
    fn test_azure_chat_message_rejects_pdf() {
        let msg = ChatMessage {
            role: ChatRole::User,
            message_type: MessageType::Pdf(vec![1, 2, 3]),
            content: "doc".to_string(),
        };

        let err = AzureOpenAIChatMessage::try_from(&msg).expect_err("PDF should be rejected");

        assert!(matches!(
            err,
            LLMError::InvalidRequest { message, .. }
                if message == "PDF input is not supported by the Azure OpenAI chat backend"
        ));
    }

    #[test]
    fn test_azure_chat_message_from_tool_use() {
        let msg = ChatMessage {
            role: ChatRole::Assistant,
            message_type: MessageType::ToolUse(vec![ToolCall {
                id: "call_1".to_string(),
                call_type: "function".to_string(),
                function: FunctionCall {
                    name: "lookup".to_string(),
                    arguments: "{\"q\":\"value\"}".to_string(),
                },
            }]),
            content: "tool use".to_string(),
        };
        let azure = AzureOpenAIChatMessage::try_from(&msg).expect("tool use should convert");
        assert!(azure.content.is_none());
        assert!(azure.tool_calls.is_some());
    }

    #[test]
    fn test_azure_tool_call_from_tool_call() {
        let call = ToolCall {
            id: "call_1".to_string(),
            call_type: "function".to_string(),
            function: FunctionCall {
                name: "lookup".to_string(),
                arguments: "{\"q\":\"value\"}".to_string(),
            },
        };
        let azure = AzureOpenAIToolCall::from(&call);
        assert_eq!(azure.id, "call_1");
        assert_eq!(azure.content_type, "function");
        assert_eq!(azure.function.name, "lookup");
    }

    #[test]
    fn test_azure_embedding_request_serialization() {
        let req = OpenAIEmbeddingRequest {
            model: "embed".to_string(),
            input: vec!["a".to_string(), "b".to_string()],
            encoding_format: Some("float".to_string()),
            dimensions: Some(3),
        };
        let serialized = serde_json::to_value(&req).unwrap();
        assert_eq!(serialized.get("model"), Some(&serde_json::json!("embed")));
        assert_eq!(
            serialized
                .get("input")
                .and_then(|v| v.as_array())
                .unwrap()
                .len(),
            2
        );
    }

    #[test]
    fn test_azure_tool_serialization() {
        let tool = Tool {
            tool_type: "function".to_string(),
            function: crate::chat::FunctionTool {
                name: "lookup".to_string(),
                description: "desc".to_string(),
                parameters: serde_json::json!({
                    "type": "object",
                    "properties": {}
                }),
            },
        };
        let serialized = serde_json::to_value(&tool).unwrap();
        assert_eq!(serialized.get("type"), Some(&serde_json::json!("function")));
    }

    #[tokio::test]
    async fn test_azure_chat_with_tools_and_embed_use_mock_server() {
        let server = MockServer::start();
        let endpoint = server.base_url();
        let provider = AzureOpenAI::new(
            "key",
            "2024-01-01",
            "dep-123",
            endpoint.clone(),
            Some("gpt-4o-mini".to_string()),
            Some(128),
            Some(0.2),
            Some(5),
            Some(0.9),
            Some(16),
            Some("float".to_string()),
            Some(3),
            Some(ToolChoice::Auto),
            Some("medium".to_string()),
        );

        let chat_mock = server.mock(|when, then| {
            when.method(POST)
                .path("/openai/deployments/dep-123/chat/completions")
                .header("api-key", "key")
                .body_includes("\"reasoning_effort\":\"medium\"")
                .body_includes("\"tool_choice\":\"auto\"")
                .body_includes("\"response_format\"");
            then.status(200).json_body(json!({
                "choices": [{
                    "message": {
                        "role": "assistant",
                        "content": "azure reply"
                    }
                }],
                "usage": {
                    "prompt_tokens": 1,
                    "completion_tokens": 2,
                    "total_tokens": 3
                }
            }));
        });

        let messages = vec![ChatMessage::user().content("hello").build()];
        let response = provider
            .chat_with_tools(
                &messages,
                Some(&[sample_tool()]),
                Some(StructuredOutputFormat {
                    name: "Answer".to_string(),
                    description: None,
                    schema: Some(json!({
                        "type": "object",
                        "properties": {
                            "answer": { "type": "string" }
                        }
                    })),
                    strict: Some(true),
                }),
            )
            .await
            .expect("azure chat should succeed");
        assert_eq!(response.text().as_deref(), Some("azure reply"));
        chat_mock.assert();

        let embed_mock = server.mock(|when, then| {
            when.method(POST)
                .path("/openai/deployments/dep-123/embeddings")
                .header("api-key", "key")
                .body_includes("\"encoding_format\":\"float\"")
                .body_includes("\"dimensions\":3");
            then.status(200).json_body(json!({
                "data": [
                    { "embedding": [0.1, 0.2, 0.3] }
                ]
            }));
        });

        let embeddings = provider
            .embed(vec!["hello".to_string()])
            .await
            .expect("embeddings should succeed");
        assert_eq!(embeddings, vec![vec![0.1, 0.2, 0.3]]);
        embed_mock.assert();
    }

    #[tokio::test]
    async fn test_azure_chat_returns_error_for_status_and_invalid_json() {
        let server = MockServer::start();
        let provider = AzureOpenAI::new(
            "key",
            "2024-01-01",
            "dep-123",
            server.base_url(),
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
        );
        let messages = vec![ChatMessage::user().content("hello").build()];

        let error_mock = server.mock(|when, then| {
            when.method(POST)
                .path("/openai/deployments/dep-123/chat/completions");
            then.status(500).body("azure down");
        });

        let err = provider
            .chat_with_tools(&messages, None, None)
            .await
            .expect_err("error status should fail");
        match err {
            LLMError::HttpStatusError {
                status_code,
                response_body,
                ..
            } => {
                assert_eq!(status_code, 500);
                assert_eq!(response_body.as_ref(), "azure down");
            }
            other => panic!("unexpected error: {other:?}"),
        }
        error_mock.assert();

        let server = MockServer::start();
        let provider = AzureOpenAI::new(
            "key",
            "2024-01-01",
            "dep-123",
            server.base_url(),
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
        );
        let invalid_mock = server.mock(|when, then| {
            when.method(POST)
                .path("/openai/deployments/dep-123/chat/completions");
            then.status(200).body("not-json");
        });

        let err = provider
            .chat_with_tools(&messages, None, None)
            .await
            .expect_err("invalid json should fail");
        match err {
            LLMError::ResponseFormatError {
                message,
                raw_response,
            } => {
                assert!(message.contains("Failed to decode"));
                assert_eq!(raw_response, "not-json");
            }
            other => panic!("unexpected error: {other:?}"),
        }
        invalid_mock.assert();
    }
}