feat(openai_dart): Support OpenRouter API (#292)

davidmigloz · Jan 13, 2024 · 57699b3 · 57699b3
1 parent 69621cc
commit 57699b3
Show file tree

Hide file tree

Showing 9 changed files with 131 additions and 133 deletions.
diff --git a/packages/openai_dart/README.md b/packages/openai_dart/README.md
@@ -16,6 +16,7 @@ Unofficial Dart client for [OpenAI](https://platform.openai.com/docs/api-referen
 - Custom base URL, headers and query params support (e.g. HTTP proxies)
 - Custom HTTP client support (e.g. SOCKS5 proxies or advanced use cases)
 - Partial Azure OpenAI API support
+- It can be used to consume OpenAI-compatible APIs like [OpenRouter](https://openrouter.ai) or [One API](https://github.com/songquanpeng/one-api)
 
 **Supported endpoints:**
 

diff --git a/packages/openai_dart/lib/src/generated/schema/chat_completion_response_choice.dart b/packages/openai_dart/lib/src/generated/schema/chat_completion_response_choice.dart
@@ -26,7 +26,7 @@ class ChatCompletionResponseChoice with _$ChatCompletionResponseChoice {
     required ChatCompletionFinishReason? finishReason,
 
     /// The index of the choice in the list of choices.
-    required int index,
+    @JsonKey(includeIfNull: false) int? index,
 
     /// An assistant message in a chat conversation.
     required ChatCompletionAssistantMessage message,

diff --git a/packages/openai_dart/lib/src/generated/schema/chat_completion_stream_response_choice.dart b/packages/openai_dart/lib/src/generated/schema/chat_completion_stream_response_choice.dart
@@ -34,7 +34,7 @@ class ChatCompletionStreamResponseChoice
     required ChatCompletionFinishReason? finishReason,
 
     /// The index of the choice in the list of choices.
-    required int index,
+    @JsonKey(includeIfNull: false) int? index,
   }) = _ChatCompletionStreamResponseChoice;
 
   /// Object construction from a JSON representation

diff --git a/packages/openai_dart/lib/src/generated/schema/create_chat_completion_response.dart b/packages/openai_dart/lib/src/generated/schema/create_chat_completion_response.dart
@@ -16,7 +16,7 @@ class CreateChatCompletionResponse with _$CreateChatCompletionResponse {
   /// Factory constructor for CreateChatCompletionResponse
   const factory CreateChatCompletionResponse({
     /// A unique identifier for the chat completion.
-    required String id,
+    @JsonKey(includeIfNull: false) String? id,
 
     /// A list of chat completion choices. Can be more than one if `n` is greater than 1.
     required List<ChatCompletionResponseChoice> choices,

diff --git a/packages/openai_dart/lib/src/generated/schema/create_chat_completion_stream_response.dart b/packages/openai_dart/lib/src/generated/schema/create_chat_completion_stream_response.dart
@@ -17,7 +17,7 @@ class CreateChatCompletionStreamResponse
   /// Factory constructor for CreateChatCompletionStreamResponse
   const factory CreateChatCompletionStreamResponse({
     /// A unique identifier for the chat completion. Each chunk has the same ID.
-    required String id,
+    @JsonKey(includeIfNull: false) String? id,
 
     /// A list of chat completion choices. Can be more than one if `n` is greater than 1.
     required List<ChatCompletionStreamResponseChoice> choices,
@@ -35,7 +35,7 @@ class CreateChatCompletionStreamResponse
     String? systemFingerprint,
 
     /// The object type, which is always `chat.completion.chunk`.
-    required CreateChatCompletionStreamResponseObject object,
+    required String object,
   }) = _CreateChatCompletionStreamResponse;
 
   /// Object construction from a JSON representation
@@ -70,13 +70,3 @@ class CreateChatCompletionStreamResponse
     };
   }
 }
-
-// ==========================================
-// ENUM: CreateChatCompletionStreamResponseObject
-// ==========================================
-
-/// The object type, which is always `chat.completion.chunk`.
-enum CreateChatCompletionStreamResponseObject {
-  @JsonValue('chat.completion.chunk')
-  chatCompletionChunk,
-}