oracular 0.15.0 → 0.16.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.16.0
+
+### Minor Changes
+
+- [#74](https://github.com/Yuribenjamin/oracular/pull/74) [`7e6b6fc`](https://github.com/Yuribenjamin/oracular/commit/7e6b6fc3885dac0167b92661e188e3f779a73a45) Thanks [@Yuribenjamin](https://github.com/Yuribenjamin)! - **The outcome record keeps the estimate the reset wipes.** `createRecord` takes the state after `observe`, so on the record of an intent's own outcome event `p` is what the engine decides right after it, with `resetOnOutcome` the prior (0.150 where it had been 0.506 one event earlier). Replay recomputes everything from the events and never reads it, but people read the log, and the number that matters most on an outcome line was gone. `createRecord(state, event, options, previous)` takes the state from before the event as an optional fourth argument; the decision of each intent whose outcome the event is then gains `before`, its `p` and `lower` at `event.at` on that state. Every other record is byte for byte what it was. `RECORD_VERSION` stays 1: a new optional field does not change it, readers ignore fields they do not know, and `replay` and `tune` never read decisions, so a log with `before` replays on every release that reads version 1. Found by the second production integration.
+
 ## 0.15.0
 
 ### Minor Changes

package/README.md

@@ -264,7 +264,7 @@ evaluate(state, intent: string, at: number, opts?): { prediction, reveal, explan
 inspect(state, at: number, opts?): { at, intents: [{ intent, prediction, reveal, explanation }] }  // evaluate for every intent
 evidenceToReveal(intentConfig, opts?): number   // pseudo-counts at which shouldReveal first becomes true
 episodeClosed(prev, next): boolean               // did an episode close between two states?
-createRecord(state, event, { installId, mode }): EventRecord   // one recorder line: the event and what was decided
+createRecord(state, event, { installId, mode }, previous?): EventRecord   // one recorder line: the event and what was decided; with the state before the event, the outcome's record keeps the estimate the reset wipes
 createEndRecord(at, { installId, mode }): EndRecord           // one recorder line: the episode ended
 serialize(state): string
 deserialize(json: string, opts?: { config?: EngineConfig; migrate?: Migrate }): EngineState

package/dist/index.cjs

@@ -899,10 +899,11 @@ function normalizeRecordOptions(value) {
   }
   return { installId, mode, top };
 }
-function createRecord(state, event, opts) {
+function createRecord(state, event, opts, previous) {
   const s = requireState(state);
   const { name, at } = validateEvent(event);
   const { installId, mode, top } = normalizeRecordOptions(opts);
+  const prev = previous === void 0 ? void 0 : requireState(previous);
   const learning = resolveLearning(s.config);
   const decisions = {};
   for (const [intentName, intent] of Object.entries(s.config.intents)) {
@@ -914,7 +915,7 @@ function createRecord(state, event, opts) {
     for (const signal of Object.keys(intent.signals)) {
       weights[signal] = rows.find((row) => row.signal === signal).effectiveWeight;
     }
-    decisions[intentName] = {
+    const decision = {
       p: prediction.p,
       lower: prediction.lower,
       shouldReveal: decideReveal(prediction, reveal),
@@ -922,6 +923,17 @@ function createRecord(state, event, opts) {
       top: rows.filter((row) => row.contribution !== 0).slice(0, top).map((row) => ({ signal: row.signal, impact: row.impact })),
       weights
     };
+    const prevIntent = prev === void 0 ? void 0 : getOwn(prev.config.intents, intentName);
+    if (prev !== void 0 && prevIntent !== void 0 && intent.outcome === name) {
+      const was = buildPrediction(
+        assessIntent(prev, intentName, prevIntent, resolveLearning(prev.config), at),
+        intentName,
+        resolveReveal(prev.config, prevIntent, void 0),
+        at
+      );
+      decision.before = { p: was.p, lower: was.lower };
+    }
+    decisions[intentName] = decision;
   }
   return { v: RECORD_VERSION, kind: "event", installId, mode, event: { name, at }, decisions };
 }