[ Edit ] refactored code, and exposed docs for types and class instancess

Author: anasfik

lib/src/instance/chat/chat.dart

@@ -3,11 +3,20 @@ import 'package:dart_openai/src/core/networking/client.dart';
 
 import '../../core/base/chat/chat.dart';
 import '../../core/models/chat/chat.dart';
+import '../../core/utils/logger.dart';
 
+/// {@template openai_chat}
+/// This class is responsible for handling all chat requests, such as creating a chat completion for the message(s).
+/// {@endtemplate}
 class OpenAIChat implements OpenAIChatBase {
   @override
   String get endpoint => "/chat/completions";
 
+  /// {@macro openai_chat}
+  OpenAIChat() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// Creates a chat completion for the message(s).
   ///
   /// [model] is the ID of the model to use.

lib/src/instance/completion/completion.dart

@@ -6,13 +6,20 @@ import 'package:meta/meta.dart';
 
 import '../../core/base/completion.dart';
 
+/// {@template openai_completion}
 /// This class is responsible for handling all the requests related to the completion in the OpenAI API such as creating a completion.
+/// {@endtemplate}
 @immutable
 @protected
 class OpenAICompletion implements OpenAICompletionBase {
   @override
   String get endpoint => "/completions";
 
+  /// {@macro openai_completion}
+  OpenAICompletion() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// Creates a new completion and returns a [OpenAICompletionModel] object.
   ///
   ///
@@ -353,8 +360,4 @@ class OpenAICompletion implements OpenAICompletionBase {
 
     return stream.map((event) => event.choices.first.text);
   }
-
-  OpenAICompletion() {
-    OpenAILogger.logEndpoint(endpoint);
-  }
 }

lib/src/instance/edits/edits.dart

@@ -6,13 +6,20 @@ import '../../core/builder/base_api_url.dart';
 import '../../core/networking/client.dart';
 import '../../core/utils/logger.dart';
 
+/// {@template openai_edits}
 /// The class that handles all the requests related to the edits in the OpenAI API.
+/// {@endtemplate}
 @immutable
 @protected
 class OpenAIEdits implements OpenAIEditsBase {
   @override
   String get endpoint => "/edits";
 
+  /// {@macro openai_edits}
+  OpenAIEdits() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// Given a [prompt] and an instruction, this method will return an edited version of the prompt.
   ///
   /// [model] is id of the model to use. You can use the `text-davinci-edit-001` or `code-davinci-edit-001` model with this method.
@@ -62,8 +69,4 @@ class OpenAIEdits implements OpenAIEditsBase {
       },
     );
   }
-
-  OpenAIEdits() {
-    OpenAILogger.logEndpoint(endpoint);
-  }
 }

lib/src/instance/embedding/embedding.dart

@@ -6,13 +6,20 @@ import '../../core/base/embeddings/base.dart';
 import '../../core/networking/client.dart';
 import '../../core/utils/logger.dart';
 
+/// {@template openai_embedding}
 /// Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+/// {@endtemplate}
 @immutable
 @protected
 class OpenAIEmbedding implements OpenAIEmbeddingBase {
   @override
   String get endpoint => "/embeddings";
 
+  /// {@macro openai_embedding}
+  OpenAIEmbedding() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// Creates an embedding vector representing the input text.
   ///
   /// [model] is the id of the model to use for completion.
@@ -56,8 +63,4 @@ class OpenAIEmbedding implements OpenAIEmbeddingBase {
       },
     );
   }
-
-  OpenAIEmbedding() {
-    OpenAILogger.logEndpoint(endpoint);
-  }
 }

lib/src/instance/files/files.dart

@@ -8,12 +8,20 @@ import 'dart:io';
 import '../../core/base/files/base.dart';
 import '../../core/utils/logger.dart';
 
