bem-ai-sdk 0.26.0 → 0.28.0

package/resources/eval/score.mjs

@@ -0,0 +1,122 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Monitor, evaluate, and iterate on the quality of every function in your
+ * environment. Function Accuracy bundles two complementary loops:
+ *
+ * ## Evaluations (`/v3/eval`)
+ *
+ * Trigger and retrieve per-transformation evaluations. Evaluations run
+ * asynchronously and score each transformation's output against the
+ * function's schema for confidence, per-field hallucination detection,
+ * and relevance. Supported for `extract`, `transform`, `analyze`, and
+ * `join` events.
+ *
+ * 1. **Trigger** — `POST /v3/eval` queues jobs for a batch of transformation IDs.
+ * 2. **Poll** — `GET /v3/eval/results` returns the current state of each
+ *    requested ID, partitioned into `results`, `pending`, and `failed`.
+ *    Accepts either `eventIDs` (preferred) or `transformationIDs` as a
+ *    comma-separated query parameter, and always keys the response by
+ *    event KSUID.
+ *
+ * Up to 100 IDs may be submitted per request.
+ *
+ * ## Metrics, review, regression (`/v3/functions/{metrics,review,regression,compare}`)
+ *
+ * Roll evaluation results and user corrections up into actionable
+ * function-level signal:
+ *
+ * - **`GET /v3/functions/metrics`** — aggregate accuracy, precision,
+ *   recall, F1, and confusion-matrix counts per function.
+ * - **`POST /v3/functions/review`** — sample-size estimation,
+ *   confidence-bucketed distribution, PR-AUC, and per-threshold
+ *   confidence intervals (Wald or Wilson) for picking review cutoffs.
+ * - **`POST /v3/functions/regression`** — replay corrected historical
+ *   inputs against a new function version, producing a labeled
+ *   regression dataset.
+ * - **`POST /v3/functions/regression/corrections`** — propagate
+ *   baseline corrections onto the regression dataset so it can be
+ *   scored.
+ * - **`POST /v3/functions/compare`** — compute aggregate and
+ *   field-level lift between any two versions, optionally scoped to
+ *   the regression dataset.
+ *
+ * All five endpoints support `extract` end-to-end on both the vision
+ * and OCR paths, alongside the legacy `transform` / `analyze` / `join`
+ * types.
+ */
+export class Score extends APIResource {
+    /**
+     * **Score a function against a list of (input, expected) pairs.**
+     *
+     * Submits a batch of `(input, expected)` pairs, runs the named function over each
+     * input, and returns per-pair + aggregate accuracy metrics comparing the
+     * function's actual output to the provided expected JSON.
+     *
+     * Scoring runs asynchronously. The response carries a `scoreRunID`; poll
+     * `GET /v3/eval/score/{scoreRunID}` until `status` is one of `completed`, `error`,
+     * or `cancelled`.
+     *
+     * `matchConfig` controls comparator behavior:
+     *
+     * - `numericTolerance`: relative tolerance for numeric fields (0 = exact)
+     * - `stringMatch`: `exact` (default) or `fuzzy` (Levenshtein ratio)
+     * - `arrayMatch`: `by-index` (default; only mode in P0)
+     * - `ignorePaths`: JSON Pointer paths to skip, supports `*` wildcards
+     *
+     * @example
+     * ```ts
+     * const score = await client.eval.score.create({
+     *   functionName: 'functionName',
+     *   pairs: [
+     *     {
+     *       expected: {},
+     *       input: {
+     *         inputContent: 'inputContent',
+     *         inputType: 'csv',
+     *       },
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v3/eval/score', { body, ...options });
+    }
+    /**
+     * **Get the status and per-pair results of a score run.**
+     *
+     * Returns `aggregate` only once `status` reaches `completed`. `perPair` is
+     * populated incrementally — each pair's `fieldResults` appears as its underlying
+     * function call terminates.
+     *
+     * @example
+     * ```ts
+     * const score = await client.eval.score.retrieve(
+     *   'scoreRunID',
+     * );
+     * ```
+     */
+    retrieve(scoreRunID, options) {
+        return this._client.get(path `/v3/eval/score/${scoreRunID}`, options);
+    }
+    /**
+     * **Cancel an in-flight score run.**
+     *
+     * Transitions the run to `cancelled`. Function calls already in flight are allowed
+     * to finish (best-effort cancellation via the job queue); results from completed
+     * pairs may still appear in subsequent GETs.
+     *
+     * @example
+     * ```ts
+     * const response = await client.eval.score.cancel(
+     *   'scoreRunID',
+     * );
+     * ```
+     */
+    cancel(scoreRunID, options) {
+        return this._client.post(path `/v3/eval/score/${scoreRunID}/cancel`, options);
+    }
+}
+//# sourceMappingURL=score.mjs.map

