rai-sdk 0.1.1

Rust AI SDK — unified client for OpenAI, Anthropic, and OpenRouter with typed models, structured output, tool calling, and streaming
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
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
//! The client and request builders that drive generation.
//!
//! [`ClientBuilder`] assembles configuration, a default model, and any shared
//! tools into a [`Client`]. Each call to [`Client::request`] returns a
//! [`RequestBuilder`], a typestate builder whose terminal methods only become
//! available once the request has both a prompt and a model.
//!
//! The builder exposes four families of terminal operations: `generate` and
//! `generate_once` for text, `generate_structured` and
//! `generate_structured_once` for typed output, `stream` and
//! `stream_accumulated` for streaming, and per-request overrides such as
//! configuration, tools, and retry policy. The `_once` variants perform a single
//! provider call and do not execute registered tools.

use std::{any::type_name, marker::PhantomData, pin::Pin};

use futures::{Stream, StreamExt};
use schemars::JsonSchema;
use serde::de::DeserializeOwned;
use tracing::{debug, error, info, instrument};

use crate::{
    config::Config,
    error::{Error, ProviderKind, Result},
    generation::GenerationConfig,
    message::{Message, Prompt, Response, StructuredOutput, ToolDefinition},
    model::Model,
    retry::RetryConfig,
    tool::{Tool, ToolContext, ToolRegistry},
};

#[cfg(feature = "openai")]
use crate::provider::OpenAIProvider;

#[cfg(feature = "anthropic")]
use crate::provider::AnthropicProvider;

#[cfg(feature = "openrouter")]
use crate::provider::OpenRouterProvider;

#[derive(Clone, Copy)]
enum ToolAvailability {
    Enabled,
    IgnoredForStructuredOnce,
}

#[doc(hidden)]
pub struct ModelMissing;

#[doc(hidden)]
pub struct ModelReady;

/// Unified AI client for OpenAI, Anthropic, and OpenRouter.
///
/// A client owns provider credentials and HTTP clients, an optional default
/// model, default generation and retry settings, and any tools shared by every
/// request. Build one once and reuse it: individual requests are cheap, but
/// constructing a client initializes a client per configured provider.
///
/// Use [`ClientBuilder`] for the common path, or [`Client::new`] when you
/// already have a [`Config`].
///
/// # Typestate
///
/// The `ModelState` parameter records whether a default model is present.
/// [`ClientBuilder::model`] moves the builder into the model-ready state, and
/// only a model-ready client hands out request builders that can call
/// [`RequestBuilder::generate`] without naming a model. A client built without a
/// default model is still fully usable — every request just has to call
/// [`RequestBuilder::model`] first. Either way, a request missing a model is a
/// compile error rather than a runtime one.
///
/// # Examples
///
/// ```no_run
/// use rai_sdk::{ClientBuilder, Model};
///
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let client = ClientBuilder::new()
///     .from_env()
///     .model(Model::gpt4o_mini())
///     .build()?;
///
/// // Reuse the same client for many requests.
/// for prompt in ["Define a trait.", "Define a lifetime."] {
///     let response = client.request().prompt(prompt).generate().await?;
///     println!("{}", response.text());
/// }
/// # Ok(())
/// # }
/// ```
pub struct Client<ModelState = ModelMissing> {
    config: Config,
    default_model: Option<Model>,
    default_config: GenerationConfig,
    default_retry_config: RetryConfig,
    tool_registry: ToolRegistry,
    state: PhantomData<ModelState>,

    #[cfg(feature = "openai")]
    openai: Option<OpenAIProvider>,

    #[cfg(feature = "anthropic")]
    anthropic: Option<AnthropicProvider>,

    #[cfg(feature = "openrouter")]
    openrouter: Option<OpenRouterProvider>,
}

impl<ModelState> std::fmt::Debug for Client<ModelState> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut s = f.debug_struct("Client");
        s.field("default_model", &self.default_model);
        s.field("default_config", &self.default_config);

        #[cfg(feature = "openai")]
        s.field("openai", &self.openai);

        #[cfg(feature = "anthropic")]
        s.field("anthropic", &self.anthropic);

        #[cfg(feature = "openrouter")]
        s.field("openrouter", &self.openrouter);

        s.finish()
    }
}

impl Client<ModelMissing> {
    /// Create a client from an explicit [`Config`], with no default model.
    ///
    /// Every request from this client must select a model with
    /// [`RequestBuilder::model`]. Use [`ClientBuilder`] instead if you want a
    /// default model or client-level tools.
    ///
    /// A provider whose API key is missing is simply left uninitialized rather
    /// than failing here; using it later returns
    /// [`Error::ProviderNotConfigured`].
    ///
    /// # Errors
    ///
    /// Returns an error if a configured provider's HTTP client cannot be
    /// constructed, for example because the request timeout is invalid.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use rai_sdk::{Client, Config, Model};
    ///
    /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = Client::new(Config::from_env())?;
    ///
    /// let response = client
    ///     .request()
    ///     .model(Model::gpt4o_mini())
    ///     .prompt("Hello")
    ///     .generate()
    ///     .await?;
    /// # println!("{}", response.text());
    /// # Ok(())
    /// # }
    /// ```
    pub fn new(config: Config) -> Result<Self> {
        let default_retry_config = config.retry_config();
        Self::new_with_defaults(
            config,
            None,
            GenerationConfig::default(),
            default_retry_config,
            ToolRegistry::new(),
        )
    }

    /// Create a builder for configuring a client with defaults.
    ///
    /// Equivalent to [`ClientBuilder::new`].
    pub fn builder() -> ClientBuilder<ModelMissing> {
        ClientBuilder::new()
    }

    /// Start a request.
    ///
    /// This client has no default model, so the returned builder requires
    /// [`RequestBuilder::model`] before it will expose `generate` and friends.
    pub fn request(&self) -> RequestBuilder<'_, PromptMissing, ModelMissing, ModelMissing> {
        self.request_builder()
    }
}