+/// {@template openai_files}
+/// This class is responsible for handling all files requests, such as uploading a file to be used across various endpoints/features.
+/// {@endtemplate}
 @immutable
 @protected
 class OpenAIFiles implements OpenAIFilesBase {
   @override
   String get endpoint => "/files";
 
+  /// {@macro openai_files}
+  OpenAIFiles() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// This method fetches for your files list that exists in your OPenAI account.
   ///
   /// Example:
@@ -114,6 +122,7 @@ class OpenAIFiles implements OpenAIFilesBase {
   @override
   Future<bool> delete(String fileId) async {
     final String fileIdEndpoint = "/$fileId";
+
     return await OpenAINetworkingClient.delete(
       from: BaseApiUrlBuilder.build(endpoint + fileIdEndpoint),
       onSuccess: (Map<String, dynamic> response) {
@@ -123,8 +132,4 @@ class OpenAIFiles implements OpenAIFilesBase {
       },
     );
   }
-
-  OpenAIFiles() {
-    OpenAILogger.logEndpoint(endpoint);
-  }
 }

lib/src/instance/fine_tunes/fine_tunes.dart

@@ -7,12 +7,20 @@ import 'package:meta/meta.dart';
 import '../../core/base/fine_tunes/base.dart';
 import '../../core/utils/logger.dart';
 
+/// {@template openai_finetunes}
+/// This class is responsible for handling all fine-tunes requests, such as creating a fine-tune model.
+/// {@endtemplate}
 @immutable
 @protected
 class OpenAIFineTunes implements OpenAIFineTunesBase {
   @override
   String get endpoint => "/fine-tunes";
 
+  /// {@macro openai_finetunes}
+  OpenAIFineTunes() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// [trainingFile] is The ID of an uploaded file that contains training data. The file must be formatted as a JSONL file and uploaded with the purpose of fine-tuning.
   ///
   ///
@@ -225,8 +233,4 @@ class OpenAIFineTunes implements OpenAIFineTunesBase {
       },
     );
   }
-
-  OpenAIFineTunes() {
-    OpenAILogger.logEndpoint(endpoint);
-  }
 }

lib/src/instance/images/images.dart

@@ -12,13 +12,20 @@ import '../../core/models/image/enum.dart';
 import '../../core/models/image/variation/variation.dart';
 import '../../core/utils/logger.dart';
 
+/// {@template openai_images}
 /// The class that handles all the requests related to the images in the OpenAI API.
+/// {@endtemplate}
 @immutable
 @protected
 class OpenAIImages implements OpenAIImagesBase {
   @override
   String get endpoint => "/images";
 
+  /// {@macro openai_images}
+  OpenAIImages() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// This function creates an image based on a given prompt.
   ///
   ///
@@ -197,8 +204,4 @@ class OpenAIImages implements OpenAIImagesBase {
       to: BaseApiUrlBuilder.build(endpoint + variations),
     );
   }
-
-  OpenAIImages() {
-    OpenAILogger.logEndpoint(endpoint);
-  }
 }

lib/src/instance/model/model.dart

@@ -5,14 +5,20 @@ import '../../core/builder/base_api_url.dart';
 import '../../core/networking/client.dart';
 import 'package:meta/meta.dart';
 
+/// {@template openai_model}
 /// The class that handles all the requests related to the models in the OpenAI API.
-/// it provides methods to list all the models, retrieve a model by it's id, and delete a fine-tuned model that you did made.
+/// {@endtemplate}
 @immutable
 @protected
 class OpenAIModel implements OpenAIModelBase {
   @override
   String get endpoint => "/models";
 
+  /// {@macro openai_model}
+  OpenAIModel() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// Lists all the models available in the OpenAI API and returns a list of [OpenAIModelModel] objects.
   /// Refer to [Models](https://platform.openai.com/docs/models/models) for more information about the available models.
   ///
@@ -71,8 +77,4 @@ class OpenAIModel implements OpenAIModelBase {
       },
     );
   }
-
-  OpenAIModel() {
-    OpenAILogger.logEndpoint(endpoint);
-  }
 }

lib/src/instance/moderations/moderations.dart

@@ -7,12 +7,20 @@ import 'package:meta/meta.dart';
 
 import '../../core/utils/logger.dart';
 
+/// {@template openai_moderation}
+/// The class that handles all the requests related to the moderation in the OpenAI API.
+/// {@endtemplate}
 @immutable
 @protected
 class OpenAIModeration implements OpenAIModerationBase {
   @override
   String get endpoint => "/moderations";
 
+  /// {@macro openai_moderation}
+  OpenAIModeration() {
+    OpenAILogger.logEndpoint(endpoint);
+  }
+
   /// Creates a moderation request.
   ///
   ///
@@ -48,8 +56,4 @@ class OpenAIModeration implements OpenAIModerationBase {
       to: BaseApiUrlBuilder.build(endpoint),
     );
   }
-
-  OpenAIModeration() {
-    OpenAILogger.logEndpoint(endpoint);
-  }
 }