@zils/sdk 0.3.0 → 0.4.0

package/README.md

@@ -59,6 +59,10 @@ apply; one HTTP request does not mean one model evaluation. See the
 [ranking contract](https://github.com/ooo-hq/zils-sdk/blob/main/docs/developer-tools.md#ranking)
 for numerical limits, failure behavior, and examples.
 
+**New in 0.4.0:** `record(question, fn)` logs a decision function's inputs and
+answers for `zils fit run`, which measures how much of that traffic Zils can take.
+See [zils fit](https://github.com/ooo-hq/zils-sdk/blob/main/docs/fit.md).
+
 **New in 0.3.0:** add `groupSize: 4` to the rank request to compare
 overlapping groups instead. Group sizes must be integers from 2 to 10 and are
 capped to the list length. This sends `n` Choice judgments, fits relative Luce

package/dist/fit.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Shadow-log a decision function for `zils fit run`. Behaviour is unchanged: each call's
+ * input and answer are appended to fit-log.jsonl (or ZILS_FIT_LOG). The log holds real
+ * inputs, so it is created owner-only. Failed calls are not logged, and a logging error
+ * never reaches the caller.
+ */
+export declare function record<A extends unknown[], R>(question: string, fn: (...args: A) => R): (...args: A) => R;

package/dist/fit.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.record = record;
+const node_fs_1 = require("node:fs");
+/**
+ * Shadow-log a decision function for `zils fit run`. Behaviour is unchanged: each call's
+ * input and answer are appended to fit-log.jsonl (or ZILS_FIT_LOG). The log holds real
+ * inputs, so it is created owner-only. Failed calls are not logged, and a logging error
+ * never reaches the caller.
+ */
+function record(question, fn) {
+    return (...args) => {
+        const answer = fn(...args);
+        const state = args.length === 1 ? args[0] : { args };
+        if (answer instanceof Promise) {
+            return answer.then(value => { write(question, state, value); return value; });
+        }
+        write(question, state, answer);
+        return answer;
+    };
+}
+function write(question, state, answer) {
+    try {
+        const line = JSON.stringify({ question, state, answer, ts: Date.now() / 1000 });
+        (0, node_fs_1.appendFileSync)(process.env.ZILS_FIT_LOG || 'fit-log.jsonl', line + '\n', { mode: 0o600 });
+    }
+    catch (error) {
+        console.error(`zils fit: call not recorded (${error.name})`);
+    }
+}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { TypeSafeClient, type TypeSafeClientConfig, type APIPromise, type Questions, type SystemOneRequest, type SystemOneResult as BaseResult, type RequestOptions, type Usage as BaseUsage } from '@typesafe-ai/sdk';
 import { type RankRequest, type RankResult } from './ranking.js';
 export type { RankRequest, RankResult, RankedItem } from './ranking.js';
+export { record } from './fit.js';
 export { noul, choice, score, APIError, APIConnectionError, APITimeoutError, APIUserAbortError, AuthenticationError, RateLimitError, TypeSafeError as ZilsError, } from '@typesafe-ai/sdk';
 export type { Question, Questions, SystemOneRequest, RequestOptions, RetryPolicy, ModelCard, NoulQuestion, ChoiceQuestion, ScoreQuestion, NoulResponse, ChoiceResponse, ScoreResponse, JsonValue, EntryType, } from '@typesafe-ai/sdk';
 export interface Usage extends BaseUsage {

package/dist/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZilsClient = exports.ZilsError = exports.RateLimitError = exports.AuthenticationError = exports.APIUserAbortError = exports.APITimeoutError = exports.APIConnectionError = exports.APIError = exports.score = exports.choice = exports.noul = void 0;
+exports.ZilsClient = exports.ZilsError = exports.RateLimitError = exports.AuthenticationError = exports.APIUserAbortError = exports.APITimeoutError = exports.APIConnectionError = exports.APIError = exports.score = exports.choice = exports.noul = exports.record = void 0;
 const sdk_1 = require("@typesafe-ai/sdk");
 const ranking_js_1 = require("./ranking.js");
+var fit_js_1 = require("./fit.js");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return fit_js_1.record; } });
 var sdk_2 = require("@typesafe-ai/sdk");
 Object.defineProperty(exports, "noul", { enumerable: true, get: function () { return sdk_2.noul; } });
 Object.defineProperty(exports, "choice", { enumerable: true, get: function () { return sdk_2.choice; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zils/sdk",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Typed JavaScript and TypeScript client for Zils decisions",
   "license": "MIT",
   "homepage": "https://zils.ai",