whio-api-sdk 1.0.177-beta → 1.0.179-beta

package/README.md

@@ -1,2 +1,85 @@
 # whio-sdk
 A JS SDK that interacts with our medical-assistant-api 
+
+## Audio Transcription Queue
+
+The SDK now supports automatic audio transcription through a background queue system. When you upload audio files, they are automatically processed and transcribed.
+
+### Upload Audio with Transcription Queue
+
+```typescript
+import { ApiSDK, AudioFileStatus } from 'whio-sdk';
+
+const sdk = new ApiSDK({ baseUrl: 'https://your-api.com' });
+
+// Simple upload (automatically triggers transcription)
+const audioFile = await sdk.uploadAudioFileToSession(sessionId, file);
+
+// Upload with cultural context
+const audioFileWithContext = await sdk.uploadAudioFileToSession(
+  sessionId, 
+  file, 
+  'audio.mp3', 
+  'This is cultural context for the audio'
+);
+
+// Alternative method with options object
+const audioFileAlt = await sdk.uploadAudioFileWithTranscriptionQueue(sessionId, file, {
+  fileName: 'recording.mp3',
+  culturalTranscription: 'Patient discussing symptoms in Māori'
+});
+```
+
+### Check Transcription Results
+
+```typescript
+// Get specific audio file with transcription results
+const audioFile = await sdk.getAudioFile(audioFileId);
+
+if (audioFile.status === AudioFileStatus.TRANSCRIBED) {
+  console.log('Transcription:', audioFile.transcription);
+  console.log('Cultural Context:', audioFile.cultural_transcription);
+}
+
+// Get all transcribed files
+const transcribedFiles = await sdk.getTranscribedAudioFiles();
+
+// Get files currently being processed
+const processingFiles = await sdk.getProcessingAudioFiles();
+
+// Get failed transcriptions
+const failedFiles = await sdk.getFailedAudioFiles();
+```
+
+### Audio File Status
+
+Audio files have the following status values:
+- `UPLOADED` - File uploaded, waiting for transcription
+- `PROCESSING` - Currently being transcribed
+- `TRANSCRIBED` - Transcription complete
+- `FAILED` - Transcription failed
+
+### Key Features
+
+- **Automatic Processing**: Upload triggers transcription automatically
+- **Serial Processing**: Files are processed one at a time for reliability
+- **Cultural Context**: Optional cultural transcription field for context
+- **Status Tracking**: Monitor transcription progress
+- **Error Handling**: Graceful handling of transcription failures
+- **Fire and Forget**: No polling required - just upload and check later
+
+### Example Usage
+
+```typescript
+// Upload and get immediate response
+const audioFile = await sdk.uploadAudioFileToSession(sessionId, audioBlob, 'recording.wav');
+console.log('Status:', audioFile.status); // 'UPLOADED'
+
+// Check later for transcription results
+setTimeout(async () => {
+  const updatedFile = await sdk.getAudioFile(audioFile.id);
+  if (updatedFile.status === AudioFileStatus.TRANSCRIBED) {
+    console.log('Transcription ready:', updatedFile.transcription);
+  }
+}, 10000); // Check after 10 seconds
+```

package/dist/src/sdk/sdk.d.ts

