@output.ai/llm 0.0.13 → 0.0.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/llm",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Framework abstraction to interact with LLM models",
   "type": "module",
   "main": "src/index.js",
@@ -13,6 +13,7 @@
     "@ai-sdk/azure": "2.0.53",
     "@ai-sdk/openai": "2.0.52",
     "@output.ai/core": ">=0.0.1",
+    "@output.ai/prompt": ">=0.0.1",
     "ai": "5.0.48"
   },
   "license": "UNLICENSED"

package/src/index.d.ts

@@ -1,44 +1,60 @@
-import type {
-  GenerateTextOptions,
-  GenerateObjectOptions
-} from 'ai';
+import type * as AiTypes from 'ai';
+import type { Prompt } from '@output.ai/prompt';
 
-export interface Prompt {
-  config: {
-    provider: 'anthropic' | 'openai' | 'azure' ;
-    model: string;
-    temperature?: number;
-    max_tokens?: number;
-  };
-  messages: Array<{
-    role: string;
-    content: string;
-  }>;
-}
+export type { Prompt };
 
-// Omit prompt/messages from AI SDK options and add our Prompt type
-export type GenerateTextOptionsWithPrompt = Omit<
-  GenerateTextOptions,
-  'prompt' | 'messages' | 'model'
-> & {
-  prompt: Prompt,
-};
+type NativeGenerateTextArgs = Parameters<typeof AiTypes.generateText>[0];
+type NativeGenerateObjectArgs = Parameters<typeof AiTypes.generateObject>[0];
 
-export type GenerateObjectOptionsWithPrompt<SCHEMA> = Omit<
-  GenerateObjectOptions<SCHEMA>,
-  'prompt' | 'messages' | 'model' | 'schema' | 'schemaName' | 'schemaDescription' | 'output'
-> & {
-  prompt: Prompt,
-  schema: Record<string, unknown> | object,
-  schemaName?: string,
-  schemaDescription?: string,
-  output?: 'object' | 'array',
-};
+/**
+ * Simplify types into a plain object
+ */
+type Simplify<T> = { [K in keyof T]: T[K] } & {};
 
+/**
+ * Text generation arguments
+ * Include all native AI SDK generateText options and a Prompt object from `@output.ai/prompt`
+ */
+export type GenerateTextArgs = Simplify<
+  Partial<Omit<NativeGenerateTextArgs, 'prompt'>> & { prompt: Prompt }
+>;
+
+/**
+ * Object generation arguments
+ * Include all native AI SDK generateObject options and a Prompt object from `@output.ai/prompt`
+ */
+export type GenerateObjectArgs = Simplify<
+  Partial<Omit<NativeGenerateObjectArgs, 'prompt'>> & { prompt: Prompt }
+>;
+
+/**
+ * Use a LLM Model to generate text
+ *
+ * This function a wrapper over AI SDK's generateText function.
+ *
+ * It accepts the same arguments of the the original function, plus a "Prompt" object, generated using the `output.ai/prompt`.
+ *
+ * The Prompt object will set `model`, `messages`, `temperature` and `max_tokens`, however all these can be overwritten by their AI SDK native argument values.
+ *
+ * @param {GenerateTextArgs} args - Generation arguments
+ * @returns {Promise<string>}
+ */
 export function generateText(
-  options: GenerateTextOptionsWithPrompt
+  args: GenerateTextArgs
 ): Promise<string>;
 
-export function generateObject<T = unknown>(
-  options: GenerateObjectOptionsWithPrompt<T>
-): Promise<T>;
+/**
+ * Use a LLM Model to generate object
+ *
+ * This function a wrapper over AI SDK's generateObject function.
+ *
+ * It accepts the same arguments of the the original function, plus a "Prompt" object, generated using the `output.ai/prompt`.
+ *
+ * The Prompt object will set `model`, `messages`, `temperature` and `max_tokens`, however all these can be overwritten by their AI SDK native argument values.
+ *
+ * @param {GenerateObjectArgs} args - Generation arguments
+ * @returns {Promise<object>}
+ */
+export function generateObject(
+  args: GenerateObjectArgs
+): Promise<object>;