@future-explorer/lib 1.0.9 → 1.0.10

package/README.md

@@ -87,11 +87,11 @@ const SentimentSchema = z.object({
 });
 
 // Generate structured response
-const result = await client.generateStructuredResponse(
-  SentimentSchema,
-  'I absolutely love this product!',
-  'You are a sentiment analysis expert.'
-);
+const result = await client.generateStructuredResponse({
+  schema: SentimentSchema,
+  userPrompt: 'I absolutely love this product!',
+  systemMessage: 'You are a sentiment analysis expert.',
+});
 
 console.log(result.sentiment); // 'positive'
 console.log(result.confidence); // 0.95
@@ -108,7 +108,7 @@ console.log(result.summary); // '...'
 
 ### Methods
 
-- `generateStructuredResponse<T>(schema, userPrompt, systemMessage?)`: Generates a structured response matching the Zod schema
+- `generateStructuredResponse<T>(params: GenerateObjectParams<T>)`: Generates a structured response matching the Zod schema. Accepts `schema`, `userPrompt`, `systemMessage`, plus any additional `generateObject()` options
 - `getModel()`: Returns the underlying LanguageModel instance
 
 ## Development

package/dist/clients/ai/unified/unified-ai-client.d.ts

@@ -1,6 +1,5 @@
 import { LanguageModel } from 'ai';
-import { ZodSchema } from 'zod';
-import { Provider } from './unified-ai-client.model';
+import { GenerateObjectParams, Provider } from './unified-ai-client.model';
 /**
  * Unified AI Client that supports multiple AI providers (OpenAI, XAI, Gemini)
  * and allows generating structured responses based on Zod schemas.
@@ -13,11 +12,8 @@ export declare class UnifiedAiClient {
      *
      * @template T - The type inferred from the Zod schema
      *
-     * @param schema - Zod schema defining the expected response structure.
-     *                 The AI model will be constrained to return data matching this schema.
-     * @param prompt - User input/message to send to the AI model (role: user)
-     * @param system - Optional system instructions that define the AI's behavior,
-     *                 persona, and task context (role: system)
+     * @param params - Configuration object for the structured response generation.
+     *                  See {@link GenerateObjectParams} for all available options.
      *
      * @returns Promise resolving to the validated object matching the schema type T
      *
@@ -33,16 +29,16 @@ export declare class UnifiedAiClient {
      * });
      *
      * // Generate structured response
-     * const result = await service.generateStructuredResponse(
-     *   SentimentSchema,
-     *   'I absolutely love this product!',
-     *   'You are a sentiment analysis expert. Be precise with confidence scores.'
-     * );
+     * const result = await service.generateStructuredResponse({
+     *   schema: SentimentSchema,
+     *   userPrompt: 'I absolutely love this product!',
+     *   systemMessage: 'You are a sentiment analysis expert. Be precise with confidence scores.',
+     * });
      *
      * console.log(result.sentiment);   // 'positive'
      * console.log(result.confidence);  // 0.95
      */
