openai 7.3.0 → 7.5.0

package/lib/ResponsesParser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ResponsesParser.d.ts","sourceRoot":"","sources":["../src/lib/ResponsesParser.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,yCAAsC;AACxE,OAAO,EACL,kBAAkB,EAClB,KAAK,YAAY,EAEjB,KAAK,cAAc,EAGnB,KAAK,QAAQ,EACb,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,wBAAwB,EAC7B,KAAK,IAAI,EACV,4CAAyC;AAC1C,OAAO,EAAE,KAAK,uBAAuB,EAAgC,yBAAsB;AAE3F,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,kBAAkB,GAAG,IAAI,CAAC;AAE3E,MAAM,MAAM,6BAA6B,GAAG,wBAAwB,GAAG;IACrE,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B,CAAC;AAEF,KAAK,gBAAgB,GAAG;IAAE,IAAI,CAAC,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAEtD,MAAM,MAAM,8BAA8B,CAAC,MAAM,SAAS,gBAAgB,IACxE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,uBAAuB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;AAE5F,wBAAgB,kBAAkB,CAChC,MAAM,SAAS,wBAAwB,GAAG,IAAI,EAC9C,OAAO,GAAG,MAAM,SAAS,IAAI,GAAG,IAAI,GAAG,8BAA8B,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAC1F,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAmC7D;AAED,wBAAgB,aAAa,CAC3B,MAAM,SAAS,wBAAwB,EACvC,OAAO,GAAG,8BAA8B,CAAC,MAAM,CAAC,EAChD,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAsD7D;AAkBD,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAWpF;AAED,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,GAAG,CAAC;IACf,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,yBAAyB,CACnC,QAAQ,SAAS,WAAW,EAC5B,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,QAAQ,GAAG,IAAI,GAAG,KAAK,IAChE,YAAY,GAAG;IACjB,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEzB,MAAM,EAAE,qBAAqB,CAAC;IAC9B,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC;IAC9D,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;CAChD,CAAC;AAEF,wBAAgB,yBAAyB,CAAC,QAAQ,SAAS,WAAW,EACpE,IAAI,EAAE,YAAY,EAClB,EACE,MAAM,EACN,QAAQ,GACT,EAAE;IACD,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC;CAC5C,GACA,yBAAyB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAmBlD;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,yBAAyB,CAAC,GAAG,CAAC,CAEpF;AAwBD,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,gCAAgC,GAAG,IAAI,GAAG,SAAS,EAC3D,QAAQ,EAAE,wBAAwB,GACjC,OAAO,CAOT;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,SAAS,QAczE;AASD,wBAAgB,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI,CAejD"}
+{"version":3,"file":"ResponsesParser.d.ts","sourceRoot":"","sources":["../src/lib/ResponsesParser.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,yCAAsC;AACxE,OAAO,KAAK,EACV,YAAY,EAEZ,cAAc,EAGd,QAAQ,EACR,wBAAwB,EACxB,gCAAgC,EAChC,kCAAkC,EAClC,wBAAwB,EACxB,kBAAkB,EAClB,IAAI,EACL,4CAAyC;AAE1C,OAAO,KAAK,EAAE,uBAAuB,EAAE,yBAAsB;AAE7D,sEAAsE;AACtE,MAAM,MAAM,oBAAoB,GAAG,IAAI,EAAE,GAAG,kBAAkB,GAAG,IAAI,CAAC;AAEtE,yFAAyF;AACzF,MAAM,MAAM,6BAA6B,GAAG,wBAAwB,GAAG;IACrE,iEAAiE;IACjE,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B,CAAC;AAEF,6FAA6F;AAC7F,KAAK,gBAAgB,GAAG;IACtB,gFAAgF;IAChF,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B,CAAC;AAEF,qFAAqF;AACrF,KAAK,gBAAgB,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GACpD,IAAI,GACJ,MAAM,SAAS,uBAAuB,CAAC,MAAM,OAAO,CAAC,GACnD,OAAO,GACP,MAAM,SAAS,kCAAkC,GAC/C,OAAO,GACP,IAAI,CAAC;AAEb;;;;;;;GAOG;AACH,MAAM,MAAM,8BAA8B,CAAC,MAAM,SAAS,gBAAgB,IAAI,gBAAgB,CAC5F,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CACtC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,SAAS,wBAAwB,GAAG,IAAI,EAC9C,OAAO,GAAG,MAAM,SAAS,IAAI,GAAG,IAAI,GAAG,8BAA8B,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAC1F,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAkC7D;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,MAAM,SAAS,wBAAwB,EACvC,OAAO,GAAG,8BAA8B,CAAC,MAAM,CAAC,EAChD,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAsD7D;AASD,kGAAkG;AAClG,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAWpF;AAED,4FAA4F;AAC5F,KAAK,WAAW,GAAG;IACjB,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,SAAS,EAAE,GAAG,CAAC;IACf,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC;CAC7C,CAAC;AAEF,8FAA8F;AAC9F,MAAM,MAAM,yBAAyB,CACnC,QAAQ,SAAS,WAAW,EAC5B,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,GAAG,IAAI,GAAG,KAAK,IACrF,YAAY,GAAG;IACjB,2FAA2F;IAC3F,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnC,uFAAuF;IACvF,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEzB,qFAAqF;IACrF,MAAM,EAAE,qBAAqB,CAAC;IAC9B,iFAAiF;IACjF,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC;IAC9D,oFAAoF;IACpF,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;CAChD,CAAC;AAEF,qGAAqG;AACrG,wBAAgB,yBAAyB,CAAC,QAAQ,SAAS,WAAW,EACpE,IAAI,EAAE,YAAY,EAClB,EACE,MAAM,EACN,QAAQ,GACT,EAAE;IACD,sFAAsF;IACtF,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,+EAA+E;IAC/E,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC;CAC5C,GACA,yBAAyB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAmBlD;AAED,qFAAqF;AACrF,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,yBAAyB,CAAC,GAAG,CAAC,CAEpF;AA2BD,gGAAgG;AAChG,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,gCAAgC,GAAG,IAAI,GAAG,SAAS,EAC3D,QAAQ,EAAE,wBAAwB,GACjC,OAAO,CAOT;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,SAAS,QAczE;AASD,4FAA4F;AAC5F,wBAAgB,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI,CAejD"}

package/lib/ResponsesParser.js

@@ -10,6 +10,10 @@ exports.validateInputTools = validateInputTools;
 exports.addOutputText = addOutputText;
 const error_1 = require("../error.js");
 const parser_1 = require("../lib/parser.js");
+/**
+ * Adds parsed-output fields to a response, invoking parsers only when its request
+ * includes an auto-parseable text format or strict function tool.
+ */
 function maybeParseResponse(response, params) {
     if (!params || !hasAutoParseableInput(params)) {
         const parsed = {
@@ -31,9 +35,7 @@ function maybeParseResponse(response, params) {
                         })),
                     };
                 }
-                else {
-                    return item;
-                }
+                return item;
             }),
         };
         if (needsOutputText(response, parsed)) {
@@ -43,6 +45,12 @@ function maybeParseResponse(response, params) {
     }
     return parseResponse(response, params);
 }
