chore: update audio & images interfaces, examples and client

Author: anasfik

endpoints_todo.md

@@ -224,6 +224,9 @@ This document tracks the implementation status of all OpenAI API endpoints in th
 - [x] **Get Conversation Items** - ✅ Implemented (Custom)
 - [x] **Get Conversation Item** - ✅ Implemented (Custom)
 
+### Videos API (Custom)
+- [~] None
+
 ### Evals API (Custom - Stub Implementation)
 - [~] **Create Eval** - ⚠️ Stub Implementation (Throws UnimplementedError)
 - [~] **List Evals** - ⚠️ Stub Implementation (Throws UnimplementedError)

example/lib/conversation_get_item_example.dart

@@ -6,14 +6,27 @@ import 'package:example/env/env.dart';
 void main() async {
   OpenAI.apiKey = Env.apiKey;
 
+  final outputDir = Directory('speechOutput');
+
+  final exists = await outputDir.exists();
+
+  final input = "I should've been strong";
+  final model = "tts-1";
+  final voice = OpenAIAudioVoice.fable;
+
+  final fileName = [
+    model,
+    DateTime.now().millisecond.toString(),
+  ].join('_');
+
   // The speech request.
   File speechFile = await OpenAI.instance.audio.createSpeech(
-    model: "tts-1",
-    input: "it is what it is.",
-    voice: OpenAIAudioVoice.nova,
-    responseFormat: OpenAIAudioSpeechResponseFormat.opus,
-    outputDirectory: await Directory("speechOutput").create(),
-    outputFileName: DateTime.now().microsecondsSinceEpoch.toString(),
+    model: model,
+    input: input,
+    voice: voice,
+    responseFormat: OpenAIAudioSpeechResponseFormat.mp3,
+    outputDirectory: exists ? outputDir : await outputDir.create(),
+    outputFileName: fileName,
   );
 
   // The file result.

example/lib/create_audio_speech.dart

@@ -11,19 +11,28 @@ Future<void> main() async {
 // Set the OpenAI API key from the .env file.
   OpenAI.apiKey = Env.apiKey;
 
+  final textAudioFile =
+      "https://www.cbvoiceovers.com/wp-content/uploads/2017/05/Commercial-showreel.mp3";
+
 // create the audio transcription.
   final transcription = await OpenAI.instance.audio.createTranscription(
-    file: await getFileFromUrl(
-      'https://www.cbvoiceovers.com/wp-content/uploads/2017/05/Commercial-showreel.mp3',
-    ),
     model: "whisper-1",
+    file: await getFileFromUrl(textAudioFile),
+    include: ["logprobs"],
     responseFormat: OpenAIAudioResponseFormat.verbose_json,
-    timestampGranularities: [OpenAIAudioTimestampGranularity.segment],
+    language: "en",
+    prompt: "transcribe this audio with 0.5x speed",
   );
 
-  // print the transcription.
-  print(transcription.text);
-  print(transcription.segments?.map((e) => e.end));
+  if (transcription is OpenAITranscriptionModel) {
+    print(transcription.logprobs);
+    print(transcription.text);
+    print(transcription.usage);
+  } else if (transcription is OpenAITranscriptionVerboseModel) {
+    // print the transcription.
+    print(transcription.text);
+    print(transcription.segments?.map((e) => e.end));
+  }
 }
 
 Future<File> getFileFromUrl(String networkUrl) async {

example/lib/create_audio_transcription.dart

@@ -12,16 +12,17 @@ Future<void> main() async {
   OpenAI.apiKey = Env.apiKey;
 
 // create the audio transcription.
-  final translation = await OpenAI.instance.audio.createTranslation(
+  final translationText = await OpenAI.instance.audio.createTranslation(
     file: await getFileFromUrl(
         'https://www.cbvoiceovers.com/wp-content/uploads/2017/05/Commercial-showreel.mp3',
         fileExtension: "mp3"),
     model: "whisper-1",
+    prompt: "use different english words",
     responseFormat: OpenAIAudioResponseFormat.json,
   );
 
   // print the translation.
-  print(translation.text);
+  print(translationText);
 }
 
 Future<File> getFileFromUrl(

example/lib/create_audio_translation.dart

@@ -0,0 +1,22 @@
+import 'package:dart_openai/dart_openai.dart';
+import 'package:example/env/env.dart';
+
+void main() async {
+  // Set the OpenAI API key from the .env file.
+  OpenAI.apiKey = Env.apiKey;
+
+  // Creates the Image
+  final images = await OpenAI.instance.image.create(
+    model: "dall-e-3",
+    prompt: "image of a cat in a spaceship",
+    n: 1,
+    responseFormat: OpenAIImageResponseFormat.url,
+    size: OpenAIImageSize.size1024,
+    quality: OpenAIImageQuality.standard,
+    style: OpenAIImageStyle.vivid,
+  );
+
+  final url = images.data.firstOrNull?.url;
+
+  print(url);
+}

example/lib/image_creation.dart

@@ -6,10 +6,9 @@ import 'package:example/env/env.dart';
 void main() async {
   OpenAI.apiKey = Env.apiKey;
 
-  OpenAIImageModel imageEdits = await OpenAI.instance.image.edit(
+  final imageEdits = await OpenAI.instance.image.edit(
     prompt: 'mask the image with color red',
-    image: File("IMAGE PATH HERE"),
-    mask: File("MASK PATH HERE"),
+    image: File("../whatsapp.png"),
     n: 1,
     size: OpenAIImageSize.size1024,
     responseFormat: OpenAIImageResponseFormat.b64Json,

example/lib/image_edit_example.dart

@@ -7,7 +7,7 @@ Future<void> main() async {
   OpenAI.apiKey = Env.apiKey;
 
   // List all files.
-  List<OpenAIFileModel> files = await OpenAI.instance.file.list();
+  final files = await OpenAI.instance.file.list();
 
   // Print the files.
   print(files);

example/lib/list_all_files.dart

@@ -26,7 +26,7 @@ abstract class CreateInterface {
     Directory? outputDirectory,
   });
 
-  Future<OpenAIAudioModel> createTranscription({
+  Future<OpenAITranscriptionGeneralModel> createTranscription({
     required File file,
     required String model,
     String? prompt,
@@ -37,7 +37,7 @@ abstract class CreateInterface {
     OpenAIAudioChunkingConfig? chunkingStrategy,
   });
 
-  Future<OpenAIAudioModel> createTranslation({
+  Future<String> createTranslation({
     required File file,
     required String model,
     String? prompt,

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

@@ -1,6 +1,5 @@
 import 'package:dart_openai/src/core/base/entity/interfaces/enpoint.dart';
 
-import '../../enum.dart';
 import 'interfaces/create.dart';
 import 'interfaces/edit.dart';
 import 'interfaces/variations.dart';
@@ -11,57 +10,3 @@ abstract class OpenAIImagesBase
         CreateInterface,
         EditInterface,
         VariationInterface {}
-
-extension SizeToStingExtension on OpenAIImageSize {
-  String get value {
-    switch (this) {
-      case OpenAIImageSize.size256:
-        return "256x256";
-      case OpenAIImageSize.size512:
-        return "512x512";
-      case OpenAIImageSize.size1024:
-        return "1024x1024";
-      case OpenAIImageSize.size1792Horizontal:
-        return "1792x1024";
-      case OpenAIImageSize.size1792Vertical:
-        return "1024x1792";
-    }
-  }
-}
-
-extension StyleToStingExtension on OpenAIImageStyle {
-  String get value {
-    return name;
-
-    // ! pretty sure this will be needed in the future in case of adding more styles that can't be got from the `name` field.
-    // switch (this) {
-    //   case OpenAIImageStyle.vivid:
-    //     return "vivid";
-    //   case OpenAIImageStyle.natural:
-    //     return "natural";
-    // }
-  }
-}
-
-extension QualityToStingExtension on OpenAIImageQuality {
-  String get value {
-    return name;
-
-    // ! pretty sure this will be needed in the future in case of adding more qualities that can't be got from the `name` field.
-    // switch (this) {
-    //   case OpenAIImageQuality.hd:
-    //     return "hd";
-    // }
-  }
-}
-
-extension ResponseFormatToStingExtension on OpenAIImageResponseFormat {
-  String get value {
-    switch (this) {
-      case OpenAIImageResponseFormat.url:
-        return "url";
-      case OpenAIImageResponseFormat.b64Json:
-        return "b64_json";
-    }
-  }
-}