Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

adapter-fallback-demo.ts

246 lines7.1 KB

1/**
2 * ADAPTER FALLBACK DEMONSTRATION
3 *
4 * This example shows how to use the fallback feature to automatically
5 * try multiple adapters in order when one fails (rate limits, errors, downtime).
6 *
7 * NEW API: Each fallback now specifies both adapter name AND model
8 *
9 * NOTE: This demo file has been updated to use the new fallbacks API.
10 * For a complete example, see fallbacks-with-models-example.ts
11 */
13import { AI } from "../packages/ai/src";
14import { OpenAIAdapter } from "../packages/ai-openai/src";
15import { AnthropicAdapter } from "../packages/ai-anthropic/src";
16import { OllamaAdapter } from "../packages/ai-ollama/src";
18// ============================================
19// EXAMPLE 1: Global Fallback Configuration in Constructor
20// ============================================
22const ai = new AI({
23 adapters: {
24 primary: new OpenAIAdapter({
25 apiKey: process.env.OPENAI_API_KEY || "",
26 }),
27 secondary: new AnthropicAdapter({
28 apiKey: process.env.ANTHROPIC_API_KEY || "",
29 }),
30 tertiary: new OllamaAdapter({
31 host: "http://localhost:11434",
32 }),
33 },
34 // Global fallback configuration - each specifies adapter AND model
35 fallbacks: [
36 { adapter: "primary", model: "gpt-4" },
37 { adapter: "secondary", model: "claude-3-5-sonnet-20241022" },
38 { adapter: "tertiary", model: "llama2" },
39 ],
40});
42/**
43 * Using global fallback configuration from constructor
44 * If primary fails, tries secondary, then tertiary
45 */
46async function exampleGlobalFallback() {
47 try {
48 const result = await ai.chat({
49 fallbacks: [], // Empty array means use global fallbacks
50 messages: [
51 {
52 role: "user",
53 content: "What is TypeScript?",
54 },
55 ],
56 });
58 console.log("✅ Success:", result.content);
59 } catch (error: any) {
60 console.error("❌ All fallbacks failed:", error.message);
61 }
62}
64// ============================================
65// EXAMPLE 2: Per-Request Fallback Override
66// ============================================
68/**
69 * Override global fallback configuration for specific requests
70 * This request will try: secondary -> primary -> tertiary
71 */
72async function exampleCustomFallback() {
73 try {
74 const result = await ai.chat({
75 fallbacks: [
76 { adapter: "secondary", model: "claude-3-haiku-20240307" }, // Try Anthropic first
77 { adapter: "primary", model: "gpt-3.5-turbo" }, // Then OpenAI
78 { adapter: "tertiary", model: "llama3" }, // Finally Ollama
79 ],
80 messages: [
81 {
82 role: "user",
83 content: "Explain rate limiting",
84 },
85 ],
86 });
88 console.log("✅ Success:", result.content);
89 } catch (error: any) {
90 console.error("❌ All fallbacks failed:", error.message);
91 }
92}
94// ============================================
95// EXAMPLE 3: Single Adapter Mode (No Fallback)
96// ============================================
98/**
99 * Use a specific adapter without fallback
100 * If it fails, the error is thrown immediately
101 */
102async function exampleSingleAdapter() {
103 try {
104 const result = await ai.chat({
105 adapter: "primary", // ✅ Type-safe: must be "primary" | "secondary" | "tertiary"
106 model: "gpt-4", // ✅ Type-safe: must be valid for "primary" adapter
107 messages: [
108 {
109 role: "user",
110 content: "What is 2+2?",
111 },
112 ],
113 });
115 console.log("✅ Primary adapter success:", result.content);
116 } catch (error: any) {
117 console.error("❌ Primary adapter failed:", error.message);
118 }
119}
121// ============================================
122// EXAMPLE 4: Different Models Per Adapter
123// ============================================
125/**
126 * Use different models optimized for each adapter
127 */
128async function exampleDifferentModelsPerAdapter() {
129 try {
130 const result = await ai.chat({
131 fallbacks: [
132 { adapter: "primary", model: "gpt-4o" }, // Latest OpenAI model
133 { adapter: "secondary", model: "claude-3-5-sonnet-20241022" }, // Anthropic's best
134 { adapter: "tertiary", model: "llama3" }, // Local fallback
135 ],
136 messages: [
137 {
138 role: "user",
139 content: "Summarize the concept of machine learning",
140 },
141 ],
142 });
144 console.log("✅ Success:", result.content);
145 } catch (error: any) {
146 console.error("❌ All fallbacks failed:", error.message);
147 }
148}
150// ============================================
151// EXAMPLE 5: Type Safety Demo
152// ============================================
154/**
155 * TypeScript enforces that models match their adapters
156 */
157function demonstrateTypeSafety() {
158 // ✅ Valid - model matches adapter
159 ai.chat({
160 fallbacks: [
161 { adapter: "primary", model: "gpt-4" }, // OpenAI model with OpenAI adapter
162 { adapter: "secondary", model: "claude-3-5-sonnet-20241022" }, // Claude model with Anthropic adapter
163 ],
164 messages: [{ role: "user", content: "Hello" }],
165 });
167 // ❌ This would be a TypeScript error:
168 // ai.chat({
169 // fallbacks: [
170 // { adapter: "primary", model: "claude-3-5-sonnet-20241022" }, // ERROR: Claude model with OpenAI adapter
171 // ],
172 // messages: [{ role: "user", content: "Hello" }],
173 // });
174}
176// ============================================
177// EXAMPLE 6: Without Global Fallbacks
178// ============================================
180const aiNoGlobalFallback = new AI({
181 adapters: {
182 openai: new OpenAIAdapter({
183 apiKey: process.env.OPENAI_API_KEY || "",
184 }),
185 anthropic: new AnthropicAdapter({
186 apiKey: process.env.ANTHROPIC_API_KEY || "",
187 }),
188 },
189 // No global fallbacks configured
190});
192async function exampleWithoutGlobalFallback() {
193 try {
194 // Must provide fallbacks in each request
195 const result = await aiNoGlobalFallback.chat({
196 fallbacks: [
197 { adapter: "openai", model: "gpt-4" },
198 { adapter: "anthropic", model: "claude-3-5-sonnet-20241022" },
199 ],
200 messages: [
201 {
202 role: "user",
203 content: "What is AI?",
204 },
205 ],
206 });
208 console.log("✅ Success:", result.content);
209 } catch (error: any) {
210 console.error("❌ All fallbacks failed:", error.message);
211 }
212}
214// ============================================
215// RUN ALL EXAMPLES
216// ============================================
218async function main() {
219 console.log("=".repeat(60));
220 console.log("ADAPTER FALLBACK EXAMPLES");
221 console.log("=".repeat(60));
223 console.log("\n1. Global Fallback:");
224 await exampleGlobalFallback();
226 console.log("\n2. Custom Fallback Order:");
227 await exampleCustomFallback();
229 console.log("\n3. Single Adapter (No Fallback):");
230 await exampleSingleAdapter();
232 console.log("\n4. Different Models Per Adapter:");
233 await exampleDifferentModelsPerAdapter();
235 console.log("\n5. Type Safety:");
236 demonstrateTypeSafety();
238 console.log("\n6. Without Global Fallback:");
239 await exampleWithoutGlobalFallback();
241 console.log("\n" + "=".repeat(60));
242 console.log("✅ All examples complete!");
243 console.log("=".repeat(60));
244}
246main().catch(console.error);