[ Edit ] exposed more enums for chat, audio, umage for better developer experience and refactored and added more docs

Author: anasfik

README.md

@@ -219,7 +219,10 @@ Creates a completion for the chat message, note you need to set each message as
 OpenAIChatCompletionModel chatCompletion = await OpenAI.instance.chat.create(
     model: "gpt-3.5-turbo",
     messages: [
-      OpenAIChatCompletionChoiceMessageModel(content: "hello, what is Flutter and Dart ?", role: "user"),
+      OpenAIChatCompletionChoiceMessageModel(
+        content: "hello, what is Flutter and Dart ?",
+        role: OpenAIChatMessageRole.user,
+        ),
     ],
 );
 ```
@@ -234,7 +237,7 @@ OpenAIStreamChatCompletionModel chatStream = OpenAI.instance.chat.createStream(
     messages: [
       OpenAIChatCompletionChoiceMessageModel(
         content: "hello",
-        role: "user",
+        role: OpenAIChatMessageRole.user,
       )
     ],
   );
@@ -277,7 +280,7 @@ Generates a new image based on a prompt given.
   prompt: 'an astronaut on the sea',
   n: 1,
   size: OpenAIImageSize.size1024,
-  responseFormat: OpenAIResponseFormat.url,
+  responseFormat: OpenAIImageResponseFormat.url,
 );
 ```
 
@@ -292,7 +295,7 @@ OpenAiImageEditModel imageEdit = await OpenAI.instance.image.edit(
  prompt: "mask the image with a dinosaur",
  n: 1,
  size: OpenAIImageSize.size1024,
- responseFormat: OpenAIResponseFormat.url,
+ responseFormat: OpenAIImageResponseFormat.url,
 );
 ```
 
@@ -305,7 +308,7 @@ OpenAIImageVariationModel imageVariation = await OpenAI.instance.image.variation
  image: File(/* IMAGE PATH HERE */),
  n: 1,
  size: OpenAIImageSize.size1024,
- responseFormat: OpenAIResponseFormat.url,
+ responseFormat: OpenAIImageResponseFormat.url,
 );
 ```
 

example/lib/chat_campletion_stream_example.dart

@@ -12,7 +12,7 @@ void main() {
     messages: [
       OpenAIChatCompletionChoiceMessageModel(
         content: "hello",
-        role: "user",
+        role: OpenAIChatMessageRole.user,
       )
     ],
   );

example/lib/chat_completion_example.dart

@@ -6,11 +6,13 @@ void main() async {
   // Set the OpenAI API key from the .env file.
   OpenAI.apiKey = Env.apiKey;
 
-  OpenAIChatCompletionModel chatCompletion = await OpenAI.instance.chat.create(
-      model: "gpt-3.5-turbo",
-      messages: [
-        OpenAIChatCompletionChoiceMessageModel(content: "hello", role: "user")
-      ]);
+  OpenAIChatCompletionModel chatCompletion =
+      await OpenAI.instance.chat.create(model: "gpt-3.5-turbo", messages: [
+    OpenAIChatCompletionChoiceMessageModel(
+      content: "hello",
+      role: OpenAIChatMessageRole.user,
+    )
+  ]);
 
   print(chatCompletion.id);
   print(chatCompletion.choices.first.message);

example/lib/image_variation_example.dart

@@ -13,7 +13,7 @@ Future<void> main() async {
     image: File("example.png"),
     n: 1,
     size: OpenAIImageSize.size256,
-    responseFormat: OpenAIResponseFormat.b64Json,
+    responseFormat: OpenAIImageResponseFormat.b64Json,
   );
 
   // Prints the result.

lib/src/core/base/images/base.dart

@@ -25,12 +25,12 @@ extension SizeToStingExtension on OpenAIImageSize {
   }
 }
 
-extension ResponseFormatToStingExtension on OpenAIResponseFormat {
+extension ResponseFormatToStingExtension on OpenAIImageResponseFormat {
   String get value {
     switch (this) {
-      case OpenAIResponseFormat.url:
+      case OpenAIImageResponseFormat.url:
         return "url";
-      case OpenAIResponseFormat.b64Json:
+      case OpenAIImageResponseFormat.b64Json:
         return "b64_json";
     }
   }

lib/src/core/base/images/interfaces/create.dart

@@ -6,7 +6,7 @@ abstract class CreateInterface {
     required String prompt,
     int? n,
     OpenAIImageSize? size,
-    OpenAIResponseFormat? responseFormat,
+    OpenAIImageResponseFormat? responseFormat,
     String? user,
   });
 }

lib/src/core/base/images/interfaces/edit.dart

@@ -9,7 +9,7 @@ abstract class EditInterface {
     required String prompt,
     int? n,
     OpenAIImageSize? size,
-    OpenAIResponseFormat? responseFormat,
+    OpenAIImageResponseFormat? responseFormat,
     String? user,
   });
 }

lib/src/core/base/images/interfaces/variations.dart

@@ -7,7 +7,7 @@ abstract class VariationInterface {
     required File image,
     int? n,
     OpenAIImageSize? size,
-    OpenAIResponseFormat? responseFormat,
+    OpenAIImageResponseFormat? responseFormat,
     String? user,
   });
 }

lib/src/core/models/chat/sub_models/choices/sub_models/message.dart

@@ -1,9 +1,11 @@
+import '../../../../image/enum.dart';
+
 /// {@template openai_chat_completion_choice_message_model}
 /// This represents the message of the [OpenAIChatCompletionChoiceModel] model of the OpenAI API, which is used and get returned while using the [OpenAIChat] methods.
 /// {@endtemplate}
 class OpenAIChatCompletionChoiceMessageModel {
   /// The [role] of the message.
-  final String role;
+  final OpenAIChatMessageRole role;
 
   /// The [content] of the message.
   final String content;
@@ -24,15 +26,16 @@ class OpenAIChatCompletionChoiceMessageModel {
     Map<String, dynamic> json,
   ) {
     return OpenAIChatCompletionChoiceMessageModel(
-      role: json['role'],
+      role: OpenAIChatMessageRole.values
+          .firstWhere((role) => role.name == json['role']),
       content: json['content'],
     );
   }
 
   /// This method used to convert the [OpenAIChatCompletionChoiceMessageModel] to a [Map<String, dynamic>] object.
   Map<String, dynamic> toMap() {
     return {
-      "role": role,
+      "role": role.name,
       "content": content,
     };
   }

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

@@ -1,5 +1,7 @@
 enum OpenAIImageSize { size256, size512, size1024 }
 
-enum OpenAIResponseFormat { url, b64Json }
+enum OpenAIImageResponseFormat { url, b64Json }
 
 enum OpenAIAudioResponseFormat { json, text, srt, verbose_json, vtt }
+
+enum OpenAIChatMessageRole { system, user, assistant }