impl<ModelState> Client<ModelState> {
    fn request_builder(&self) -> RequestBuilder<'_, PromptMissing, ModelState, ModelState> {
        RequestBuilder::new(self)
    }

    fn new_with_defaults(
        config: Config,
        default_model: Option<Model>,
        default_config: GenerationConfig,
        default_retry_config: RetryConfig,
        tool_registry: ToolRegistry,
    ) -> Result<Self> {
        info!("Initializing AI client");

        #[cfg(feature = "openai")]
        let openai = if config.openai_key().is_some() {
            match OpenAIProvider::new(&config) {
                Ok(provider) => {
                    info!("OpenAI provider initialized");
                    Some(provider)
                }
                Err(e) => {
                    tracing::warn!(error = %e, "Failed to initialize OpenAI provider");
                    None
                }
            }
        } else {
            tracing::debug!("OpenAI API key not configured, provider disabled");
            None
        };

        #[cfg(feature = "anthropic")]
        let anthropic = if config.anthropic_key().is_some() {
            match AnthropicProvider::new(&config) {
                Ok(provider) => {
                    info!("Anthropic provider initialized");
                    Some(provider)
                }
                Err(e) => {
                    tracing::warn!(error = %e, "Failed to initialize Anthropic provider");
                    None
                }
            }
        } else {
            tracing::debug!("Anthropic API key not configured, provider disabled");
            None
        };

        #[cfg(feature = "openrouter")]
        let openrouter = if config.openrouter_key().is_some() {
            match OpenRouterProvider::new(&config) {
                Ok(provider) => {
                    info!("OpenRouter provider initialized");
                    Some(provider)
                }
                Err(e) => {
                    tracing::warn!(error = %e, "Failed to initialize OpenRouter provider");
                    None
                }
            }
        } else {
            tracing::debug!("OpenRouter API key not configured, provider disabled");
            None
        };

        info!("AI client initialized successfully");

        Ok(Self {
            config,
            default_model,
            default_config,
            default_retry_config,
            tool_registry,
            state: PhantomData,
            #[cfg(feature = "openai")]
            openai,
            #[cfg(feature = "anthropic")]
            anthropic,
            #[cfg(feature = "openrouter")]
            openrouter,
        })
    }

    async fn generate_with_tools(
        &self,
        model: Model,
        prompt: &Prompt,
        config: &GenerationConfig,
        retry_config: &RetryConfig,
        tool_registry: &ToolRegistry,
    ) -> Result<Response> {
        let Some(tool_definitions) =
            (!tool_registry.is_empty()).then(|| tool_registry.definitions())
        else {
            return crate::retry::with_retry(retry_config, "generate", || {
                self.generate_once_internal(model.clone(), prompt, config, None)
            })
            .await;
        };

        let mut prompt_with_tools = prompt.clone();
        let max_rounds = config.tool_round_limit();

        for round in 0..max_rounds {
            let response = crate::retry::with_retry(retry_config, "generate", || {
                self.generate_once_internal(
                    model.clone(),
                    &prompt_with_tools,
                    config,
                    Some(&tool_definitions),
                )
            })
            .await?;

            let tool_calls: Vec<_> = response
                .messages
                .iter()
                .flat_map(|message| message.tool_calls.iter().cloned())
                .collect();

            if tool_calls.is_empty() {
                return Ok(response);
            }

            prompt_with_tools.messages.extend(response.messages.clone());

            for tool_call in tool_calls {
                let tool_message = tool_registry
                    .execute(
                        &tool_call,
                        ToolContext {
                            provider: model.provider(),
                            model: model.as_str().to_string(),
                            round,
                            tool_name: tool_call.name.clone(),
                            tool_call_id: tool_call.id.clone(),
                        },
                    )
                    .await?;
                prompt_with_tools.messages.push(tool_message);
            }
        }

        Err(Error::ToolLoopLimitExceeded { max_rounds })
    }

    async fn generate_once_internal(
        &self,
        model: Model,
        prompt: &Prompt,
        config: &GenerationConfig,
        tool_definitions: Option<&[ToolDefinition]>,
    ) -> Result<Response> {
        #[cfg(not(any(feature = "openai", feature = "anthropic", feature = "openrouter")))]
        let _ = (prompt, config, tool_definitions);

        match model {
            #[cfg(feature = "openai")]
            Model::OpenAI(ref openai_model) => {
                let provider = self
                    .openai
                    .as_ref()
                    .ok_or_else(|| Error::ProviderNotConfigured(ProviderKind::OpenAI))?;
                provider
                    .generate(openai_model, prompt, config, tool_definitions)
                    .await
            }

            #[cfg(feature = "anthropic")]
            Model::Anthropic(ref anthropic_model) => {
                let provider = self
                    .anthropic
                    .as_ref()
                    .ok_or_else(|| Error::ProviderNotConfigured(ProviderKind::Anthropic))?;
                provider
                    .generate(anthropic_model, prompt, config, tool_definitions)
                    .await
            }

            #[cfg(feature = "openrouter")]
            Model::OpenRouter(ref openrouter_model) => {
                let provider = self
                    .openrouter
                    .as_ref()
                    .ok_or_else(|| Error::ProviderNotConfigured(ProviderKind::OpenRouter))?;
                provider
                    .generate(openrouter_model, prompt, config, tool_definitions)
                    .await
            }

            #[allow(unreachable_patterns)]
            _ => Err(Error::ProviderNotEnabled(model.provider())),
        }
    }

    /// Stream a completion for an explicit model and prompt.
    ///
    /// Prefer [`RequestBuilder::stream`], which applies the client's defaults,
    /// retry policy, and per-request tool overrides. This lower-level entry
    /// point is useful when you are driving the model and prompt yourself.
    ///
    /// # Errors
    ///
    /// - [`Error::InvalidRequest`] if any tool is registered on this client,
    ///   since streaming cannot run a tool loop. Because this method takes no
    ///   request context, it can only consider the client's tools; use
    ///   [`RequestBuilder::stream`] with [`RequestBuilder::no_tools`] to stream
    ///   from a client that has tools registered.
    /// - [`Error::ProviderNotConfigured`] if the model's provider has no API key.
    /// - [`Error::ProviderNotEnabled`] if its Cargo feature is disabled.
    /// - A transport or provider error if the request itself fails.
    pub async fn generate_stream(
        &self,
        model: Model,
        prompt: &Prompt,
        config: &GenerationConfig,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<crate::provider::ProviderStreamEvent>> + Send>>>
    {
        ensure_streamable(&self.tool_registry)?;
        self.generate_stream_inner(model, prompt, config).await
    }

    /// Open a provider stream without considering tools.
    ///
    /// Callers are responsible for having already rejected tool-bearing
    /// requests via [`ensure_streamable`].
    #[instrument(skip(self, prompt, config))]
    async fn generate_stream_inner(
        &self,
        model: Model,
        prompt: &Prompt,
        config: &GenerationConfig,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<crate::provider::ProviderStreamEvent>> + Send>>>
    {
        #[cfg(not(any(feature = "openai", feature = "anthropic", feature = "openrouter")))]
        let _ = (prompt, config);

        match model {
            #[cfg(feature = "openai")]
            Model::OpenAI(ref openai_model) => {
                let provider = self
                    .openai
                    .as_ref()
                    .ok_or_else(|| Error::ProviderNotConfigured(ProviderKind::OpenAI))?;
                provider.generate_stream(openai_model, prompt, config).await
            }

            #[cfg(feature = "anthropic")]
            Model::Anthropic(ref anthropic_model) => {
                let provider = self
                    .anthropic
                    .as_ref()
                    .ok_or_else(|| Error::ProviderNotConfigured(ProviderKind::Anthropic))?;
                provider
                    .generate_stream(anthropic_model, prompt, config)
                    .await
            }

            #[cfg(feature = "openrouter")]
            Model::OpenRouter(ref openrouter_model) => {
                let provider = self
                    .openrouter
                    .as_ref()
                    .ok_or_else(|| Error::ProviderNotConfigured(ProviderKind::OpenRouter))?;
                provider
                    .generate_stream(openrouter_model, prompt, config)
                    .await
            }

            #[allow(unreachable_patterns)]
            _ => Err(Error::ProviderNotEnabled(model.provider())),
        }
    }

    /// Whether a provider is usable: its feature is enabled and it has
    /// credentials.
    ///
    /// Use this to branch at runtime instead of discovering a missing key
    /// through a failed request.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use rai_sdk::{ClientBuilder, Model, ProviderKind};
    ///
    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = ClientBuilder::new().from_env().build()?;
    ///
    /// let model = if client.is_provider_available(ProviderKind::Anthropic) {
    ///     Model::claude_sonnet_46()
    /// } else {
    ///     Model::gpt4o_mini()
    /// };
    /// # let _ = model;
    /// # Ok(())
    /// # }
    /// ```
    pub fn is_provider_available(&self, provider: ProviderKind) -> bool {
        match provider {
            #[cfg(feature = "openai")]
            ProviderKind::OpenAI => self.openai.is_some(),

            #[cfg(feature = "anthropic")]
            ProviderKind::Anthropic => self.anthropic.is_some(),

            #[cfg(feature = "openrouter")]
            ProviderKind::OpenRouter => self.openrouter.is_some(),

            #[allow(unreachable_patterns)]
            _ => false,
        }
    }

    /// The configuration this client was built with.
    ///
    /// Note that the returned [`Config`] contains API keys; do not log it.
    pub fn config(&self) -> &Config {
        &self.config
    }
}

impl Client<ModelReady> {
    /// Start a request that inherits this client's default model.
    ///
    /// Because the model is already known, the returned builder only needs a
    /// prompt before you can call [`RequestBuilder::generate`]. Override the
    /// model per request with [`RequestBuilder::model`].
    pub fn request(&self) -> RequestBuilder<'_, PromptMissing, ModelReady, ModelReady> {
        self.request_builder()
    }
}