package/resources/eval/score.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"score.mjs","sourceRoot":"","sources":["../../src/resources/eval/score.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;CACF"}

package/resources/fs.d.mts

@@ -212,6 +212,12 @@ export interface FNavigateParams {
      * pointing at the toggle.
      */
     op: FsOp;
+    /**
+     * Request-scoping concerns that are orthogonal to the op itself. Carried on a
+     * `context` object so future scoping hints (e.g. as-of timestamps, read
+     * consistency) can slot in without reshaping the op-specific fields.
+     */
+    context?: FNavigateParams.Context;
     /**
      * When true, return only the hit count without snippet payload. Cheaper than
      * fetching matches when the agent only wants a yes/no.
@@ -270,6 +276,28 @@ export interface FNavigateParams {
     select?: Array<string>;
 }
 export declare namespace FNavigateParams {
+    /**
+     * Request-scoping concerns that are orthogonal to the op itself. Carried on a
+     * `context` object so future scoping hints (e.g. as-of timestamps, read
+     * consistency) can slot in without reshaping the op-specific fields.
+     */
+    interface Context {
+        /**
+         * Bucket KSUID (prefix `bkt_`) to scope the request to — a named partition of the
+         * knowledge graph within the caller's account+environment.
+         *
+         * **Optional.** Omitting it (or passing an empty value) leaves the request
+         * UNSCOPED: memory-level reads (`find` / `open` / `xref`) return entities across
+         * every bucket in the account+environment, so pre-bucket callers keep their
+         * original all-entities behavior unchanged. (Writes are different: a parse call
+         * with no bucket targets the account default bucket.) When a bucket IS supplied,
+         * memory-level ops return only entities in that bucket; doc-level ops
+         * (`ls`/`cat`/`head`/`stat`/`grep`) are unaffected either way — documents are not
+         * bucket-partitioned. A bucket that does not belong to the caller's
+         * account+environment is rejected.
+         */
+        bucket?: string;
+    }
     /**
      * Filter options for `op=ls` and `op=find`.
      */

package/resources/fs.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"fs.d.mts","sourceRoot":"","sources":["../src/resources/fs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAGzF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtF;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,EAAE,IAAI,CAAC;IAET;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,EAAE,IAAI,CAAC;IAET;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
+{"version":3,"file":"fs.d.mts","sourceRoot":"","sources":["../src/resources/fs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAGzF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtF;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,EAAE,IAAI,CAAC;IAET;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,EAAE,IAAI,CAAC;IAET;;;;OAIG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC;IAElC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;;;OAIG;IACH,UAAiB,OAAO;QACtB;;;;;;;;;;;;;WAaG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/fs.d.ts

@@ -212,6 +212,12 @@ export interface FNavigateParams {
      * pointing at the toggle.
      */
     op: FsOp;
+    /**
+     * Request-scoping concerns that are orthogonal to the op itself. Carried on a
+     * `context` object so future scoping hints (e.g. as-of timestamps, read
+     * consistency) can slot in without reshaping the op-specific fields.
+     */
+    context?: FNavigateParams.Context;
     /**
      * When true, return only the hit count without snippet payload. Cheaper than
      * fetching matches when the agent only wants a yes/no.
@@ -270,6 +276,28 @@ export interface FNavigateParams {
     select?: Array<string>;
 }
 export declare namespace FNavigateParams {
+    /**
+     * Request-scoping concerns that are orthogonal to the op itself. Carried on a
+     * `context` object so future scoping hints (e.g. as-of timestamps, read
+     * consistency) can slot in without reshaping the op-specific fields.
+     */
+    interface Context {
+        /**
+         * Bucket KSUID (prefix `bkt_`) to scope the request to — a named partition of the
+         * knowledge graph within the caller's account+environment.
+         *
+         * **Optional.** Omitting it (or passing an empty value) leaves the request
+         * UNSCOPED: memory-level reads (`find` / `open` / `xref`) return entities across
+         * every bucket in the account+environment, so pre-bucket callers keep their
+         * original all-entities behavior unchanged. (Writes are different: a parse call
+         * with no bucket targets the account default bucket.) When a bucket IS supplied,
+         * memory-level ops return only entities in that bucket; doc-level ops
+         * (`ls`/`cat`/`head`/`stat`/`grep`) are unaffected either way — documents are not
+         * bucket-partitioned. A bucket that does not belong to the caller's
+         * account+environment is rejected.
+         */
+        bucket?: string;
+    }
     /**
      * Filter options for `op=ls` and `op=find`.
      */

package/resources/fs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../src/resources/fs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAGzF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtF;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,EAAE,IAAI,CAAC;IAET;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,EAAE,IAAI,CAAC;IAET;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
+{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../src/resources/fs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAGzF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtF;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,EAAE,IAAI,CAAC;IAET;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,EAAE,IAAI,CAAC;IAET;;;;OAIG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC;IAElC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;;;OAIG;IACH,UAAiB,OAAO;QACtB;;;;;;;;;;;;;WAaG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/functions/functions.d.mts

@@ -16,8 +16,8 @@ export declare class Functions extends APIResource {
     /**
      * **Create a function.**
      *
-     * The function type (`extract`, `classify`, `split`, `join`, `enrich`, or
-     * `payload_shaping`) determines which configuration fields are required — see
+     * The function `type` determines which configuration fields are required — see the
+     * `CreateFunctionV3` discriminated union and
      * [Function types overview](/guide/function-types/overview) for the per-type
      * contract.
      *
@@ -261,7 +261,7 @@ export declare namespace ClassificationListItem {
 /**
  * V3 wire form of the classify function create payload.
  */
-export type CreateFunction = CreateFunction.ExtractFunction | CreateFunction.ClassifyFunction | CreateFunction.SendFunction | CreateFunction.SplitFunction | CreateFunction.JoinFunction | CreateFunction.PayloadShapingFunction | CreateFunction.EnrichFunction | CreateFunction.ParseFunction;
+export type CreateFunction = CreateFunction.ExtractFunction | CreateFunction.ClassifyFunction | CreateFunction.SendFunction | CreateFunction.SplitFunction | CreateFunction.JoinFunction | CreateFunction.PayloadShapingFunction | CreateFunction.EnrichFunction | CreateFunction.ParseFunction | CreateFunction.RenderFunction;
 export declare namespace CreateFunction {
     interface ExtractFunction {
         /**
@@ -553,6 +553,55 @@ export declare namespace CreateFunction {
             enableBoundingBoxes?: boolean;
         }
     }
+    interface RenderFunction {
+        /**
+         * Name of function. Must be UNIQUE on a per-environment basis.
+         */
+        functionName: string;
+        /**
+         * Request-side render configuration. Carries the template document as
+         * base64-encoded `.docx` bytes: the server validates them, stores the template,
+         * and derives the placeholder/style-id contract at create/update time, so clients
+         * never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
+         * returns the derived contract.
+         */
+        renderConfig: RenderFunction.RenderConfig;
+        type: 'render';
+        /**
+         * Display name of function. Human-readable name to help you identify the function.
+         */
+        displayName?: string;
+        /**
+         * Array of tags to categorize and organize functions.
+         */
+        tags?: Array<string>;
+    }
+    namespace RenderFunction {
+        /**
+         * Request-side render configuration. Carries the template document as
+         * base64-encoded `.docx` bytes: the server validates them, stores the template,
+         * and derives the placeholder/style-id contract at create/update time, so clients
+         * never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
+         * returns the derived contract.
+         */
+        interface RenderConfig {
+            template: RenderConfig.Template;
+        }
+        namespace RenderConfig {
+            interface Template {
+                /**
+                 * Base64-encoded `.docx` bytes. In the Bem CLI, use `@path/to/file` to embed it
+                 * automatically.
+                 */
+                base64: string;
+                /**
+                 * Original upload filename (e.g. `contract.docx`), stored for display only. Does
+                 * not affect where the template is stored.
+                 */
+                name?: string;
+            }
+        }
+    }
 }
 /**
  * Configuration for an enrich function.
@@ -875,7 +924,7 @@ export interface EnrichStep {
  * `classify` in place of `route`. Legacy `transform` and `analyze` functions
  * remain readable via V3.
  */
-export type Function = Function.TransformFunction | Function.ExtractFunction | Function.AnalyzeFunction | Function.ClassifyFunction | Function.SendFunction | Function.SplitFunction | Function.JoinFunction | Function.PayloadShapingFunction | Function.EnrichFunction | Function.ParseFunction;
+export type Function = Function.TransformFunction | Function.ExtractFunction | Function.AnalyzeFunction | Function.ClassifyFunction | Function.SendFunction | Function.SplitFunction | Function.JoinFunction | Function.PayloadShapingFunction | Function.EnrichFunction | Function.ParseFunction | Function.RenderFunction;
 export declare namespace Function {
     interface TransformFunction {
         /**
@@ -1418,6 +1467,134 @@ export declare namespace Function {
             enableBoundingBoxes?: boolean;
         }
     }
+    interface RenderFunction {
+        /**
+         * Unique identifier of function.
+         */
+        functionID: string;
+        /**
+         * Name of function. Must be UNIQUE on a per-environment basis.
+         */
+        functionName: string;
+        type: 'render';
+        /**
+         * Version number of function.
+         */
+        versionNum: number;
+        /**
+         * Audit trail information for the function.
+         */
+        audit?: FunctionsAPI.FunctionAudit;
+        /**
+         * Display name of function. Human-readable name to help you identify the function.
+         */
+        displayName?: string;
+        /**
+         * Per-version configuration for a Render function.
+         *
+         * Render emits a `.docx` from schema-typed JSON by composing the JSON into a
+         * `.docx` template. The template document is stored server-side; this response
+         * exposes only the contract derived from it. Schema validation runs internally in
+         * the ML service against the bundled core schema; no customer-supplied schema
+         * rides this surface.
+         */
+        renderConfig?: RenderFunction.RenderConfig;
+        /**
+         * Array of tags to categorize and organize functions.
+         */
+        tags?: Array<string>;
+        /**
+         * List of workflows that use this function.
+         */
+        usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
+    }
+    namespace RenderFunction {
+        /**
+         * Per-version configuration for a Render function.
+         *
+         * Render emits a `.docx` from schema-typed JSON by composing the JSON into a
+         * `.docx` template. The template document is stored server-side; this response
+         * exposes only the contract derived from it. Schema validation runs internally in
+         * the ML service against the bundled core schema; no customer-supplied schema
+         * rides this surface.
+         */
+        interface RenderConfig {
+            /**
+             * The uploaded template: its filename, a short-lived presigned download URL, and
+             * the placeholder/style contract derived from it. Absent on configs created before
+             * template capture existed.
+             */
+            template?: RenderConfig.Template;
+        }
+        namespace RenderConfig {
+            /**
+             * The uploaded template: its filename, a short-lived presigned download URL, and
+             * the placeholder/style contract derived from it. Absent on configs created before
+             * template capture existed.
+             */
+            interface Template {
+                /**
+                 * Short-lived presigned URL to download the stored `.docx`. The private storage
+                 * location is never exposed.
+                 */
+                downloadURL?: string;
+                /**
+                 * Supported list kinds (`decimal`, `bullet`) the template's `numbering.xml`
+                 * defines an `abstractNum` for. Empty means the template can hold no list, so any
+                 * list primitive will fail at render.
+                 */
+                listKinds?: Array<'decimal' | 'bullet'>;
+                /**
+                 * Original filename of the uploaded template (e.g. `contract.docx`), echoed back
+                 * for display. Absent on templates uploaded before the filename was captured.
+                 */
+                name?: string;
+                /**
+                 * The placeholder contract a Render template declares, grouped by how each
+                 * placeholder is filled. Derived from the template at create/update time by
+                 * scanning its `docxtpl` tags; not user-supplied.
+                 *
+                 * - `stringKeys`: bare string placeholders (`{{ key }}`) filled with a single
+                 *   value.
+                 * - `blockKeys`: wrapped-primitive placeholders (`{{p key }}`) — bind one core
+                 *   primitive (paragraph, table, image, or list). The placeholder's own paragraph
+                 *   dissolves and is replaced by the rendered subdocument's blocks, rather than
+                 *   substituting text inline.
+                 */
+                placeholders?: Template.Placeholders;
+                /**
+                 * Paragraph/character style IDs the uploaded template defines and the rendered
+                 * output can reference. Derived from the template's `styles.xml` at create/update
+                 * time.
+                 */
+                styleIds?: Array<string>;
+                /**
+                 * Style IDs whose type is table — the styles a `table` primitive's required
+                 * `styleId` can name. Empty means the template defines no table style, so any
+                 * table primitive will fail at render.
+                 */
+                tableStyleIds?: Array<string>;
+            }
+            namespace Template {
+                /**
+                 * The placeholder contract a Render template declares, grouped by how each
+                 * placeholder is filled. Derived from the template at create/update time by
+                 * scanning its `docxtpl` tags; not user-supplied.
+                 *
+                 * - `stringKeys`: bare string placeholders (`{{ key }}`) filled with a single
+                 *   value.
+                 * - `blockKeys`: wrapped-primitive placeholders (`{{p key }}`) — bind one core
+                 *   primitive (paragraph, table, image, or list). The placeholder's own paragraph
+                 *   dissolves and is replaced by the rendered subdocument's blocks, rather than
+                 *   substituting text inline.
+                 */
+                interface Placeholders {
+                    blockKeys: Array<string>;
+                    stringKeys: Array<string>;
+                }
+            }
+        }
+    }
 }
 export interface FunctionAudit {
     /**
@@ -1449,7 +1626,7 @@ export interface FunctionResponse {
 /**
  * The type of the function.
  */
-export type FunctionType = 'transform' | 'extract' | 'route' | 'classify' | 'send' | 'split' | 'join' | 'analyze' | 'payload_shaping' | 'enrich' | 'parse';
+export type FunctionType = 'transform' | 'extract' | 'route' | 'classify' | 'send' | 'split' | 'join' | 'analyze' | 'payload_shaping' | 'enrich' | 'parse' | 'render';
 export interface ListFunctionsResponse {
     functions?: Array<Function>;
     /**
@@ -1465,6 +1642,12 @@ export interface ListFunctionsResponse {
  * output concern) and cross-document memory linking (an environment-wide concern).
  */
 export interface ParseConfig {
+    /**
+     * Optional bucket NAME that parse-extracted entities land in when no call-level
+     * bucket is supplied. Lower precedence than a call-level bucket, higher than the
+     * account+environment default.
+     */
+    defaultBucket?: string;
     /**
      * When true, extract named entities (people, organizations, products, studies,
      * identifiers, etc.) and the relationships between them, and dedupe by canonical
@@ -1520,7 +1703,7 @@ export interface SplitFunctionSemanticPageItemClass {
  * unions (existing classify functions are returned from V2 GET endpoints
  * verbatim).V3 wire form of the classify function upsert payload.
  */
-export type UpdateFunction = UpdateFunction.ExtractFunction | UpdateFunction.ClassifyFunction | UpdateFunction.SendFunction | UpdateFunction.SplitFunction | UpdateFunction.JoinFunction | UpdateFunction.PayloadShapingFunction | UpdateFunction.UpsertEnrichFunction | UpdateFunction.ParseFunction;
+export type UpdateFunction = UpdateFunction.ExtractFunction | UpdateFunction.ClassifyFunction | UpdateFunction.SendFunction | UpdateFunction.SplitFunction | UpdateFunction.JoinFunction | UpdateFunction.PayloadShapingFunction | UpdateFunction.UpsertEnrichFunction | UpdateFunction.ParseFunction | UpdateFunction.RenderFunction;
 export declare namespace UpdateFunction {
     interface ExtractFunction {
         type: 'extract';
@@ -1819,6 +2002,55 @@ export declare namespace UpdateFunction {
             enableBoundingBoxes?: boolean;
         }
     }
+    interface RenderFunction {
+        type: 'render';
+        /**
+         * Display name of function. Human-readable name to help you identify the function.
+         */
+        displayName?: string;
+        /**
+         * Name of function. Must be UNIQUE on a per-environment basis.
+         */
+        functionName?: string;
+        /**
+         * Request-side render configuration. Carries the template document as
+         * base64-encoded `.docx` bytes: the server validates them, stores the template,
+         * and derives the placeholder/style-id contract at create/update time, so clients
+         * never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
+         * returns the derived contract.
+         */
+        renderConfig?: RenderFunction.RenderConfig;
+        /**
+         * Array of tags to categorize and organize functions.
+         */
+        tags?: Array<string>;
+    }
+    namespace RenderFunction {
+        /**
+         * Request-side render configuration. Carries the template document as
+         * base64-encoded `.docx` bytes: the server validates them, stores the template,
+         * and derives the placeholder/style-id contract at create/update time, so clients
+         * never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
+         * returns the derived contract.
+         */
+        interface RenderConfig {
+            template: RenderConfig.Template;
+        }
+        namespace RenderConfig {
+            interface Template {
+                /**
+                 * Base64-encoded `.docx` bytes. In the Bem CLI, use `@path/to/file` to embed it
+                 * automatically.
+                 */
+                base64: string;
+                /**
+                 * Original upload filename (e.g. `contract.docx`), stored for display only. Does
+                 * not affect where the template is stored.
+                 */
+                name?: string;
+            }
+        }
+    }
 }
 export interface UserActionSummary {
     /**
@@ -2907,7 +3139,7 @@ export declare namespace FunctionGetMetricsResponse {
         }
     }
 }
-export type FunctionCreateParams = FunctionCreateParams.CreateExtractFunction | FunctionCreateParams.CreateClassifyFunction | FunctionCreateParams.CreateSendFunction | FunctionCreateParams.CreateSplitFunction | FunctionCreateParams.CreateJoinFunction | FunctionCreateParams.CreatePayloadShapingFunction | FunctionCreateParams.CreateEnrichFunction | FunctionCreateParams.CreateParseFunction;
+export type FunctionCreateParams = FunctionCreateParams.CreateExtractFunction | FunctionCreateParams.CreateClassifyFunction | FunctionCreateParams.CreateSendFunction | FunctionCreateParams.CreateSplitFunction | FunctionCreateParams.CreateJoinFunction | FunctionCreateParams.CreatePayloadShapingFunction | FunctionCreateParams.CreateEnrichFunction | FunctionCreateParams.CreateParseFunction | FunctionCreateParams.CreateRenderFunction;
 export declare namespace FunctionCreateParams {
     interface CreateExtractFunction {
         /**
@@ -3196,8 +3428,57 @@ export declare namespace FunctionCreateParams {
             enableBoundingBoxes?: boolean;
         }
     }
+    interface CreateRenderFunction {
+        /**
+         * Name of function. Must be UNIQUE on a per-environment basis.
+         */
+        functionName: string;
+        /**
+         * Request-side render configuration. Carries the template document as
+         * base64-encoded `.docx` bytes: the server validates them, stores the template,
+         * and derives the placeholder/style-id contract at create/update time, so clients
+         * never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
+         * returns the derived contract.
+         */
+        renderConfig: CreateRenderFunction.RenderConfig;
+        type: 'render';
+        /**
+         * Display name of function. Human-readable name to help you identify the function.
+         */
+        displayName?: string;
+        /**
+         * Array of tags to categorize and organize functions.
+         */
+        tags?: Array<string>;
+    }
+    namespace CreateRenderFunction {
+        /**
+         * Request-side render configuration. Carries the template document as
+         * base64-encoded `.docx` bytes: the server validates them, stores the template,
+         * and derives the placeholder/style-id contract at create/update time, so clients
+         * never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
+         * returns the derived contract.
+         */
+        interface RenderConfig {
+            template: RenderConfig.Template;
+        }
+        namespace RenderConfig {
+            interface Template {
+                /**
+                 * Base64-encoded `.docx` bytes. In the Bem CLI, use `@path/to/file` to embed it
+                 * automatically.
+                 */
+                base64: string;
+                /**
+                 * Original upload filename (e.g. `contract.docx`), stored for display only. Does
+                 * not affect where the template is stored.
+                 */
+                name?: string;
+            }
+        }
+    }
 }
-export type FunctionUpdateParams = FunctionUpdateParams.UpsertExtractFunction | FunctionUpdateParams.UpsertClassifyFunction | FunctionUpdateParams.UpsertSendFunction | FunctionUpdateParams.UpsertSplitFunction | FunctionUpdateParams.UpsertJoinFunction | FunctionUpdateParams.UpsertPayloadShapingFunction | FunctionUpdateParams.UpsertEnrichFunction | FunctionUpdateParams.UpsertParseFunction;
+export type FunctionUpdateParams = FunctionUpdateParams.UpsertExtractFunction | FunctionUpdateParams.UpsertClassifyFunction | FunctionUpdateParams.UpsertSendFunction | FunctionUpdateParams.UpsertSplitFunction | FunctionUpdateParams.UpsertJoinFunction | FunctionUpdateParams.UpsertPayloadShapingFunction | FunctionUpdateParams.UpsertEnrichFunction | FunctionUpdateParams.UpsertParseFunction | FunctionUpdateParams.UpsertRenderFunction;
 export declare namespace FunctionUpdateParams {
     interface UpsertExtractFunction {
         type: 'extract';
@@ -3474,6 +3755,55 @@ export declare namespace FunctionUpdateParams {
             enableBoundingBoxes?: boolean;
         }
     }
+    interface UpsertRenderFunction {
+        type: 'render';
+        /**
+         * Display name of function. Human-readable name to help you identify the function.
+         */
+        displayName?: string;
+        /**
+         * Name of function. Must be UNIQUE on a per-environment basis.
+         */
+        functionName?: string;
+        /**
+         * Request-side render configuration. Carries the template document as
+         * base64-encoded `.docx` bytes: the server validates them, stores the template,
+         * and derives the placeholder/style-id contract at create/update time, so clients
+         * never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
+         * returns the derived contract.
+         */
+        renderConfig?: UpsertRenderFunction.RenderConfig;
+        /**
+         * Array of tags to categorize and organize functions.
+         */
+        tags?: Array<string>;
+    }
+    namespace UpsertRenderFunction {
+        /**
+         * Request-side render configuration. Carries the template document as
+         * base64-encoded `.docx` bytes: the server validates them, stores the template,
+         * and derives the placeholder/style-id contract at create/update time, so clients
+         * never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
+         * returns the derived contract.
+         */
+        interface RenderConfig {
+            template: RenderConfig.Template;
+        }
+        namespace RenderConfig {
+            interface Template {
+                /**
+                 * Base64-encoded `.docx` bytes. In the Bem CLI, use `@path/to/file` to embed it
+                 * automatically.
+                 */
+                base64: string;
+                /**
+                 * Original upload filename (e.g. `contract.docx`), stored for display only. Does
+                 * not affect where the template is stored.
+                 */
+                name?: string;
+            }
+        }
+    }
 }
 export interface FunctionListParams extends FunctionsPageParams {
     displayName?: string;