-    generateStructuredResponse<T>(schema: ZodSchema<T>, userPrompt: string, systemMessage?: string): Promise<T>;
+    generateStructuredResponse<T>(params: GenerateObjectParams<T>): Promise<T>;
     /**
      * Retrieves the underlying LanguageModel instance.
      * @returns The LanguageModel instance used by the UnifiedAiClient.

package/dist/clients/ai/unified/unified-ai-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unified-ai-client.d.ts","sourceRoot":"","sources":["../../../../src/clients/ai/unified/unified-ai-client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAkB,aAAa,EAAE,MAAM,IAAI,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAErD;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,KAAK,CAAgB;gBAEjB,QAAQ,EAAE,QAAQ;IAI9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,0BAA0B,CAAC,CAAC,EAChC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,UAAU,EAAE,MAAM,EAClB,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,CAAC,CAAC;IAWb;;;OAGG;IACH,QAAQ,IAAI,aAAa;IAIzB,OAAO,CAAC,WAAW;CAYpB"}
+{"version":3,"file":"unified-ai-client.d.ts","sourceRoot":"","sources":["../../../../src/clients/ai/unified/unified-ai-client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAkB,aAAa,EAAE,MAAM,IAAI,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAE3E;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,KAAK,CAAgB;gBAEjB,QAAQ,EAAE,QAAQ;IAI9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,0BAA0B,CAAC,CAAC,EAAE,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAchF;;;OAGG;IACH,QAAQ,IAAI,aAAa;IAIzB,OAAO,CAAC,WAAW;CAYpB"}

package/dist/clients/ai/unified/unified-ai-client.js

@@ -20,11 +20,8 @@ class UnifiedAiClient {
      *
      * @template T - The type inferred from the Zod schema
      *
-     * @param schema - Zod schema defining the expected response structure.
-     *                 The AI model will be constrained to return data matching this schema.
-     * @param prompt - User input/message to send to the AI model (role: user)
-     * @param system - Optional system instructions that define the AI's behavior,
-     *                 persona, and task context (role: system)
+     * @param params - Configuration object for the structured response generation.
+     *                  See {@link GenerateObjectParams} for all available options.
      *
      * @returns Promise resolving to the validated object matching the schema type T
      *
@@ -40,17 +37,19 @@ class UnifiedAiClient {
      * });
      *
      * // Generate structured response
-     * const result = await service.generateStructuredResponse(
-     *   SentimentSchema,
-     *   'I absolutely love this product!',
-     *   'You are a sentiment analysis expert. Be precise with confidence scores.'
-     * );
+     * const result = await service.generateStructuredResponse({
+     *   schema: SentimentSchema,
+     *   userPrompt: 'I absolutely love this product!',
+     *   systemMessage: 'You are a sentiment analysis expert. Be precise with confidence scores.',
+     * });
      *
      * console.log(result.sentiment);   // 'positive'
      * console.log(result.confidence);  // 0.95
      */
-    async generateStructuredResponse(schema, userPrompt, systemMessage) {
+    async generateStructuredResponse(params) {
+        const { schema, userPrompt, systemMessage, ...rest } = params;
         const result = await (0, ai_1.generateObject)({
+            ...rest,
             model: this.model,
             schema: schema, // Option 2: Use jsonSchema instead of Zod directly: schema: jsonSchema<T>(zodToJsonSchema(schema) as any),
             prompt: userPrompt,

package/dist/clients/ai/unified/unified-ai-client.model.d.ts

@@ -1,3 +1,22 @@
+import { generateObject } from 'ai';
+import { ZodSchema } from 'zod';
+/**
+ * Options for generating a structured response from the AI model.
+ *
+ * @template T - The type inferred from the Zod schema
+ *
+ * Includes the core params (schema, userPrompt, systemMessage) plus
+ * any additional options supported by the underlying `generateObject()` call
+ * (e.g. mode, schemaName, schemaDescription, maxTokens, temperature, etc.).
+ */
+export interface GenerateObjectParams<T> extends Omit<Parameters<typeof generateObject>[0], 'model' | 'schema' | 'prompt' | 'system' | 'messages'> {
+    /** Zod schema defining the expected response structure. */
+    schema: ZodSchema<T>;
+    /** User input/message to send to the AI model (role: user). */
+    userPrompt: string;
+    /** Optional system instructions that define the AI's behavior, persona, and task context (role: system). */
+    systemMessage?: string;
+}
 /**
  * Enum representing supported AI providers.
  */

package/dist/clients/ai/unified/unified-ai-client.model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unified-ai-client.model.d.ts","sourceRoot":"","sources":["../../../../src/clients/ai/unified/unified-ai-client.model.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,QAAQ;IAClB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,GAAG,QAAQ;IACX;;OAEG;IACH,MAAM,WAAW;CAClB"}
+{"version":3,"file":"unified-ai-client.model.d.ts","sourceRoot":"","sources":["../../../../src/clients/ai/unified/unified-ai-client.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAEhC;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,CACrC,SAAQ,IAAI,CACV,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,EACpC,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CACtD;IACD,2DAA2D;IAC3D,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACrB,+DAA+D;IAC/D,UAAU,EAAE,MAAM,CAAC;IACnB,4GAA4G;IAC5G,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,oBAAY,QAAQ;IAClB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,GAAG,QAAQ;IACX;;OAEG;IACH,MAAM,WAAW;CAClB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@future-explorer/lib",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "Shared utilities and clients for Future Explorer projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",