enum ToolOverride {
    Inherit,
    Replace(Vec<Tool>),
    Append(Vec<Tool>),
    None,
}

struct ResolvedRequest {
    model: Model,
    config: GenerationConfig,
    retry_config: RetryConfig,
    tool_registry: ToolRegistry,
}

#[doc(hidden)]
pub struct PromptMissing;

#[doc(hidden)]
pub struct PromptReady;

/// Builder for a single AI generation request.
///
/// Created by [`Client::request`]. Chain overrides, supply a prompt, then call
/// one terminal method. Anything you do not override is inherited from the
/// client.
///
/// # Terminal methods
///
/// | Method | Returns | Runs registered tools |
/// | --- | --- | --- |
/// | [`generate`](Self::generate) | [`Response`] | yes, until a final answer |
/// | [`generate_once`](Self::generate_once) | [`Response`] | no, one provider call |
/// | [`generate_structured`](Self::generate_structured) | [`StructuredOutput<T>`] | yes |
/// | [`generate_structured_once`](Self::generate_structured_once) | [`StructuredOutput<T>`] | no |
/// | [`generate_with_history`](Self::generate_with_history) | [`Response`] | yes |
/// | [`stream`](Self::stream) | stream of provider events | not supported |
/// | [`generate_stream_events`](Self::generate_stream_events) | stream of high-level events | not supported |
/// | [`stream_accumulated`](Self::stream_accumulated) | [`Response`] | not supported |
///
/// Methods ending in `_once` make exactly one provider call and never execute
/// tools.
///
/// # Typestate
///
/// The terminal methods only exist once the builder has both a prompt and a
/// model, so an incomplete request cannot be sent. A model comes either from
/// the client's default or from [`model`](Self::model); the prompt comes from
/// [`prompt`](Self::prompt). If `generate` appears to be missing, one of those
/// two is absent.
///
/// # Examples
///
/// ```no_run
/// use rai_sdk::{ClientBuilder, GenerationConfig, Model};
///
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let client = ClientBuilder::new()
///     .from_env()
///     .model(Model::gpt4o_mini())
///     .build()?;
///
/// let response = client
///     .request()
///     .model(Model::claude_sonnet_46())                       // override the model
///     .config(GenerationConfig::new().with_temperature(0.2))   // override sampling
///     .no_tools()                                             // ignore client tools
///     .prompt("Summarize the borrow checker.")
///     .generate()
///     .await?;
/// # println!("{}", response.text());
/// # Ok(())
/// # }
/// ```
pub struct RequestBuilder<
    'a,
    PromptState = PromptMissing,
    RequestModelState = ModelMissing,
    ClientModelState = ModelMissing,
> {
    client: &'a Client<ClientModelState>,
    model: Option<Model>,
    config: Option<GenerationConfig>,
    retry_config: Option<RetryConfig>,
    prompt: Option<Prompt>,
    tool_override: ToolOverride,
    prompt_state: PhantomData<PromptState>,
    model_state: PhantomData<RequestModelState>,
}

impl<'a, ClientModelState> RequestBuilder<'a, PromptMissing, ClientModelState, ClientModelState> {
    fn new(client: &'a Client<ClientModelState>) -> Self {
        Self {
            client,
            model: None,
            config: None,
            retry_config: None,
            prompt: None,
            tool_override: ToolOverride::Inherit,
            prompt_state: PhantomData,
            model_state: PhantomData,
        }
    }
}

