@mate-academy/llm-gateway 1.3.1 → 1.3.2

package/README.md

@@ -35,6 +35,9 @@ import {
   LLMAssistanceService,
   LLMSpeechToTextService,
   LLMTextToSpeechService,
+  LLMRoles,
+  LLMMessageContentType,
+  LLMUploadFileMimeTypes,
 } from '@mate-academy/llm-gateway';
 
 // Define provider options
@@ -145,8 +148,8 @@ class MyUseCase {
     // Use completion service
     const completion = await this.llmCompletionService.sendMessage({
       message: {
-        role: 'user',
-        content: { type: 'text', text: prompt }
+        role: LLMRoles.User,
+        content: { type: LLMMessageContentType.TEXT, text: prompt }
       },
       model: this.getPreferredModel(),
     });
@@ -167,9 +170,12 @@ class MyUseCase {
   async generateSpeech(text) {
     // Use text-to-speech service
     const speech = await this.llmTextToSpeechService.createSpeech({
-      input: text,
+      text: text,
       model: this.getPreferredModel(),
-      voice: 'alloy', // OpenAI voice option
+      speechOptions: {
+        voice: 'alloy', // OpenAI voice option
+        response_format: 'mp3',
+      },
     });
 
     return speech;
@@ -183,13 +189,6 @@ class MyUseCase {
 }
 ```
 
-    this.llmAssistanceService = LLMServiceFactory.getAssistanceService(
-      config.llmProvider,
-      logger,
-      llmProviderOptions,
-    );
-  }
-
 ### Usage Examples
 
 #### Basic Text Completion
@@ -197,8 +196,8 @@ class MyUseCase {
 ```typescript
 const result = await completionService.sendMessage({
   message: {
-    role: 'user',
-    content: { type: 'text', text: 'Hello, how are you?' }
+    role: LLMRoles.User,
+    content: { type: LLMMessageContentType.TEXT, text: 'Hello, how are you?' }
   },
   model: preferredModel,
 });
@@ -211,9 +210,9 @@ console.log(result.text); // AI response
 ```typescript
 // Upload files for context
 const uploadedFile = await assistanceService.uploadFile({
-  filename: 'document.pdf',
-  content: fileBuffer,
-  mimeType: 'application/pdf',
+  name: 'document.txt',
+  path: '/path/to/document.txt',
+  mimeType: LLMUploadFileMimeTypes.PLAIN_TEXT,
 });
 
 // Create file storage
@@ -239,7 +238,6 @@ const chat = await assistanceService.createChat({
 const transcription = await speechToTextService.transcribe({
   pathToAudio: '/path/to/audio.mp3',
   model: preferredModel,
-  language: 'en', // optional
 });
 
 console.log(transcription.text); // Transcribed text
@@ -249,14 +247,16 @@ console.log(transcription.text); // Transcribed text
 
 ```typescript
 const speech = await textToSpeechService.createSpeech({
-  input: 'Hello, this will be converted to speech',
+  text: 'Hello, this will be converted to speech',
   model: preferredModel,
-  voice: 'alloy', // OpenAI voice option
-  response_format: 'mp3',
+  speechOptions: {
+    voice: 'alloy', // OpenAI voice option
+    response_format: 'mp3',
+  },
 });
 
 // Save audio buffer to file
-fs.writeFileSync('output.mp3', speech.audioBuffer);
+fs.writeFileSync('output.mp3', speech.audio);
 ```
 
 ## API Reference
@@ -313,9 +313,24 @@ Interface for chat/assistance services with file handling capabilities.
 #### Methods
 
 - `uploadFile(file)`: Upload a file to the LLM service
+  - Parameters: `LLMUploadFile` with `name`, `path`, and `mimeType`
+  - Returns: `Promise<LLMUploadFileResult>`
+- `deleteFile(fileId)`: Delete a file from the LLM service
 - `createFileStorage(options)`: Create a file storage for organizing files
+  - Parameters: `LLMCreateFileStorageOptions` with `uploadedFiles`, `model`, and optional `instructions`
+  - Returns: `Promise<LLMCreateFileStorageResult>`
+- `deleteFileStorage(fileStorageId)`: Delete a file storage
+- `createAssistant(options)`: Create an AI assistant with specific instructions
+  - Parameters: `LLMCreateAssistantOptions` with `model`, optional `instructions` and `storageIds`
+  - Returns: `Promise<LLMCreateAssistantResult>`
+- `deleteAssistant(assistantId)`: Delete an assistant
 - `createChat(options)`: Create a new chat/conversation
+  - Parameters: `LLMCreateChatOptions` with `model`, optional `instructions`, `history`, `files`, and `storageId`
+  - Returns: `Promise<LLMCreateChatResult>`
+- `deleteChat(chatId)`: Delete a chat
 - `assistInChat(options)`: Send a message in an existing chat and get an assistant response
+  - Parameters: `LLMAssistanceOptions` with `model`, `message`, `chatId`, and `assistantId`
+  - Returns: `Promise<LLMAssistanceResult>`
 
 ### LLMSpeechToTextService
 
@@ -341,7 +356,8 @@ Supports all service types: completion, assistance, speech-to-text, and text-to-
 
 **Available Models:**
 - GPT-4 models for completion and assistance
-- TTS models for text-to-speech
+- Whisper models for speech-to-text transcription
+- TTS models for text-to-speech generation
 
 ### Google Generative AI
 
@@ -823,8 +839,8 @@ export class YourProviderTextToSpeechService extends LLMTextToSpeechService<LLMP
     try {
       // Implement provider-specific speech creation logic
       return {
-        audioBuffer: Buffer.from('audio data'),
-        format: 'mp3',
+        audio: Buffer.from('audio data'),
+        mimeType: 'audio/mp3',
       };
     } catch (error) {
       this.logger.error('Error in YourProvider speech creation', { error });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mate-academy/llm-gateway",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "A gateway package for LLM services.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",