@output.ai/llm 0.2.4 → 0.2.6

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.4",
+  "version": "0.2.6",
   "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.48",
+    "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/index.d.ts

@@ -36,7 +36,7 @@ export type Prompt = {
   /** General configurations for the LLM */
   config: {
     /** LLM Provider */
-    provider: 'anthropic' | 'openai' | 'azure';
+    provider: 'anthropic' | 'openai' | 'azure' | 'vertex';
 
     /** Model name/identifier */
     model: string;
@@ -59,12 +59,12 @@ export type Prompt = {
  * Load a prompt file and render it with variables.
  *
  * @param {string} name - Name of the prompt file (without .prompt extension)
- * @param {Record<string, string | number>} [variables] - Variables to interpolate
+ * @param {Record<string, string | number | boolean>} [variables] - Variables to interpolate
  * @returns {Prompt} Loaded and rendered prompt object
  */
 export function loadPrompt(
   name: string,
-  variables?: Record<string, string | number>
+  variables?: Record<string, string | number | boolean>
 ): Prompt;
 
 /**
@@ -75,13 +75,13 @@ export function loadPrompt(
  *
  * @param {object} args - Generation arguments
  * @param {string} args.prompt - Prompt file name
- * @param {Record<string, string | number>} args.variables - Variables to interpolate
+ * @param {Record<string, string | number | boolean>} args.variables - Variables to interpolate
  * @returns {Promise<string>} Generated text
  */
 export function generateText(
   args: {
     prompt: string,
-    variables?: Record<string, string | number>
+    variables?: Record<string, string | number | boolean>
   }
 ): Promise<string>;
 
@@ -93,7 +93,7 @@ export function generateText(
  *
  * @param {object} args - Generation arguments
  * @param {string} args.prompt - Prompt file name
- * @param {Record<string, string | number>} args.variables - Variables to interpolate
+ * @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
@@ -102,7 +102,7 @@ export function generateText(
 export function generateObject<TSchema extends z.ZodObject>(
   args: {
     prompt: string,
-    variables?: Record<string, string | number>,
+    variables?: Record<string, string | number | boolean>,
     schema: TSchema,
     schemaName?: string,
     schemaDescription?: string
@@ -117,7 +117,7 @@ export function generateObject<TSchema extends z.ZodObject>(
  *
  * @param {object} args - Generation arguments
  * @param {string} args.prompt - Prompt file name
- * @param {Record<string, string | number>} args.variables - Variables to interpolate
+ * @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
@@ -126,7 +126,7 @@ export function generateObject<TSchema extends z.ZodObject>(
 export function generateArray<TSchema extends z.ZodType>(
   args: {
     prompt: string,
-    variables?: Record<string, string | number>,
+    variables?: Record<string, string | number | boolean>,
     schema: TSchema,
     schemaName?: string,
     schemaDescription?: string
@@ -141,14 +141,14 @@ export function generateArray<TSchema extends z.ZodType>(
  *
  * @param {object} args - Generation arguments
  * @param {string} args.prompt - Prompt file name
- * @param {Record<string, string | number>} args.variables - Variables to interpolate
+ * @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
  */
 export function generateEnum<const TEnum extends readonly [string, ...string[]]>(
   args: {
     prompt: string,
-    variables?: Record<string, string | number>,
+    variables?: Record<string, string | number | boolean>,
     enum: TEnum
   }
 ): Promise<TEnum[number]>;

package/src/prompt_loader.js

@@ -18,7 +18,7 @@ const renderPrompt = ( name, content, values ) => {
  * Load a prompt file and render it with variables.
  *
  * @param {string} name - Name of the prompt file (without .prompt extension)
- * @param {Record<string, string | number>} [values] - Variables to interpolate
+ * @param {Record<string, string | number | boolean>} [values] - Variables to interpolate
  * @returns {Prompt} Loaded and rendered prompt object
  */
 export const loadPrompt = ( name, values = {} ) => {

package/src/prompt_loader.spec.js

@@ -146,4 +146,34 @@ temperature: 0.7
     expect( result.config.maxTokens ).toBe( 1024 );
   } );
 
+  it( 'should render boolean variables correctly', () => {
+    const promptContent = `---
+provider: anthropic
+model: claude-3-5-sonnet-20241022
+---
+
+<user>{% if debug %}Debug mode enabled{% else %}Debug mode disabled{% endif %}</user>`;
+
+    loadContent.mockReturnValue( promptContent );
+
+    const result = loadPrompt( 'test', { debug: true } );
+
+    expect( result.messages[0].content ).toBe( 'Debug mode enabled' );
+  } );
+
+  it( 'should render false boolean variables', () => {
+    const promptContent = `---
+provider: anthropic
+model: claude-3-5-sonnet-20241022
+---
+
+<user>{% if enabled %}Feature enabled{% else %}Feature disabled{% endif %}</user>`;
+
+    loadContent.mockReturnValue( promptContent );
+
+    const result = loadPrompt( 'test', { enabled: false } );
+
+    expect( result.messages[0].content ).toBe( 'Feature disabled' );
+  } );
+
 } );

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(),