Feat/assistant beta (#22)

* feat: Introduce Thread model and createThread API method

* feat: Introduce addThreadMessage method

* feat: Add the rest of the models and calls for Assistant Thread API

* refactor: Rename Trascription to TraNscription

* feat: Add documentation

* chore: Update CHANGELOG.md

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.3.6
+
+- Introduce Assistant API https://platform.openai.com/docs/assistants/overview
+
 ## 0.3.0
 
 - Support GPT4 version

README.md

@@ -41,7 +41,7 @@ APIs have been supported by this library. Update to support latest models. Now y
 - Audio Transcription
 
 ```dart
-  final result = await client.createTrascription(
+  final result = await client.createTranscription(
     TranscriptionRequest(
       file: 'assets/ttsmaker-file-2023-3-22-14-57-0.mp3',
     ),

lib/openai_api.dart

@@ -14,3 +14,4 @@ export 'src/image/image_variation.dart';
 export 'src/model.dart';
 export 'package:cancellation_token_http/http.dart'
     show CancellationToken, CancelledException, TimeoutCancellationToken;
+export 'src/thread/exports.dart';

lib/src/client.dart

@@ -10,6 +10,7 @@ const dataPrefix = "data: ";
 class OpenaiClient {
   late OpenaiConfig _config;
   late http.Client _client;
+
   OpenaiClient({
     required OpenaiConfig config,
     http.Client? httpClient,
@@ -19,13 +20,15 @@ class OpenaiClient {
   }
 
   OpenaiConfig get config => _config;
+
   http.Client get client => _client;
 
   Future<dynamic> sendFormRequest(
     http.MultipartRequest request, {
+    bool isBeta = false,
     http.CancellationToken? cancellationToken,
   }) async {
-    request.headers.addAll(_authenticateHeaders());
+    request.headers.addAll(_authenticateHeaders(isBeta));
     final response = await http.Response.fromStream(await client.send(
       request,
       cancellationToken: cancellationToken,
@@ -37,19 +40,26 @@ class OpenaiClient {
   Future<dynamic> sendRequest(
     String endpoint,
     dynamic body, {
+    bool isBeta = false,
     http.CancellationToken? cancellationToken,
   }) async {
-    return jsonDecode(utf8.decode(await sendRequestRaw(endpoint, body)));
+    return jsonDecode(utf8.decode(await sendRequestRaw(
+      endpoint,
+      body,
+      isBeta: isBeta,
+      cancellationToken: cancellationToken,
+    )));
   }
 
   Future<dynamic> sendRequestRaw(
     String endpoint,
     dynamic body, {
+    bool isBeta = false,
     http.CancellationToken? cancellationToken,
   }) async {
     final response = await client.post(
       Uri.parse("${config.baseUrl}/$endpoint"),
-      headers: _authenticateHeaders()..addAll(kJsonTypeHeader),
+      headers: _authenticateHeaders(isBeta)..addAll(kJsonTypeHeader),
       body: jsonEncode(body),
       cancellationToken: cancellationToken,
     );
@@ -59,11 +69,12 @@ class OpenaiClient {
 
   Future<dynamic> get(
     String endpoint, {
+    bool isBeta = false,
     http.CancellationToken? cancellationToken,
   }) async {
     final response = await client.get(
       Uri.parse("${config.baseUrl}/$endpoint"),
-      headers: _authenticateHeaders(),
+      headers: _authenticateHeaders(isBeta),
       cancellationToken: cancellationToken,
     );
     handleException(response);
@@ -73,14 +84,15 @@ class OpenaiClient {
   Future sendStreamRequest(
     String endpoint,
     dynamic body, {
+    bool isBeta = false,
     Function(dynamic)? onSuccess,
     http.CancellationToken? cancellationToken,
   }) async {
     var request = http.Request(
       'POST',
       Uri.parse("${config.baseUrl}/$endpoint"),
     );
-    request.headers.addAll(_authenticateHeaders());
+    request.headers.addAll(_authenticateHeaders(isBeta));
     request.headers.addAll(kJsonTypeHeader);
 
     if (body != null) {
@@ -133,9 +145,10 @@ class OpenaiClient {
     });
   }
 
-  Map<String, String> _authenticateHeaders() {
+  Map<String, String> _authenticateHeaders(bool isBeta) {
     return {
       'Authorization': 'Bearer ${config.apiKey}',
+      if (isBeta) 'OpenAI-Beta': 'assistants=v1',
     };
   }
 
@@ -159,9 +172,9 @@ class OpenaiClient {
 
         /// receive a valid http status code but invalid error object
         throw OpenaiException(
-            code: response.statusCode,
-            error:
-                OpenaiError(message: "unkown http error", type: "unkown_type"));
+          code: response.statusCode,
+          error: OpenaiError(message: "unkown http error", type: "unkown_type"),
+        );
       } on FormatException catch (e) {
         // server returns invalid json oject
         throw OpenaiException(

lib/src/thread/exports.dart

@@ -0,0 +1,5 @@
+export './thread.dart';
+export './thread_message.dart';
+export './thread_run.dart';
+export './thread_run_step.dart';
+export './thread_requests.dart';

lib/src/thread/thread.dart

@@ -0,0 +1,28 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+
+part 'thread.freezed.dart';
+
+part 'thread.g.dart';
+
+/// Represents a thread that contains messages.
+/// https://platform.openai.com/docs/api-reference/threads
+@freezed
+class Thread with _$Thread {
+  factory Thread({
+    /// The identifier, which can be referenced in API endpoints.
+    required String id,
+
+    /// The object type, which is always thread.
+    @Default('thread') String object,
+
+    /// The Unix timestamp (in seconds) for when the thread was created.
+    required int createdAt,
+
+    /// Set of 16 key-value pairs that can be attached to an object. This can be useful
+    /// for storing additional information about the object in a structured format.
+    /// Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
+    @Default(<String, dynamic>{}) Map<String, dynamic> metadata,
+  }) = _Thread;
+
+  factory Thread.fromJson(Map<String, dynamic> json) => _$ThreadFromJson(json);
+}