Measure the compactor with a probe run

[onechat] / README.rst

diff --git a/README.rst b/README.rst
index fdcc0e0af17f1c70de0795242da868f4a67fe2e9..c74a815ee0387db961d3d4d1953b8280114d23e0 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -63,6 +63,25 @@ before they expire. The file belongs to OneChat only. Do not share it
 with the Codex CLI, because each program rotates the refresh token and
 logs the other out.
 
 with the Codex CLI, because each program rotates the refresh token and
 logs the other out.
 

+*******
+ Probe
+*******
+
+``onechat probe LOG COUNT`` measures the compactor on a log. It appends
+the first COUNT messages of LOG, one JSON object ``{"kind", "text"}`` on
+each line, to a new chat in ``probe/`` in the data directory, and builds
+its tree with real model calls. The calls use the quota of the account.
+The run stops at the first failed call, or when the used percent of a
+quota window grows by more than 15 points. At the end it reports the
+calls per message, the cached share of the input tokens, the retries,
+the line sizes, and the quota at the first and the last call.
+
+A test writes a generated log of readable made-up messages:
+
+.. code:: console
+
+   ONECHAT_PROBE_LOG=probe.jsonl go test -run TestProbeLogHasTheSyntheticMix
+

 *************
  Development
 *************
 *************
  Development
 *************