feat: Add support for shortening embeddings (#311)

https://openai.com/blog/new-embedding-models-and-api-updates#native-support-for-shortening-embeddings

packages/openai_dart/lib/src/generated/schema/create_embedding_request.dart

@@ -26,6 +26,9 @@ class CreateEmbeddingRequest with _$CreateEmbeddingRequest {
     @Default(EmbeddingEncodingFormat.float)
     EmbeddingEncodingFormat encodingFormat,
 
+    /// The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.
+    @JsonKey(includeIfNull: false) int? dimensions,
+
     /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
     @JsonKey(includeIfNull: false) String? user,
   }) = _CreateEmbeddingRequest;
@@ -39,11 +42,18 @@ class CreateEmbeddingRequest with _$CreateEmbeddingRequest {
     'model',
     'input',
     'encoding_format',
+    'dimensions',
     'user'
   ];
 
+  /// Validation constants
+  static const dimensionsMinValue = 1;
+
   /// Perform validations on the schema property values
   String? validateSchema() {
+    if (dimensions != null && dimensions! < dimensionsMinValue) {
+      return "The value of 'dimensions' cannot be < $dimensionsMinValue";
+    }
     return null;
   }
 
@@ -53,6 +63,7 @@ class CreateEmbeddingRequest with _$CreateEmbeddingRequest {
       'model': model,
       'input': input,
       'encoding_format': encodingFormat,
+      'dimensions': dimensions,
       'user': user,
     };
   }

packages/openai_dart/lib/src/generated/schema/schema.freezed.dart

