feat (provider): Define type for ObjectGenerationMode. (#3816)

vercel · Nov 21, 2024 · b446ae5 · b446ae5
1 parent d853d6d
commit b446ae5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.changeset/tame-paws-laugh.md b/.changeset/tame-paws-laugh.md
@@ -0,0 +1,5 @@
+---
+'@ai-sdk/provider': patch
+---
+
+feat (provider): Define type for ObjectGenerationMode.
diff --git a/packages/provider/src/language-model/v1/language-model-v1.ts b/packages/provider/src/language-model/v1/language-model-v1.ts
@@ -36,7 +36,7 @@ model. `undefined` can be returned if object generation is not supported.
 This is needed to generate the best objects possible w/o requiring the
 user to explicitly specify the object generation mode.
    */
-  readonly defaultObjectGenerationMode: 'json' | 'tool' | undefined;
+  readonly defaultObjectGenerationMode: LanguageModelV1ObjectGenerationMode;
 
   /**
 Flag whether this model supports image URLs. Default is `true`.
@@ -280,3 +280,9 @@ export type LanguageModelV1StreamPart =
 
   // error parts are streamed, allowing for multiple errors
   | { type: 'error'; error: unknown };
+
+/**
+The object generation modes available for use with a model. `undefined`
+represents no support for object generation.
+   */
+export type LanguageModelV1ObjectGenerationMode = 'json' | 'tool' | undefined;