Best Practices

1// ✅ Good - Environment variables
2const ai = AIModel.createFromEnv('openai');
3 
4// ✅ Good - Secure config service
5const ai = new AIModel({
6  apiKey: configService.getAIKey(),
7  provider: 'openai'
8});
9 
10// ❌ Avoid - Hardcoded keys
11const ai = new AIModel({
12  apiKey: 'sk-12345...',  // Don't do this!
13  provider: 'openai'
14});

1// ✅ Good - Comprehensive error handling
2try {
3  const response = await ai.sendTextMessage(userInput);
4  return response.content;
5} catch (error) {
6  if (error.message.includes('context length')) {
7    // Handle context window issues
8    await ai.clearMessages();
9    return await ai.sendTextMessage('Please summarize your previous question: ' + userInput);
10  }
11  throw error; // Re-throw unexpected errors
12}
13 
14// ❌ Avoid - Silent failures
15const response = await ai.sendTextMessage(input); // No error handling

1// ✅ Good - Monitor token usage
2const response = await ai.sendTextMessage(largeText);
3console.log(`Used ${response.usage.totalTokens} tokens`);
4 
5// Estimate costs (rough calculation)
6const cost = (response.usage.totalTokens / 1000) * 0.002; // Adjust per model
7console.log(`Estimated cost: $${cost.toFixed(4)}`);
8 
9// ❌ Avoid - Uncontrolled token usage
10// No monitoring of token consumption

1// ✅ Good - Manage context window
2function isConversationTooLong(ai: AIModel): boolean {
3  const messages = ai.getMessages();
4  const totalLength = messages.reduce((sum, msg) => {
5    return sum + (typeof msg.content === 'string' ? msg.content.length : 1000);
6  }, 0);
7  return totalLength > 8000; // Approximate token limit
8}
9 
10// Reset if conversation gets too long
11if (isConversationTooLong(ai)) {
12  ai.clearMessages();
13  ai.addSystemPrompt('Previous conversation was cleared due to length limits.');
14}