[ Add ] added enum for audio response format for better dev experience

Author: anasfik

README.md

@@ -340,6 +340,7 @@ for transcribing an audio `File`, you can use the `createTranscription()` method
 OpenAIAudioModel transcription = OpenAI.instance.audio.createTranscription(
   file: /* THE AUDIO FILE HERE */,
   model: "whisper-1",
+  responseFormat: OpenAIAudioResponseFormat.json,
 );
 ```
 
@@ -351,6 +352,8 @@ to get access to the translation API, and translate an audio file to english, yo
 OpenAIAudioModel translation = await OpenAI.instance.audio.createTranslation(
   file: /* THE AUDIO FILE HERE */,
   model: "whisper-1",
+  responseFormat: OpenAIAudioResponseFormat.text,
+
 );
 ```
 

example/lib/create_audio_translation.dart

@@ -16,7 +16,7 @@ Future<void> main() async {
         'https://www.cbvoiceovers.com/wp-content/uploads/2017/05/Commercial-showreel.mp3',
         fileExtension: "mp3"),
     model: "whisper-1",
-    responseFormat: "json",
+    responseFormat: OpenAIAudioResponseFormat.json,
   );
 
   // print the translation.

lib/src/core/base/audio/interfaces.dart

@@ -7,7 +7,7 @@ abstract class CreateInterface {
     required File file,
     required String model,
     String? prompt,
-    String? responseFormat,
+    OpenAIAudioResponseFormat? responseFormat,
     double? temperature,
     String? language,
   });
@@ -16,7 +16,7 @@ abstract class CreateInterface {
     required File file,
     required String model,
     String? prompt,
-    String? responseFormat,
+    OpenAIAudioResponseFormat? responseFormat,
     double? temperature,
   });
 }

lib/src/core/models/image/enum.dart

@@ -1,3 +1,5 @@
 enum OpenAIImageSize { size256, size512, size1024 }
 
 enum OpenAIResponseFormat { url, b64Json }
+
+enum OpenAIAudioResponseFormat { json, text, srt, verbose_json, vtt }

lib/src/instance/audio/audio.dart

@@ -1,21 +1,34 @@
+import 'dart:math';
+
 import 'package:dart_openai/src/core/builder/base_api_url.dart';
 import 'package:dart_openai/src/core/models/audio/audio.dart';
 import 'package:dart_openai/src/core/networking/client.dart';
 
 import 'dart:io';
 
+import '../../../openai.dart';
 import '../../core/base/audio/audio.dart';
+import '../../core/utils/logger.dart';
 
+/// {@template openai_audio}
+/// This class is responsible for handling all audio requests, such as creating a transcription or translation for a given audio file.
+/// {@endtemplate}
 class OpenAIAudio implements OpenAIAudioBase {
   @override
   String get endpoint => "/audio";
 
+  /// {@macro openai_audio}
+  OpenAIAudio() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
+ 
   @override
   Future<OpenAIAudioModel> createTranscription({
     required File file,
     required String model,
     String? prompt,
-    String? responseFormat,
+    OpenAIAudioResponseFormat? responseFormat,
     double? temperature,
     String? language,
   }) async {
@@ -25,7 +38,7 @@ class OpenAIAudio implements OpenAIAudioBase {
       body: {
         "model": model,
         if (prompt != null) "prompt": prompt,
-        if (responseFormat != null) "response_format": responseFormat,
+        if (responseFormat != null) "response_format": responseFormat.name,
         if (temperature != null) "temperature": temperature.toString(),
         if (language != null) "language": language,
       },
@@ -40,7 +53,7 @@ class OpenAIAudio implements OpenAIAudioBase {
     required File file,
     required String model,
     String? prompt,
-    String? responseFormat,
+    OpenAIAudioResponseFormat? responseFormat,
     double? temperature,
   }) async {
     return await OpenAINetworkingClient.fileUpload(
@@ -49,7 +62,7 @@ class OpenAIAudio implements OpenAIAudioBase {
       body: {
         "model": model,
         if (prompt != null) "prompt": prompt,
-        if (responseFormat != null) "response_format": responseFormat,
+        if (responseFormat != null) "response_format": responseFormat.name,
         if (temperature != null) "temperature": temperature.toString(),
       },
       onSuccess: (Map<String, dynamic> response) {

test/openai_test.dart

@@ -219,7 +219,7 @@ void main() async {
       final transcription = await OpenAI.instance.audio.createTranscription(
         file: audioExampleFile,
         model: "whisper-1",
-        responseFormat: "json",
+        responseFormat: OpenAIAudioResponseFormat.json,
       );
 
       expect(transcription, isA<OpenAIAudioModel>());