@cubicecho/agent-core 2.6.0 → 2.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -7
- package/dist/agent-loop.js +5 -1
- package/dist/client.d.ts +30 -4
- package/dist/client.js +119 -11
- package/dist/config.d.ts +25 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/retry.d.ts +15 -0
- package/dist/retry.js +21 -0
- package/dist/run-turn.d.ts +10 -1
- package/dist/run-turn.js +19 -2
- package/dist/stream.d.ts +8 -1
- package/dist/stream.js +32 -11
- package/llms.txt +6 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,8 +27,8 @@ only, Node >=22.
|
|
|
27
27
|
| `side-task` | One-shot calls that support a run without being one — small prompt, short answer, no tools, never worth failing the run over. `askJson` holds the answer to a schema where the server can. |
|
|
28
28
|
| `hooks` | The host's side of lifecycle hooks: `gather` before a request and `notify` after, the shared context budget, `withContext` to put what they add on the turn's question, `untrusted` to fence text nobody vouched for, and `turnMessages` to hand them a transcript. Running a hook is a runner the caller passes. |
|
|
29
29
|
| `events` | The in-memory bus a watcher reads while a run happens: `emit`, `watch`, `history`, `fold`. A watcher's backlog is capped and reports its own gaps. |
|
|
30
|
-
| `client` | A pooled `OpenAI` client per endpoint, plus the context
|
|
31
|
-
| `retry` | What to do when a request is lost, refused or too big: `isTransient`, `backoffMs`, `ContextOverflow`, `EndpointSilent`, `requestTokens`. |
|
|
30
|
+
| `client` | A pooled `OpenAI` client per endpoint, plus the context window: the served one where a local server says, the listed one otherwise, and their caches. |
|
|
31
|
+
| `retry` | What to do when a request is lost, refused or too big: `isTransient`, `isModelLoading`, `backoffMs`, `ContextOverflow`, `EndpointSilent`, `requestTokens`. |
|
|
32
32
|
| `config` | The structural interfaces every function here asks for. |
|
|
33
33
|
| `run-turn` | `runTurn`: one turn with the retry loop around the negotiation around the stream. The whole loop, for a caller that wants it rather than its parts. Sizes the request against an opt-in `contextLimit`. |
|
|
34
34
|
| `agent-loop` | `runAgentLoop`: the loop above a turn — `runTurn` per step, the tools between, `load_tools` and preselection handled, until the model stops asking. Plus the parts it is made of: `buildBody`, `preselect`, `preview`, and `resolveApiKey` for a caller deciding which key an endpoint gets. |
|
|
@@ -145,11 +145,21 @@ is worth another attempt. The content-free `{"role":"assistant"}` most servers o
|
|
|
145
145
|
does not set it: nothing has been shown to anybody yet, so an endpoint that primes the stream and
|
|
146
146
|
then wedges is retried like one that never answered at all.
|
|
147
147
|
|
|
148
|
-
`idleMs` is silence, not a deadline: the timer is rearmed on every chunk, so a model that is
|
|
149
|
-
|
|
148
|
+
`idleMs` is silence, not a deadline: the timer is rearmed on every chunk, so a model that is still
|
|
149
|
+
talking is never cut off however long it takes, and one that has stopped answering raises
|
|
150
150
|
`EndpointSilent` rather than hanging the run. `timeoutMs(config)` returns `undefined` for a
|
|
151
|
-
`requestTimeoutSeconds` of zero or absent, which waits forever — what a local model answering
|
|
152
|
-
|
|
151
|
+
`requestTimeoutSeconds` of zero or absent, which waits forever — what a local model answering slowly
|
|
152
|
+
needs.
|
|
153
|
+
|
|
154
|
+
The first chunk gets its own allowance, `firstChunkMs`, because the first wait is prefill: tens of
|
|
155
|
+
seconds for a long prompt on a local GPU, minutes on a CPU, and longer again when the server is
|
|
156
|
+
loading the model on demand. It holds until a chunk carries something, so an empty
|
|
157
|
+
`{"role":"assistant"}` sent before the prompt is read does not start the idle clock.
|
|
158
|
+
`firstTokenMs(config)` reads `firstTokenSeconds` off the endpoint, and five times
|
|
159
|
+
`requestTimeoutSeconds` where that is absent. With a watchdog armed, the SDK's own timer is switched
|
|
160
|
+
off for the stream; it runs until the headers arrive, which is the end of prefill, and used to
|
|
161
|
+
abandon one at the idle number. `requestTimeoutSeconds` still bounds calls that do not stream, side
|
|
162
|
+
tasks and model listings, the same way.
|
|
153
163
|
|
|
154
164
|
## Structured side tasks
|
|
155
165
|
|
|
@@ -191,6 +201,16 @@ const turn = await runTurn(client, supports, build, {
|
|
|
191
201
|
});
|
|
192
202
|
```
|
|
193
203
|
|
|
204
|
+
`contextLimitFor` answers the operator's number when there is one. Otherwise it asks for the window
|
|
205
|
+
the server is actually serving the model in (`servedWindow`): llama.cpp's `/props`
|
|
206
|
+
(`default_generation_settings.n_ctx`) and LM Studio's `/api/v0/models` (`loaded_context_length`).
|
|
207
|
+
That differs from the trained window in the case the guard exists for, a 256k model started at `-c
|
|
208
|
+
16384`. A server with neither route is latched and not asked again. Failing both, it reads the
|
|
209
|
+
`/v1/models` listing: `max_model_len` from vLLM, `context_length` from OpenRouter, and llama.cpp's
|
|
210
|
+
`meta.n_ctx_train`, which is only the trained window. Ollama reports no window on any route this
|
|
211
|
+
reads, and truncates an over-long prompt rather than refusing it, so on Ollama pass `contextLength`
|
|
212
|
+
or there is no guard at all.
|
|
213
|
+
|
|
194
214
|
What is weighed is the prompt plus the reply ceiling the body carries, under whichever spelling
|
|
195
215
|
was chosen, because that is what the endpoint weighs: a 30k prompt into a 32k window with
|
|
196
216
|
`max_tokens: 4096` is refused there, so it is refused here. A body with no ceiling reserves
|
|
@@ -209,6 +229,14 @@ refuses instead — one round trip later — and `runTurn` reads that refusal ba
|
|
|
209
229
|
original error as `cause`. A rate limit borrows those words and means the opposite ("Request too
|
|
210
230
|
large for gpt-4o ... on tokens per min"); that is ruled out and waited through as the 429 it is.
|
|
211
231
|
|
|
232
|
+
A server still loading the model is waited for on its own clock. llama.cpp answers 503 `Loading
|
|
233
|
+
model` (type `unavailable_error`) until the weights are mapped, thirty to ninety seconds for a large
|
|
234
|
+
model from a cold cache, and a router build says the same while it swaps models; `backoffMs` would
|
|
235
|
+
give up inside fifteen. `isModelLoading` recognises it, and `runTurn` polls every `LOADING_POLL_MS`
|
|
236
|
+
for up to `loadingTimeoutMs` (two minutes by default, zero to turn it off) without spending
|
|
237
|
+
`maxRetries`, with one notice at the start. `runAgentLoop` reads it as `loadingTimeoutSeconds` off
|
|
238
|
+
the config. A 503 that says nothing about loading stays on the ordinary backoff.
|
|
239
|
+
|
|
212
240
|
## The loop
|
|
213
241
|
|
|
214
242
|
`runAgentLoop` is the part of an agent that three servers had each written, and that had drifted
|
|
@@ -221,7 +249,7 @@ did. What it does not know is what the run is for — the prompt, the tools, and
|
|
|
221
249
|
import { runAgentLoop, emit } from "@cubicecho/agent-core";
|
|
222
250
|
|
|
223
251
|
const { turn, messages, usage, loaded } = await runAgentLoop({
|
|
224
|
-
config, // Endpoint & ModelParams & { maxToolIterations, toolDiscovery?, maxRetries?, contextLength? }
|
|
252
|
+
config, // Endpoint & ModelParams & { maxToolIterations, toolDiscovery?, maxRetries?, loadingTimeoutSeconds?, contextLength? }
|
|
225
253
|
system, // sent as the first message; on-demand mode appends the catalogue
|
|
226
254
|
messages: history, // ending in the question; not written to
|
|
227
255
|
tools, // every tool the run may reach
|
package/dist/agent-loop.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { capabilitiesFor } from "./capabilities.js";
|
|
2
|
-
import { getClient, NO_KEY, timeoutMs } from "./client.js";
|
|
2
|
+
import { firstTokenMs, getClient, NO_KEY, timeoutMs } from "./client.js";
|
|
3
3
|
import { errorMessage } from "./errors.js";
|
|
4
4
|
import { gather, notify, turnIndex, turnMessages, withContext, } from "./hooks.js";
|
|
5
5
|
import { runTurn } from "./run-turn.js";
|
|
@@ -187,9 +187,13 @@ export async function runAgentLoop(options) {
|
|
|
187
187
|
model: config.model,
|
|
188
188
|
droppable: Object.keys(config.extraBody ?? {}),
|
|
189
189
|
maxRetries,
|
|
190
|
+
...(config.loadingTimeoutSeconds === undefined
|
|
191
|
+
? {}
|
|
192
|
+
: { loadingTimeoutMs: Math.max(0, config.loadingTimeoutSeconds) * 1000 }),
|
|
190
193
|
contextLimit: config.contextLength ?? 0,
|
|
191
194
|
signal,
|
|
192
195
|
idleMs: timeoutMs(config),
|
|
196
|
+
firstChunkMs: firstTokenMs(config) ?? 0,
|
|
193
197
|
onNotice: notice,
|
|
194
198
|
onThinking: (text) => onEvent?.({ kind: "thinking", text }),
|
|
195
199
|
onOutput: (text) => onEvent?.({ kind: "output", text }),
|
package/dist/client.d.ts
CHANGED
|
@@ -12,6 +12,14 @@ export declare const NO_KEY = "agent-core";
|
|
|
12
12
|
* @param config Read for `requestTimeoutSeconds` alone.
|
|
13
13
|
*/
|
|
14
14
|
export declare const timeoutMs: (config: Pick<Endpoint, "requestTimeoutSeconds">) => number | undefined;
|
|
15
|
+
/** How many idle windows the first chunk gets when `firstTokenSeconds` is not given. */
|
|
16
|
+
export declare const FIRST_TOKEN_FACTOR = 5;
|
|
17
|
+
/**
|
|
18
|
+
* The wait for a streamed turn's first chunk, in the SDK's spelling: `undefined` is no limit.
|
|
19
|
+
*
|
|
20
|
+
* @param config Read for `firstTokenSeconds`, and `requestTimeoutSeconds` where that is absent.
|
|
21
|
+
*/
|
|
22
|
+
export declare const firstTokenMs: (config: Pick<Endpoint, "requestTimeoutSeconds" | "firstTokenSeconds">) => number | undefined;
|
|
15
23
|
/**
|
|
16
24
|
* The client for an endpoint, built once and kept.
|
|
17
25
|
*
|
|
@@ -67,6 +75,23 @@ export declare const endpointId: (config: {
|
|
|
67
75
|
baseUrl: string;
|
|
68
76
|
apiKey?: string;
|
|
69
77
|
}) => string;
|
|
78
|
+
/**
|
|
79
|
+
* The window a local server is actually serving a model in, which its listing does not say.
|
|
80
|
+
*
|
|
81
|
+
* llama.cpp reports it on `/props` as `default_generation_settings.n_ctx`, per slot, and LM
|
|
82
|
+
* Studio on `/api/v0/models` as `loaded_context_length` while the model is loaded. Both differ
|
|
83
|
+
* from the trained window in the case that matters, a model started in a smaller one than it was
|
|
84
|
+
* built for, and reading the trained one lets an overflow through the guard meant to catch it.
|
|
85
|
+
* Ollama reports nothing on either; an operator there has to declare the window.
|
|
86
|
+
*
|
|
87
|
+
* Zero where no answer was found. A server without either route, which is every hosted API, is
|
|
88
|
+
* latched and not asked again; one that could not be reached is not remembered at all.
|
|
89
|
+
*
|
|
90
|
+
* @param config The endpoint, plus the model whose window is wanted.
|
|
91
|
+
*/
|
|
92
|
+
export declare function servedWindow(config: Endpoint & {
|
|
93
|
+
model: string;
|
|
94
|
+
}): Promise<number>;
|
|
70
95
|
/**
|
|
71
96
|
* Asks an endpoint what it serves, and remembers the answer.
|
|
72
97
|
*
|
|
@@ -81,10 +106,11 @@ export declare function listModels(config: Endpoint): Promise<ModelInfo[]>;
|
|
|
81
106
|
* happily load a 256k model at `-c 16384` and go on listing it as 256k — and a run refused on
|
|
82
107
|
* the honest-looking number is a run that fails at the endpoint instead.
|
|
83
108
|
*
|
|
84
|
-
* Otherwise the
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
109
|
+
* Otherwise the window the server is actually serving the model in, where it has an API that
|
|
110
|
+
* says (`servedWindow`), and failing that the endpoint's listing — asked once, and again whenever
|
|
111
|
+
* it does not name this model, since a model can arrive after the first listing was taken. A
|
|
112
|
+
* server that will not list models still has to be able to run a turn: a failure here is an
|
|
113
|
+
* unknown window, not a failed run.
|
|
88
114
|
*
|
|
89
115
|
* @param config The endpoint, plus the model whose window is wanted.
|
|
90
116
|
* @param declared The operator's own number. Above zero it wins and the endpoint is not asked.
|
package/dist/client.js
CHANGED
|
@@ -47,6 +47,20 @@ const clients = new Map();
|
|
|
47
47
|
* constraint.
|
|
48
48
|
*/
|
|
49
49
|
const MAX_CLIENTS = 32;
|
|
50
|
+
/** How many idle windows the first chunk gets when `firstTokenSeconds` is not given. */
|
|
51
|
+
export const FIRST_TOKEN_FACTOR = 5;
|
|
52
|
+
/**
|
|
53
|
+
* The wait for a streamed turn's first chunk, in the SDK's spelling: `undefined` is no limit.
|
|
54
|
+
*
|
|
55
|
+
* @param config Read for `firstTokenSeconds`, and `requestTimeoutSeconds` where that is absent.
|
|
56
|
+
*/
|
|
57
|
+
export const firstTokenMs = (config) => {
|
|
58
|
+
if (config.firstTokenSeconds === undefined) {
|
|
59
|
+
const idle = timeoutMs(config);
|
|
60
|
+
return idle === undefined ? undefined : idle * FIRST_TOKEN_FACTOR;
|
|
61
|
+
}
|
|
62
|
+
return config.firstTokenSeconds > 0 ? config.firstTokenSeconds * 1000 : undefined;
|
|
63
|
+
};
|
|
50
64
|
/**
|
|
51
65
|
* The client for an endpoint, built once and kept.
|
|
52
66
|
*
|
|
@@ -89,12 +103,13 @@ export function getClient(config) {
|
|
|
89
103
|
return client;
|
|
90
104
|
}
|
|
91
105
|
/**
|
|
92
|
-
* The context window, spelled every way a server spells it.
|
|
106
|
+
* The context window, spelled every way a server spells it at the top of a listing entry.
|
|
93
107
|
*
|
|
94
108
|
* None of these is in the OpenAI listing schema, so every server that says anything says it as
|
|
95
|
-
* an extra key of its own: `
|
|
96
|
-
*
|
|
97
|
-
*
|
|
109
|
+
* an extra key of its own: `max_model_len` is vLLM, `context_length` OpenRouter, `n_ctx` the raw
|
|
110
|
+
* llama bindings. Whichever turns up first is taken — a server reporting two of them is
|
|
111
|
+
* reporting the same number twice. llama.cpp puts its number under `meta` instead, and LM Studio
|
|
112
|
+
* and Ollama put none on this route at all; see `servedWindow`.
|
|
98
113
|
*/
|
|
99
114
|
const CONTEXT_KEYS = [
|
|
100
115
|
"context_length",
|
|
@@ -103,14 +118,19 @@ const CONTEXT_KEYS = [
|
|
|
103
118
|
"context_window",
|
|
104
119
|
"n_ctx",
|
|
105
120
|
];
|
|
121
|
+
const positive = (value) => (typeof value === "number" && value > 0 ? value : 0);
|
|
106
122
|
function contextLengthOf(model) {
|
|
107
123
|
const record = model;
|
|
108
124
|
for (const key of CONTEXT_KEYS) {
|
|
109
|
-
const value = record[key];
|
|
110
|
-
if (
|
|
125
|
+
const value = positive(record[key]);
|
|
126
|
+
if (value)
|
|
111
127
|
return value;
|
|
112
128
|
}
|
|
113
|
-
|
|
129
|
+
// llama.cpp's, and the window the model was trained with rather than the one it is served in:
|
|
130
|
+
// a 256k model started at `-c 16384` lists 262144 here. Better than nothing, and why the
|
|
131
|
+
// served window is asked for first. `meta` is `null` while the model loads.
|
|
132
|
+
const meta = record.meta;
|
|
133
|
+
return positive(meta?.n_ctx_train);
|
|
114
134
|
}
|
|
115
135
|
/**
|
|
116
136
|
* The last listing from each endpoint, so a run can size its window without a round trip.
|
|
@@ -172,6 +192,88 @@ export const endpointKey = (config) => JSON.stringify([config.baseUrl, config.ap
|
|
|
172
192
|
* @param config Read for `baseUrl` and `apiKey` alone, as `endpointKey` reads it.
|
|
173
193
|
*/
|
|
174
194
|
export const endpointId = (config) => createHash("sha256").update(endpointKey(config)).digest("hex");
|
|
195
|
+
/**
|
|
196
|
+
* Served windows found by asking a server's own API, keyed on endpoint and model together.
|
|
197
|
+
*
|
|
198
|
+
* A model's entry stays until `resetClients`, like a listing; a server that answered without one
|
|
199
|
+
* is asked again after `LISTING_MISS_MS`, like a listing that did not name the model.
|
|
200
|
+
*/
|
|
201
|
+
const served = new Map();
|
|
202
|
+
/** Endpoints that answered both probes with a refusal, and are not asked again. */
|
|
203
|
+
const unserved = new Set();
|
|
204
|
+
/** How long a probe may take before the window is taken from the listing instead. */
|
|
205
|
+
const PROBE_TIMEOUT_MS = 10_000;
|
|
206
|
+
/** The server root behind an OpenAI-compatible base URL, which is where the native APIs live. */
|
|
207
|
+
const rootOf = (baseUrl) => baseUrl.replace(/\/+$/, "").replace(/\/v1$/, "");
|
|
208
|
+
/** A route this server does not have, rather than one that failed to answer. */
|
|
209
|
+
const NOT_THERE = new Set([404, 405, 501]);
|
|
210
|
+
/**
|
|
211
|
+
* Asks one native endpoint. `missing` is a server without the route; `body` is absent for that
|
|
212
|
+
* and for any other refusal, and a server that could not be reached throws.
|
|
213
|
+
*/
|
|
214
|
+
async function probe(config, path) {
|
|
215
|
+
const apiKey = config.apiKey || undefined;
|
|
216
|
+
const response = await fetch(`${rootOf(config.baseUrl)}${path}`, {
|
|
217
|
+
headers: apiKey ? { authorization: `Bearer ${apiKey}` } : {},
|
|
218
|
+
signal: AbortSignal.timeout(timeoutMs(config) ?? PROBE_TIMEOUT_MS),
|
|
219
|
+
});
|
|
220
|
+
if (!response.ok)
|
|
221
|
+
return { missing: NOT_THERE.has(response.status) };
|
|
222
|
+
try {
|
|
223
|
+
return { missing: false, body: await response.json() };
|
|
224
|
+
}
|
|
225
|
+
catch {
|
|
226
|
+
return { missing: false };
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* The window a local server is actually serving a model in, which its listing does not say.
|
|
231
|
+
*
|
|
232
|
+
* llama.cpp reports it on `/props` as `default_generation_settings.n_ctx`, per slot, and LM
|
|
233
|
+
* Studio on `/api/v0/models` as `loaded_context_length` while the model is loaded. Both differ
|
|
234
|
+
* from the trained window in the case that matters, a model started in a smaller one than it was
|
|
235
|
+
* built for, and reading the trained one lets an overflow through the guard meant to catch it.
|
|
236
|
+
* Ollama reports nothing on either; an operator there has to declare the window.
|
|
237
|
+
*
|
|
238
|
+
* Zero where no answer was found. A server without either route, which is every hosted API, is
|
|
239
|
+
* latched and not asked again; one that could not be reached is not remembered at all.
|
|
240
|
+
*
|
|
241
|
+
* @param config The endpoint, plus the model whose window is wanted.
|
|
242
|
+
*/
|
|
243
|
+
export async function servedWindow(config) {
|
|
244
|
+
const endpoint = endpointKey(config);
|
|
245
|
+
if (unserved.has(endpoint))
|
|
246
|
+
return 0;
|
|
247
|
+
const key = JSON.stringify([endpoint, config.model]);
|
|
248
|
+
const known = served.get(key);
|
|
249
|
+
if (known && (known.window > 0 || Date.now() - known.at < LISTING_MISS_MS))
|
|
250
|
+
return known.window;
|
|
251
|
+
let window = 0;
|
|
252
|
+
try {
|
|
253
|
+
// Named, for a llama.cpp router serving several models; a single-model server ignores it.
|
|
254
|
+
const props = await probe(config, `/props?model=${encodeURIComponent(config.model)}`);
|
|
255
|
+
const settings = props.body
|
|
256
|
+
?.default_generation_settings;
|
|
257
|
+
window = positive(settings?.n_ctx);
|
|
258
|
+
if (!window) {
|
|
259
|
+
const lmstudio = await probe(config, "/api/v0/models");
|
|
260
|
+
const { data } = (lmstudio.body ?? {});
|
|
261
|
+
const entry = Array.isArray(data)
|
|
262
|
+
? data.find((model) => model?.id === config.model)
|
|
263
|
+
: undefined;
|
|
264
|
+
window = positive(entry?.loaded_context_length);
|
|
265
|
+
if (props.missing && lmstudio.missing) {
|
|
266
|
+
unserved.add(endpoint);
|
|
267
|
+
return 0;
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
catch {
|
|
272
|
+
return 0;
|
|
273
|
+
}
|
|
274
|
+
served.set(key, { window, at: Date.now() });
|
|
275
|
+
return window;
|
|
276
|
+
}
|
|
175
277
|
/**
|
|
176
278
|
* Asks an endpoint what it serves, and remembers the answer.
|
|
177
279
|
*
|
|
@@ -193,10 +295,11 @@ export async function listModels(config) {
|
|
|
193
295
|
* happily load a 256k model at `-c 16384` and go on listing it as 256k — and a run refused on
|
|
194
296
|
* the honest-looking number is a run that fails at the endpoint instead.
|
|
195
297
|
*
|
|
196
|
-
* Otherwise the
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
*
|
|
298
|
+
* Otherwise the window the server is actually serving the model in, where it has an API that
|
|
299
|
+
* says (`servedWindow`), and failing that the endpoint's listing — asked once, and again whenever
|
|
300
|
+
* it does not name this model, since a model can arrive after the first listing was taken. A
|
|
301
|
+
* server that will not list models still has to be able to run a turn: a failure here is an
|
|
302
|
+
* unknown window, not a failed run.
|
|
200
303
|
*
|
|
201
304
|
* @param config The endpoint, plus the model whose window is wanted.
|
|
202
305
|
* @param declared The operator's own number. Above zero it wins and the endpoint is not asked.
|
|
@@ -204,6 +307,9 @@ export async function listModels(config) {
|
|
|
204
307
|
export async function contextLimitFor(config, declared = 0) {
|
|
205
308
|
if (declared > 0)
|
|
206
309
|
return declared;
|
|
310
|
+
const window = await servedWindow(config);
|
|
311
|
+
if (window > 0)
|
|
312
|
+
return window;
|
|
207
313
|
const key = endpointKey(config);
|
|
208
314
|
const listed = () => listings.get(key)?.find((model) => model.id === config.model);
|
|
209
315
|
// The listing is asked for again when it does not name this model, rather than only when
|
|
@@ -245,4 +351,6 @@ export function resetClients() {
|
|
|
245
351
|
clients.clear();
|
|
246
352
|
listings.clear();
|
|
247
353
|
misses.clear();
|
|
354
|
+
served.clear();
|
|
355
|
+
unserved.clear();
|
|
248
356
|
}
|
package/dist/config.d.ts
CHANGED
|
@@ -18,7 +18,13 @@ export interface Endpoint {
|
|
|
18
18
|
/** Empty is normal — a local server ignores it. See `getClient` for what is sent instead. */
|
|
19
19
|
apiKey: string;
|
|
20
20
|
/**
|
|
21
|
-
* Zero, less, or absent means no limit — what a local model
|
|
21
|
+
* How long an endpoint may go quiet. Zero, less, or absent means no limit — what a local model
|
|
22
|
+
* answering slowly needs.
|
|
23
|
+
*
|
|
24
|
+
* Not the whole request, which may take as long as the model keeps talking. On a streamed turn
|
|
25
|
+
* it is the silence allowed between chunks, the idle watchdog; the wait for the first chunk is
|
|
26
|
+
* `firstTokenSeconds`. On a call that does not stream, a side task or a model listing, it is
|
|
27
|
+
* the SDK's timer, which runs until the response headers arrive.
|
|
22
28
|
*
|
|
23
29
|
* Optional because a consumer that has no timeout to give should not have to invent one. Two
|
|
24
30
|
* of the three servers this was extracted from carry no such field, and requiring it made
|
|
@@ -26,6 +32,18 @@ export interface Endpoint {
|
|
|
26
32
|
* number standing in for an absent one.
|
|
27
33
|
*/
|
|
28
34
|
requestTimeoutSeconds?: number;
|
|
35
|
+
/**
|
|
36
|
+
* How long a streamed turn may wait for its first chunk. Absent is five times
|
|
37
|
+
* `requestTimeoutSeconds`; zero or less is no limit.
|
|
38
|
+
*
|
|
39
|
+
* Its own number because the first wait is prefill, and on a local server prefill of a long
|
|
40
|
+
* prompt is tens of seconds on a GPU and minutes on a CPU, where the gap between tokens is a
|
|
41
|
+
* fraction of a second. A server loading the model on demand, Ollama after `keep_alive` or LM
|
|
42
|
+
* Studio just in time, holds the request open for the same reason. One number for both waits
|
|
43
|
+
* was either too slow to notice a wedged stream or tight enough to abandon a prefill, and a
|
|
44
|
+
* retry pays for that prefill again from nothing.
|
|
45
|
+
*/
|
|
46
|
+
firstTokenSeconds?: number;
|
|
29
47
|
}
|
|
30
48
|
/** What to ask the model for. */
|
|
31
49
|
export interface ModelParams {
|
|
@@ -68,6 +86,12 @@ export interface ToolPolicy {
|
|
|
68
86
|
/** How many times a lost or refused request is worth sending again. See `retry.ts`. */
|
|
69
87
|
export interface RetryPolicy {
|
|
70
88
|
maxRetries: number;
|
|
89
|
+
/**
|
|
90
|
+
* How long to wait for a local server that says it is still loading the model, absent two
|
|
91
|
+
* minutes and zero not at all. Separate from `maxRetries`, which is sized for a request that
|
|
92
|
+
* was lost rather than for weights being read off a disk. See `isModelLoading`.
|
|
93
|
+
*/
|
|
94
|
+
loadingTimeoutSeconds?: number;
|
|
71
95
|
}
|
|
72
96
|
/**
|
|
73
97
|
* A whole agent configuration — every part, plus the two fields that belong to no group.
|
package/dist/index.d.ts
CHANGED
|
@@ -12,14 +12,14 @@
|
|
|
12
12
|
export { type AgentLoopHooks, type AgentLoopOptions, type AgentLoopResult, buildBody, preselect, preview, resolveApiKey, runAgentLoop, type ToolCallOutcome, type ToolCallRequest, } from "./agent-loop.ts";
|
|
13
13
|
export { type Capabilities, capabilitiesFor, type ModelCapabilities, modelCapabilitiesFor, type NegotiateOptions, negotiate, resetCapabilities, } from "./capabilities.ts";
|
|
14
14
|
export type { CatalogServer } from "./catalog.ts";
|
|
15
|
-
export { contextLimitFor, getClient, listModels, type ModelInfo, NO_KEY, resetClients, timeoutMs, } from "./client.ts";
|
|
15
|
+
export { contextLimitFor, FIRST_TOKEN_FACTOR, firstTokenMs, getClient, listModels, type ModelInfo, NO_KEY, resetClients, servedWindow, timeoutMs, } from "./client.ts";
|
|
16
16
|
export { COMPACT_AT, type CompactionOptions, type CompactionPlan, compactTranscript, KEEP_RATIO, type PruneOptions, planCompaction, pruneToolResults, SUMMARY_LEAD, SUMMARY_PROMPT, summariser, summaryInput, } from "./compaction.ts";
|
|
17
17
|
export type { AgentConfig, Endpoint, ModelParams, RetryPolicy, ToolPolicy, } from "./config.ts";
|
|
18
18
|
export { errorMessage } from "./errors.ts";
|
|
19
19
|
export { configureEvents, type EventBusOptions, emit, endRun, fold, history, type RunEvent, type RunEventInput, type RunEventKind, type RunUsage, resetEvents, watch, } from "./events.ts";
|
|
20
20
|
export { assembleContext, configureHooks, type Gathered, gather, HOOK_CONTEXT_TOKENS, HOOK_EVENTS, HOOK_PREFACE, type HookContext, type HookEvent, type HookMessage, type HookNote, type HookOptions, type HookOutcome, type HookRunner, INJECT_EVENTS, notify, resetHooks, turnIndex, turnMessages, UNTRUSTED_PREFACE, untrusted, withContext, } from "./hooks.ts";
|
|
21
21
|
export { resetAll } from "./reset.ts";
|
|
22
|
-
export { backoffMs, ContextOverflow, compact, EndpointSilent, isOverflow, isTransient, messageTokens, requestTokens, SMALLEST_LIKELY_WINDOW, sleep, } from "./retry.ts";
|
|
22
|
+
export { backoffMs, ContextOverflow, compact, EndpointSilent, isModelLoading, isOverflow, isTransient, LOADING_POLL_MS, LOADING_TIMEOUT_MS, messageTokens, requestTokens, SMALLEST_LIKELY_WINDOW, sleep, } from "./retry.ts";
|
|
23
23
|
export { type RunTurnOptions, runTurn } from "./run-turn.ts";
|
|
24
24
|
export { isGrammarError, relaxTools, sanitizeTools } from "./schema-compat.ts";
|
|
25
25
|
export { type AskJsonOptions, ask, askJson, clean, listLines, parseJson, resetHints, type SideTaskOptions, tryAsk, } from "./side-task.ts";
|
package/dist/index.js
CHANGED
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
*/
|
|
12
12
|
export { buildBody, preselect, preview, resolveApiKey, runAgentLoop, } from "./agent-loop.js";
|
|
13
13
|
export { capabilitiesFor, modelCapabilitiesFor, negotiate, resetCapabilities, } from "./capabilities.js";
|
|
14
|
-
export { contextLimitFor, getClient, listModels, NO_KEY, resetClients, timeoutMs, } from "./client.js";
|
|
14
|
+
export { contextLimitFor, FIRST_TOKEN_FACTOR, firstTokenMs, getClient, listModels, NO_KEY, resetClients, servedWindow, timeoutMs, } from "./client.js";
|
|
15
15
|
export { COMPACT_AT, compactTranscript, KEEP_RATIO, planCompaction, pruneToolResults, SUMMARY_LEAD, SUMMARY_PROMPT, summariser, summaryInput, } from "./compaction.js";
|
|
16
16
|
export { errorMessage } from "./errors.js";
|
|
17
17
|
export { configureEvents, emit, endRun, fold, history, resetEvents, watch, } from "./events.js";
|
|
18
18
|
export { assembleContext, configureHooks, gather, HOOK_CONTEXT_TOKENS, HOOK_EVENTS, HOOK_PREFACE, INJECT_EVENTS, notify, resetHooks, turnIndex, turnMessages, UNTRUSTED_PREFACE, untrusted, withContext, } from "./hooks.js";
|
|
19
19
|
export { resetAll } from "./reset.js";
|
|
20
|
-
export { backoffMs, ContextOverflow, compact, EndpointSilent, isOverflow, isTransient, messageTokens, requestTokens, SMALLEST_LIKELY_WINDOW, sleep, } from "./retry.js";
|
|
20
|
+
export { backoffMs, ContextOverflow, compact, EndpointSilent, isModelLoading, isOverflow, isTransient, LOADING_POLL_MS, LOADING_TIMEOUT_MS, messageTokens, requestTokens, SMALLEST_LIKELY_WINDOW, sleep, } from "./retry.js";
|
|
21
21
|
export { runTurn } from "./run-turn.js";
|
|
22
22
|
export { isGrammarError, relaxTools, sanitizeTools } from "./schema-compat.js";
|
|
23
23
|
export { ask, askJson, clean, listLines, parseJson, resetHints, tryAsk, } from "./side-task.js";
|
package/dist/retry.d.ts
CHANGED
|
@@ -93,6 +93,21 @@ export declare const SMALLEST_LIKELY_WINDOW = 8192;
|
|
|
93
93
|
* @param error The rejection, as caught. What is not an SDK error is not transient.
|
|
94
94
|
*/
|
|
95
95
|
export declare function isTransient(error: unknown): boolean;
|
|
96
|
+
/**
|
|
97
|
+
* Whether a failure is a local server still loading the model, rather than one failing to serve.
|
|
98
|
+
*
|
|
99
|
+
* llama.cpp answers 503 `Loading model` with type `unavailable_error` from the moment it starts
|
|
100
|
+
* until the weights are mapped, and a router build says the same while it swaps models. That is
|
|
101
|
+
* thirty to ninety seconds for a large model from a cold page cache, and `backoffMs` gives up
|
|
102
|
+
* inside fifteen: sized for a busy host, not for one reading a file. A plain 503 is not this.
|
|
103
|
+
*
|
|
104
|
+
* @param error The rejection, as caught.
|
|
105
|
+
*/
|
|
106
|
+
export declare function isModelLoading(error: unknown): boolean;
|
|
107
|
+
/** How long to wait between asking a loading server again. */
|
|
108
|
+
export declare const LOADING_POLL_MS = 3000;
|
|
109
|
+
/** How long `runTurn` waits for a model to load unless told otherwise. */
|
|
110
|
+
export declare const LOADING_TIMEOUT_MS = 120000;
|
|
96
111
|
/**
|
|
97
112
|
* Exponential, with jitter so several tasks failing at once do not return in lockstep.
|
|
98
113
|
*
|
package/dist/retry.js
CHANGED
|
@@ -214,6 +214,27 @@ export function isTransient(error) {
|
|
|
214
214
|
const { status } = error;
|
|
215
215
|
return status === 408 || status === 409 || status === 429 || (status ?? 0) >= 500;
|
|
216
216
|
}
|
|
217
|
+
/**
|
|
218
|
+
* Whether a failure is a local server still loading the model, rather than one failing to serve.
|
|
219
|
+
*
|
|
220
|
+
* llama.cpp answers 503 `Loading model` with type `unavailable_error` from the moment it starts
|
|
221
|
+
* until the weights are mapped, and a router build says the same while it swaps models. That is
|
|
222
|
+
* thirty to ninety seconds for a large model from a cold page cache, and `backoffMs` gives up
|
|
223
|
+
* inside fifteen: sized for a busy host, not for one reading a file. A plain 503 is not this.
|
|
224
|
+
*
|
|
225
|
+
* @param error The rejection, as caught.
|
|
226
|
+
*/
|
|
227
|
+
export function isModelLoading(error) {
|
|
228
|
+
if (!(error instanceof OpenAI.APIError) || error.status !== 503)
|
|
229
|
+
return false;
|
|
230
|
+
const body = error.error;
|
|
231
|
+
return (body?.type === "unavailable_error" ||
|
|
232
|
+
/loading model|model is loading|unavailable_error/i.test(`${error.message} ${body?.message ?? ""}`));
|
|
233
|
+
}
|
|
234
|
+
/** How long to wait between asking a loading server again. */
|
|
235
|
+
export const LOADING_POLL_MS = 3000;
|
|
236
|
+
/** How long `runTurn` waits for a model to load unless told otherwise. */
|
|
237
|
+
export const LOADING_TIMEOUT_MS = 120_000;
|
|
217
238
|
/**
|
|
218
239
|
* Exponential, with jitter so several tasks failing at once do not return in lockstep.
|
|
219
240
|
*
|
package/dist/run-turn.d.ts
CHANGED
|
@@ -63,6 +63,15 @@ export interface RunTurnOptions extends Omit<StreamTurnOptions, "produced"> {
|
|
|
63
63
|
* of `extraBody`, ordinarily. See `NegotiateOptions.droppable`; it needs `model` too.
|
|
64
64
|
*/
|
|
65
65
|
droppable?: Iterable<string>;
|
|
66
|
+
/**
|
|
67
|
+
* How long to wait on a server answering that the model is still loading, `LOADING_TIMEOUT_MS`
|
|
68
|
+
* unless given; zero gives up on the first such answer like any other 503.
|
|
69
|
+
*
|
|
70
|
+
* Polled every `LOADING_POLL_MS` without spending `maxRetries`, and announced once rather than
|
|
71
|
+
* per poll. A consumer that starts alongside its llama.cpp, or asks a router for a model it
|
|
72
|
+
* has to swap in, meets this on its first request every time.
|
|
73
|
+
*/
|
|
74
|
+
loadingTimeoutMs?: number;
|
|
66
75
|
}
|
|
67
76
|
/**
|
|
68
77
|
* `request` is a callback rather than a body because the body has to be rebuilt from whatever
|
|
@@ -77,4 +86,4 @@ export interface RunTurnOptions extends Omit<StreamTurnOptions, "produced"> {
|
|
|
77
86
|
* @param options Retry budget, context limit, the model to negotiate for, notices, and the
|
|
78
87
|
* stream's own callbacks.
|
|
79
88
|
*/
|
|
80
|
-
export declare function runTurn(client: OpenAI, supports: Capabilities, request: (supports: Capabilities, model: ModelCapabilities | undefined) => OpenAI.ChatCompletionCreateParamsStreaming, { maxRetries, onNotice, contextLimit, model, droppable, ...stream }?: RunTurnOptions): Promise<Turn>;
|
|
89
|
+
export declare function runTurn(client: OpenAI, supports: Capabilities, request: (supports: Capabilities, model: ModelCapabilities | undefined) => OpenAI.ChatCompletionCreateParamsStreaming, { maxRetries, onNotice, contextLimit, model, droppable, loadingTimeoutMs, ...stream }?: RunTurnOptions): Promise<Turn>;
|
package/dist/run-turn.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { negotiate } from "./capabilities.js";
|
|
2
2
|
import { errorMessage } from "./errors.js";
|
|
3
|
-
import { backoffMs, ContextOverflow, compact, isOverflow, isTransient, requestTokens, SMALLEST_LIKELY_WINDOW, sleep, } from "./retry.js";
|
|
3
|
+
import { backoffMs, ContextOverflow, compact, isModelLoading, isOverflow, isTransient, LOADING_POLL_MS, LOADING_TIMEOUT_MS, requestTokens, SMALLEST_LIKELY_WINDOW, sleep, } from "./retry.js";
|
|
4
4
|
import { streamTurn } from "./stream.js";
|
|
5
5
|
/**
|
|
6
6
|
* `request` is a callback rather than a body because the body has to be rebuilt from whatever
|
|
@@ -15,7 +15,7 @@ import { streamTurn } from "./stream.js";
|
|
|
15
15
|
* @param options Retry budget, context limit, the model to negotiate for, notices, and the
|
|
16
16
|
* stream's own callbacks.
|
|
17
17
|
*/
|
|
18
|
-
export async function runTurn(client, supports, request, { maxRetries = 0, onNotice, contextLimit = 0, model, droppable, ...stream } = {}) {
|
|
18
|
+
export async function runTurn(client, supports, request, { maxRetries = 0, onNotice, contextLimit = 0, model, droppable, loadingTimeoutMs = LOADING_TIMEOUT_MS, ...stream } = {}) {
|
|
19
19
|
// Sized once rather than per build. `request` is called again for every downgrade and every
|
|
20
20
|
// retry, but a downgraded body is strictly smaller than the one before it and the transcript
|
|
21
21
|
// does not change between attempts — so the first body is the one worth measuring, and
|
|
@@ -42,6 +42,9 @@ export async function runTurn(client, supports, request, { maxRetries = 0, onNot
|
|
|
42
42
|
}
|
|
43
43
|
return body;
|
|
44
44
|
};
|
|
45
|
+
// When the server first said it was loading. Unset until then, and never reset: a model that
|
|
46
|
+
// loads, fails and loads again has had its allowance.
|
|
47
|
+
let loadingSince;
|
|
45
48
|
for (let attempt = 0;; attempt++) {
|
|
46
49
|
const produced = { any: false };
|
|
47
50
|
try {
|
|
@@ -66,6 +69,20 @@ export async function runTurn(client, supports, request, { maxRetries = 0, onNot
|
|
|
66
69
|
if (!(error instanceof ContextOverflow) && isOverflow(errorMessage(error))) {
|
|
67
70
|
throw new ContextOverflow(errorMessage(error), { cause: error });
|
|
68
71
|
}
|
|
72
|
+
if (isModelLoading(error) && loadingTimeoutMs > 0) {
|
|
73
|
+
const now = Date.now();
|
|
74
|
+
if (loadingSince === undefined) {
|
|
75
|
+
loadingSince = now;
|
|
76
|
+
onNotice?.(`${model ?? "the model"} is still loading — waiting up to ${compact(loadingTimeoutMs / 1000)}s`);
|
|
77
|
+
}
|
|
78
|
+
if (now - loadingSince < loadingTimeoutMs) {
|
|
79
|
+
// Not an attempt: the request was never looked at, and a two-minute load would
|
|
80
|
+
// otherwise have to be bought with a retry budget meant for dropped connections.
|
|
81
|
+
attempt--;
|
|
82
|
+
await sleep(LOADING_POLL_MS, stream.signal);
|
|
83
|
+
continue;
|
|
84
|
+
}
|
|
85
|
+
}
|
|
69
86
|
if (attempt >= maxRetries || !isTransient(error))
|
|
70
87
|
throw error;
|
|
71
88
|
const wait = backoffMs(attempt);
|
package/dist/stream.d.ts
CHANGED
|
@@ -75,6 +75,13 @@ export interface StreamTurnOptions {
|
|
|
75
75
|
* needs.
|
|
76
76
|
*/
|
|
77
77
|
idleMs?: number;
|
|
78
|
+
/**
|
|
79
|
+
* Silence allowed before the first chunk, `idleMs` unless given; zero waits forever.
|
|
80
|
+
*
|
|
81
|
+
* The first wait is prefill, or a server loading the model, and is routinely many times the
|
|
82
|
+
* gap between tokens. See `Endpoint.firstTokenSeconds` and `firstTokenMs`.
|
|
83
|
+
*/
|
|
84
|
+
firstChunkMs?: number;
|
|
78
85
|
/** Set by the first chunk that carries anything, so a failed call knows if it can be retried. */
|
|
79
86
|
produced?: Produced;
|
|
80
87
|
/** The model's scratchpad, as it arrives. */
|
|
@@ -98,4 +105,4 @@ export interface StreamTurnOptions {
|
|
|
98
105
|
* @param body The request, which must set `stream: true`.
|
|
99
106
|
* @param options Cancellation, the idle watchdog, and the token callbacks.
|
|
100
107
|
*/
|
|
101
|
-
export declare function streamTurn(client: OpenAI, body: OpenAI.ChatCompletionCreateParamsStreaming, { signal, idleMs, produced, onThinking, onOutput }?: StreamTurnOptions): Promise<Turn>;
|
|
108
|
+
export declare function streamTurn(client: OpenAI, body: OpenAI.ChatCompletionCreateParamsStreaming, { signal, idleMs, firstChunkMs, produced, onThinking, onOutput }?: StreamTurnOptions): Promise<Turn>;
|
package/dist/stream.js
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { EndpointSilent } from "./retry.js";
|
|
2
|
+
/** The largest delay a timer takes, which is as close to none as the SDK's timeout option goes. */
|
|
3
|
+
const NO_SDK_TIMEOUT = 2 ** 31 - 1;
|
|
2
4
|
/**
|
|
3
5
|
* Runs one turn as a stream, reporting tokens as they arrive and assembling them back into a
|
|
4
6
|
* message.
|
|
@@ -15,7 +17,7 @@ import { EndpointSilent } from "./retry.js";
|
|
|
15
17
|
* @param body The request, which must set `stream: true`.
|
|
16
18
|
* @param options Cancellation, the idle watchdog, and the token callbacks.
|
|
17
19
|
*/
|
|
18
|
-
export async function streamTurn(client, body, { signal, idleMs, produced, onThinking, onOutput } = {}) {
|
|
20
|
+
export async function streamTurn(client, body, { signal, idleMs, firstChunkMs, produced, onThinking, onOutput } = {}) {
|
|
19
21
|
// Silence, not duration: the timer is rearmed on every chunk, so a model that is still
|
|
20
22
|
// talking is never cut off however long it takes, and one that has stopped talking does not
|
|
21
23
|
// hang the run until someone notices. A request that never answers at all is the same case
|
|
@@ -23,14 +25,20 @@ export async function streamTurn(client, body, { signal, idleMs, produced, onThi
|
|
|
23
25
|
const watchdog = new AbortController();
|
|
24
26
|
const linked = signal ? AbortSignal.any([signal, watchdog.signal]) : watchdog.signal;
|
|
25
27
|
let idle;
|
|
26
|
-
const
|
|
27
|
-
|
|
28
|
-
|
|
28
|
+
const first = firstChunkMs ?? idleMs;
|
|
29
|
+
// Until the model says something the wait is still prefill, however many empty chunks a
|
|
30
|
+
// server sends first: some open the stream with `{"role":"assistant"}` before they have read
|
|
31
|
+
// the prompt, and switching to the idle allowance on that abandoned the prefill it preceded.
|
|
32
|
+
let talking = false;
|
|
33
|
+
const rearm = (carried) => {
|
|
34
|
+
talking ||= carried;
|
|
35
|
+
const ms = talking ? idleMs : first;
|
|
29
36
|
clearTimeout(idle);
|
|
30
|
-
|
|
37
|
+
if (ms)
|
|
38
|
+
idle = setTimeout(() => watchdog.abort(), ms);
|
|
31
39
|
};
|
|
32
40
|
try {
|
|
33
|
-
rearm();
|
|
41
|
+
rearm(false);
|
|
34
42
|
return await collect();
|
|
35
43
|
}
|
|
36
44
|
catch (error) {
|
|
@@ -39,7 +47,9 @@ export async function streamTurn(client, body, { signal, idleMs, produced, onThi
|
|
|
39
47
|
// this backwards records a stopped run as an endpoint fault, which nobody notices until
|
|
40
48
|
// they read the row and disbelieve it.
|
|
41
49
|
if (watchdog.signal.aborted && !signal?.aborted) {
|
|
42
|
-
|
|
50
|
+
const waited = talking ? idleMs : first;
|
|
51
|
+
const before = talking || first === idleMs ? "" : " before its first token";
|
|
52
|
+
throw new EndpointSilent(`the model endpoint sent nothing for ${(waited ?? 0) / 1000}s${before}`);
|
|
43
53
|
}
|
|
44
54
|
throw error;
|
|
45
55
|
}
|
|
@@ -47,15 +57,23 @@ export async function streamTurn(client, body, { signal, idleMs, produced, onThi
|
|
|
47
57
|
clearTimeout(idle);
|
|
48
58
|
}
|
|
49
59
|
async function collect() {
|
|
50
|
-
|
|
60
|
+
// The SDK's own timer runs until the headers arrive, which for a stream is the end of
|
|
61
|
+
// prefill, and it was set from the idle number. Where a watchdog is armed it covers that
|
|
62
|
+
// wait already, with the allowance meant for it, so the SDK is told to leave it alone.
|
|
63
|
+
const watched = first || idleMs;
|
|
64
|
+
const stream = await client.chat.completions.create(body, {
|
|
65
|
+
signal: linked,
|
|
66
|
+
...(watched ? { timeout: NO_SDK_TIMEOUT } : {}),
|
|
67
|
+
});
|
|
51
68
|
const content = [];
|
|
52
69
|
const calls = new Map();
|
|
53
70
|
const usage = { prompt: 0, completion: 0, total: 0, cached: 0 };
|
|
54
71
|
let finishReason = "";
|
|
55
72
|
for await (const chunk of stream) {
|
|
56
73
|
// Rearmed on every chunk, latched below on only some: a priming chunk is the endpoint
|
|
57
|
-
// being alive, which is all the watchdog is asking about.
|
|
58
|
-
|
|
74
|
+
// being alive, which is all the watchdog is asking about. Which allowance it rearms with
|
|
75
|
+
// moves from the first chunk's to the idle one when a chunk carries something.
|
|
76
|
+
rearm(false);
|
|
59
77
|
// Assigned rather than accumulated. `stream_options.include_usage` sends one final chunk
|
|
60
78
|
// and the two agree there, but a server that reports cumulatively per chunk makes a sum
|
|
61
79
|
// of sums out of an accumulator — and a token count wrong by a factor of the chunk count
|
|
@@ -87,7 +105,10 @@ export async function streamTurn(client, body, { signal, idleMs, produced, onThi
|
|
|
87
105
|
// fragments count even though no callback reports them: a partial call is state the turn
|
|
88
106
|
// has accumulated, and losing a retry is the safer half of that trade. Set before the
|
|
89
107
|
// callbacks, so a watcher that throws mid-token cannot be told the same token twice.
|
|
90
|
-
|
|
108
|
+
const carried = Boolean(thinking || delta.content || delta.tool_calls?.length);
|
|
109
|
+
if (carried && !talking)
|
|
110
|
+
rearm(true);
|
|
111
|
+
if (produced && carried)
|
|
91
112
|
produced.any = true;
|
|
92
113
|
if (thinking)
|
|
93
114
|
onThinking?.(thinking);
|
package/llms.txt
CHANGED
|
@@ -45,11 +45,14 @@ The contract between whatever holds the tools and the loop that offers them to a
|
|
|
45
45
|
### client
|
|
46
46
|
|
|
47
47
|
- `contextLimitFor` — How much a model will read, in tokens.
|
|
48
|
+
- `FIRST_TOKEN_FACTOR` — How many idle windows the first chunk gets when `firstTokenSeconds` is not given.
|
|
49
|
+
- `firstTokenMs` — The wait for a streamed turn's first chunk, in the SDK's spelling: `undefined` is no limit.
|
|
48
50
|
- `getClient` — The client for an endpoint, built once and kept.
|
|
49
51
|
- `listModels` — Asks an endpoint what it serves, and remembers the answer.
|
|
50
52
|
- `ModelInfo` (type) — A model an endpoint offers, and what it says the model will read.
|
|
51
53
|
- `NO_KEY` — The SDK insists on a non-empty key even where the server will not look at it.
|
|
52
54
|
- `resetClients` — Forgets every cached client and listing.
|
|
55
|
+
- `servedWindow` — The window a local server is actually serving a model in, which its listing does not say.
|
|
53
56
|
- `timeoutMs` — Zero, less, or absent means no limit, which the SDK spells as `undefined`.
|
|
54
57
|
|
|
55
58
|
### compaction
|
|
@@ -139,8 +142,11 @@ Everything about a request failing that is not about what the request said.
|
|
|
139
142
|
- `ContextOverflow` — The request was bigger than the model will read.
|
|
140
143
|
- `compact` — 1234 → "1.2k".
|
|
141
144
|
- `EndpointSilent` — The endpoint stopped answering mid-request.
|
|
145
|
+
- `isModelLoading` — Whether a failure is a local server still loading the model, rather than one failing to serve.
|
|
142
146
|
- `isOverflow` — Whether a refusal means the request was too big, rather than merely refused.
|
|
143
147
|
- `isTransient` — Whether a failed request is worth trying again.
|
|
148
|
+
- `LOADING_POLL_MS` — How long to wait between asking a loading server again.
|
|
149
|
+
- `LOADING_TIMEOUT_MS` — How long `runTurn` waits for a model to load unless told otherwise.
|
|
144
150
|
- `messageTokens` — One message's estimated tokens, by the same count `requestTokens` sums for a whole request.
|
|
145
151
|
- `requestTokens` — What this request will cost the window, in tokens, near enough.
|
|
146
152
|
- `SMALLEST_LIKELY_WINDOW` — The smallest window worth believing in, and the floor under `runTurn`'s guard.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cubicecho/agent-core",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.7.0",
|
|
4
4
|
"description": "The endpoint-agnostic half of an OpenAI-compatible agent loop: tool-schema compatibility, on-demand tool loading, one-shot side tasks, run events, and a pooled client.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"openai",
|