fix(core): Enhanced chat streaming and error handling across providers

ts/abstract.classes.multimodal.ts

@@ -1,32 +1,65 @@
+/**
+ * Message format for chat interactions
+ */
+export interface ChatMessage {
+  role: 'assistant' | 'user' | 'system';
+  content: string;
+}
+
+/**
+ * Options for chat interactions
+ */
+export interface ChatOptions {
+  systemMessage: string;
+  userMessage: string;
+  messageHistory: ChatMessage[];
+}
+
+/**
+ * Response format for chat interactions
+ */
+export interface ChatResponse {
+  role: 'assistant';
+  message: string;
+}
+
+/**
+ * Abstract base class for multi-modal AI models.
+ * Provides a common interface for different AI providers (OpenAI, Anthropic, Perplexity, Ollama)
+ */
 export abstract class MultiModalModel {
   /**
-   * starts the model
+   * Initializes the model and any necessary resources
+   * Should be called before using any other methods
    */
   abstract start(): Promise<void>;
   
   /**
-   * stops the model
+   * Cleans up any resources used by the model
+   * Should be called when the model is no longer needed
    */
   abstract stop(): Promise<void>;
 
-  public abstract chat(optionsArg: {
-    systemMessage: string,
-    userMessage: string,
-    messageHistory: {
-      role: 'assistant' | 'user';
-      content: string;
-    }[]
-  }): Promise<{
-    role: 'assistant';
-    message: string;
-  }>
+  /**
+   * Synchronous chat interaction with the model
+   * @param optionsArg Options containing system message, user message, and message history
+   * @returns Promise resolving to the assistant's response
+   */
+  public abstract chat(optionsArg: ChatOptions): Promise<ChatResponse>;
   
   /**
-   * Defines a streaming interface for chat interactions.
-   * The implementation will vary based on the specific AI model.
-   * @param input
+   * Streaming interface for chat interactions
+   * Allows for real-time responses from the model
+   * @param input Stream of user messages
+   * @returns Stream of model responses
    */
-  public abstract chatStream(input: ReadableStream<string>): Promise<ReadableStream<string>>;
-
+  public abstract chatStream(input: ReadableStream<Uint8Array>): Promise<ReadableStream<string>>;
 
+  /**
+   * Text-to-speech conversion
+   * @param optionsArg Options containing the message to convert to speech
+   * @returns Promise resolving to a readable stream of audio data
+   * @throws Error if the provider doesn't support audio generation
+   */
+  public abstract audio(optionsArg: { message: string }): Promise<NodeJS.ReadableStream>;
 }