impl<'a, PromptState, RequestModelState, ClientModelState>
    RequestBuilder<'a, PromptState, RequestModelState, ClientModelState>
{
    fn with_prompt_state<NextPromptState>(
        self,
    ) -> RequestBuilder<'a, NextPromptState, RequestModelState, ClientModelState> {
        RequestBuilder {
            client: self.client,
            model: self.model,
            config: self.config,
            retry_config: self.retry_config,
            prompt: self.prompt,
            tool_override: self.tool_override,
            prompt_state: PhantomData,
            model_state: PhantomData,
        }
    }

    fn with_model_state<NextRequestModelState>(
        self,
    ) -> RequestBuilder<'a, PromptState, NextRequestModelState, ClientModelState> {
        RequestBuilder {
            client: self.client,
            model: self.model,
            config: self.config,
            retry_config: self.retry_config,
            prompt: self.prompt,
            tool_override: self.tool_override,
            prompt_state: PhantomData,
            model_state: PhantomData,
        }
    }

    /// Override the model, and therefore the provider, for this request.
    ///
    /// Takes precedence over the client's default model. Calling this makes the
    /// builder model-ready even if the client has no default.
    pub fn model(
        mut self,
        model: Model,
    ) -> RequestBuilder<'a, PromptState, ModelReady, ClientModelState> {
        self.model = Some(model);
        self.with_model_state()
    }

    /// Override generation settings for this request.
    ///
    /// Replaces the client's default [`GenerationConfig`] wholesale rather than
    /// merging with it, so include every setting you want.
    pub fn config(mut self, config: GenerationConfig) -> Self {
        self.config = Some(config);
        self
    }

    /// Override the retry configuration for this request.
    pub fn retry_config(mut self, config: RetryConfig) -> Self {
        self.retry_config = Some(config);
        self
    }

    /// Disable retries for this request.
    pub fn no_retry(mut self) -> Self {
        self.retry_config = Some(RetryConfig::none());
        self
    }

    /// Set the prompt or conversation history for this request.
    ///
    /// Accepts anything convertible into a [`Prompt`]: a `&str`, a `String`, a
    /// single [`Message`], a `Vec<Message>`, or a full `Prompt` with multi-turn
    /// history and multimodal content.
    ///
    /// # Examples
    ///
    /// ```
    /// use rai_sdk::{Message, Prompt};
    ///
    /// // Each of these is accepted by `prompt()`.
    /// let _: Prompt = "a plain string".into();
    /// let _: Prompt = Message::user("a single message").into();
    /// let _: Prompt = vec![
    ///     Message::system("You are terse."),
    ///     Message::user("Explain lifetimes."),
    /// ]
    /// .into();
    ///
    /// // Or build one up explicitly.
    /// let _ = Prompt::single(Message::system("You are terse."))
    ///     .with_message(Message::user("Explain lifetimes."));
    /// ```
    pub fn prompt<P>(
        mut self,
        prompt: P,
    ) -> RequestBuilder<'a, PromptReady, RequestModelState, ClientModelState>
    where
        P: Into<Prompt>,
    {
        self.prompt = Some(prompt.into());
        self.with_prompt_state()
    }

    /// Replace inherited tools with a single request-specific tool.
    pub fn tool(mut self, tool: Tool) -> Self {
        match &mut self.tool_override {
            ToolOverride::Replace(tools) => tools.push(tool),
            _ => self.tool_override = ToolOverride::Replace(vec![tool]),
        }
        self
    }

    /// Replace inherited tools with a custom set for this request.
    pub fn tools<T>(mut self, tools: T) -> Self
    where
        T: IntoIterator<Item = Tool>,
    {
        let mut collected: Vec<_> = tools.into_iter().collect();

        match &mut self.tool_override {
            ToolOverride::Replace(existing) => existing.append(&mut collected),
            _ => self.tool_override = ToolOverride::Replace(collected),
        }

        self
    }

    /// Add one more tool while still keeping client-level tools.
    pub fn additional_tool(mut self, tool: Tool) -> Self {
        match &mut self.tool_override {
            ToolOverride::Replace(tools) => tools.push(tool),
            ToolOverride::Append(tools) => tools.push(tool),
            ToolOverride::Inherit => self.tool_override = ToolOverride::Append(vec![tool]),
            ToolOverride::None => self.tool_override = ToolOverride::Replace(vec![tool]),
        }
        self
    }

    /// Add several request-only tools while still keeping client-level tools.
    pub fn additional_tools<T>(mut self, tools: T) -> Self
    where
        T: IntoIterator<Item = Tool>,
    {
        let mut collected: Vec<_> = tools.into_iter().collect();

        match &mut self.tool_override {
            ToolOverride::Replace(existing) => existing.append(&mut collected),
            ToolOverride::Append(existing) => existing.append(&mut collected),
            ToolOverride::Inherit => self.tool_override = ToolOverride::Append(collected),
            ToolOverride::None => self.tool_override = ToolOverride::Replace(collected),
        }

        self
    }

    /// Disable all tools for this request, including client defaults.
    ///
    /// Also the way to stream from a client that has tools registered, since the
    /// streaming methods reject any request carrying tools.
    pub fn no_tools(mut self) -> Self {
        self.tool_override = ToolOverride::None;
        self
    }
}

impl<'a, PromptState, ClientModelState>
    RequestBuilder<'a, PromptState, ModelReady, ClientModelState>
{
    fn resolve(&self) -> Result<ResolvedRequest> {
        let model = self
            .model
            .clone()
            .or_else(|| self.client.default_model.clone())
            .expect("model-ready request builder must contain or inherit a model");

        let config = self
            .config
            .clone()
            .unwrap_or_else(|| self.client.default_config.clone());

        let tool_registry = match &self.tool_override {
            ToolOverride::Inherit => self.client.tool_registry.clone(),
            ToolOverride::Replace(tools) => {
                let mut registry = ToolRegistry::new();
                registry.extend(tools.clone())?;
                registry
            }
            ToolOverride::Append(tools) => {
                let mut registry = self.client.tool_registry.clone();
                registry.extend(tools.clone())?;
                registry
            }
            ToolOverride::None => ToolRegistry::new(),
        };

        let retry_config = self
            .retry_config
            .clone()
            .unwrap_or_else(|| self.client.default_retry_config.clone());

        Ok(ResolvedRequest {
            model,
            config,
            retry_config,
            tool_registry,
        })
    }
}

