@output.ai/llm 0.3.0-dev.pr341-d46aaf1 → 0.3.0-dev.pr341-daa6878

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/llm",
-  "version": "0.3.0-dev.pr341-d46aaf1",
+  "version": "0.3.0-dev.pr341-daa6878",
   "description": "Framework abstraction to interact with LLM models",
   "type": "module",
   "main": "src/index.js",

package/src/ai_sdk.js

@@ -5,6 +5,14 @@ import * as AI from 'ai';
 import { validateGenerateTextArgs, validateGenerateObjectArgs, validateGenerateArrayArgs, validateGenerateEnumArgs } from './validations.js';
 import { loadPrompt } from './prompt_loader.js';
 
+const _deprecationWarned = new Set();
+const warnDeprecated = ( name, message ) => {
+  if ( !_deprecationWarned.has( name ) ) {
+    _deprecationWarned.add( name );
+    process.emitWarning( message, { type: 'DeprecationWarning', code: `OUTPUT_DEP_${name.toUpperCase()}` } );
+  }
+};
+
 const traceWrapper = async ( { traceId, resultProperty, fn } ) => {
   try {
     const response = await fn();
@@ -97,8 +105,17 @@ export async function generateText( { prompt, variables, ...extraAiSdkOptions }
 /**
  * Use an LLM model to generate an object with a fixed schema.
  *
- * @deprecated Use generateText() with Output.object({ schema }) instead:
- *   generateText({ prompt, output: Output.object({ schema }) })
+ * @deprecated Since v0.3.0. Use generateText() with Output.object({ schema }) instead.
+ *   Will be removed in v1.0.0.
+ *
+ * @example Migration:
+ * ```js
+ * // Before (deprecated):
+ * const { object } = await generateObject({ prompt: 'my_prompt', schema: MySchema });
+ *
+ * // After (recommended):
+ * const { output } = await generateText({ prompt: 'my_prompt', output: Output.object({ schema: MySchema }) });
+ * ```
  *
  * @param {object} args - Generation arguments
  * @param {string} args.prompt - Prompt file name
@@ -106,9 +123,13 @@ export async function generateText( { prompt, variables, ...extraAiSdkOptions }
  * @param {z.ZodType} args.schema - Output schema
  * @param {string} [args.schemaName] - Output schema name
  * @param {string} [args.schemaDescription] - Output schema description
+ * @see {@link generateText} for the recommended replacement
  * @returns {Promise<GenerateObjectResult>} AI SDK response with object and metadata
  */
 export async function generateObject( args ) {
+  warnDeprecated( 'generateObject',
+    'generateObject() is deprecated since v0.3.0 and will be removed in v1.0.0. ' +
+    'Use generateText() with Output.object({ schema }) instead.' );
   validateGenerateObjectArgs( args );
   const { prompt, variables, schema, schemaName, schemaDescription, ...extraAiSdkOptions } = args;
   const loadedPrompt = loadPrompt( prompt, variables );
@@ -127,8 +148,17 @@ export async function generateObject( args ) {
 /**
  * Use an LLM model to generate an array of values with a fixed schema.
  *
- * @deprecated Use generateText() with Output.array({ element }) instead:
- *   generateText({ prompt, output: Output.array({ element: schema }) })
+ * @deprecated Since v0.3.0. Use generateText() with Output.array({ element }) instead.
+ *   Will be removed in v1.0.0.
+ *
+ * @example Migration:
+ * ```js
+ * // Before (deprecated):
+ * const { object } = await generateArray({ prompt: 'my_prompt', schema: ItemSchema });
+ *
+ * // After (recommended):
+ * const { output } = await generateText({ prompt: 'my_prompt', output: Output.array({ element: ItemSchema }) });
+ * ```
  *
  * @param {object} args - Generation arguments
  * @param {string} args.prompt - Prompt file name
@@ -136,9 +166,13 @@ export async function generateObject( args ) {
  * @param {z.ZodType} args.schema - Output schema (array item)
  * @param {string} [args.schemaName] - Output schema name
  * @param {string} [args.schemaDescription] - Output schema description
+ * @see {@link generateText} for the recommended replacement
  * @returns {Promise<GenerateObjectResult>} AI SDK response with array and metadata
  */
 export async function generateArray( args ) {
+  warnDeprecated( 'generateArray',
+    'generateArray() is deprecated since v0.3.0 and will be removed in v1.0.0. ' +
+    'Use generateText() with Output.array({ element: schema }) instead.' );
   validateGenerateArrayArgs( args );
   const { prompt, variables, schema, schemaName, schemaDescription, ...extraAiSdkOptions } = args;
   const loadedPrompt = loadPrompt( prompt, variables );
@@ -157,16 +191,29 @@ export async function generateArray( args ) {
 /**
  * Use an LLM model to generate a result from an enum (array of string values).
  *
- * @deprecated Use generateText() with Output.choice({ options }) instead:
- *   generateText({ prompt, output: Output.choice({ options: enumValues }) })
+ * @deprecated Since v0.3.0. Use generateText() with Output.choice({ options }) instead.
+ *   Will be removed in v1.0.0.
+ *
+ * @example Migration:
+ * ```js
+ * // Before (deprecated):
+ * const { object } = await generateEnum({ prompt: 'my_prompt', enum: ['yes', 'no', 'maybe'] });
+ *
+ * // After (recommended):
+ * const { output } = await generateText({ prompt: 'my_prompt', output: Output.choice({ options: ['yes', 'no', 'maybe'] }) });
+ * ```
  *
  * @param {object} args - Generation arguments
  * @param {string} args.prompt - Prompt file name
  * @param {Record<string, string | number>} [args.variables] - Variables to interpolate
  * @param {string[]} args.enum - Allowed values for the generation
+ * @see {@link generateText} for the recommended replacement
  * @returns {Promise<GenerateObjectResult>} AI SDK response with enum value and metadata
  */
 export async function generateEnum( args ) {
+  warnDeprecated( 'generateEnum',
+    'generateEnum() is deprecated since v0.3.0 and will be removed in v1.0.0. ' +
+    'Use generateText() with Output.choice({ options }) instead.' );
   validateGenerateEnumArgs( args );
   const { prompt, variables, enum: _enum, ...extraAiSdkOptions } = args;
   const loadedPrompt = loadPrompt( prompt, variables );

package/src/index.d.ts

@@ -254,8 +254,17 @@ export function generateText<
 /**
  * Use an LLM model to generate an object with a fixed schema.
  *
- * @deprecated Use generateText() with Output.object({ schema }) instead:
- *   `generateText({ prompt, output: Output.object({ schema }) })`
+ * @deprecated Since v0.3.0. Use generateText() with Output.object({ schema }) instead.
+ *   Will be removed in v1.0.0.
+ *
+ * @example Migration:
+ * ```ts
+ * // Before (deprecated):
+ * const { object } = await generateObject({ prompt: 'my_prompt', schema: MySchema });
+ *
+ * // After (recommended):
+ * const { output } = await generateText({ prompt: 'my_prompt', output: Output.object({ schema: MySchema }) });
+ * ```
  *
  * @param args - Generation arguments.
  * @param args.prompt - Prompt file name.
@@ -263,6 +272,7 @@ export function generateText<
  * @param args.schema - Output schema.
  * @param args.schemaName - Output schema name.
  * @param args.schemaDescription - Output schema description.
+ * @see {@link generateText} for the recommended replacement
  * @returns AI SDK response with object and metadata.
  */
 export function generateObject<TSchema extends z.ZodType>(
@@ -278,8 +288,17 @@ export function generateObject<TSchema extends z.ZodType>(
 /**
  * Use an LLM model to generate an array of values with a fixed schema.
  *
- * @deprecated Use generateText() with Output.array({ element }) instead:
- *   `generateText({ prompt, output: Output.array({ element: schema }) })`
+ * @deprecated Since v0.3.0. Use generateText() with Output.array({ element }) instead.
+ *   Will be removed in v1.0.0.
+ *
+ * @example Migration:
+ * ```ts
+ * // Before (deprecated):
+ * const { object } = await generateArray({ prompt: 'my_prompt', schema: ItemSchema });
+ *
+ * // After (recommended):
+ * const { output } = await generateText({ prompt: 'my_prompt', output: Output.array({ element: ItemSchema }) });
+ * ```
  *
  * @param args - Generation arguments.
  * @param args.prompt - Prompt file name.
@@ -287,6 +306,7 @@ export function generateObject<TSchema extends z.ZodType>(
  * @param args.schema - Output schema (array item).
  * @param args.schemaName - Output schema name.
  * @param args.schemaDescription - Output schema description.
+ * @see {@link generateText} for the recommended replacement
  * @returns AI SDK response with array and metadata.
  */
 export function generateArray<TSchema extends z.ZodType>(
@@ -302,13 +322,23 @@ export function generateArray<TSchema extends z.ZodType>(
 /**
  * Use an LLM model to generate a result from an enum (array of string values).
  *
- * @deprecated Use generateText() with Output.choice({ options }) instead:
- *   `generateText({ prompt, output: Output.choice({ options: enumValues }) })`
+ * @deprecated Since v0.3.0. Use generateText() with Output.choice({ options }) instead.
+ *   Will be removed in v1.0.0.
+ *
+ * @example Migration:
+ * ```ts
+ * // Before (deprecated):
+ * const { object } = await generateEnum({ prompt: 'my_prompt', enum: ['yes', 'no', 'maybe'] });
+ *
+ * // After (recommended):
+ * const { output } = await generateText({ prompt: 'my_prompt', output: Output.choice({ options: ['yes', 'no', 'maybe'] }) });
+ * ```
  *
  * @param args - Generation arguments.
  * @param args.prompt - Prompt file name.
  * @param args.variables - Variables to interpolate.
  * @param args.enum - Allowed values for the generation.
+ * @see {@link generateText} for the recommended replacement
  * @returns AI SDK response with enum value and metadata.
  */
 export function generateEnum<const TEnum extends readonly [string, ...string[]]>(