whio-api-sdk 1.0.176 → 1.0.178-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

@@ -1,4 +1,4 @@
-import { LoginResponse, LoginCredentials, SDKConfig, User, UpdateUserDto, Organization, TemplateCategory, Template, Team, UserTemplate, TranscriptionSummary, TranscriptionAudioUploadResponse, PasswordChangeResponse, Session, CreateSessionDto, UpdateSessionDto, Agent, AudioFile, UpdateAudioFileDto } from './types';
+import { LoginResponse, LoginCredentials, SDKConfig, User, UpdateUserDto, Organization, TemplateCategory, Template, Team, UserTemplate, TranscriptionSummary, TranscriptionAudioUploadResponse, PasswordChangeResponse, Session, CreateSessionDto, UpdateSessionDto, Agent, AudioFile, UpdateAudioFileDto, AgentSettings, CreateAgentSettingsDto, UpdateAgentSettingsDto } from './types';
 export declare class ApiSDK {
     private baseUrl;
     private storage;
@@ -96,7 +96,17 @@ export declare class ApiSDK {
     deleteAgent(id: string): Promise<void>;
     addAgentToOrganization(agentId: string, organizationId: string): Promise<void>;
     removeAgentFromOrganization(agentId: string, organizationId: string): Promise<void>;
-    uploadAudioFileToSession(sessionId: string, file: File | Blob, fileName?: string): Promise<AudioFile>;
+    createAgentSettings(settingsData: CreateAgentSettingsDto): Promise<AgentSettings>;
+    getAgentSettings(organizationId?: string, agentId?: string): Promise<AgentSettings[]>;
+    getAgentSettingsById(id: string): Promise<AgentSettings>;
+    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, 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[]>;
@@ -106,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 {
@@ -724,12 +724,66 @@ export class ApiSDK {
         });
     }
     // ======================
+    // AGENT SETTINGS METHODS
+    // ======================
+    createAgentSettings(settingsData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request(urls.agentSettings, 'POST', settingsData);
+        });
+    }
+    getAgentSettings(organizationId, agentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = new URLSearchParams();
+            if (organizationId)
+                params.append('organizationId', organizationId);
+            if (agentId)
+                params.append('agentId', agentId);
+            const queryString = params.toString();
+            const endpoint = queryString ? `${urls.agentSettings}?${queryString}` : urls.agentSettings;
+            return this.request(endpoint, 'GET');
+        });
+    }
+    getAgentSettingsById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request(`${urls.agentSettings}/${id}`, 'GET');
+        });
+    }
+    getAgentSettingsByAgentAndOrganization(agentId, organizationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request(`${urls.agentSettings}/agent/${agentId}/organization/${organizationId}`, 'GET');
+        });
+    }
+    updateAgentSettings(id, settingsData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request(`${urls.agentSettings}/${id}`, 'PATCH', settingsData);
+        });
+    }
+    deleteAgentSettings(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.request(`${urls.agentSettings}/${id}`, 'DELETE');
+        });
+    }
+    // ======================
     // 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);
         });
     }
@@ -797,4 +851,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