impl<'a, ClientModelState> RequestBuilder<'a, PromptReady, ModelReady, ClientModelState> {
    /// Generate a response, automatically executing any tool calls the model
    /// requests.
    ///
    /// This is the method you usually want. If tools are registered, it runs the
    /// loop — send, execute requested tools, append results, send again — until
    /// the model answers without asking for more tools. With no tools
    /// registered, it is a single call.
    ///
    /// Transient failures are retried according to the effective
    /// [`RetryConfig`].
    ///
    /// # Errors
    ///
    /// - [`Error::ProviderNotConfigured`] if the provider has no API key, or
    ///   [`Error::ProviderNotEnabled`] if its Cargo feature is off.
    /// - [`Error::ToolLoopLimitExceeded`] if the model keeps requesting tools
    ///   past [`GenerationConfig::with_max_tool_rounds`] (default 8).
    /// - [`Error::ToolNotFound`] if the model requests a tool that is not
    ///   registered.
    /// - [`Error::RateLimit`], [`Error::Timeout`], or [`Error::Http`] if the
    ///   request still fails after retries.
    /// - [`Error::Auth`], [`Error::InvalidRequest`], [`Error::ContentFiltered`],
    ///   or [`Error::Request`] for provider-side rejections.
    ///
    /// Note that a tool handler returning an error does *not* fail this call:
    /// the error is passed back to the model as tool content so it can react.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use rai_sdk::{ClientBuilder, Model};
    ///
    /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = ClientBuilder::new()
    ///     .from_env()
    ///     .model(Model::gpt4o_mini())
    ///     .build()?;
    ///
    /// let response = client
    ///     .request()
    ///     .prompt("Name one Rust testing crate.")
    ///     .generate()
    ///     .await?;
    ///
    /// println!("{}", response.text());
    /// if let Some(usage) = &response.usage {
    ///     println!("tokens: {:?}", usage.total_tokens);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn generate(self) -> Result<Response> {
        let resolved = self.resolve()?;
        let prompt = self
            .prompt
            .as_ref()
            .expect("prompt-ready request builder must contain a prompt");
        self.client
            .generate_with_tools(
                resolved.model,
                prompt,
                &resolved.config,
                &resolved.retry_config,
                &resolved.tool_registry,
            )
            .await
    }

    /// Make exactly one provider call, without executing tools.
    ///
    /// Tool *definitions* are still advertised to the model, so the response may
    /// contain tool calls — they are returned to you on the response messages
    /// instead of being executed. Use this when you want to inspect, gate, or
    /// approve tool calls, or drive the loop yourself.
    ///
    /// # Errors
    ///
    /// Same as [`generate`](Self::generate), except it cannot return
    /// [`Error::ToolLoopLimitExceeded`] or [`Error::ToolNotFound`], since no
    /// tool is executed.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use rai_sdk::{ClientBuilder, Model};
    ///
    /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
    /// # let client = ClientBuilder::new().from_env().model(Model::gpt4o_mini()).build()?;
    /// let response = client
    ///     .request()
    ///     .prompt("What is the weather in Paris?")
    ///     .generate_once()
    ///     .await?;
    ///
    /// for message in &response.messages {
    ///     for call in &message.tool_calls {
    ///         println!("requested {} with {}", call.name, call.arguments);
    ///     }
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn generate_once(self) -> Result<Response> {
        let resolved = self.resolve()?;
        let prompt = self
            .prompt
            .as_ref()
            .expect("prompt-ready request builder must contain a prompt");
        let tool_definitions =
            request_tool_definitions(&resolved.tool_registry, ToolAvailability::Enabled);

        crate::retry::with_retry(&resolved.retry_config, "generate_once", || {
            self.client.generate_once_internal(
                resolved.model.clone(),
                prompt,
                &resolved.config,
                tool_definitions.as_deref(),
            )
        })
        .await
    }

    /// Generate a response that must match the Rust type `T`.
    ///
    /// A JSON Schema is generated from `T` and sent to the provider, the
    /// response is validated against that schema, and only then deserialized.
    /// Tools still run as in [`generate`](Self::generate).
    ///
    /// `T` must be non-recursive: recursive types force `$ref`/`$defs`, which
    /// strict providers reject. See
    /// [`GenerationConfig::with_json_schema_for`].
    ///
    /// # Errors
    ///
    /// Everything [`generate`](Self::generate) can return, plus
    /// [`Error::StructuredOutput`] if the response is empty, is not valid JSON,
    /// fails schema validation, or does not deserialize into `T`.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use rai_sdk::{ClientBuilder, JsonSchema, Model};
    /// use serde::Deserialize;
    ///
    /// #[derive(Debug, Deserialize, JsonSchema)]
    /// struct Summary {
    ///     title: String,
    ///     bullet_points: Vec<String>,
    /// }
    ///
    /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
    /// # let client = ClientBuilder::new().from_env().model(Model::gpt4o_mini()).build()?;
    /// let structured = client
    ///     .request()
    ///     .prompt("Summarize the Rust ownership model.")
    ///     .generate_structured::<Summary>()
    ///     .await?;
    ///
    /// println!("{}", structured.output.title);
    /// for point in &structured.output.bullet_points {
    ///     println!("- {point}");
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn generate_structured<T>(self) -> Result<StructuredOutput<T>>
    where
        T: DeserializeOwned + JsonSchema,
    {
        let resolved = self.resolve()?;
        let prompt = self
            .prompt
            .as_ref()
            .expect("prompt-ready request builder must contain a prompt");
        let config = structured_config_for::<T>(&resolved.config)?;
        let response = self
            .client
            .generate_with_tools(
                resolved.model,
                prompt,
                &config,
                &resolved.retry_config,
                &resolved.tool_registry,
            )
            .await?;

        parse_structured_output(response)
    }

    /// Make exactly one provider call and parse the result as `T`.
    ///
    /// Unlike [`generate_once`](Self::generate_once), configured tools are not
    /// even advertised to the model: they are ignored entirely (and a log line
    /// records that). Use this for a pure transformation on a client that
    /// happens to have tools registered.
    ///
    /// # Errors
    ///
    /// Same as [`generate_structured`](Self::generate_structured), minus the
    /// tool-loop errors.
    pub async fn generate_structured_once<T>(self) -> Result<StructuredOutput<T>>
    where
        T: DeserializeOwned + JsonSchema,
    {
        let resolved = self.resolve()?;
        let prompt = self
            .prompt
            .as_ref()
            .expect("prompt-ready request builder must contain a prompt");
        let config = structured_config_for::<T>(&resolved.config)?;
        let tool_definitions = request_tool_definitions(
            &resolved.tool_registry,
            ToolAvailability::IgnoredForStructuredOnce,
        );

        let response =
            crate::retry::with_retry(&resolved.retry_config, "generate_structured_once", || {
                self.client.generate_once_internal(
                    resolved.model.clone(),
                    prompt,
                    &config,
                    tool_definitions.as_deref(),
                )
            })
            .await?;

        parse_structured_output(response)
    }

    /// Generate a response with prior conversation turns prepended.
    ///
    /// A convenience over assembling the history into the [`Prompt`] yourself:
    /// each [`ConversationTurn`](crate::message::ConversationTurn) contributes
    /// its user message, assistant message, and any tool results, followed by
    /// this request's prompt. Tools run as in [`generate`](Self::generate).
    ///
    /// # Errors
    ///
    /// Same as [`generate`](Self::generate).
    pub async fn generate_with_history(
        self,
        history: &[crate::message::ConversationTurn],
    ) -> Result<Response> {
        let resolved = self.resolve()?;
        let prompt = self
            .prompt
            .as_ref()
            .expect("prompt-ready request builder must contain a prompt")
            .clone()
            .with_history(history.to_vec());

        self.client
            .generate_with_tools(
                resolved.model,
                &prompt,
                &resolved.config,
                &resolved.retry_config,
                &resolved.tool_registry,
            )
            .await
    }

    /// Stream the response as high-level [`StreamEvent`](crate::message::StreamEvent)s.
    ///
    /// Higher level than [`stream`](Self::stream): text deltas are passed
    /// through, tool-call argument fragments are buffered and emitted as whole
    /// calls, and a final `TurnComplete` event carries the assembled
    /// [`ConversationTurn`](crate::message::ConversationTurn) — convenient for
    /// feeding conversation history back into a later request.
    ///
    /// Registered tools are *not* executed; this only reports what the model
    /// asked for.
    ///
    /// # Errors
    ///
    /// Same as [`stream`](Self::stream), including [`Error::InvalidRequest`]
    /// when the request's effective tool set is non-empty. Once the stream is
    /// open, individual items may also be errors.
    pub async fn generate_stream_events(
        self,
    ) -> Result<impl Stream<Item = Result<crate::message::StreamEvent>> + Send> {
        let resolved = self.resolve()?;
        let prompt = self
            .prompt
            .as_ref()
            .expect("prompt-ready request builder must contain a prompt");

        ensure_streamable(&resolved.tool_registry)?;

        let mut stream = crate::retry::with_retry(&resolved.retry_config, "stream", || {
            self.client
                .generate_stream_inner(resolved.model.clone(), prompt, &resolved.config)
        })
        .await?;

        let user_message = prompt
            .messages
            .last()
            .cloned()
            .unwrap_or_else(|| crate::message::Message::user(""));

        let stream_events = async_stream::stream! {
            let mut accumulated_content = String::new();
            let mut current_tool_id: Option<String> = None;
            let mut current_tool_name: Option<String> = None;
            let mut current_tool_args = String::new();
            let mut tool_calls = Vec::new();

            while let Some(chunk_result) = stream.next().await {
                match chunk_result {
                    Ok(chunk) => {
                        match chunk {
                            crate::provider::ProviderStreamEvent::Text(text) => {
                                accumulated_content.push_str(&text);
                                yield Ok(crate::message::StreamEvent::TextDelta { text });
                            }
                            crate::provider::ProviderStreamEvent::ToolCallStart { id, name } => {
                                if let (Some(tid), Some(tname)) = (current_tool_id.take(), current_tool_name.take()) {
                                    let args_json = serde_json::from_str(&current_tool_args).unwrap_or(serde_json::Value::Null);
                                    tool_calls.push(crate::message::ToolCall {
                                        id: tid.clone(),
                                        name: tname.clone(),
                                        arguments: args_json,
                                    });
                                    yield Ok(crate::message::StreamEvent::ToolCall {
                                        id: tid,
                                        name: tname,
                                        arguments: current_tool_args.clone(),
                                    });
                                    current_tool_args.clear();
                                }
                                current_tool_id = Some(id);
                                current_tool_name = Some(name);
                            }
                            crate::provider::ProviderStreamEvent::ToolCallChunk { id: _, arguments } => {
                                current_tool_args.push_str(&arguments);
                            }
                            crate::provider::ProviderStreamEvent::Done { finish_reason: _, usage: _ } => {
                                if let (Some(tid), Some(tname)) = (current_tool_id.take(), current_tool_name.take()) {
                                    let args_json = serde_json::from_str(&current_tool_args).unwrap_or(serde_json::Value::Null);
                                    tool_calls.push(crate::message::ToolCall {
                                        id: tid.clone(),
                                        name: tname.clone(),
                                        arguments: args_json,
                                    });
                                    yield Ok(crate::message::StreamEvent::ToolCall {
                                        id: tid,
                                        name: tname,
                                        arguments: current_tool_args.clone(),
                                    });
                                }

                                let mut assistant_message = crate::message::Message::assistant(accumulated_content.clone());
                                assistant_message.tool_calls = tool_calls.clone();

                                let turn = crate::message::ConversationTurn {
                                    user_message: user_message.clone(),
                                    assistant_message,
                                    tool_results: Vec::new(),
                                };
                                yield Ok(crate::message::StreamEvent::TurnComplete { turn });
                            }
                        }
                    }
                    Err(e) => {
                        yield Err(e);
                    }
                }
            }
        };

        Ok(stream_events)
    }

    /// Stream raw provider events as they arrive.
    ///
    /// Use this to render output incrementally. Each item is a [`Result`], since
    /// a stream can fail partway through — do not discard the error case, or a
    /// mid-stream failure will look like a clean end of output.
    ///
    /// # Errors
    ///
    /// Returns [`Error::InvalidRequest`] if the request would carry any tool,
    /// because streaming cannot run a tool loop. This considers the request's
    /// effective tool set, so [`no_tools`](Self::no_tools) lets you stream from
    /// a client that has tools registered, and [`tool`](Self::tool) on the
    /// request is rejected even when the client itself has none.
    ///
    /// Otherwise the same causes as [`Client::generate_stream`]:
    /// [`Error::ProviderNotConfigured`], [`Error::ProviderNotEnabled`], or a
    /// transport or provider failure. Once the stream is open, individual items
    /// may also be errors.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use futures::StreamExt;
    /// use rai_sdk::{ClientBuilder, Model, provider::ProviderStreamEvent};
    ///
    /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
    /// # let client = ClientBuilder::new().from_env().model(Model::gpt4o_mini()).build()?;
    /// let mut stream = client
    ///     .request()
    ///     .prompt("Count from one to five.")
    ///     .stream()
    ///     .await?;
    ///
    /// while let Some(event) = stream.next().await {
    ///     match event? {
    ///         ProviderStreamEvent::Text(text) => print!("{text}"),
    ///         ProviderStreamEvent::Done { .. } => println!(),
    ///         _ => {}
    ///     }
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn stream(
        self,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<crate::provider::ProviderStreamEvent>> + Send>>>
    {
        let resolved = self.resolve()?;
        let prompt = self
            .prompt
            .as_ref()
            .expect("prompt-ready request builder must contain a prompt");

        ensure_streamable(&resolved.tool_registry)?;

        crate::retry::with_retry(&resolved.retry_config, "stream", || {
            self.client
                .generate_stream_inner(resolved.model.clone(), prompt, &resolved.config)
        })
        .await
    }

    /// Stream internally and return one complete [`Response`].
    ///
    /// Uses the streaming transport (lower time-to-first-byte, and less likely
    /// to sit near a timeout on long generations) but consumes every chunk for
    /// you, so the result is shaped exactly like [`generate`](Self::generate).
    /// Reach for this when you want streaming's latency behavior without
    /// handling events.
    ///
    /// Only text and the terminating event are accumulated, so tool calls are
    /// not represented in the returned response.
    ///
    /// # Errors
    ///
    /// Same as [`stream`](Self::stream), including [`Error::InvalidRequest`]
    /// when the request's effective tool set is non-empty, plus any error
    /// encountered while consuming the stream.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use rai_sdk::{ClientBuilder, Model};
    ///
    /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
    /// # let client = ClientBuilder::new().from_env().model(Model::gpt4o_mini()).build()?;
    /// let response = client
    ///     .request()
    ///     .prompt("Write a short launch announcement.")
    ///     .stream_accumulated()
    ///     .await?;
    ///
    /// println!("{}", response.text());
    /// # Ok(())
    /// # }
    /// ```
    pub async fn stream_accumulated(self) -> Result<Response> {
        let resolved = self.resolve()?;
        let prompt = self
            .prompt
            .as_ref()
            .expect("prompt-ready request builder must contain a prompt");

        ensure_streamable(&resolved.tool_registry)?;

        let model_str = resolved.model.as_str().to_string();
        let provider = resolved.model.provider();

        let mut stream = crate::retry::with_retry(&resolved.retry_config, "stream", || {
            self.client
                .generate_stream_inner(resolved.model.clone(), prompt, &resolved.config)
        })
        .await?;

        let mut accumulated_content = String::new();
        let mut finish_reason = None;
        let mut usage = None;

        while let Some(chunk_result) = stream.next().await {
            let chunk = chunk_result?;
            match chunk {
                crate::provider::ProviderStreamEvent::Text(text) => {
                    accumulated_content.push_str(&text);
                }
                crate::provider::ProviderStreamEvent::Done {
                    finish_reason: fr,
                    usage: u,
                } => {
                    if fr.is_some() {
                        finish_reason = fr;
                    }
                    if u.is_some() {
                        usage = u;
                    }
                }
                _ => {}
            }
        }

        Ok(Response {
            messages: vec![Message::assistant(accumulated_content)],
            usage,
            model: model_str,
            provider,
            finish_reason,
        })
    }
}