@@ -39,9 +39,9 @@ export declare class ApiSDK {
     getTemplates(): Promise<Template[]>;
     getTemplatesByOrganization(): Promise<Template[]>;
     getUserTemplates(): Promise<UserTemplate[]>;
-    generateTranscriptionSummary(transcript: string, templateId: string, sessionId: string): Promise<TranscriptionSummary>;
+    generateTranscriptionSummary(templateId: string, sessionId: string): Promise<TranscriptionSummary>;
     getByOrganizationTranscriptionSummaries(organizationId: string): Promise<TranscriptionSummary[]>;
-    generateTranscriptionSummaryFromUserTemplate(transcript: string, userTemplateId: string): Promise<TranscriptionSummary>;
+    generateTranscriptionSummaryFromUserTemplate(userTemplateId: string, sessionId: string): Promise<TranscriptionSummary>;
     updateTranscriptionSummary(id: string, content: string): Promise<TranscriptionSummary>;
     uploadLargeAudioFile(formData: FormData): Promise<string>;
     uploadAudioFile(formData: FormData): Promise<TranscriptionAudioUploadResponse | null>;
@@ -102,7 +102,11 @@ export declare class ApiSDK {
     getAgentSettingsByAgentAndOrganization(agentId: string, organizationId: string): Promise<AgentSettings>;
     updateAgentSettings(id: string, settingsData: UpdateAgentSettingsDto): Promise<AgentSettings>;
     deleteAgentSettings(id: string): Promise<void>;
-    uploadAudioFileToSession(sessionId: string, file: File | Blob, fileName?: string): Promise<AudioFile>;
+    uploadAudioFileToSession(sessionId: string, file: File | Blob, fileName?: string, culturalTranscription?: string): Promise<AudioFile>;
+    uploadAudioFileWithTranscriptionQueue(sessionId: string, file: File | Blob, options?: {
+        fileName?: string;
+        culturalTranscription?: string;
+    }): Promise<AudioFile>;
     getMyAudioFiles(): Promise<AudioFile[]>;
     getAllAudioFiles(): Promise<AudioFile[]>;
     getOrganizationAudioFiles(): Promise<AudioFile[]>;
@@ -112,4 +116,7 @@ export declare class ApiSDK {
     deleteAudioFile(id: string): Promise<void>;
     downloadAudioFile(id: string): Promise<Blob>;
     downloadAudioFileAsUrl(id: string): Promise<string>;
+    getTranscribedAudioFiles(): Promise<AudioFile[]>;
+    getProcessingAudioFiles(): Promise<AudioFile[]>;
+    getFailedAudioFiles(): Promise<AudioFile[]>;
 }

package/dist/src/sdk/sdk.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 // sdk.ts
-import { OrganizationRoleType, } from './types';
+import { OrganizationRoleType, AudioFileStatus, } from './types';
 import urls from './urls';
 import { jwtDecode } from 'jwt-decode';
 export class ApiSDK {
@@ -365,10 +365,9 @@ export class ApiSDK {
     // ======================
     // trANSCRIPTION SUMMARY METHODS
     // ====================== 
-    generateTranscriptionSummary(transcript, templateId, sessionId) {
+    generateTranscriptionSummary(templateId, sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             const generateSummaryDto = {
-                transcript,
                 templateId,
                 userId: this.user.id,
                 fromUserTemplate: false,
@@ -383,13 +382,13 @@ export class ApiSDK {
             return this.request(`${urls.transcriptionSummaries}/organization/${organizationId}`, 'GET');
         });
     }
-    generateTranscriptionSummaryFromUserTemplate(transcript, userTemplateId) {
+    generateTranscriptionSummaryFromUserTemplate(userTemplateId, sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             const generateSummaryDto = {
-                transcript,
                 templateId: userTemplateId,
                 userId: this.user.id,
                 fromUserTemplate: true,
+                sessionId: sessionId,
             };
             const transcriptionSummary = yield this.request(urls.transcriptionSummary, 'POST', generateSummaryDto);
             return transcriptionSummary;
@@ -766,10 +765,24 @@ export class ApiSDK {
     // ======================
     // AUDIO FILE METHODS
     // ======================
-    uploadAudioFileToSession(sessionId, file, fileName) {
+    uploadAudioFileToSession(sessionId, file, fileName, culturalTranscription) {
         return __awaiter(this, void 0, void 0, function* () {
             const formData = new FormData();
             formData.append('file', file, fileName);
+            if (culturalTranscription) {
+                formData.append('cultural_transcription', culturalTranscription);
+            }
+            return this.fileUploadRequest(`${urls.audioFiles}/upload/${sessionId}`, formData);
+        });
+    }
+    uploadAudioFileWithTranscriptionQueue(sessionId, file, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const formData = new FormData();
+            formData.append('file', file, options === null || options === void 0 ? void 0 : options.fileName);
+            if (options === null || options === void 0 ? void 0 : options.culturalTranscription) {
+                formData.append('cultural_transcription', options.culturalTranscription);
+            }
+            // This will automatically trigger the transcription queue
             return this.fileUploadRequest(`${urls.audioFiles}/upload/${sessionId}`, formData);
         });
     }
@@ -837,4 +850,25 @@ export class ApiSDK {
             return URL.createObjectURL(blob);
         });
     }
+    // ======================
+    // TRANSCRIPTION QUEUE HELPER METHODS
+    // ======================
+    getTranscribedAudioFiles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const audioFiles = yield this.getMyAudioFiles();
+            return audioFiles.filter(file => file.status === AudioFileStatus.TRANSCRIBED && file.transcription);
+        });
+    }
+    getProcessingAudioFiles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const audioFiles = yield this.getMyAudioFiles();
+            return audioFiles.filter(file => file.status === AudioFileStatus.PROCESSING);
+        });
+    }
+    getFailedAudioFiles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const audioFiles = yield this.getMyAudioFiles();
+            return audioFiles.filter(file => file.status === AudioFileStatus.FAILED);
+        });
+    }
 }