@@ -270,6 +270,8 @@ export interface PasswordChangeResponse {
 export interface Session {
     id: string;
     transcript: string;
+    medicalTranscription?: string;
+    culturalTranscription?: string;
     dateTime: string;
     startDateTime?: string;
     stopDateTime?: string;
@@ -288,6 +290,8 @@ export interface Session {
 }
 export interface CreateSessionDto {
     transcript: string;
+    medicalTranscription?: string;
+    culturalTranscription?: string;
     dateTime: string;
     startDateTime?: string;
     stopDateTime?: string;
@@ -299,6 +303,8 @@ export interface CreateSessionDto {
 }
 export interface UpdateSessionDto {
     transcript?: string;
+    medicalTranscription?: string;
+    culturalTranscription?: string;
     dateTime?: string;
     startDateTime?: string;
     stopDateTime?: string;
@@ -343,6 +349,8 @@ export interface AudioFile {
     mimeType: string;
     uploadId?: string;
     transcriptionUrl?: string;
+    transcription?: string;
+    cultural_transcription?: string;
     status: AudioFileStatus;
     createdAt: string;
     updatedAt: string;
@@ -362,5 +370,37 @@ 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;
+    topK: number;
+    topP: number;
+    repetitionPenalty: number;
+    createdAt: string;
+    updatedAt: string;
+    agentId: string;
+    organizationId: string;
+    agent?: Agent;
+    organization?: Organization;
+}
+export interface CreateAgentSettingsDto {
+    agentId: string;
+    organizationId: string;
+    temperature?: number;
+    topK?: number;
+    topP?: number;
+    repetitionPenalty?: number;
+}
+export interface UpdateAgentSettingsDto {
+    temperature?: number;
+    topK?: number;
+    topP?: number;
+    repetitionPenalty?: number;
+}

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

@@ -26,6 +26,7 @@ declare const urls: {
     userRoles: string;
     sessions: string;
     agents: string;
+    agentSettings: string;
     audioFiles: string;
 };
 export default urls;

package/dist/src/sdk/urls.js

@@ -35,6 +35,8 @@ const urls = {
     sessions: '/sessions',
     // Agents
     agents: '/agents',
+    // Agent Settings
+    agentSettings: '/agent-settings',
     // Audio Files
     audioFiles: '/audio-files',
 };

package/example-agent-settings.ts

@@ -0,0 +1,77 @@
+// Example usage of AgentSettings functionality
+import { ApiSDK, CreateAgentSettingsDto, UpdateAgentSettingsDto } from './src/sdk';
+
+async function exampleAgentSettingsUsage() {
+  // Initialize SDK
+  const sdk = new ApiSDK({
+    baseUrl: 'http://localhost:3000',
+    storage: {
+      getItem: (key) => localStorage.getItem(key),
+      setItem: (key, value) => localStorage.setItem(key, value),
+      removeItem: (key) => localStorage.removeItem(key),
+    }
+  });
+
+  try {
+    // Login first (superuser required for agent settings)
+    await sdk.login({
+      email: 'superuser@example.com',
+      password: 'password123'
+    });
+
+    // Create agent settings
+    const createData: CreateAgentSettingsDto = {
+      agentId: 'agent-uuid-here',
+      organizationId: 'org-uuid-here',
+      temperature: 0.7,
+      topK: 40,
+      topP: 0.9,
+      repetitionPenalty: 1.1
+    };
+
+    const newSettings = await sdk.createAgentSettings(createData);
+    console.log('Created agent settings:', newSettings);
+
+    // Get all agent settings
+    const allSettings = await sdk.getAgentSettings();
+    console.log('All agent settings:', allSettings);
+
+    // Get settings for specific organization
+    const orgSettings = await sdk.getAgentSettings('org-uuid-here');
+    console.log('Organization settings:', orgSettings);
+
+    // Get settings for specific agent
+    const agentSettings = await sdk.getAgentSettings(undefined, 'agent-uuid-here');
+    console.log('Agent settings:', agentSettings);
+
+    // Get specific settings by agent and organization
+    const specificSettings = await sdk.getAgentSettingsByAgentAndOrganization(
+      'agent-uuid-here', 
+      'org-uuid-here'
+    );
+    console.log('Specific settings:', specificSettings);
+
+    // Update agent settings
+    const updateData: UpdateAgentSettingsDto = {
+      temperature: 0.8,
+      topK: 50
+    };
+
+    const updatedSettings = await sdk.updateAgentSettings(newSettings.id, updateData);
+    console.log('Updated settings:', updatedSettings);
+
+    // Get settings by ID
+    const settingsById = await sdk.getAgentSettingsById(newSettings.id);
+    console.log('Settings by ID:', settingsById);
+
+    // Delete agent settings
+    await sdk.deleteAgentSettings(newSettings.id);
+    console.log('Agent settings deleted');
+
+  } catch (error) {
+    console.error('Error:', error);
+  }
+}
+
+// Export for use in other files
+export { exampleAgentSettingsUsage };

package/package.json

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

package/src/sdk/sdk.ts

@@ -44,6 +44,10 @@ import {
   AudioFileStatus,
   CreateAudioFileDto,
   UpdateAudioFileDto,
+  UploadAudioFileDto,
+  AgentSettings,
+  CreateAgentSettingsDto,
+  UpdateAgentSettingsDto,
 } from './types';
 import urls from './urls';
 import { jwtDecode } from 'jwt-decode';
@@ -790,14 +794,65 @@ export class ApiSDK {
     await this.request(`${urls.agents}/${agentId}/organizations/${organizationId}`, 'DELETE');
   }
 
+  // ======================
+  // AGENT SETTINGS METHODS
+  // ======================
+
+  public async createAgentSettings(settingsData: CreateAgentSettingsDto): Promise<AgentSettings> {
+    return this.request<AgentSettings>(urls.agentSettings, 'POST', settingsData);
+  }
+
+  public async getAgentSettings(organizationId?: string, agentId?: string): Promise<AgentSettings[]> {
+    const params = new URLSearchParams();
+    if (organizationId) params.append('organizationId', organizationId);
+    if (agentId) params.append('agentId', agentId);
+    
+    const queryString = params.toString();
+    const endpoint = queryString ? `${urls.agentSettings}?${queryString}` : urls.agentSettings;
+    
+    return this.request<AgentSettings[]>(endpoint, 'GET');
+  }
+
+  public async getAgentSettingsById(id: string): Promise<AgentSettings> {
+    return this.request<AgentSettings>(`${urls.agentSettings}/${id}`, 'GET');
+  }
+
+  public async getAgentSettingsByAgentAndOrganization(agentId: string, organizationId: string): Promise<AgentSettings> {
+    return this.request<AgentSettings>(`${urls.agentSettings}/agent/${agentId}/organization/${organizationId}`, 'GET');
+  }
+
+  public async updateAgentSettings(id: string, settingsData: UpdateAgentSettingsDto): Promise<AgentSettings> {
+    return this.request<AgentSettings>(`${urls.agentSettings}/${id}`, 'PATCH', settingsData);
+  }
+
+  public async deleteAgentSettings(id: string): Promise<void> {
+    await this.request(`${urls.agentSettings}/${id}`, 'DELETE');
+  }
+
   // ======================
   // 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);
   }
 
@@ -864,4 +919,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

@@ -345,6 +345,8 @@ export interface PasswordChangeResponse {
 export interface Session {
   id: string;
   transcript: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
   dateTime: string;
   startDateTime?: string;
   stopDateTime?: string;
@@ -367,6 +369,8 @@ export interface Session {
 // Session DTOs
 export interface CreateSessionDto {
   transcript: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
   dateTime: string;
   startDateTime?: string;
   stopDateTime?: string;
@@ -380,6 +384,8 @@ export interface CreateSessionDto {
 
 export interface UpdateSessionDto {
   transcript?: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
   dateTime?: string;
   startDateTime?: string;
   stopDateTime?: string;
@@ -434,6 +440,8 @@ export interface AudioFile {
   mimeType: string;
   uploadId?: string;
   transcriptionUrl?: string;
+  transcription?: string;
+  cultural_transcription?: string;
   status: AudioFileStatus;
   createdAt: string;
   updatedAt: string;
@@ -459,5 +467,46 @@ 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;
+  temperature: number;
+  topK: number;
+  topP: number;
+  repetitionPenalty: number;
+  createdAt: string;
+  updatedAt: string;
+  agentId: string;
+  organizationId: string;
+  
+  // Relationships (populated by API)
+  agent?: Agent;
+  organization?: Organization;
+}
+
+// Agent Settings DTOs
+export interface CreateAgentSettingsDto {
+  agentId: string;
+  organizationId: string;
+  temperature?: number;
+  topK?: number;
+  topP?: number;
+  repetitionPenalty?: number;
+}
+
+export interface UpdateAgentSettingsDto {
+  temperature?: number;
+  topK?: number;
+  topP?: number;
+  repetitionPenalty?: number;
+}

package/src/sdk/urls.ts

@@ -44,6 +44,9 @@ const urls = {
   // Agents
   agents: '/agents',
   
+  // Agent Settings
+  agentSettings: '/agent-settings',
+  
   // Audio Files
   audioFiles: '/audio-files',
 }