/// Reject a streaming request when tools are in play.
///
/// Streaming has no way to execute a tool loop, since that requires issuing
/// follow-up requests. Failing loudly is better than quietly dropping tools the
/// caller registered.
fn ensure_streamable(tool_registry: &ToolRegistry) -> Result<()> {
    if tool_registry.is_empty() {
        return Ok(());
    }

    Err(Error::InvalidRequest(
        "Streaming with tools is not supported. Use generate() to run tools, \
         or no_tools() on the request to stream without them."
            .into(),
    ))
}

fn request_tool_definitions(
    tool_registry: &ToolRegistry,
    availability: ToolAvailability,
) -> Option<Vec<ToolDefinition>> {
    if tool_registry.is_empty() {
        return None;
    }

    match availability {
        ToolAvailability::Enabled => Some(tool_registry.definitions()),
        ToolAvailability::IgnoredForStructuredOnce => {
            info!(
                tool_count = tool_registry.definitions().len(),
                "Ignoring configured tools for generate_structured_once; use generate_structured for tool loops"
            );
            None
        }
    }
}

fn structured_config_for<T>(config: &GenerationConfig) -> Result<GenerationConfig>
where
    T: JsonSchema,
{
    let mut config = config.clone();
    config.json_schema = Some(structured_schema_for::<T>()?);
    Ok(config)
}