+/**
+ * Parses completed response text and strict function-tool arguments.
+ *
+ * Incomplete or nonterminal responses keep their parsed values as `null`, and
+ * `output_parsed` returns the first successfully parsed output-text item.
+ */
 function parseResponse(response, params) {
     const shouldParse = !response.status || response.status === 'completed';
     const output = response.output.map((item) => {
@@ -66,7 +74,7 @@ function parseResponse(response, params) {
         }
         return item;
     });
-    const parsed = Object.assign({}, response, { output });
+    const parsed = { ...response, output };
     if (needsOutputText(response, parsed)) {
         addOutputText(parsed);
     }
@@ -89,22 +97,17 @@ function parseResponse(response, params) {
     return parsed;
 }
 function parseTextFormat(params, content) {
-    if (params.text?.format?.type !== 'json_schema') {
-        return null;
-    }
-    if ('$parseRaw' in params.text?.format) {
-        const text_format = params.text?.format;
-        return text_format.$parseRaw(content);
-    }
-    return JSON.parse(content);
+    return (0, parser_1.parseResponseFormatContent)(params.text?.format, content);
 }
+/** Returns whether the request includes an auto-parseable text format or strict function tool. */
 function hasAutoParseableInput(params) {
-    if ((0, parser_1.isAutoParsableResponseFormat)(params.text?.format)) {
+    if ((0, parser_1.isParseableResponseFormat)(params.text?.format)) {
         return true;
     }
     return (Array.isArray(params.tools) &&
         params.tools.some((tool) => isAutoParsableTool(tool) || (tool.type === 'function' && tool.strict === true)));
 }
+/** Copies a Responses API function tool and attaches non-enumerable parser and callback metadata. */
 function makeParseableResponseTool(tool, { parser, callback, }) {
     const obj = { ...tool };
     Object.defineProperties(obj, {
@@ -123,6 +126,7 @@ function makeParseableResponseTool(tool, { parser, callback, }) {
     });
     return obj;
 }
+/** Returns whether a Responses API tool carries the SDK's argument-parser marker. */
 function isAutoParsableTool(tool) {
     return tool?.['$brand'] === 'auto-parseable-tool';
 }
@@ -131,14 +135,19 @@ function getInputToolByName(input_tools, name) {
 }
 function parseToolCall(params, toolCall) {
     const inputTool = getInputToolByName(params.tools ?? [], toolCall.name);
+    let parsedArguments = null;
+    if (isAutoParsableTool(inputTool)) {
+        parsedArguments = inputTool.$parseRaw(toolCall.arguments);
+    }
+    else if (inputTool?.strict) {
+        parsedArguments = JSON.parse(toolCall.arguments);
+    }
     return {
         ...toolCall,
-        ...toolCall,
-        parsed_arguments: isAutoParsableTool(inputTool) ? inputTool.$parseRaw(toolCall.arguments)
-            : inputTool?.strict ? JSON.parse(toolCall.arguments)
-                : null,
+        parsed_arguments: parsedArguments,
     };
 }
+/** Returns whether a response function call matches a strict or auto-parseable request tool. */
 function shouldParseToolCall(params, toolCall) {
     if (!params) {
         return false;
@@ -146,6 +155,11 @@ function shouldParseToolCall(params, toolCall) {
     const inputTool = getInputToolByName(params.tools ?? [], toolCall.name);
     return isAutoParsableTool(inputTool) || inputTool?.strict || false;
 }
+/**
+ * Validates that compatible chat completion tools can be automatically parsed.
+ *
+ * @throws {OpenAIError} If a tool is not a function or is missing `strict: true`.
+ */
 function validateInputTools(tools) {
     for (const tool of tools ?? []) {
         if (tool.type !== 'function') {
@@ -159,6 +173,7 @@ function validateInputTools(tools) {
 function needsOutputText(response, target) {
     return !Object.getOwnPropertyDescriptor(response, 'output_text') || target.output_text == null;
 }
+/** Replaces `output_text` with the concatenated text from every response output message. */
 function addOutputText(rsp) {
     const texts = [];
     for (const output of rsp.output) {

package/lib/ResponsesParser.js.map

@@ -1 +1 @@
-{"version":3,"file":"ResponsesParser.js","sourceRoot":"","sources":["../src/lib/ResponsesParser.ts"],"names":[],"mappings":";;AA4BA,gDAsCC;AAED,sCAyDC;AAkBD,sDAWC;AAoBD,8DA4BC;AAED,gDAEC;AAwBD,kDAUC;AAED,gDAcC;AASD,sCAeC;AAxRD,uCAAuC;AAevC,6CAA2F;AAa3F,SAAgB,kBAAkB,CAGhC,QAAkB,EAAE,MAAc;IAClC,IAAI,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG;YACb,GAAG,QAAQ;YACX,aAAa,EAAE,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACnC,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;oBAClC,OAAO;wBACL,GAAG,IAAI;wBACP,gBAAgB,EAAE,IAAI;qBACvB,CAAC;gBACJ,CAAC;gBAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO;wBACL,GAAG,IAAI;wBACP,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;4BACtC,GAAG,OAAO;4BACV,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;qBACJ,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC,CAAC;SACH,CAAC;QAEF,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YACtC,aAAa,CAAC,MAAkB,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACzC,CAAC;AAED,SAAgB,aAAa,CAG3B,QAAkB,EAAE,MAAc;IAClC,MAAM,WAAW,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,WAAW,CAAC;IACxE,MAAM,MAAM,GAA6C,QAAQ,CAAC,MAAM,CAAC,GAAG,CAC1E,CAAC,IAAI,EAAqC,EAAE;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;QACzF,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAkC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC1E,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBACnC,OAAO;wBACL,GAAG,OAAO;wBACV,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;qBACnE,CAAC;gBACJ,CAAC;gBAED,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC,CAAC;YAEH,OAAO;gBACL,GAAG,IAAI;gBACP,OAAO;aACR,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CACF,CAAC;IAEF,MAAM,MAAM,GAAmD,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACvG,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;QACtC,aAAa,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,EAAE;QAC7C,UAAU,EAAE,IAAI;QAChB,GAAG;YACD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC9B,SAAS;gBACX,CAAC;gBAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrC,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;wBAC9D,OAAO,OAAO,CAAC,MAAM,CAAC;oBACxB,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAiC,CAAC;AAC3C,CAAC;AAED,SAAS,eAAe,CAGtB,MAAc,EAAE,OAAe;IAC/B,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QACvC,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,EAAE,MAAqD,CAAC;QACvF,OAAO,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC;AAED,SAAgB,qBAAqB,CAAC,MAAqC;IACzE,IAAI,IAAA,qCAA4B,EAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CACzF,CACF,CAAC;AACJ,CAAC;AAoBD,SAAgB,yBAAyB,CACvC,IAAkB,EAClB,EACE,MAAM,EACN,QAAQ,GAIT;IAED,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAExB,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE;QAC3B,MAAM,EAAE;YACN,KAAK,EAAE,qBAAqB;YAC5B,UAAU,EAAE,KAAK;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,MAAM;YACb,UAAU,EAAE,KAAK;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,KAAK;SAClB;KACF,CAAC,CAAC;IAEH,OAAO,GAAuD,CAAC;AACjE,CAAC;AAED,SAAgB,kBAAkB,CAAC,IAAS;IAC1C,OAAO,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,qBAAqB,CAAC;AACpD,CAAC;AAED,SAAS,kBAAkB,CAAC,WAAwB,EAAE,IAAY;IAChE,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAEnE,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CACpB,MAAc,EACd,QAAkC;IAElC,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAExE,OAAO;QACL,GAAG,QAAQ;QACX,GAAG,QAAQ;QACX,gBAAgB,EACd,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC;YACvE,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACpD,CAAC,CAAC,IAAI;KACT,CAAC;AACJ,CAAC;AAED,SAAgB,mBAAmB,CACjC,MAA2D,EAC3D,QAAkC;IAElC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxE,OAAO,kBAAkB,CAAC,SAAS,CAAC,IAAI,SAAS,EAAE,MAAM,IAAI,KAAK,CAAC;AACrE,CAAC;AAED,SAAgB,kBAAkB,CAAC,KAAuC;IACxE,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,IAAI,mBAAW,CACnB,2EAA2E,IAAI,CAAC,IAAI,IAAI,CACzF,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,mBAAW,CACnB,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,4FAA4F,CACxH,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CACtB,QAAkB,EAClB,MAAwD;IAExD,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC;AACjG,CAAC;AAED,SAAgB,aAAa,CAAC,GAAa;IACzC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBACnC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED,GAAG,CAAC,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC"}
+{"version":3,"file":"ResponsesParser.js","sourceRoot":"","sources":["../src/lib/ResponsesParser.ts"],"names":[],"mappings":";;AA2DA,gDAqCC;AAQD,sCAyDC;AAUD,sDAWC;AA+BD,8DA8BC;AAGD,gDAEC;AA4BD,kDAUC;AAOD,gDAcC;AAUD,sCAeC;AA5UD,uCAAuC;AAgBvC,6CAAsF;AAuCtF;;;GAGG;AACH,SAAgB,kBAAkB,CAGhC,QAAkB,EAAE,MAAc;IAClC,IAAI,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG;YACb,GAAG,QAAQ;YACX,aAAa,EAAE,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACnC,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;oBAClC,OAAO;wBACL,GAAG,IAAI;wBACP,gBAAgB,EAAE,IAAI;qBACvB,CAAC;gBACJ,CAAC;gBAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO;wBACL,GAAG,IAAI;wBACP,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;4BACtC,GAAG,OAAO;4BACV,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;qBACJ,CAAC;gBACJ,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;SACH,CAAC;QAEF,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YACtC,aAAa,CAAC,MAAkB,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAG3B,QAAkB,EAAE,MAAc;IAClC,MAAM,WAAW,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,WAAW,CAAC;IACxE,MAAM,MAAM,GAAwC,QAAQ,CAAC,MAAM,CAAC,GAAG,CACrE,CAAC,IAAI,EAAqC,EAAE;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;QACzF,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,OAAO,GAA6B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBACrE,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBACnC,OAAO;wBACL,GAAG,OAAO;wBACV,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;qBACnE,CAAC;gBACJ,CAAC;gBAED,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC,CAAC;YAEH,OAAO;gBACL,GAAG,IAAI;gBACP,OAAO;aACR,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CACF,CAAC;IAEF,MAAM,MAAM,GAAmD,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,CAAC;IACvF,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;QACtC,aAAa,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,EAAE;QAC7C,UAAU,EAAE,IAAI;QAChB,GAAG;YACD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC9B,SAAS;gBACX,CAAC;gBAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrC,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;wBAC9D,OAAO,OAAO,CAAC,MAAM,CAAC;oBACxB,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAiC,CAAC;AAC3C,CAAC;AAED,SAAS,eAAe,CAGtB,MAAc,EAAE,OAAe;IAC/B,OAAO,IAAA,mCAA0B,EAAU,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC;AAED,kGAAkG;AAClG,SAAgB,qBAAqB,CAAC,MAAqC;IACzE,IAAI,IAAA,kCAAyB,EAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;QACnD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CACzF,CACF,CAAC;AACJ,CAAC;AA8BD,qGAAqG;AACrG,SAAgB,yBAAyB,CACvC,IAAkB,EAClB,EACE,MAAM,EACN,QAAQ,GAMT;IAED,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAExB,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE;QAC3B,MAAM,EAAE;YACN,KAAK,EAAE,qBAAqB;YAC5B,UAAU,EAAE,KAAK;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,MAAM;YACb,UAAU,EAAE,KAAK;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,KAAK;SAClB;KACF,CAAC,CAAC;IAEH,OAAO,GAAuD,CAAC;AACjE,CAAC;AAED,qFAAqF;AACrF,SAAgB,kBAAkB,CAAC,IAAS;IAC1C,OAAO,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,qBAAqB,CAAC;AACpD,CAAC;AAED,SAAS,kBAAkB,CAAC,WAAmB,EAAE,IAAY;IAC3D,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAEnE,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CACpB,MAAc,EACd,QAAkC;IAElC,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAExE,IAAI,eAAe,GAAY,IAAI,CAAC;IACpC,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,eAAe,GAAG,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC5D,CAAC;SAAM,IAAI,SAAS,EAAE,MAAM,EAAE,CAAC;QAC7B,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,OAAO;QACL,GAAG,QAAQ;QACX,gBAAgB,EAAE,eAAe;KAClC,CAAC;AACJ,CAAC;AAED,gGAAgG;AAChG,SAAgB,mBAAmB,CACjC,MAA2D,EAC3D,QAAkC;IAElC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxE,OAAO,kBAAkB,CAAC,SAAS,CAAC,IAAI,SAAS,EAAE,MAAM,IAAI,KAAK,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,KAAuC;IACxE,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,IAAI,mBAAW,CACnB,2EAA2E,IAAI,CAAC,IAAI,IAAI,CACzF,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,mBAAW,CACnB,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,4FAA4F,CACxH,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CACtB,QAAkB,EAClB,MAAwD;IAExD,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC;AACjG,CAAC;AAED,4FAA4F;AAC5F,SAAgB,aAAa,CAAC,GAAa;IACzC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBACnC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED,GAAG,CAAC,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC"}

package/lib/ResponsesParser.mjs

@@ -1,5 +1,9 @@
 import { OpenAIError } from "../error.mjs";
-import { isAutoParsableResponseFormat } from "../lib/parser.mjs";
+import { isParseableResponseFormat, parseResponseFormatContent } from "../lib/parser.mjs";
+/**
+ * Adds parsed-output fields to a response, invoking parsers only when its request
+ * includes an auto-parseable text format or strict function tool.
+ */
 export function maybeParseResponse(response, params) {
     if (!params || !hasAutoParseableInput(params)) {
         const parsed = {
@@ -21,9 +25,7 @@ export function maybeParseResponse(response, params) {
                         })),
                     };
                 }
-                else {
-                    return item;
-                }
+                return item;
             }),
         };
         if (needsOutputText(response, parsed)) {
@@ -33,6 +35,12 @@ export function maybeParseResponse(response, params) {
     }
     return parseResponse(response, params);
 }
+/**
+ * Parses completed response text and strict function-tool arguments.
+ *
+ * Incomplete or nonterminal responses keep their parsed values as `null`, and
+ * `output_parsed` returns the first successfully parsed output-text item.
+ */
 export function parseResponse(response, params) {
     const shouldParse = !response.status || response.status === 'completed';
     const output = response.output.map((item) => {
@@ -56,7 +64,7 @@ export function parseResponse(response, params) {
         }
         return item;
     });
-    const parsed = Object.assign({}, response, { output });
+    const parsed = { ...response, output };
     if (needsOutputText(response, parsed)) {
         addOutputText(parsed);
     }
@@ -79,22 +87,17 @@ export function parseResponse(response, params) {
     return parsed;
 }
 function parseTextFormat(params, content) {
-    if (params.text?.format?.type !== 'json_schema') {
-        return null;
-    }
-    if ('$parseRaw' in params.text?.format) {
-        const text_format = params.text?.format;
-        return text_format.$parseRaw(content);
-    }
-    return JSON.parse(content);
+    return parseResponseFormatContent(params.text?.format, content);
 }
+/** Returns whether the request includes an auto-parseable text format or strict function tool. */
 export function hasAutoParseableInput(params) {
-    if (isAutoParsableResponseFormat(params.text?.format)) {
+    if (isParseableResponseFormat(params.text?.format)) {
         return true;
     }
     return (Array.isArray(params.tools) &&
         params.tools.some((tool) => isAutoParsableTool(tool) || (tool.type === 'function' && tool.strict === true)));
 }
+/** Copies a Responses API function tool and attaches non-enumerable parser and callback metadata. */
 export function makeParseableResponseTool(tool, { parser, callback, }) {
     const obj = { ...tool };
     Object.defineProperties(obj, {
@@ -113,6 +116,7 @@ export function makeParseableResponseTool(tool, { parser, callback, }) {
     });
     return obj;
 }
+/** Returns whether a Responses API tool carries the SDK's argument-parser marker. */
 export function isAutoParsableTool(tool) {
     return tool?.['$brand'] === 'auto-parseable-tool';
 }
@@ -121,14 +125,19 @@ function getInputToolByName(input_tools, name) {
 }
 function parseToolCall(params, toolCall) {
     const inputTool = getInputToolByName(params.tools ?? [], toolCall.name);
+    let parsedArguments = null;
+    if (isAutoParsableTool(inputTool)) {
+        parsedArguments = inputTool.$parseRaw(toolCall.arguments);
+    }
+    else if (inputTool?.strict) {
+        parsedArguments = JSON.parse(toolCall.arguments);
+    }
     return {
         ...toolCall,
-        ...toolCall,
-        parsed_arguments: isAutoParsableTool(inputTool) ? inputTool.$parseRaw(toolCall.arguments)
-            : inputTool?.strict ? JSON.parse(toolCall.arguments)
-                : null,
+        parsed_arguments: parsedArguments,
     };
 }
+/** Returns whether a response function call matches a strict or auto-parseable request tool. */
 export function shouldParseToolCall(params, toolCall) {
     if (!params) {
         return false;
@@ -136,6 +145,11 @@ export function shouldParseToolCall(params, toolCall) {
     const inputTool = getInputToolByName(params.tools ?? [], toolCall.name);
     return isAutoParsableTool(inputTool) || inputTool?.strict || false;
 }
+/**
+ * Validates that compatible chat completion tools can be automatically parsed.
+ *
+ * @throws {OpenAIError} If a tool is not a function or is missing `strict: true`.
+ */
 export function validateInputTools(tools) {
     for (const tool of tools ?? []) {
         if (tool.type !== 'function') {
@@ -149,6 +163,7 @@ export function validateInputTools(tools) {
 function needsOutputText(response, target) {
     return !Object.getOwnPropertyDescriptor(response, 'output_text') || target.output_text == null;
 }
+/** Replaces `output_text` with the concatenated text from every response output message. */
 export function addOutputText(rsp) {
     const texts = [];
     for (const output of rsp.output) {

package/lib/ResponsesParser.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ResponsesParser.mjs","sourceRoot":"","sources":["../src/lib/ResponsesParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,qBAAiB;AAevC,OAAO,EAAgC,4BAA4B,EAAE,0BAAsB;AAa3F,MAAM,UAAU,kBAAkB,CAGhC,QAAkB,EAAE,MAAc;IAClC,IAAI,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG;YACb,GAAG,QAAQ;YACX,aAAa,EAAE,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACnC,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;oBAClC,OAAO;wBACL,GAAG,IAAI;wBACP,gBAAgB,EAAE,IAAI;qBACvB,CAAC;gBACJ,CAAC;gBAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO;wBACL,GAAG,IAAI;wBACP,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;4BACtC,GAAG,OAAO;4BACV,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;qBACJ,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC,CAAC;SACH,CAAC;QAEF,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YACtC,aAAa,CAAC,MAAkB,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,aAAa,CAG3B,QAAkB,EAAE,MAAc;IAClC,MAAM,WAAW,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,WAAW,CAAC;IACxE,MAAM,MAAM,GAA6C,QAAQ,CAAC,MAAM,CAAC,GAAG,CAC1E,CAAC,IAAI,EAAqC,EAAE;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;QACzF,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAkC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC1E,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBACnC,OAAO;wBACL,GAAG,OAAO;wBACV,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;qBACnE,CAAC;gBACJ,CAAC;gBAED,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC,CAAC;YAEH,OAAO;gBACL,GAAG,IAAI;gBACP,OAAO;aACR,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CACF,CAAC;IAEF,MAAM,MAAM,GAAmD,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACvG,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;QACtC,aAAa,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,EAAE;QAC7C,UAAU,EAAE,IAAI;QAChB,GAAG;YACD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC9B,SAAS;gBACX,CAAC;gBAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrC,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;wBAC9D,OAAO,OAAO,CAAC,MAAM,CAAC;oBACxB,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAiC,CAAC;AAC3C,CAAC;AAED,SAAS,eAAe,CAGtB,MAAc,EAAE,OAAe;IAC/B,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QACvC,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,EAAE,MAAqD,CAAC;QACvF,OAAO,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,MAAqC;IACzE,IAAI,4BAA4B,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CACzF,CACF,CAAC;AACJ,CAAC;AAoBD,MAAM,UAAU,yBAAyB,CACvC,IAAkB,EAClB,EACE,MAAM,EACN,QAAQ,GAIT;IAED,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAExB,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE;QAC3B,MAAM,EAAE;YACN,KAAK,EAAE,qBAAqB;YAC5B,UAAU,EAAE,KAAK;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,MAAM;YACb,UAAU,EAAE,KAAK;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,KAAK;SAClB;KACF,CAAC,CAAC;IAEH,OAAO,GAAuD,CAAC;AACjE,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAS;IAC1C,OAAO,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,qBAAqB,CAAC;AACpD,CAAC;AAED,SAAS,kBAAkB,CAAC,WAAwB,EAAE,IAAY;IAChE,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAEnE,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CACpB,MAAc,EACd,QAAkC;IAElC,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAExE,OAAO;QACL,GAAG,QAAQ;QACX,GAAG,QAAQ;QACX,gBAAgB,EACd,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC;YACvE,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACpD,CAAC,CAAC,IAAI;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,MAA2D,EAC3D,QAAkC;IAElC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxE,OAAO,kBAAkB,CAAC,SAAS,CAAC,IAAI,SAAS,EAAE,MAAM,IAAI,KAAK,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAuC;IACxE,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,IAAI,WAAW,CACnB,2EAA2E,IAAI,CAAC,IAAI,IAAI,CACzF,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,WAAW,CACnB,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,4FAA4F,CACxH,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CACtB,QAAkB,EAClB,MAAwD;IAExD,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC;AACjG,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAa;IACzC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBACnC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED,GAAG,CAAC,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC"}
+{"version":3,"file":"ResponsesParser.mjs","sourceRoot":"","sources":["../src/lib/ResponsesParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,qBAAiB;AAgBvC,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,0BAAsB;AAuCtF;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAGhC,QAAkB,EAAE,MAAc;IAClC,IAAI,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG;YACb,GAAG,QAAQ;YACX,aAAa,EAAE,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACnC,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;oBAClC,OAAO;wBACL,GAAG,IAAI;wBACP,gBAAgB,EAAE,IAAI;qBACvB,CAAC;gBACJ,CAAC;gBAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO;wBACL,GAAG,IAAI;wBACP,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;4BACtC,GAAG,OAAO;4BACV,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;qBACJ,CAAC;gBACJ,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;SACH,CAAC;QAEF,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YACtC,aAAa,CAAC,MAAkB,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAG3B,QAAkB,EAAE,MAAc;IAClC,MAAM,WAAW,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,WAAW,CAAC;IACxE,MAAM,MAAM,GAAwC,QAAQ,CAAC,MAAM,CAAC,GAAG,CACrE,CAAC,IAAI,EAAqC,EAAE;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;QACzF,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,OAAO,GAA6B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBACrE,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBACnC,OAAO;wBACL,GAAG,OAAO;wBACV,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;qBACnE,CAAC;gBACJ,CAAC;gBAED,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC,CAAC;YAEH,OAAO;gBACL,GAAG,IAAI;gBACP,OAAO;aACR,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CACF,CAAC;IAEF,MAAM,MAAM,GAAmD,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,CAAC;IACvF,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;QACtC,aAAa,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,EAAE;QAC7C,UAAU,EAAE,IAAI;QAChB,GAAG;YACD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC9B,SAAS;gBACX,CAAC;gBAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrC,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;wBAC9D,OAAO,OAAO,CAAC,MAAM,CAAC;oBACxB,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAiC,CAAC;AAC3C,CAAC;AAED,SAAS,eAAe,CAGtB,MAAc,EAAE,OAAe;IAC/B,OAAO,0BAA0B,CAAU,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,qBAAqB,CAAC,MAAqC;IACzE,IAAI,yBAAyB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;QACnD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CACzF,CACF,CAAC;AACJ,CAAC;AA8BD,qGAAqG;AACrG,MAAM,UAAU,yBAAyB,CACvC,IAAkB,EAClB,EACE,MAAM,EACN,QAAQ,GAMT;IAED,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAExB,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE;QAC3B,MAAM,EAAE;YACN,KAAK,EAAE,qBAAqB;YAC5B,UAAU,EAAE,KAAK;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,MAAM;YACb,UAAU,EAAE,KAAK;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,KAAK;SAClB;KACF,CAAC,CAAC;IAEH,OAAO,GAAuD,CAAC;AACjE,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,kBAAkB,CAAC,IAAS;IAC1C,OAAO,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,qBAAqB,CAAC;AACpD,CAAC;AAED,SAAS,kBAAkB,CAAC,WAAmB,EAAE,IAAY;IAC3D,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAEnE,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CACpB,MAAc,EACd,QAAkC;IAElC,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAExE,IAAI,eAAe,GAAY,IAAI,CAAC;IACpC,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,eAAe,GAAG,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC5D,CAAC;SAAM,IAAI,SAAS,EAAE,MAAM,EAAE,CAAC;QAC7B,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,OAAO;QACL,GAAG,QAAQ;QACX,gBAAgB,EAAE,eAAe;KAClC,CAAC;AACJ,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,mBAAmB,CACjC,MAA2D,EAC3D,QAAkC;IAElC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxE,OAAO,kBAAkB,CAAC,SAAS,CAAC,IAAI,SAAS,EAAE,MAAM,IAAI,KAAK,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAuC;IACxE,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,IAAI,WAAW,CACnB,2EAA2E,IAAI,CAAC,IAAI,IAAI,CACzF,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,WAAW,CACnB,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,4FAA4F,CACxH,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CACtB,QAAkB,EAClB,MAAwD;IAExD,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC;AACjG,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,aAAa,CAAC,GAAa;IACzC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBACnC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED,GAAG,CAAC,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC"}

package/lib/RunnableFunction.d.mts

@@ -1,13 +1,15 @@
-import { type ChatCompletionRunner } from "./ChatCompletionRunner.mjs";
-import { type ChatCompletionStreamingRunner } from "./ChatCompletionStreamingRunner.mjs";
-import { JSONSchema } from "./jsonschema.mjs";
+import type { ChatCompletionRunner } from "./ChatCompletionRunner.mjs";
+import type { ChatCompletionStreamingRunner } from "./ChatCompletionStreamingRunner.mjs";
+import type { JSONSchema } from "./jsonschema.mjs";
+/** A synchronous callback result or a promise that resolves to the same result. */
 type PromiseOrValue<T> = T | Promise<T>;
+/** A function tool that parses raw JSON arguments before invoking its callback. */
 export type RunnableFunctionWithParse<Args extends object, ToolContext = unknown> = {
     /**
      * @param args the return value from `parse`.
      * @param runner the runner evaluating this callback.
      * @param toolContext the context passed to `.runTools()`.
-     * @returns a string to send back to OpenAI.
+     * @returns A value that the runner serializes into a tool-result message.
      */
     function: (args: Args, runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>, toolContext: ToolContext) => PromiseOrValue<unknown>;
     /**
@@ -16,7 +18,7 @@ export type RunnableFunctionWithParse<Args extends object, ToolContext = unknown
      */
     parse: (input: string) => PromiseOrValue<Args>;
     /**
-     * The parameters the function accepts, describes as a JSON Schema object.
+     * The parameters the function accepts, described as a JSON Schema object.
      */
     parameters: JSONSchema;
     /**
@@ -27,18 +29,20 @@ export type RunnableFunctionWithParse<Args extends object, ToolContext = unknown
      * The name of the function to be called. Will default to function.name if omitted.
      */
     name?: string | undefined;
+    /** Whether the tool's parameters use strict Structured Outputs validation. */
     strict?: boolean | undefined;
 };
+/** A function tool whose callback receives the model's raw JSON argument string. */
 export type RunnableFunctionWithoutParse<ToolContext = unknown> = {
     /**
      * @param args the raw args from the OpenAI function call.
      * @param runner the runner evaluating this callback.
      * @param toolContext the context passed to `.runTools()`.
-     * @returns a string to send back to OpenAI
+     * @returns A value that the runner serializes into a tool-result message.
      */
     function: (args: string, runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>, toolContext: ToolContext) => PromiseOrValue<unknown>;
     /**
-     * The parameters the function accepts, describes as a JSON Schema object.
+     * The parameters the function accepts, described as a JSON Schema object.
      */
     parameters: JSONSchema;
     /**
@@ -49,42 +53,63 @@ export type RunnableFunctionWithoutParse<ToolContext = unknown> = {
      * The name of the function to be called. Will default to function.name if omitted.
      */
     name?: string | undefined;
+    /** Whether the tool's parameters use strict Structured Outputs validation. */
     strict?: boolean | undefined;
 };
+/** Selects a raw-argument or parsed-argument runnable function from its argument type. */
 export type RunnableFunction<Args extends object | string, ToolContext = unknown> = Args extends string ? RunnableFunctionWithoutParse<ToolContext> : Args extends object ? RunnableFunctionWithParse<Args, ToolContext> : never;
+/** Wraps a raw-argument or parsed-argument runnable function in an API function-tool shape. */
 export type RunnableToolFunction<Args extends object | string, ToolContext = unknown> = Args extends string ? RunnableToolFunctionWithoutParse<ToolContext> : Args extends object ? RunnableToolFunctionWithParse<Args, ToolContext> : never;
+/** An executable API function tool whose callback receives raw JSON arguments. */
 export type RunnableToolFunctionWithoutParse<ToolContext = unknown> = {
+    /** Identifies this tool as a callable function. */
     type: 'function';
+    /** The function definition, callback, and raw-argument configuration. */
     function: RunnableFunctionWithoutParse<ToolContext>;
 };
+/** An executable API function tool whose callback receives parsed arguments. */
 export type RunnableToolFunctionWithParse<Args extends object, ToolContext = unknown> = {
+    /** Identifies this tool as a callable function. */
     type: 'function';
+    /** The function definition, argument parser, and callback. */
     function: RunnableFunctionWithParse<Args, ToolContext>;
 };
 /**
  * A broad tool shape for contextually typing callbacks when the argument type is inferred.
  */
 export type RunnableToolFunctionWithContext<ToolContext> = {
+    /** Identifies this tool as a callable function. */
     type: 'function';
+    /** The function definition whose callback receives the runner's context value. */
     function: {
+        /** Invokes the tool with its arguments, active runner, and supplied context. */
         function: (args: any, runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>, toolContext: ToolContext) => PromiseOrValue<unknown>;
+        /** Optionally converts raw JSON arguments into the callback's argument value. */
         parse?: (input: string) => PromiseOrValue<any>;
+        /** JSON Schema describing the arguments accepted by the function. */
         parameters: JSONSchema;
+        /** Model-facing explanation of what the function does and when to call it. */
         description: string;
+        /** Explicit function name; defaults to the JavaScript callback's name. */
         name?: string | undefined;
+        /** Whether the tool's parameters use strict Structured Outputs validation. */
         strict?: boolean | undefined;
     };
 };
+/** Returns whether a runnable function provides a parser for its raw argument string. */
 export declare function isRunnableFunctionWithParse<Args extends object, ToolContext = unknown>(fn: any): fn is RunnableFunctionWithParse<Args, ToolContext>;
+/** The ordered raw-string or parsed-object argument types accepted by runnable functions. */
 export type BaseFunctionsArgs = readonly (object | string)[];
+/** Runnable function definitions whose callback arguments correspond to an argument-type tuple. */
 export type RunnableFunctions<FunctionsArgs extends BaseFunctionsArgs, ToolContext = unknown> = [
     any[]
 ] extends [FunctionsArgs] ? readonly RunnableFunction<any, ToolContext>[] : {
     [Index in keyof FunctionsArgs]: Index extends number ? RunnableFunction<FunctionsArgs[Index], ToolContext> : FunctionsArgs[Index];
 };
-export type RunnableTools<FunctionsArgs extends BaseFunctionsArgs, ToolContext = unknown> = [any[]] extends ([
+/** Runnable function tools whose callback arguments correspond to an argument-type tuple. */
+export type RunnableTools<FunctionsArgs extends BaseFunctionsArgs, ToolContext = unknown> = [any[]] extends [
     FunctionsArgs
-]) ? readonly RunnableToolFunction<any, ToolContext>[] : {
+] ? readonly RunnableToolFunction<any, ToolContext>[] : {
     [Index in keyof FunctionsArgs]: Index extends number ? RunnableToolFunction<FunctionsArgs[Index], ToolContext> : FunctionsArgs[Index];
 };
 /**
@@ -92,8 +117,11 @@ export type RunnableTools<FunctionsArgs extends BaseFunctionsArgs, ToolContext =
  * argument type matches the `parse` return type.
  */
 export declare class ParsingToolFunction<Args extends object, ToolContext = unknown> {
-    type: 'function';
+    /** Identifies the wrapped tool as a callable function. */
+    type: "function";
+    /** The wrapped function definition, argument parser, and callback. */
     function: RunnableFunctionWithParse<Args, ToolContext>;
+    /** Wraps a parsed-argument function definition in the function-tool shape. */
     constructor(input: RunnableFunctionWithParse<Args, ToolContext>);
 }
 export {};

package/lib/RunnableFunction.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"RunnableFunction.d.mts","sourceRoot":"","sources":["../src/lib/RunnableFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,oBAAoB,EAAE,mCAA+B;AACnE,OAAO,EAAE,KAAK,6BAA6B,EAAE,4CAAwC;AACrF,OAAO,EAAE,UAAU,EAAE,yBAAqB;AAE1C,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAExC,MAAM,MAAM,yBAAyB,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI;IAClF;;;;;OAKG;IACH,QAAQ,EAAE,CACR,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7B;;;OAGG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/C;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,4BAA4B,CAAC,WAAW,GAAG,OAAO,IAAI;IAChE;;;;;OAKG;IACH,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI,IAAI,SAAS,MAAM,GACrG,4BAA4B,CAAC,WAAW,CAAC,GACzC,IAAI,SAAS,MAAM,GAAG,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,GAClE,KAAK,CAAC;AAER,MAAM,MAAM,oBAAoB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI,IAAI,SAAS,MAAM,GACzG,gCAAgC,CAAC,WAAW,CAAC,GAC7C,IAAI,SAAS,MAAM,GAAG,6BAA6B,CAAC,IAAI,EAAE,WAAW,CAAC,GACtE,KAAK,CAAC;AAER,MAAM,MAAM,gCAAgC,CAAC,WAAW,GAAG,OAAO,IAAI;IACpE,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,4BAA4B,CAAC,WAAW,CAAC,CAAC;CACrD,CAAC;AACF,MAAM,MAAM,6BAA6B,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI;IACtF,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,CAAC,WAAW,IAAI;IACzD,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE;QACR,QAAQ,EAAE,CACR,IAAI,EAAE,GAAG,EACT,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;QAC7B,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/C,UAAU,EAAE,UAAU,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,wBAAgB,2BAA2B,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,EACpF,EAAE,EAAE,GAAG,GACN,EAAE,IAAI,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAEpD;AAED,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAE7D,MAAM,MAAM,iBAAiB,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,GAAG,OAAO,IAAI;IAC9F,GAAG,EAAE;CACN,SAAS,CAAC,aAAa,CAAC,GACvB,SAAS,gBAAgB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GAC7C;KACG,KAAK,IAAI,MAAM,aAAa,GAAG,KAAK,SAAS,MAAM,GAAG,gBAAgB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GACxG,aAAa,CAAC,KAAK,CAAC;CACvB,CAAC;AAEJ,MAAM,MAAM,aAAa,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,GAAG,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAC1G;IAAC,aAAa;CAAC,CAChB,GACC,SAAS,oBAAoB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GACjD;KACG,KAAK,IAAI,MAAM,aAAa,GAAG,KAAK,SAAS,MAAM,GAClD,oBAAoB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GACvD,aAAa,CAAC,KAAK,CAAC;CACvB,CAAC;AAEJ;;;GAGG;AACH,qBAAa,mBAAmB,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO;IACzE,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;gBAE3C,KAAK,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC;CAIhE"}
+{"version":3,"file":"RunnableFunction.d.mts","sourceRoot":"","sources":["../src/lib/RunnableFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,mCAA+B;AACnE,OAAO,KAAK,EAAE,6BAA6B,EAAE,4CAAwC;AACrF,OAAO,KAAK,EAAE,UAAU,EAAE,yBAAqB;AAE/C,mFAAmF;AACnF,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAExC,mFAAmF;AACnF,MAAM,MAAM,yBAAyB,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI;IAClF;;;;;OAKG;IACH,QAAQ,EAAE,CACR,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7B;;;OAGG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/C;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,8EAA8E;IAC9E,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,oFAAoF;AACpF,MAAM,MAAM,4BAA4B,CAAC,WAAW,GAAG,OAAO,IAAI;IAChE;;;;;OAKG;IACH,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,8EAA8E;IAC9E,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,0FAA0F;AAC1F,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI,IAAI,SAAS,MAAM,GACnG,4BAA4B,CAAC,WAAW,CAAC,GACzC,IAAI,SAAS,MAAM,GACjB,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,GAC5C,KAAK,CAAC;AAEZ,+FAA+F;AAC/F,MAAM,MAAM,oBAAoB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI,IAAI,SAAS,MAAM,GACvG,gCAAgC,CAAC,WAAW,CAAC,GAC7C,IAAI,SAAS,MAAM,GACjB,6BAA6B,CAAC,IAAI,EAAE,WAAW,CAAC,GAChD,KAAK,CAAC;AAEZ,kFAAkF;AAClF,MAAM,MAAM,gCAAgC,CAAC,WAAW,GAAG,OAAO,IAAI;IACpE,mDAAmD;IACnD,IAAI,EAAE,UAAU,CAAC;IACjB,yEAAyE;IACzE,QAAQ,EAAE,4BAA4B,CAAC,WAAW,CAAC,CAAC;CACrD,CAAC;AACF,gFAAgF;AAChF,MAAM,MAAM,6BAA6B,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI;IACtF,mDAAmD;IACnD,IAAI,EAAE,UAAU,CAAC;IACjB,8DAA8D;IAC9D,QAAQ,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,CAAC,WAAW,IAAI;IACzD,mDAAmD;IACnD,IAAI,EAAE,UAAU,CAAC;IACjB,kFAAkF;IAClF,QAAQ,EAAE;QACR,gFAAgF;QAChF,QAAQ,EAAE,CACR,IAAI,EAAE,GAAG,EACT,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;QAC7B,iFAAiF;QACjF,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/C,qEAAqE;QACrE,UAAU,EAAE,UAAU,CAAC;QACvB,8EAA8E;QAC9E,WAAW,EAAE,MAAM,CAAC;QACpB,0EAA0E;QAC1E,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,8EAA8E;QAC9E,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,yFAAyF;AACzF,wBAAgB,2BAA2B,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,EACpF,EAAE,EAAE,GAAG,GACN,EAAE,IAAI,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAEpD;AAED,6FAA6F;AAC7F,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAE7D,mGAAmG;AACnG,MAAM,MAAM,iBAAiB,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,GAAG,OAAO,IAAI;IAC9F,GAAG,EAAE;CACN,SAAS,CAAC,aAAa,CAAC,GACrB,SAAS,gBAAgB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GAC7C;KACG,KAAK,IAAI,MAAM,aAAa,GAAG,KAAK,SAAS,MAAM,GAChD,gBAAgB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GACnD,aAAa,CAAC,KAAK,CAAC;CACzB,CAAC;AAEN,6FAA6F;AAC7F,MAAM,MAAM,aAAa,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,GAAG,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS;IAC1G,aAAa;CACd,GACG,SAAS,oBAAoB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GACjD;KACG,KAAK,IAAI,MAAM,aAAa,GAAG,KAAK,SAAS,MAAM,GAChD,oBAAoB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GACvD,aAAa,CAAC,KAAK,CAAC;CACzB,CAAC;AAEN;;;GAGG;AACH,qBAAa,mBAAmB,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO;IACzE,0DAA0D;IAC1D,IAAI,EAAG,UAAU,CAAU;IAC3B,sEAAsE;IACtE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEvD,8EAA8E;gBAClE,KAAK,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC;CAGhE"}

package/lib/RunnableFunction.d.ts

@@ -1,13 +1,15 @@
-import { type ChatCompletionRunner } from "./ChatCompletionRunner.js";
-import { type ChatCompletionStreamingRunner } from "./ChatCompletionStreamingRunner.js";
-import { JSONSchema } from "./jsonschema.js";
+import type { ChatCompletionRunner } from "./ChatCompletionRunner.js";
+import type { ChatCompletionStreamingRunner } from "./ChatCompletionStreamingRunner.js";
+import type { JSONSchema } from "./jsonschema.js";
+/** A synchronous callback result or a promise that resolves to the same result. */
 type PromiseOrValue<T> = T | Promise<T>;
+/** A function tool that parses raw JSON arguments before invoking its callback. */
 export type RunnableFunctionWithParse<Args extends object, ToolContext = unknown> = {
     /**
      * @param args the return value from `parse`.
      * @param runner the runner evaluating this callback.
      * @param toolContext the context passed to `.runTools()`.
-     * @returns a string to send back to OpenAI.
+     * @returns A value that the runner serializes into a tool-result message.
      */
     function: (args: Args, runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>, toolContext: ToolContext) => PromiseOrValue<unknown>;
     /**
@@ -16,7 +18,7 @@ export type RunnableFunctionWithParse<Args extends object, ToolContext = unknown
      */
     parse: (input: string) => PromiseOrValue<Args>;
     /**
-     * The parameters the function accepts, describes as a JSON Schema object.
+     * The parameters the function accepts, described as a JSON Schema object.
      */
     parameters: JSONSchema;
     /**
@@ -27,18 +29,20 @@ export type RunnableFunctionWithParse<Args extends object, ToolContext = unknown
      * The name of the function to be called. Will default to function.name if omitted.
      */
     name?: string | undefined;
+    /** Whether the tool's parameters use strict Structured Outputs validation. */
     strict?: boolean | undefined;
 };
+/** A function tool whose callback receives the model's raw JSON argument string. */
 export type RunnableFunctionWithoutParse<ToolContext = unknown> = {
     /**
      * @param args the raw args from the OpenAI function call.
      * @param runner the runner evaluating this callback.
      * @param toolContext the context passed to `.runTools()`.
-     * @returns a string to send back to OpenAI
+     * @returns A value that the runner serializes into a tool-result message.
      */
     function: (args: string, runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>, toolContext: ToolContext) => PromiseOrValue<unknown>;
     /**
-     * The parameters the function accepts, describes as a JSON Schema object.
+     * The parameters the function accepts, described as a JSON Schema object.
      */
     parameters: JSONSchema;
     /**
@@ -49,42 +53,63 @@ export type RunnableFunctionWithoutParse<ToolContext = unknown> = {
      * The name of the function to be called. Will default to function.name if omitted.
      */
     name?: string | undefined;
+    /** Whether the tool's parameters use strict Structured Outputs validation. */
     strict?: boolean | undefined;
 };
+/** Selects a raw-argument or parsed-argument runnable function from its argument type. */
 export type RunnableFunction<Args extends object | string, ToolContext = unknown> = Args extends string ? RunnableFunctionWithoutParse<ToolContext> : Args extends object ? RunnableFunctionWithParse<Args, ToolContext> : never;
+/** Wraps a raw-argument or parsed-argument runnable function in an API function-tool shape. */
 export type RunnableToolFunction<Args extends object | string, ToolContext = unknown> = Args extends string ? RunnableToolFunctionWithoutParse<ToolContext> : Args extends object ? RunnableToolFunctionWithParse<Args, ToolContext> : never;
+/** An executable API function tool whose callback receives raw JSON arguments. */
 export type RunnableToolFunctionWithoutParse<ToolContext = unknown> = {
+    /** Identifies this tool as a callable function. */
     type: 'function';
+    /** The function definition, callback, and raw-argument configuration. */
     function: RunnableFunctionWithoutParse<ToolContext>;
 };
+/** An executable API function tool whose callback receives parsed arguments. */
 export type RunnableToolFunctionWithParse<Args extends object, ToolContext = unknown> = {
+    /** Identifies this tool as a callable function. */
     type: 'function';
+    /** The function definition, argument parser, and callback. */
     function: RunnableFunctionWithParse<Args, ToolContext>;
 };
 /**
  * A broad tool shape for contextually typing callbacks when the argument type is inferred.
  */
 export type RunnableToolFunctionWithContext<ToolContext> = {
+    /** Identifies this tool as a callable function. */
     type: 'function';
+    /** The function definition whose callback receives the runner's context value. */
     function: {
+        /** Invokes the tool with its arguments, active runner, and supplied context. */
         function: (args: any, runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>, toolContext: ToolContext) => PromiseOrValue<unknown>;
+        /** Optionally converts raw JSON arguments into the callback's argument value. */
         parse?: (input: string) => PromiseOrValue<any>;
+        /** JSON Schema describing the arguments accepted by the function. */
         parameters: JSONSchema;
+        /** Model-facing explanation of what the function does and when to call it. */
         description: string;
+        /** Explicit function name; defaults to the JavaScript callback's name. */
         name?: string | undefined;
+        /** Whether the tool's parameters use strict Structured Outputs validation. */
         strict?: boolean | undefined;
     };
 };
+/** Returns whether a runnable function provides a parser for its raw argument string. */
 export declare function isRunnableFunctionWithParse<Args extends object, ToolContext = unknown>(fn: any): fn is RunnableFunctionWithParse<Args, ToolContext>;
+/** The ordered raw-string or parsed-object argument types accepted by runnable functions. */
 export type BaseFunctionsArgs = readonly (object | string)[];
+/** Runnable function definitions whose callback arguments correspond to an argument-type tuple. */
 export type RunnableFunctions<FunctionsArgs extends BaseFunctionsArgs, ToolContext = unknown> = [
     any[]
 ] extends [FunctionsArgs] ? readonly RunnableFunction<any, ToolContext>[] : {
     [Index in keyof FunctionsArgs]: Index extends number ? RunnableFunction<FunctionsArgs[Index], ToolContext> : FunctionsArgs[Index];
 };
-export type RunnableTools<FunctionsArgs extends BaseFunctionsArgs, ToolContext = unknown> = [any[]] extends ([
+/** Runnable function tools whose callback arguments correspond to an argument-type tuple. */
+export type RunnableTools<FunctionsArgs extends BaseFunctionsArgs, ToolContext = unknown> = [any[]] extends [
     FunctionsArgs
-]) ? readonly RunnableToolFunction<any, ToolContext>[] : {
+] ? readonly RunnableToolFunction<any, ToolContext>[] : {
     [Index in keyof FunctionsArgs]: Index extends number ? RunnableToolFunction<FunctionsArgs[Index], ToolContext> : FunctionsArgs[Index];
 };
 /**
@@ -92,8 +117,11 @@ export type RunnableTools<FunctionsArgs extends BaseFunctionsArgs, ToolContext =
  * argument type matches the `parse` return type.
  */
 export declare class ParsingToolFunction<Args extends object, ToolContext = unknown> {
-    type: 'function';
+    /** Identifies the wrapped tool as a callable function. */
+    type: "function";
+    /** The wrapped function definition, argument parser, and callback. */
     function: RunnableFunctionWithParse<Args, ToolContext>;
+    /** Wraps a parsed-argument function definition in the function-tool shape. */
     constructor(input: RunnableFunctionWithParse<Args, ToolContext>);
 }
 export {};

package/lib/RunnableFunction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RunnableFunction.d.ts","sourceRoot":"","sources":["../src/lib/RunnableFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,oBAAoB,EAAE,kCAA+B;AACnE,OAAO,EAAE,KAAK,6BAA6B,EAAE,2CAAwC;AACrF,OAAO,EAAE,UAAU,EAAE,wBAAqB;AAE1C,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAExC,MAAM,MAAM,yBAAyB,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI;IAClF;;;;;OAKG;IACH,QAAQ,EAAE,CACR,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7B;;;OAGG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/C;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,4BAA4B,CAAC,WAAW,GAAG,OAAO,IAAI;IAChE;;;;;OAKG;IACH,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI,IAAI,SAAS,MAAM,GACrG,4BAA4B,CAAC,WAAW,CAAC,GACzC,IAAI,SAAS,MAAM,GAAG,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,GAClE,KAAK,CAAC;AAER,MAAM,MAAM,oBAAoB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI,IAAI,SAAS,MAAM,GACzG,gCAAgC,CAAC,WAAW,CAAC,GAC7C,IAAI,SAAS,MAAM,GAAG,6BAA6B,CAAC,IAAI,EAAE,WAAW,CAAC,GACtE,KAAK,CAAC;AAER,MAAM,MAAM,gCAAgC,CAAC,WAAW,GAAG,OAAO,IAAI;IACpE,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,4BAA4B,CAAC,WAAW,CAAC,CAAC;CACrD,CAAC;AACF,MAAM,MAAM,6BAA6B,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI;IACtF,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,CAAC,WAAW,IAAI;IACzD,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE;QACR,QAAQ,EAAE,CACR,IAAI,EAAE,GAAG,EACT,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;QAC7B,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/C,UAAU,EAAE,UAAU,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,wBAAgB,2BAA2B,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,EACpF,EAAE,EAAE,GAAG,GACN,EAAE,IAAI,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAEpD;AAED,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAE7D,MAAM,MAAM,iBAAiB,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,GAAG,OAAO,IAAI;IAC9F,GAAG,EAAE;CACN,SAAS,CAAC,aAAa,CAAC,GACvB,SAAS,gBAAgB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GAC7C;KACG,KAAK,IAAI,MAAM,aAAa,GAAG,KAAK,SAAS,MAAM,GAAG,gBAAgB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GACxG,aAAa,CAAC,KAAK,CAAC;CACvB,CAAC;AAEJ,MAAM,MAAM,aAAa,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,GAAG,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAC1G;IAAC,aAAa;CAAC,CAChB,GACC,SAAS,oBAAoB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GACjD;KACG,KAAK,IAAI,MAAM,aAAa,GAAG,KAAK,SAAS,MAAM,GAClD,oBAAoB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GACvD,aAAa,CAAC,KAAK,CAAC;CACvB,CAAC;AAEJ;;;GAGG;AACH,qBAAa,mBAAmB,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO;IACzE,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;gBAE3C,KAAK,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC;CAIhE"}
+{"version":3,"file":"RunnableFunction.d.ts","sourceRoot":"","sources":["../src/lib/RunnableFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,kCAA+B;AACnE,OAAO,KAAK,EAAE,6BAA6B,EAAE,2CAAwC;AACrF,OAAO,KAAK,EAAE,UAAU,EAAE,wBAAqB;AAE/C,mFAAmF;AACnF,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAExC,mFAAmF;AACnF,MAAM,MAAM,yBAAyB,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI;IAClF;;;;;OAKG;IACH,QAAQ,EAAE,CACR,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7B;;;OAGG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/C;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,8EAA8E;IAC9E,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,oFAAoF;AACpF,MAAM,MAAM,4BAA4B,CAAC,WAAW,GAAG,OAAO,IAAI;IAChE;;;;;OAKG;IACH,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,8EAA8E;IAC9E,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,0FAA0F;AAC1F,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI,IAAI,SAAS,MAAM,GACnG,4BAA4B,CAAC,WAAW,CAAC,GACzC,IAAI,SAAS,MAAM,GACjB,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,GAC5C,KAAK,CAAC;AAEZ,+FAA+F;AAC/F,MAAM,MAAM,oBAAoB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI,IAAI,SAAS,MAAM,GACvG,gCAAgC,CAAC,WAAW,CAAC,GAC7C,IAAI,SAAS,MAAM,GACjB,6BAA6B,CAAC,IAAI,EAAE,WAAW,CAAC,GAChD,KAAK,CAAC;AAEZ,kFAAkF;AAClF,MAAM,MAAM,gCAAgC,CAAC,WAAW,GAAG,OAAO,IAAI;IACpE,mDAAmD;IACnD,IAAI,EAAE,UAAU,CAAC;IACjB,yEAAyE;IACzE,QAAQ,EAAE,4BAA4B,CAAC,WAAW,CAAC,CAAC;CACrD,CAAC;AACF,gFAAgF;AAChF,MAAM,MAAM,6BAA6B,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,IAAI;IACtF,mDAAmD;IACnD,IAAI,EAAE,UAAU,CAAC;IACjB,8DAA8D;IAC9D,QAAQ,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,CAAC,WAAW,IAAI;IACzD,mDAAmD;IACnD,IAAI,EAAE,UAAU,CAAC;IACjB,kFAAkF;IAClF,QAAQ,EAAE;QACR,gFAAgF;QAChF,QAAQ,EAAE,CACR,IAAI,EAAE,GAAG,EACT,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,OAAO,CAAC,EAC9E,WAAW,EAAE,WAAW,KACrB,cAAc,CAAC,OAAO,CAAC,CAAC;QAC7B,iFAAiF;QACjF,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/C,qEAAqE;QACrE,UAAU,EAAE,UAAU,CAAC;QACvB,8EAA8E;QAC9E,WAAW,EAAE,MAAM,CAAC;QACpB,0EAA0E;QAC1E,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,8EAA8E;QAC9E,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,yFAAyF;AACzF,wBAAgB,2BAA2B,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO,EACpF,EAAE,EAAE,GAAG,GACN,EAAE,IAAI,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAEpD;AAED,6FAA6F;AAC7F,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAE7D,mGAAmG;AACnG,MAAM,MAAM,iBAAiB,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,GAAG,OAAO,IAAI;IAC9F,GAAG,EAAE;CACN,SAAS,CAAC,aAAa,CAAC,GACrB,SAAS,gBAAgB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GAC7C;KACG,KAAK,IAAI,MAAM,aAAa,GAAG,KAAK,SAAS,MAAM,GAChD,gBAAgB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GACnD,aAAa,CAAC,KAAK,CAAC;CACzB,CAAC;AAEN,6FAA6F;AAC7F,MAAM,MAAM,aAAa,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,GAAG,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS;IAC1G,aAAa;CACd,GACG,SAAS,oBAAoB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GACjD;KACG,KAAK,IAAI,MAAM,aAAa,GAAG,KAAK,SAAS,MAAM,GAChD,oBAAoB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GACvD,aAAa,CAAC,KAAK,CAAC;CACzB,CAAC;AAEN;;;GAGG;AACH,qBAAa,mBAAmB,CAAC,IAAI,SAAS,MAAM,EAAE,WAAW,GAAG,OAAO;IACzE,0DAA0D;IAC1D,IAAI,EAAG,UAAU,CAAU;IAC3B,sEAAsE;IACtE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEvD,8EAA8E;gBAClE,KAAK,EAAE,yBAAyB,CAAC,IAAI,EAAE,WAAW,CAAC;CAGhE"}