@output.ai/llm 0.2.5 → 0.2.7

package/README.md

@@ -1,99 +1,57 @@
-# LLM Module
+# @output.ai/llm
 
-Framework abstraction to interact with LLM models, including prompt management and structured generation.
+Unified LLM generation API with built-in prompt templating for Output Framework workflows.
 
-## Quick Start
+[![npm version](https://img.shields.io/npm/v/@output.ai/llm)](https://www.npmjs.com/package/@output.ai/llm)
+[![Documentation](https://img.shields.io/badge/docs-docs.output.ai-blue)](https://docs.output.ai/packages/llm)
 
-```js
-import { generateText } from '@output.ai/llm';
+## Installation
 
-const response = await generateText({
-  prompt: 'my_prompt@v1',
-  variables: { topic: 'AI workflows' }
-});
+```bash
+npm install @output.ai/llm
 ```
 
-## Features
-
-- **Unified API**: Single import for prompt loading and LLM generation
-- **Multiple Generation Types**: Text, objects, arrays, and enums
-- **Prompt Management**: Load and render `.prompt` files with variable interpolation
-- **Multi-Provider Support**: Anthropic, OpenAI, and Azure
-- **Type Safety**: Full TypeScript support with Zod schemas
-
-## Generate Text
-
-Generate unstructured text from an LLM:
+## Quick Start
 
-```js
+```typescript
 import { generateText } from '@output.ai/llm';
 
-const response = await generateText({
-  prompt: 'explain_topic@v1',
-  variables: { topic: 'machine learning' }
+const result = await generateText({
+  prompt: 'summarize@v1',
+  variables: { text: 'Your content here' }
 });
 ```
 
-## Generate Object
+## Generation Functions
+
+| Function | Description |
+|----------|-------------|
+| `generateText` | Generate unstructured text |
+| `generateObject` | Generate a structured object matching a Zod schema |
+| `generateArray` | Generate an array of structured items |
+| `generateEnum` | Generate a value from allowed options |
 
-Generate a structured object matching a Zod schema:
+### Example: Structured Output
 
-```js
+```typescript
 import { generateObject } from '@output.ai/llm';
 import { z } from '@output.ai/core';
 
-const recipeSchema = z.object({
-  title: z.string(),
-  ingredients: z.array(z.string()),
-  steps: z.array(z.string())
-});
-
 const recipe = await generateObject({
   prompt: 'recipe@v1',
   variables: { dish: 'lasagna' },
-  schema: recipeSchema
-});
-```
-
-## Generate Array
-
-Generate an array of structured items:
-
-```js
-import { generateArray } from '@output.ai/llm';
-import { z } from '@output.ai/core';
-
-const taskSchema = z.object({
-  title: z.string(),
-  priority: z.number()
-});
-
-const tasks = await generateArray({
-  prompt: 'task_list@v1',
-  variables: { project: 'website' },
-  schema: taskSchema
-});
-```
-
-## Generate Enum
-
-Generate a value from a list of allowed options:
-
-```js
-import { generateEnum } from '@output.ai/llm';
-
-const category = await generateEnum({
-  prompt: 'categorize@v1',
-  variables: { text: 'Product announcement' },
-  enum: ['marketing', 'engineering', 'sales', 'support']
+  schema: z.object({
+    title: z.string(),
+    ingredients: z.array(z.string()),
+    steps: z.array(z.string())
+  })
 });
 ```
 
 ## Prompt Files
 
-Prompt files use YAML frontmatter for configuration and support LiquidJS templating:
+Prompt files use YAML frontmatter for configuration and LiquidJS for templating:
 
-**File: `explain_topic@v1.prompt`**
 ```yaml
 ---
 provider: anthropic
@@ -102,27 +60,23 @@ temperature: 0.7
 ---
 
 <system>
-You are a concise technical explainer.
+You are a helpful assistant.
 </system>
 
 <user>
-Explain {{ topic }} in 3 bullet points.
+{{ user_message }}
 </user>
 ```
 
-## Configuration Options
+### Supported Providers
 
-Prompt files support these configuration fields:
+- **Anthropic** - Requires `ANTHROPIC_API_KEY`
+- **OpenAI** - Requires `OPENAI_API_KEY`
+- **Azure OpenAI** - Requires Azure-specific environment variables
 
-```yaml
----
-provider: anthropic | openai | azure
-model: model-name
-temperature: 0.0-1.0 (optional)
-maxTokens: number (optional)
-providerOptions: (optional)
-  thinking:
-    type: enabled
-    budgetTokens: number
----
-```
+## Documentation
+
+For comprehensive documentation, visit:
+
+- [Package Reference](https://docs.output.ai/packages/llm)
+- [Getting Started](https://docs.output.ai/quickstart)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/llm",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "Framework abstraction to interact with LLM models",
   "type": "module",
   "main": "src/index.js",
@@ -11,11 +11,15 @@
   "dependencies": {
     "@ai-sdk/anthropic": "2.0.28",
     "@ai-sdk/azure": "2.0.53",
+    "@ai-sdk/google-vertex": "3.0.96",
     "@ai-sdk/openai": "2.0.52",
     "@output.ai/core": ">=0.0.1",
     "ai": "5.0.52",
     "gray-matter": "4.0.3",
     "liquidjs": "10.22.0"
   },
-  "license": "UNLICENSED"
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/src/ai_model.js

@@ -1,8 +1,9 @@
 import { anthropic } from '@ai-sdk/anthropic';
 import { azure } from '@ai-sdk/azure';
+import { vertex } from '@ai-sdk/google-vertex';
 import { openai } from '@ai-sdk/openai';
 
-const providers = { azure, anthropic, openai };
+const providers = { azure, anthropic, openai, vertex };
 
 export function loadModel( prompt ) {
   const config = prompt?.config;

package/src/ai_sdk.spec.js

@@ -167,4 +167,162 @@ describe( 'ai_sdk', () => {
     } );
     expect( result ).toBe( 'B' );
   } );
+
+  it( 'generateText: passes provider-specific options to AI SDK', async () => {
+    const promptWithProviderOptions = {
+      config: {
+        provider: 'anthropic',
+        model: 'claude-sonnet-4-20250514',
+        providerOptions: {
+          thinking: {
+            type: 'enabled',
+            budgetTokens: 5000
+          },
+          anthropic: {
+            effort: 'medium',
+            customOption: 'value'
+          },
+          customField: 'should-be-passed'
+        }
+      },
+      messages: [ { role: 'user', content: 'Test' } ]
+    };
+    loadPromptImpl.mockReturnValueOnce( promptWithProviderOptions );
+
+    const { generateText } = await importSut();
+    await generateText( { prompt: 'test_prompt@v1' } );
+
+    expect( aiFns.generateText ).toHaveBeenCalledWith( {
+      model: 'MODEL',
+      messages: promptWithProviderOptions.messages,
+      providerOptions: {
+        thinking: {
+          type: 'enabled',
+          budgetTokens: 5000
+        },
+        anthropic: {
+          effort: 'medium',
+          customOption: 'value'
+        },
+        customField: 'should-be-passed'
+      }
+    } );
+  } );
+
+  it( 'generateObject: passes provider-specific options to AI SDK', async () => {
+    const promptWithOpenAIOptions = {
+      config: {
+        provider: 'openai',
+        model: 'o3-mini',
+        temperature: 0.8,
+        providerOptions: {
+          openai: {
+            reasoningEffort: 'high',
+            reasoningSummary: 'detailed'
+          }
+        }
+      },
+      messages: [ { role: 'user', content: 'Generate object' } ]
+    };
+    loadPromptImpl.mockReturnValueOnce( promptWithOpenAIOptions );
+
+    const { generateObject } = await importSut();
+    const schema = z.object( { result: z.string() } );
+    await generateObject( { prompt: 'test_prompt@v1', schema } );
+
+    expect( aiFns.generateObject ).toHaveBeenCalledWith( {
+      output: 'object',
+      schema,
+      schemaName: undefined,
+      schemaDescription: undefined,
+      model: 'MODEL',
+      messages: promptWithOpenAIOptions.messages,
+      temperature: 0.8,
+      providerOptions: {
+        openai: {
+          reasoningEffort: 'high',
+          reasoningSummary: 'detailed'
+        }
+      }
+    } );
+  } );
+
+  it( 'generateArray: passes azure-specific options to AI SDK', async () => {
+    const promptWithAzureOptions = {
+      config: {
+        provider: 'azure',
+        model: 'gpt-4',
+        maxTokens: 2000,
+        providerOptions: {
+          azure: {
+            deploymentName: 'my-deployment',
+            apiVersion: '2023-12-01-preview'
+          }
+        }
+      },
+      messages: [ { role: 'user', content: 'Generate array' } ]
+    };
+    loadPromptImpl.mockReturnValueOnce( promptWithAzureOptions );
+
+    const { generateArray } = await importSut();
+    const schema = z.string();
+    await generateArray( { prompt: 'test_prompt@v1', schema } );
+
+    expect( aiFns.generateObject ).toHaveBeenCalledWith( {
+      output: 'array',
+      schema,
+      schemaName: undefined,
+      schemaDescription: undefined,
+      model: 'MODEL',
+      messages: promptWithAzureOptions.messages,
+      maxOutputTokens: 2000,
+      providerOptions: {
+        azure: {
+          deploymentName: 'my-deployment',
+          apiVersion: '2023-12-01-preview'
+        }
+      }
+    } );
+  } );
+
+  it( 'generateEnum: passes mixed provider options to AI SDK', async () => {
+    const promptWithMixedOptions = {
+      config: {
+        provider: 'anthropic',
+        model: 'claude-3-opus-20240229',
+        providerOptions: {
+          thinking: {
+            type: 'enabled',
+            budgetTokens: 3000
+          },
+          anthropic: {
+            effort: 'high'
+          },
+          customField: { nested: 'value' }
+        }
+      },
+      messages: [ { role: 'user', content: 'Choose option' } ]
+    };
+    loadPromptImpl.mockReturnValueOnce( promptWithMixedOptions );
+
+    const { generateEnum } = await importSut();
+    await generateEnum( { prompt: 'test_prompt@v1', enum: [ 'A', 'B', 'C' ] } );
+
+    expect( aiFns.generateObject ).toHaveBeenCalledWith( {
+      output: 'enum',
+      enum: [ 'A', 'B', 'C' ],
+      model: 'MODEL',
+      messages: promptWithMixedOptions.messages,
+      providerOptions: {
+        thinking: {
+          type: 'enabled',
+          budgetTokens: 3000
+        },
+        anthropic: {
+          effort: 'high'
+        },
+        customField: { nested: 'value' }
+      }
+    } );
+  } );
 } );

package/src/index.d.ts

@@ -1,23 +1,28 @@
 import type { z } from '@output.ai/core';
 
 /**
- * Represents a single message in a prompt conversation
+ * Represents a single message in a prompt conversation.
+ *
  * @example
+ * ```ts
  * const msg: PromptMessage = {
  *   role: 'user',
  *   content: 'Hello, Claude!'
  * };
+ * ```
  */
 export type PromptMessage = {
-  /** The role of the message. Examples: 'system', 'user', 'assistant' */
+  /** The role of the message. Examples include 'system', 'user', and 'assistant'. */
   role: string;
   /** The content of the message */
   content: string;
 };
 
 /**
- * Configuration for LLM prompt generation
+ * Configuration for LLM prompt generation.
+ *
  * @example
+ * ```ts
  * const prompt: Prompt = {
  *   name: 'summarizePrompt',
  *   config: {
@@ -28,15 +33,16 @@ export type PromptMessage = {
  *   },
  *   messages: [...]
  * };
+ * ```
  */
 export type Prompt = {
   /** Name of the prompt file */
   name: string;
 
-  /** General configurations for the LLM */
+  /** General configuration for the LLM */
   config: {
-    /** LLM Provider */
-    provider: 'anthropic' | 'openai' | 'azure';
+    /** LLM provider */
+    provider: 'anthropic' | 'openai' | 'azure' | 'vertex';
 
     /** Model name/identifier */
     model: string;
@@ -44,10 +50,10 @@ export type Prompt = {
     /** Generation temperature (0-2). Lower = more deterministic */
     temperature?: number;
 
-    /** Maximum tokens in the response */
+    /** Maximum number of tokens in the response */
     maxTokens?: number;
 
-    /** Provider-specific configurations */
+    /** Provider-specific options */
     providerOptions?: Record<string, unknown>;
   };
 
@@ -56,11 +62,11 @@ export type Prompt = {
 };
 
 /**
- * Load a prompt file and render it with variables.
+ * Loads a prompt file and interpolates variables into its content.
  *
- * @param {string} name - Name of the prompt file (without .prompt extension)
- * @param {Record<string, string | number | boolean>} [variables] - Variables to interpolate
- * @returns {Prompt} Loaded and rendered prompt object
+ * @param name - Name of the prompt file (without `.prompt` extension).
+ * @param variables - Variables to interpolate.
+ * @returns The loaded prompt object.
  */
 export function loadPrompt(
   name: string,
@@ -71,12 +77,12 @@ export function loadPrompt(
  * Use an LLM model to generate text.
  *
  * This function is a wrapper over the AI SDK's `generateText`.
- * The prompt file sets `model`, `messages`, `temperature`, `max_tokens`, and `provider_options`.
+ * The prompt file sets `model`, `messages`, `temperature`, `maxTokens`, and `providerOptions`.
  *
- * @param {object} args - Generation arguments
- * @param {string} args.prompt - Prompt file name
- * @param {Record<string, string | number | boolean>} args.variables - Variables to interpolate
- * @returns {Promise<string>} Generated text
+ * @param args - Generation arguments.
+ * @param args.prompt - Prompt file name.
+ * @param args.variables - Variables to interpolate.
+ * @returns Generated text.
  */
 export function generateText(
   args: {
@@ -89,15 +95,15 @@ export function generateText(
  * Use an LLM model to generate an object with a fixed schema.
  *
  * This function is a wrapper over the AI SDK's `generateObject`.
- * The prompt file sets `model`, `messages`, `temperature`, `max_tokens`, and `provider_options`.
+ * The prompt file sets `model`, `messages`, `temperature`, `maxTokens`, and `providerOptions`.
  *
- * @param {object} args - Generation arguments
- * @param {string} args.prompt - Prompt file name
- * @param {Record<string, string | number | boolean>} args.variables - Variables to interpolate
- * @param {z.ZodObject} args.schema - Output schema
- * @param {string} [args.schemaName] - Output schema name
- * @param {string} [args.schemaDescription] - Output schema description
- * @returns {Promise<object>} Object matching the provided schema
+ * @param args - Generation arguments.
+ * @param args.prompt - Prompt file name.
+ * @param args.variables - Variables to interpolate.
+ * @param args.schema - Output schema.
+ * @param args.schemaName - Output schema name.
+ * @param args.schemaDescription - Output schema description.
+ * @returns Resolves to an object matching the provided schema.
  */
 export function generateObject<TSchema extends z.ZodObject>(
   args: {
@@ -113,15 +119,15 @@ export function generateObject<TSchema extends z.ZodObject>(
  * Use an LLM model to generate an array of values with a fixed schema.
  *
  * This function is a wrapper over the AI SDK's `generateObject` with `output: 'array'`.
- * The prompt file sets `model`, `messages`, `temperature`, `max_tokens`, and `provider_options`.
+ * The prompt file sets `model`, `messages`, `temperature`, `maxTokens`, and `providerOptions`.
  *
- * @param {object} args - Generation arguments
- * @param {string} args.prompt - Prompt file name
- * @param {Record<string, string | number | boolean>} args.variables - Variables to interpolate
- * @param {z.ZodType} args.schema - Output schema (array item)
- * @param {string} [args.schemaName] - Output schema name
- * @param {string} [args.schemaDescription] - Output schema description
- * @returns {Promise<object>} Array where each element matches the schema
+ * @param args - Generation arguments.
+ * @param args.prompt - Prompt file name.
+ * @param args.variables - Variables to interpolate.
+ * @param args.schema - Output schema (array item).
+ * @param args.schemaName - Output schema name.
+ * @param args.schemaDescription - Output schema description.
+ * @returns Resolves to an array where each element matches the schema.
  */
 export function generateArray<TSchema extends z.ZodType>(
   args: {
@@ -137,13 +143,13 @@ export function generateArray<TSchema extends z.ZodType>(
  * Use an LLM model to generate a result from an enum (array of string values).
  *
  * This function is a wrapper over the AI SDK's `generateObject` with `output: 'enum'`.
- * The prompt file sets `model`, `messages`, `temperature`, `max_tokens`, and `provider_options`.
+ * The prompt file sets `model`, `messages`, `temperature`, `maxTokens`, and `providerOptions`.
  *
- * @param {object} args - Generation arguments
- * @param {string} args.prompt - Prompt file name
- * @param {Record<string, string | number | boolean>} args.variables - Variables to interpolate
- * @param {string[]} args.enum - Allowed values for the generation
- * @returns {Promise<string>} One of the provided enum values
+ * @param args - Generation arguments.
+ * @param args.prompt - Prompt file name.
+ * @param args.variables - Variables to interpolate.
+ * @param args.enum - Allowed values for the generation.
+ * @returns Resolves to one of the provided enum values.
  */
 export function generateEnum<const TEnum extends readonly [string, ...string[]]>(
   args: {

package/src/prompt_validations.js

@@ -3,7 +3,7 @@ import { ValidationError, z } from '@output.ai/core';
 export const promptSchema = z.object( {
   name: z.string(),
   config: z.object( {
-    provider: z.enum( [ 'anthropic', 'azure', 'openai' ] ),
+    provider: z.enum( [ 'anthropic', 'azure', 'openai', 'vertex' ] ),
     model: z.string(),
     temperature: z.number().optional(),
     maxTokens: z.number().optional(),
@@ -11,8 +11,13 @@ export const promptSchema = z.object( {
       thinking: z.object( {
         type: z.literal( 'enabled' ),
         budgetTokens: z.number()
-      } ).strict().optional()
-    } ).strict().optional()
+      } ).optional(),
+      anthropic: z.record( z.string(), z.unknown() ).optional(),
+      openai: z.record( z.string(), z.unknown() ).optional(),
+      azure: z.record( z.string(), z.unknown() ).optional(),
+      vertex: z.record( z.string(), z.unknown() ).optional(),
+      google: z.record( z.string(), z.unknown() ).optional()
+    } ).passthrough().optional()
   } ).strict(),
   messages: z.array(
     z.object( {
@@ -35,6 +40,19 @@ const getHintForError = errorMessage => {
   return '';
 };
 
+// Known providerOptions fields. Note: these don't map 1:1 to providers.
+// - 'google' is used by Vertex provider for Gemini language models
+// - 'vertex' is used by Vertex provider for Imagen image models
+// - 'anthropic' is used by both Anthropic provider and Vertex Anthropic
+const knownProviderOptionsFields = new Set( [
+  'thinking',
+  'anthropic',
+  'openai',
+  'azure',
+  'vertex',
+  'google'
+] );
+
 export function validatePrompt( prompt ) {
   const result = promptSchema.safeParse( prompt );
   if ( !result.success ) {
@@ -47,4 +65,12 @@ export function validatePrompt( prompt ) {
       { cause: result.error }
     );
   }
+
+  const providerOptions = prompt?.config?.providerOptions;
+  if ( providerOptions ) {
+    const unknownFields = Object.keys( providerOptions ).filter( k => !knownProviderOptionsFields.has( k ) );
+    if ( unknownFields.length > 0 ) {
+      console.warn( `Prompt "${prompt.name}": Unrecognized providerOptions fields: ${unknownFields.join( ', ' )}` );
+    }
+  }
 }

package/src/prompt_validations.spec.js

@@ -65,6 +65,115 @@ describe( 'validatePrompt', () => {
     expect( () => validatePrompt( promptWithThinking ) ).not.toThrow();
   } );
 
+  it( 'should validate a prompt with anthropic-specific providerOptions', () => {
+    const promptWithAnthropicOptions = {
+      name: 'anthropic-options-prompt',
+      config: {
+        provider: 'anthropic',
+        model: 'claude-sonnet-4-20250514',
+        providerOptions: {
+          thinking: {
+            type: 'enabled',
+            budgetTokens: 5000
+          },
+          anthropic: {
+            effort: 'medium',
+            customOption: 'value'
+          }
+        }
+      },
+      messages: [
+        {
+          role: 'user',
+          content: 'Solve this problem.'
+        }
+      ]
+    };
+
+    expect( () => validatePrompt( promptWithAnthropicOptions ) ).not.toThrow();
+  } );
+
+  it( 'should validate a prompt with openai-specific providerOptions', () => {
+    const promptWithOpenAIOptions = {
+      name: 'openai-options-prompt',
+      config: {
+        provider: 'openai',
+        model: 'o3-mini',
+        providerOptions: {
+          openai: {
+            reasoningEffort: 'high',
+            reasoningSummary: 'detailed',
+            customParameter: 'test'
+          }
+        }
+      },
+      messages: [
+        {
+          role: 'user',
+          content: 'Analyze this data.'
+        }
+      ]
+    };
+
+    expect( () => validatePrompt( promptWithOpenAIOptions ) ).not.toThrow();
+  } );
+
+  it( 'should validate a prompt with azure-specific providerOptions', () => {
+    const promptWithAzureOptions = {
+      name: 'azure-options-prompt',
+      config: {
+        provider: 'azure',
+        model: 'gpt-4',
+        providerOptions: {
+          azure: {
+            deploymentName: 'my-deployment',
+            customConfig: { key: 'value' }
+          }
+        }
+      },
+      messages: [
+        {
+          role: 'user',
+          content: 'Process this request.'
+        }
+      ]
+    };
+
+    expect( () => validatePrompt( promptWithAzureOptions ) ).not.toThrow();
+  } );
+
+  it( 'should validate a prompt with mixed providerOptions including unknown fields', () => {
+    const promptWithMixedOptions = {
+      name: 'mixed-options-prompt',
+      config: {
+        provider: 'anthropic',
+        model: 'claude-3-opus-20240229',
+        providerOptions: {
+          thinking: {
+            type: 'enabled',
+            budgetTokens: 3000
+          },
+          anthropic: {
+            effort: 'high'
+          },
+          customProviderField: 'should-be-allowed',
+          anotherCustomField: {
+            nested: 'value',
+            array: [ 1, 2, 3 ]
+          }
+        }
+      },
+      messages: [
+        {
+          role: 'user',
+          content: 'Complex request with multiple options.'
+        }
+      ]
+    };
+
+    expect( () => validatePrompt( promptWithMixedOptions ) ).not.toThrow();
+  } );
+
   it( 'should throw ValidationError when provider is invalid', () => {
     const invalidPrompt = {
       name: 'invalid-provider',