fn parse_structured_output<T>(response: Response) -> Result<StructuredOutput<T>>
where
    T: DeserializeOwned + JsonSchema,
{
    let provider = response.provider;
    let model = response.model.clone();
    let content = response
        .messages
        .first()
        .map(|message| message.content.trim())
        .unwrap_or_default();

    if content.is_empty() {
        error!(provider = %provider, model = %model, "Structured output was empty");
        return Err(Error::StructuredOutput {
            provider,
            model,
            message: "response content was empty".to_string(),
        });
    }

    let instance = serde_json::from_str::<serde_json::Value>(content).map_err(|parse_error| {
        error!(
            provider = %provider,
            model = %model,
            error = %parse_error,
            response_content = %content,
            "Structured output was not valid JSON"
        );
        Error::StructuredOutput {
            provider,
            model: model.clone(),
            message: parse_error.to_string(),
        }
    })?;

    let schema = structured_schema_for::<T>()?;

    if let Err(validation_error) = jsonschema::validate(&schema, &instance) {
        error!(
            provider = %provider,
            model = %model,
            error = %validation_error,
            response_content = %content,
            response_schema = ?schema,
            "Structured output failed JSON schema validation"
        );
        return Err(Error::StructuredOutput {
            provider,
            model,
            message: validation_error.to_string(),
        });
    }

    match serde_json::from_str::<T>(content) {
        Ok(output) => {
            debug!(
                provider = %provider,
                model = %model,
                output_type = %type_name::<T>(),
                "Structured output validated successfully"
            );
            Ok(StructuredOutput { output, response })
        }
        Err(parse_error) => {
            error!(
                provider = %provider,
                model = %model,
                error = %parse_error,
                response_content = %content,
                "Structured output validation failed"
            );
            Err(Error::StructuredOutput {
                provider,
                model,
                message: parse_error.to_string(),
            })
        }
    }
}

fn structured_schema_for<T>() -> Result<serde_json::Value>
where
    T: JsonSchema,
{
    GenerationConfig::new()
        .with_json_schema_for::<T>()
        .map(|config| {
            config
                .json_schema
                .expect("structured schema should be present")
        })
}

/// Builder for creating a [`Client`].
///
/// Set credentials (usually with [`from_env`](Self::from_env)), then optionally
/// a default model, generation config, retry policy, and shared tools, and
/// finish with [`build`](Self::build).
///
/// Explicit setters win over the environment regardless of chain order relative
/// to `from_env()`, because `from_env()` replaces the accumulated config — so
/// call it first.
///
/// # Examples
///
/// ```no_run
/// use std::time::Duration;
///
/// use rai_sdk::{ClientBuilder, GenerationConfig, Model, RetryConfig};
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = ClientBuilder::new()
///     .from_env()
///     .model(Model::gpt4o_mini())
///     .config(GenerationConfig::new().with_max_tokens(1024))
///     .retry_config(RetryConfig::new().with_initial_delay(Duration::from_millis(250)))
///     .timeout(60)
///     .build()?;
/// # let _ = client;
/// # Ok(())
/// # }
/// ```
pub struct ClientBuilder<ModelState = ModelMissing> {
    config: Config,
    default_model: Option<Model>,
    default_config: GenerationConfig,
    default_retry_config: RetryConfig,
    tools: Vec<Tool>,
    state: PhantomData<ModelState>,
}