package/dist/src/sdk/types.d.ts

@@ -93,11 +93,10 @@ export interface UpdateTemplateDto {
     categoryId?: string;
 }
 export interface GenerateTranscriptionSummaryDto {
-    transcript?: string;
     templateId: string;
     userId?: string;
     fromUserTemplate?: boolean;
-    sessionId?: string;
+    sessionId: string;
 }
 export interface UpdateTranscriptionSummaryDto {
     anonymisedTranscript?: string;
@@ -270,6 +269,8 @@ export interface PasswordChangeResponse {
 export interface Session {
     id: string;
     transcript: string;
+    medicalTranscription?: string;
+    culturalTranscription?: string;
     dateTime: string;
     startDateTime?: string;
     stopDateTime?: string;
@@ -288,6 +289,8 @@ export interface Session {
 }
 export interface CreateSessionDto {
     transcript: string;
+    medicalTranscription?: string;
+    culturalTranscription?: string;
     dateTime: string;
     startDateTime?: string;
     stopDateTime?: string;
@@ -299,6 +302,8 @@ export interface CreateSessionDto {
 }
 export interface UpdateSessionDto {
     transcript?: string;
+    medicalTranscription?: string;
+    culturalTranscription?: string;
     dateTime?: string;
     startDateTime?: string;
     stopDateTime?: string;
@@ -343,6 +348,8 @@ export interface AudioFile {
     mimeType: string;
     uploadId?: string;
     transcriptionUrl?: string;
+    transcription?: string;
+    cultural_transcription?: string;
     status: AudioFileStatus;
     createdAt: string;
     updatedAt: string;
@@ -362,8 +369,13 @@ export interface CreateAudioFileDto {
 }
 export interface UpdateAudioFileDto {
     transcriptionUrl?: string;
+    transcription?: string;
+    cultural_transcription?: string;
     status?: AudioFileStatus;
 }
+export interface UploadAudioFileDto {
+    cultural_transcription?: string;
+}
 export interface AgentSettings {
     id: string;
     temperature: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whio-api-sdk",
-  "version": "1.0.177-beta",
+  "version": "1.0.179-beta",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/src/sdk/sdk.ts

@@ -44,6 +44,7 @@ import {
   AudioFileStatus,
   CreateAudioFileDto,
   UpdateAudioFileDto,
+  UploadAudioFileDto,
   AgentSettings,
   CreateAgentSettingsDto,
   UpdateAgentSettingsDto,
@@ -454,9 +455,8 @@ export class ApiSDK {
   // ====================== 
 
   public async generateTranscriptionSummary(
-    transcript: string, templateId: string, sessionId: string): Promise<TranscriptionSummary> {
+    templateId: string, sessionId: string): Promise<TranscriptionSummary> {
     const generateSummaryDto: GenerateTranscriptionSummaryDto = {
-      transcript,
       templateId,
       userId: this.user!.id,
       fromUserTemplate: false,
@@ -479,12 +479,12 @@ export class ApiSDK {
   }
 
   public async generateTranscriptionSummaryFromUserTemplate(
-    transcript: string, userTemplateId: string): Promise<TranscriptionSummary> {
+    userTemplateId: string, sessionId: string): Promise<TranscriptionSummary> {
     const generateSummaryDto: GenerateTranscriptionSummaryDto = {
-      transcript,
       templateId: userTemplateId,
       userId: this.user!.id,
       fromUserTemplate: true,
+      sessionId: sessionId,
     };
     const transcriptionSummary: TranscriptionSummary = await this.request(
       urls.transcriptionSummary,
@@ -832,10 +832,26 @@ export class ApiSDK {
   // AUDIO FILE METHODS
   // ======================
 
-  public async uploadAudioFileToSession(sessionId: string, file: File | Blob, fileName?: string): Promise<AudioFile> {
+  public async uploadAudioFileToSession(sessionId: string, file: File | Blob, fileName?: string, culturalTranscription?: string): Promise<AudioFile> {
     const formData = new FormData();
     formData.append('file', file, fileName);
     
+    if (culturalTranscription) {
+      formData.append('cultural_transcription', culturalTranscription);
+    }
+    
+    return this.fileUploadRequest<AudioFile>(`${urls.audioFiles}/upload/${sessionId}`, formData);
+  }
+
+  public async uploadAudioFileWithTranscriptionQueue(sessionId: string, file: File | Blob, options?: { fileName?: string; culturalTranscription?: string }): Promise<AudioFile> {
+    const formData = new FormData();
+    formData.append('file', file, options?.fileName);
+    
+    if (options?.culturalTranscription) {
+      formData.append('cultural_transcription', options.culturalTranscription);
+    }
+    
+    // This will automatically trigger the transcription queue
     return this.fileUploadRequest<AudioFile>(`${urls.audioFiles}/upload/${sessionId}`, formData);
   }
 
@@ -902,4 +918,23 @@ export class ApiSDK {
     return URL.createObjectURL(blob);
   }
 
+  // ======================
+  // TRANSCRIPTION QUEUE HELPER METHODS
+  // ======================
+
+  public async getTranscribedAudioFiles(): Promise<AudioFile[]> {
+    const audioFiles = await this.getMyAudioFiles();
+    return audioFiles.filter(file => file.status === AudioFileStatus.TRANSCRIBED && file.transcription);
+  }
+
+  public async getProcessingAudioFiles(): Promise<AudioFile[]> {
+    const audioFiles = await this.getMyAudioFiles();
+    return audioFiles.filter(file => file.status === AudioFileStatus.PROCESSING);
+  }
+
+  public async getFailedAudioFiles(): Promise<AudioFile[]> {
+    const audioFiles = await this.getMyAudioFiles();
+    return audioFiles.filter(file => file.status === AudioFileStatus.FAILED);
+  }
+
 }

package/src/sdk/types.ts

@@ -125,11 +125,10 @@ export interface UpdateTemplateDto {
 
 // Transcription summary generation DTO
 export interface GenerateTranscriptionSummaryDto {
-  transcript?: string;
   templateId: string;
   userId?: string;
   fromUserTemplate?: boolean;
-  sessionId?: string; // Optional session ID for linking to a session
+  sessionId: string; // Required session ID for linking to a session
 }
 
 // Transcription summary update DTO
@@ -345,6 +344,8 @@ export interface PasswordChangeResponse {
 export interface Session {
   id: string;
   transcript: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
   dateTime: string;
   startDateTime?: string;
   stopDateTime?: string;
@@ -367,6 +368,8 @@ export interface Session {
 // Session DTOs
 export interface CreateSessionDto {
   transcript: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
   dateTime: string;
   startDateTime?: string;
   stopDateTime?: string;
@@ -380,6 +383,8 @@ export interface CreateSessionDto {
 
 export interface UpdateSessionDto {
   transcript?: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
   dateTime?: string;
   startDateTime?: string;
   stopDateTime?: string;
@@ -434,6 +439,8 @@ export interface AudioFile {
   mimeType: string;
   uploadId?: string;
   transcriptionUrl?: string;
+  transcription?: string;
+  cultural_transcription?: string;
   status: AudioFileStatus;
   createdAt: string;
   updatedAt: string;
@@ -459,9 +466,16 @@ export interface CreateAudioFileDto {
 
 export interface UpdateAudioFileDto {
   transcriptionUrl?: string;
+  transcription?: string;
+  cultural_transcription?: string;
   status?: AudioFileStatus;
 }
 
+// Audio File Upload DTO (for transcription queue)
+export interface UploadAudioFileDto {
+  cultural_transcription?: string;
+}
+
 // Agent Settings types
 export interface AgentSettings {
   id: string;