@opensecret/react 1.4.1 → 1.4.3

package/dist/index.d.ts

@@ -53,6 +53,7 @@ declare namespace api {
         uploadDocument,
         checkDocumentStatus,
         uploadDocumentWithPolling,
+        transcribeAudio,
         LoginResponse,
         UserResponse,
         KVListItem,
@@ -78,7 +79,9 @@ declare namespace api {
         ApiKeyCreateResponse,
         ApiKeyListResponse,
         DocumentStatusRequest,
-        DocumentStatusResponse
+        DocumentStatusResponse,
+        WhisperTranscriptionRequest,
+        WhisperTranscriptionResponse
     }
 }
 
@@ -1386,6 +1389,35 @@ export declare type OpenSecretContextType = {
      * Names are unique per user, so this uniquely identifies the key to delete.
      */
     deleteApiKey: typeof api.deleteApiKey;
+    /**
+     * Transcribes audio using the Whisper API
+     * @param file - The audio file to transcribe (File or Blob object)
+     * @param options - Optional transcription parameters
+     * @returns A promise resolving to the transcription response
+     * @throws {Error} If the user is not authenticated or transcription fails
+     *
+     * @description
+     * This function transcribes audio using OpenAI's Whisper model via the encrypted API.
+     *
+     * Options:
+     * - model: Model to use (default: "whisper-large-v3", routes to Tinfoil's whisper-large-v3-turbo)
+     * - language: Optional ISO-639-1 language code (e.g., "en", "es", "fr")
+     * - prompt: Optional context or previous segment transcript
+     * - temperature: Sampling temperature between 0 and 1 (default: 0.0)
+     *
+     * Supported audio formats: MP3, WAV, MP4, M4A, FLAC, OGG, WEBM
+     *
+     * Example usage:
+     * ```typescript
+     * const audioFile = new File([audioData], "recording.mp3", { type: "audio/mpeg" });
+     * const result = await context.transcribeAudio(audioFile, {
+     *   language: "en",
+     *   prompt: "This is a technical discussion about AI"
+     * });
+     * console.log(result.text);
+     * ```
+     */
+    transcribeAudio: typeof api.transcribeAudio;
 };
 
 /**
@@ -2130,6 +2162,42 @@ declare type ThirdPartyTokenResponse = {
     token: string;
 };
 
+/**
+ * Transcribes audio using the Whisper API
+ * @param file - The audio file to transcribe (File or Blob object)
+ * @param model - Model to use (default: "whisper-large-v3")
+ * @param language - Optional ISO-639-1 language code (e.g., "en", "es", "fr")
+ * @param prompt - Optional context or previous segment transcript
+ * @param temperature - Sampling temperature between 0 and 1
+ * @param apiKey - Optional API key to use instead of JWT token
+ * @returns A promise resolving to the transcription response
+ * @throws {Error} If:
+ * - The user is not authenticated
+ * - The file cannot be read
+ * - The transcription fails
+ *
+ * @description
+ * This function transcribes audio using OpenAI's Whisper model via the encrypted API.
+ * Default model "whisper-large-v3" routes to Tinfoil's whisper-large-v3-turbo.
+ *
+ * Supported audio formats:
+ * - MP3 (audio/mpeg)
+ * - WAV (audio/wav)
+ * - MP4 (audio/mp4)
+ * - M4A (audio/m4a)
+ * - FLAC (audio/flac)
+ * - OGG (audio/ogg)
+ * - WEBM (audio/webm)
+ *
+ * Example usage:
+ * ```typescript
+ * const audioFile = new File([audioData], "recording.mp3", { type: "audio/mpeg" });
+ * const result = await transcribeAudio(audioFile, undefined, "en", "Meeting about Q4");
+ * console.log(result.text);
+ * ```
+ */
+declare function transcribeAudio(file: File | Blob, model?: string, language?: string, prompt?: string, temperature?: number, apiKey?: string): Promise<WhisperTranscriptionResponse>;
+
 declare function updateEmailSettings(orgId: string, projectId: string, settings: EmailSettings): Promise<EmailSettings>;
 
 declare function updateMemberRole(orgId: string, userId: string, role: string): Promise<OrganizationMember>;
@@ -2234,4 +2302,18 @@ declare function verifyEmail(code: string): Promise<void>;
  */
 declare function verifyPlatformEmail(code: string): Promise<void>;
 
+declare type WhisperTranscriptionRequest = {
+    file: string;
+    filename: string;
+    content_type: string;
+    model: string;
+    language?: string;
+    prompt?: string;
+    temperature?: number;
+};
+
+declare type WhisperTranscriptionResponse = {
+    text: string;
+};
+
 export { }