@bedrockio/ai 0.9.0 → 0.9.1

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.1
+
+- Pass interpolated instructions back in result.
+
 ## 0.9.0
 
 - Function calls are now handled out of the box.

package/dist/cjs/BaseClient.js

@@ -23,7 +23,7 @@ class BaseClient {
      */
     async prompt(options) {
         options = this.normalizeOptions(options);
-        const { output, stream, schema } = options;
+        const { output, stream, schema, instructions } = options;
         const response = await this.runPrompt(options);
         if (!stream) {
             this.debug('Response:', response, options);
@@ -45,6 +45,7 @@ class BaseClient {
         return {
             result,
             response,
+            instructions,
             ...this.normalizeResponse(response, options),
         };
     }
@@ -156,14 +157,14 @@ class BaseClient {
     }
     normalizeInputs(options) {
         options = this.normalizeTemplateOptions(options);
-        let { system, output = 'text' } = options;
+        let { instructions, output = 'text' } = options;
         if (output === 'json') {
-            system = [system, 'Output only valid JSON.'].join('\n\n');
+            instructions = [instructions, 'Output only valid JSON.'].join('\n\n');
         }
         const messages = this.normalizeMessages(options);
         return {
-            system,
             messages,
+            instructions,
         };
     }
     normalizeTemplateOptions(options) {
@@ -175,7 +176,7 @@ class BaseClient {
             params,
             template,
         });
-        let system = '';
+        let instructions = '';
         let { messages = [] } = options;
         // Templates may contain multiple roles, ie SYSTEM or USER, making them
         // useful for one-off prompting. However in a multi-turn conversation
@@ -188,7 +189,7 @@ class BaseClient {
             const { title = 'system', content } = section;
             const role = title.toLowerCase();
             if (role === 'system') {
-                system += [system, content].join('\n');
+                instructions += [instructions, content].join('\n');
             }
             else if (!hasUserMessages) {
                 messages = [
@@ -200,10 +201,10 @@ class BaseClient {
                 ];
             }
         }
-        system = system.trim();
+        instructions = instructions.trim();
         return {
             ...options,
-            system,
+            instructions,
             messages,
         };
     }
@@ -274,7 +275,9 @@ class BaseClient {
 exports.default = BaseClient;
 /**
  * @typedef {Object} PromptOptions
- * @property {string|PromptMessage[]} input - Input to use.
+ * @property {string} input - Basic input to be comes user message.
+ * @property {string} instructions
+ * @property {PromptMessage[]} messages - Full message input.
  * @property {string} [model] - The model to use.
  * @property {boolean} stream - Stream response.
  * @property {Object} [schema] - A JSON schema compatible object that defines the output shape.

package/dist/cjs/anthropic.js

@@ -22,7 +22,7 @@ class AnthropicClient extends BaseClient_js_1.default {
         return data.map((o) => o.id);
     }
     async runPrompt(options) {
-        const { model, messages, temperature, system = '', stream = false, tokens = DEFAULT_TOKENS, } = options;
+        const { model, messages, temperature, stream = false, tokens = DEFAULT_TOKENS, instructions: system = '', } = options;
         const params = {
             model,
             stream,

package/dist/cjs/openai.js

@@ -43,7 +43,7 @@ class OpenAiClient extends BaseClient_js_1.default {
         return names;
     }
     async runPrompt(options) {
-        const { model, tools, verbosity, temperature, prevResponseId, messages: input, system: instructions = '', tool_choice = 'auto', stream = false, } = options;
+        const { model, tools, verbosity, temperature, prevResponseId, messages: input, instructions = '', tool_choice = 'auto', stream = false, } = options;
         const params = {
             model,
             tools,
@@ -150,6 +150,7 @@ class OpenAiClient extends BaseClient_js_1.default {
             return {
                 type: 'stop',
                 id: event.response.id,
+                instructions: options.instructions,
                 messages: [
                     ...options.messages,
                     {

package/dist/esm/BaseClient.js

@@ -21,7 +21,7 @@ export default class BaseClient {
      */
     async prompt(options) {
         options = this.normalizeOptions(options);
-        const { output, stream, schema } = options;
+        const { output, stream, schema, instructions } = options;
         const response = await this.runPrompt(options);
         if (!stream) {
             this.debug('Response:', response, options);
@@ -43,6 +43,7 @@ export default class BaseClient {
         return {
             result,
             response,
+            instructions,
             ...this.normalizeResponse(response, options),
         };
     }
@@ -154,14 +155,14 @@ export default class BaseClient {
     }
     normalizeInputs(options) {
         options = this.normalizeTemplateOptions(options);
-        let { system, output = 'text' } = options;
+        let { instructions, output = 'text' } = options;
         if (output === 'json') {
-            system = [system, 'Output only valid JSON.'].join('\n\n');
+            instructions = [instructions, 'Output only valid JSON.'].join('\n\n');
         }
         const messages = this.normalizeMessages(options);
         return {
-            system,
             messages,
+            instructions,
         };
     }
     normalizeTemplateOptions(options) {
@@ -173,7 +174,7 @@ export default class BaseClient {
             params,
             template,
         });
-        let system = '';
+        let instructions = '';
         let { messages = [] } = options;
         // Templates may contain multiple roles, ie SYSTEM or USER, making them
         // useful for one-off prompting. However in a multi-turn conversation
@@ -186,7 +187,7 @@ export default class BaseClient {
             const { title = 'system', content } = section;
             const role = title.toLowerCase();
             if (role === 'system') {
-                system += [system, content].join('\n');
+                instructions += [instructions, content].join('\n');
             }
             else if (!hasUserMessages) {
                 messages = [
@@ -198,10 +199,10 @@ export default class BaseClient {
                 ];
             }
         }
-        system = system.trim();
+        instructions = instructions.trim();
         return {
             ...options,
-            system,
+            instructions,
             messages,
         };
     }
@@ -271,7 +272,9 @@ export default class BaseClient {
 }
 /**
  * @typedef {Object} PromptOptions
- * @property {string|PromptMessage[]} input - Input to use.
+ * @property {string} input - Basic input to be comes user message.
+ * @property {string} instructions
+ * @property {PromptMessage[]} messages - Full message input.
  * @property {string} [model] - The model to use.
  * @property {boolean} stream - Stream response.
  * @property {Object} [schema] - A JSON schema compatible object that defines the output shape.

package/dist/esm/anthropic.js

@@ -16,7 +16,7 @@ export class AnthropicClient extends BaseClient {
         return data.map((o) => o.id);
     }
     async runPrompt(options) {
-        const { model, messages, temperature, system = '', stream = false, tokens = DEFAULT_TOKENS, } = options;
+        const { model, messages, temperature, stream = false, tokens = DEFAULT_TOKENS, instructions: system = '', } = options;
         const params = {
             model,
             stream,

package/dist/esm/openai.js

@@ -37,7 +37,7 @@ export class OpenAiClient extends BaseClient {
         return names;
     }
     async runPrompt(options) {
-        const { model, tools, verbosity, temperature, prevResponseId, messages: input, system: instructions = '', tool_choice = 'auto', stream = false, } = options;
+        const { model, tools, verbosity, temperature, prevResponseId, messages: input, instructions = '', tool_choice = 'auto', stream = false, } = options;
         const params = {
             model,
             tools,
@@ -144,6 +144,7 @@ export class OpenAiClient extends BaseClient {
             return {
                 type: 'stop',
                 id: event.response.id,
+                instructions: options.instructions,
                 messages: [
                     ...options.messages,
                     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/ai",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Bedrock wrapper for common AI chatbots.",
   "type": "module",
   "scripts": {

package/types/BaseClient.d.ts

@@ -42,8 +42,8 @@ export default class BaseClient {
      */
     normalizeOptions(options: any): any;
     normalizeInputs(options: any): {
-        system: any;
         messages: any[];
+        instructions: any;
     };
     normalizeTemplateOptions(options: any): any;
     normalizeMessages(options: any): any[];
@@ -56,9 +56,14 @@ export default class BaseClient {
 }
 export type PromptOptions = {
     /**
-     * - Input to use.
+     * - Basic input to be comes user message.
      */
-    input: string | PromptMessage[];
+    input: string;
+    instructions: string;
+    /**
+     * - Full message input.
+     */
+    messages: PromptMessage[];
     /**
      * - The model to use.
      */

package/types/BaseClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../src/BaseClient.js"],"names":[],"mappings":"AAKA;IACE,0BASC;IARC,aAIC;IACD,2BAEE;IAKJ;;;;;OAKG;IACH,gBAFW,aAAa,gBAgCvB;IAED;;;;;OAKG;IACH,gBAHW,aAAa,GAAG,aAAa,gCAsDvC;IAED;;;;OAIG;IACH,wBAFW,MAAM,OAIhB;IAID,8BAGC;IAED,8BAGC;IAED,qCAGC;IAED;;OAEG;IACH,0CAGC;IAED;;OAEG;IACH,oDAIC;IAED;;OAEG;IACH,oDAIC;IAID;;OAEG;IACH,oCAOC;IAED;;;MAeC;IAED,4CAiDC;IAED,uCAoBC;IAED;;;MA4BC;IAED,uDAWC;IAED,kDAMC;CACF;;;;;WAIa,MAAM,GAAC,aAAa,EAAE;;;;YACtB,MAAM;;;;YACN,OAAO;;;;;;;;aAEP,MAAM,GAAG,MAAM;;;;;;;;;;;sBAOf,MAAM;;;UAKN,QAAQ,GAAG,MAAM,GAAG,WAAW;aAC/B,MAAM;;iCAvVa,sBAAsB"}
+{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../src/BaseClient.js"],"names":[],"mappings":"AAKA;IACE,0BASC;IARC,aAIC;IACD,2BAEE;IAKJ;;;;;OAKG;IACH,gBAFW,aAAa,gBAiCvB;IAED;;;;;OAKG;IACH,gBAHW,aAAa,GAAG,aAAa,gCAsDvC;IAED;;;;OAIG;IACH,wBAFW,MAAM,OAIhB;IAID,8BAGC;IAED,8BAGC;IAED,qCAGC;IAED;;OAEG;IACH,0CAGC;IAED;;OAEG;IACH,oDAIC;IAED;;OAEG;IACH,oDAIC;IAID;;OAEG;IACH,oCAOC;IAED;;;MAeC;IAED,4CAiDC;IAED,uCAoBC;IAED;;;MA4BC;IAED,uDAWC;IAED,kDAMC;CACF;;;;;WAIa,MAAM;kBACN,MAAM;;;;cACN,aAAa,EAAE;;;;YACf,MAAM;;;;YACN,OAAO;;;;;;;;aAEP,MAAM,GAAG,MAAM;;;;;;;;;;;sBAOf,MAAM;;;UAKN,QAAQ,GAAG,MAAM,GAAG,WAAW;aAC/B,MAAM;;iCA1Va,sBAAsB"}

package/types/openai.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.js"],"names":[],"mappings":"AAIA;IACE,6BAAoC;IAIlC,eAAiC;IAGnC;;;;OAIG;IACH,kBAHW,cAAc,qBAgCxB;IAED;;yFAiCC;IAED;;yFAKC;IAED,oCAEC;IAwBD;;;;;;;MAeC;IAED;;;MAKC;IAID;;;;;;;;;;MAmBC;CA0CF;6BAQA,GAAC,GAAK,KAAK,GACL,SAAS,GACT,WAAW,GACX,aAAa,GACb,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ;uBA3NQ,iBAAiB;mBAFrB,QAAQ"}
+{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.js"],"names":[],"mappings":"AAIA;IACE,6BAAoC;IAIlC,eAAiC;IAGnC;;;;OAIG;IACH,kBAHW,cAAc,qBAgCxB;IAED;;yFAiCC;IAED;;yFAKC;IAED,oCAEC;IAwBD;;;;;;;MAeC;IAED;;;MAKC;IAID;;;;;;;;;;MAmBC;CA2CF;6BAQA,GAAC,GAAK,KAAK,GACL,SAAS,GACT,WAAW,GACX,aAAa,GACb,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ;uBA5NQ,iBAAiB;mBAFrB,QAAQ"}