@@ -10560,6 +10560,10 @@ mixin _$CreateEmbeddingRequest {
   EmbeddingEncodingFormat get encodingFormat =>
       throw _privateConstructorUsedError;
 
+  /// The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.
+  @JsonKey(includeIfNull: false)
+  int? get dimensions => throw _privateConstructorUsedError;
+
   /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
   @JsonKey(includeIfNull: false)
   String? get user => throw _privateConstructorUsedError;
@@ -10580,6 +10584,7 @@ abstract class $CreateEmbeddingRequestCopyWith<$Res> {
       {@_EmbeddingModelConverter() EmbeddingModel model,
       @_EmbeddingInputConverter() EmbeddingInput input,
       @JsonKey(name: 'encoding_format') EmbeddingEncodingFormat encodingFormat,
+      @JsonKey(includeIfNull: false) int? dimensions,
       @JsonKey(includeIfNull: false) String? user});
 
   $EmbeddingModelCopyWith<$Res> get model;
@@ -10603,6 +10608,7 @@ class _$CreateEmbeddingRequestCopyWithImpl<$Res,
     Object? model = null,
     Object? input = null,
     Object? encodingFormat = null,
+    Object? dimensions = freezed,
     Object? user = freezed,
   }) {
     return _then(_value.copyWith(
@@ -10618,6 +10624,10 @@ class _$CreateEmbeddingRequestCopyWithImpl<$Res,
           ? _value.encodingFormat
           : encodingFormat // ignore: cast_nullable_to_non_nullable
               as EmbeddingEncodingFormat,
+      dimensions: freezed == dimensions
+          ? _value.dimensions
+          : dimensions // ignore: cast_nullable_to_non_nullable
+              as int?,
       user: freezed == user
           ? _value.user
           : user // ignore: cast_nullable_to_non_nullable
@@ -10655,6 +10665,7 @@ abstract class _$$CreateEmbeddingRequestImplCopyWith<$Res>
       {@_EmbeddingModelConverter() EmbeddingModel model,
       @_EmbeddingInputConverter() EmbeddingInput input,
       @JsonKey(name: 'encoding_format') EmbeddingEncodingFormat encodingFormat,
+      @JsonKey(includeIfNull: false) int? dimensions,
       @JsonKey(includeIfNull: false) String? user});
 
   @override
@@ -10679,6 +10690,7 @@ class __$$CreateEmbeddingRequestImplCopyWithImpl<$Res>
     Object? model = null,
     Object? input = null,
     Object? encodingFormat = null,
+    Object? dimensions = freezed,
     Object? user = freezed,
   }) {
     return _then(_$CreateEmbeddingRequestImpl(
@@ -10694,6 +10706,10 @@ class __$$CreateEmbeddingRequestImplCopyWithImpl<$Res>
           ? _value.encodingFormat
           : encodingFormat // ignore: cast_nullable_to_non_nullable
               as EmbeddingEncodingFormat,
+      dimensions: freezed == dimensions
+          ? _value.dimensions
+          : dimensions // ignore: cast_nullable_to_non_nullable
+              as int?,
       user: freezed == user
           ? _value.user
           : user // ignore: cast_nullable_to_non_nullable
@@ -10710,6 +10726,7 @@ class _$CreateEmbeddingRequestImpl extends _CreateEmbeddingRequest {
       @_EmbeddingInputConverter() required this.input,
       @JsonKey(name: 'encoding_format')
       this.encodingFormat = EmbeddingEncodingFormat.float,
+      @JsonKey(includeIfNull: false) this.dimensions,
       @JsonKey(includeIfNull: false) this.user})
       : super._();
 
@@ -10731,14 +10748,19 @@ class _$CreateEmbeddingRequestImpl extends _CreateEmbeddingRequest {
   @JsonKey(name: 'encoding_format')
   final EmbeddingEncodingFormat encodingFormat;
 
+  /// The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.
+  @override
+  @JsonKey(includeIfNull: false)
+  final int? dimensions;
+
   /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
   @override
   @JsonKey(includeIfNull: false)
   final String? user;
 
   @override
   String toString() {
-    return 'CreateEmbeddingRequest(model: $model, input: $input, encodingFormat: $encodingFormat, user: $user)';
+    return 'CreateEmbeddingRequest(model: $model, input: $input, encodingFormat: $encodingFormat, dimensions: $dimensions, user: $user)';
   }
 
   @override
@@ -10750,13 +10772,15 @@ class _$CreateEmbeddingRequestImpl extends _CreateEmbeddingRequest {
             (identical(other.input, input) || other.input == input) &&
             (identical(other.encodingFormat, encodingFormat) ||
                 other.encodingFormat == encodingFormat) &&
+            (identical(other.dimensions, dimensions) ||
+                other.dimensions == dimensions) &&
             (identical(other.user, user) || other.user == user));
   }
 
   @JsonKey(ignore: true)
   @override
   int get hashCode =>
-      Object.hash(runtimeType, model, input, encodingFormat, user);
+      Object.hash(runtimeType, model, input, encodingFormat, dimensions, user);
 
   @JsonKey(ignore: true)
   @override
@@ -10779,6 +10803,7 @@ abstract class _CreateEmbeddingRequest extends CreateEmbeddingRequest {
           @_EmbeddingInputConverter() required final EmbeddingInput input,
           @JsonKey(name: 'encoding_format')
           final EmbeddingEncodingFormat encodingFormat,
+          @JsonKey(includeIfNull: false) final int? dimensions,
           @JsonKey(includeIfNull: false) final String? user}) =
       _$CreateEmbeddingRequestImpl;
   const _CreateEmbeddingRequest._() : super._();
@@ -10803,6 +10828,11 @@ abstract class _CreateEmbeddingRequest extends CreateEmbeddingRequest {
   EmbeddingEncodingFormat get encodingFormat;
   @override
 
+  /// The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.
+  @JsonKey(includeIfNull: false)
+  int? get dimensions;
+  @override
+
   /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
   @JsonKey(includeIfNull: false)
   String? get user;

packages/openai_dart/oas/openapi_curated.yaml

@@ -2205,6 +2205,11 @@ components:
           default: "float"
           type: string
           enum: [ "float", "base64" ]
+        dimensions:
+          description: |
+            The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.
+          type: integer
+          minimum: 1
         user: *end_user_param_configuration
       required:
         - model

packages/openai_dart/oas/openapi_official.yaml

@@ -6752,6 +6752,11 @@ components:
           default: "float"
           type: string
           enum: ["float", "base64"]
+        dimensions:
+          description: |
+            The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.
+          type: integer
+          minimum: 1
         user: *end_user_param_configuration
       required:
         - model

packages/openai_dart/test/openai_client_embeddings_test.dart

@@ -59,5 +59,19 @@ void main() {
       expect(res.data.first.index, 0);
       expect(res.data.first.embeddingVectorBase64, isNotEmpty);
     });
+
+    test('Test shortening embeddings', () async {
+      const request = CreateEmbeddingRequest(
+        model: EmbeddingModel.model(EmbeddingModels.textEmbedding3Large),
+        input: EmbeddingInput.string(
+          'The food was delicious and the waiter...',
+        ),
+        dimensions: 256,
+      );
+      final res = await client.createEmbedding(request: request);
+      expect(res.data, hasLength(1));
+      expect(res.data.first.index, 0);
+      expect(res.data.first.embeddingVector, hasLength(256));
+    });
   });
 }