impl<ModelState> std::fmt::Debug for ClientBuilder<ModelState> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("ClientBuilder")
            .field("default_model", &self.default_model)
            .field("default_config", &self.default_config)
            .field("tools_count", &self.tools.len())
            .finish()
    }
}

impl ClientBuilder<ModelMissing> {
    /// Start a client builder.
    pub fn new() -> Self {
        Self {
            config: Config::new(),
            default_model: None,
            default_config: GenerationConfig::default(),
            default_retry_config: RetryConfig::default(),
            tools: Vec::new(),
            state: PhantomData,
        }
    }
}

impl<ModelState> ClientBuilder<ModelState> {
    fn with_state<NextModelState>(self) -> ClientBuilder<NextModelState> {
        ClientBuilder {
            config: self.config,
            default_model: self.default_model,
            default_config: self.default_config,
            default_retry_config: self.default_retry_config,
            tools: self.tools,
            state: PhantomData,
        }
    }

    /// Load configuration from environment variables.
    ///
    /// Reads the API keys, base URLs, timeout, and retry variables documented in
    /// [`config`](crate::config). This **replaces** any configuration already
    /// accumulated on the builder, so call it first and then override
    /// individual values.
    pub fn from_env(mut self) -> Self {
        self.config = Config::from_env();
        self.default_retry_config = self.config.retry_config();
        self
    }

    /// Set the OpenAI API key.
    pub fn openai_key(mut self, key: impl Into<String>) -> Self {
        self.config.openai_api_key = Some(key.into());
        self
    }

    /// Set the OpenAI base URL.
    pub fn openai_base_url(mut self, url: impl Into<String>) -> Self {
        self.config.openai_base_url = Some(url.into());
        self
    }

    /// Set the Anthropic API key.
    pub fn anthropic_key(mut self, key: impl Into<String>) -> Self {
        self.config.anthropic_api_key = Some(key.into());
        self
    }

    /// Set the Anthropic base URL.
    pub fn anthropic_base_url(mut self, url: impl Into<String>) -> Self {
        self.config.anthropic_base_url = Some(url.into());
        self
    }

    /// Set the OpenRouter API key.
    pub fn openrouter_key(mut self, key: impl Into<String>) -> Self {
        self.config.openrouter_api_key = Some(key.into());
        self
    }

    /// Set the OpenRouter base URL.
    pub fn openrouter_base_url(mut self, url: impl Into<String>) -> Self {
        self.config.openrouter_base_url = Some(url.into());
        self
    }

    /// Set the OpenRouter HTTP referer attribution header.
    pub fn openrouter_http_referer(mut self, referer: impl Into<String>) -> Self {
        self.config.openrouter_http_referer = Some(referer.into());
        self
    }

    /// Set the OpenRouter title attribution header.
    pub fn openrouter_title(mut self, title: impl Into<String>) -> Self {
        self.config.openrouter_title = Some(title.into());
        self
    }

    /// Set OpenRouter app categories attribution header.
    pub fn openrouter_categories(mut self, categories: Vec<String>) -> Self {
        self.config.openrouter_categories = Some(categories);
        self
    }

    /// Set the OpenRouter App URL.
    pub fn openrouter_app_url(mut self, url: impl Into<String>) -> Self {
        let url = url.into();
        self.config.openrouter_app_url = Some(url.clone());
        self.config.openrouter_http_referer = Some(url);
        self
    }

    /// Set the OpenRouter App Title.
    pub fn openrouter_app_title(mut self, title: impl Into<String>) -> Self {
        let title = title.into();
        self.config.openrouter_app_title = Some(title.clone());
        self.config.openrouter_title = Some(title);
        self
    }

    /// Set the request timeout.
    pub fn timeout(mut self, seconds: u64) -> Self {
        self.config.timeout_seconds = Some(seconds);
        self
    }

    /// Set the default model used by request builders.
    ///
    /// This also moves the builder into the model-ready state, so the resulting
    /// client can start requests that need only a prompt. Individual requests
    /// can still override it with [`RequestBuilder::model`].
    pub fn model(mut self, model: Model) -> ClientBuilder<ModelReady> {
        self.default_model = Some(model);
        self.with_state()
    }

    /// Set the default generation config used by request builders.
    pub fn config(mut self, config: GenerationConfig) -> Self {
        self.default_config = config;
        self
    }

    /// Set the default retry configuration for all requests.
    pub fn retry_config(mut self, config: RetryConfig) -> Self {
        self.default_retry_config = config;
        self
    }

    /// Disable retries by default for all requests.
    pub fn no_retry(mut self) -> Self {
        self.default_retry_config = RetryConfig::none();
        self
    }

    /// Register a tool that [`RequestBuilder::generate`] may auto-execute.
    ///
    /// Client-level tools are available to every request. Requests that stream
    /// must opt out with [`RequestBuilder::no_tools`], since streaming cannot
    /// run a tool loop; see [`RequestBuilder::stream`].
    pub fn tool(mut self, tool: Tool) -> Self {
        self.tools.push(tool);
        self
    }

    /// Register multiple tools to be auto-executed by `generate()`.
    pub fn tools<T>(mut self, tools: T) -> Self
    where
        T: IntoIterator<Item = Tool>,
    {
        self.tools.extend(tools);
        self
    }

    /// Build the client.
    ///
    /// Providers with credentials are initialized; providers without them are
    /// left unavailable rather than causing a failure, so this succeeds even if
    /// only one key is present.
    ///
    /// # Errors
    ///
    /// - [`Error::InvalidRequest`] if two registered tools share a name, or a
    ///   tool's input schema is invalid.
    /// - An error if a provider's HTTP client cannot be constructed.
    pub fn build(self) -> Result<Client<ModelState>> {
        let mut tool_registry = ToolRegistry::new();
        tool_registry.extend(self.tools)?;
        Client::new_with_defaults(
            self.config,
            self.default_model,
            self.default_config,
            self.default_retry_config,
            tool_registry,
        )
    }
}

impl Default for ClientBuilder<ModelMissing> {
    fn default() -> Self {
        Self::new()
    }
}