frontend-agent 1.0.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/LICENSE +208 -0
- package/README.md +95 -0
- package/dist/index.d.ts +230 -0
- package/dist/index.js +489 -0
- package/dist/index.js.map +1 -0
- package/dist/rag.d.ts +37 -0
- package/dist/rag.js +132 -0
- package/dist/rag.js.map +1 -0
- package/dist/reference.d.ts +38 -0
- package/dist/reference.js +119 -0
- package/dist/reference.js.map +1 -0
- package/dist/types-BqZ6-bpz.d.ts +59 -0
- package/dist/types-ChI5DrVS.d.ts +16 -0
- package/package.json +69 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
Copyright 2026 The frontend-agent authors
|
|
2
|
+
|
|
3
|
+
This license (Apache-2.0) covers the source code, scripts, and documentation in
|
|
4
|
+
this repository. It does NOT cover: (a) the fine-tuned model weights, which are a
|
|
5
|
+
derivative of LiquidAI/LFM2.5-230M and remain under the LFM Open License v1.0; or
|
|
6
|
+
(b) the published training dataset, licensed CC-BY-4.0. See README.md.
|
|
7
|
+
|
|
8
|
+
Apache License
|
|
9
|
+
Version 2.0, January 2004
|
|
10
|
+
http://www.apache.org/licenses/
|
|
11
|
+
|
|
12
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
13
|
+
|
|
14
|
+
1. Definitions.
|
|
15
|
+
|
|
16
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
17
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
18
|
+
|
|
19
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
20
|
+
the copyright owner that is granting the License.
|
|
21
|
+
|
|
22
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
23
|
+
other entities that control, are controlled by, or are under common
|
|
24
|
+
control with that entity. For the purposes of this definition,
|
|
25
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
26
|
+
direction or management of such entity, whether by contract or
|
|
27
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
28
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
29
|
+
|
|
30
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
31
|
+
exercising permissions granted by this License.
|
|
32
|
+
|
|
33
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
34
|
+
including but not limited to software source code, documentation
|
|
35
|
+
source, and configuration files.
|
|
36
|
+
|
|
37
|
+
"Object" form shall mean any form resulting from mechanical
|
|
38
|
+
transformation or translation of a Source form, including but
|
|
39
|
+
not limited to compiled object code, generated documentation,
|
|
40
|
+
and conversions to other media types.
|
|
41
|
+
|
|
42
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
43
|
+
Object form, made available under the License, as indicated by a
|
|
44
|
+
copyright notice that is included in or attached to the work
|
|
45
|
+
(an example is provided in the Appendix below).
|
|
46
|
+
|
|
47
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
48
|
+
form, that is based on (or derived from) the Work and for which the
|
|
49
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
50
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
51
|
+
of this License, Derivative Works shall not include works that remain
|
|
52
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
53
|
+
the Work and Derivative Works thereof.
|
|
54
|
+
|
|
55
|
+
"Contribution" shall mean any work of authorship, including
|
|
56
|
+
the original version of the Work and any modifications or additions
|
|
57
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
58
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
59
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
60
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
61
|
+
means any form of electronic, verbal, or written communication sent
|
|
62
|
+
to the Licensor or its representatives, including but not limited to
|
|
63
|
+
communication on electronic mailing lists, source code control systems,
|
|
64
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
65
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
66
|
+
excluding communication that is conspicuously marked or otherwise
|
|
67
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
68
|
+
|
|
69
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
70
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
71
|
+
subsequently incorporated within the Work.
|
|
72
|
+
|
|
73
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
77
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
78
|
+
Work and such Derivative Works in Source or Object form.
|
|
79
|
+
|
|
80
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
81
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
82
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
83
|
+
(except as stated in this section) patent license to make, have made,
|
|
84
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
85
|
+
where such license applies only to those patent claims licensable
|
|
86
|
+
by such Contributor that are necessarily infringed by their
|
|
87
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
88
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
89
|
+
institute patent litigation against any entity (including a
|
|
90
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
91
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
92
|
+
or contributory patent infringement, then any patent licenses
|
|
93
|
+
granted to You under this License for that Work shall terminate
|
|
94
|
+
as of the date such litigation is filed.
|
|
95
|
+
|
|
96
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
97
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
98
|
+
modifications, and in Source or Object form, provided that You
|
|
99
|
+
meet the following conditions:
|
|
100
|
+
|
|
101
|
+
(a) You must give any other recipients of the Work or
|
|
102
|
+
Derivative Works a copy of this License; and
|
|
103
|
+
|
|
104
|
+
(b) You must cause any modified files to carry prominent notices
|
|
105
|
+
stating that You changed the files; and
|
|
106
|
+
|
|
107
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
108
|
+
that You distribute, all copyright, patent, trademark, and
|
|
109
|
+
attribution notices from the Source form of the Work,
|
|
110
|
+
excluding those notices that do not pertain to any part of
|
|
111
|
+
the Derivative Works; and
|
|
112
|
+
|
|
113
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
114
|
+
distribution, then any Derivative Works that You distribute must
|
|
115
|
+
include a readable copy of the attribution notices contained
|
|
116
|
+
within such NOTICE file, excluding those notices that do not
|
|
117
|
+
pertain to any part of the Derivative Works, in at least one
|
|
118
|
+
of the following places: within a NOTICE text file distributed
|
|
119
|
+
as part of the Derivative Works; within the Source form or
|
|
120
|
+
documentation, if provided along with the Derivative Works; or,
|
|
121
|
+
within a display generated by the Derivative Works, if and
|
|
122
|
+
wherever such third-party notices normally appear. The contents
|
|
123
|
+
of the NOTICE file are for informational purposes only and
|
|
124
|
+
do not modify the License. You may add Your own attribution
|
|
125
|
+
notices within Derivative Works that You distribute, alongside
|
|
126
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
127
|
+
that such additional attribution notices cannot be construed
|
|
128
|
+
as modifying the License.
|
|
129
|
+
|
|
130
|
+
You may add Your own copyright statement to Your modifications and
|
|
131
|
+
may provide additional or different license terms and conditions
|
|
132
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
133
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
134
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
135
|
+
the conditions stated in this License.
|
|
136
|
+
|
|
137
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
138
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
139
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
140
|
+
this License, without any additional terms or conditions.
|
|
141
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
142
|
+
the terms of any separate license agreement you may have executed
|
|
143
|
+
with Licensor regarding such Contributions.
|
|
144
|
+
|
|
145
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
146
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
147
|
+
except as required for reasonable and customary use in describing the
|
|
148
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
149
|
+
|
|
150
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
151
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
152
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
153
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
154
|
+
implied, including, without limitation, any warranties or conditions
|
|
155
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
156
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
157
|
+
appropriateness of using or redistributing the Work and assume any
|
|
158
|
+
risks associated with Your exercise of permissions under this License.
|
|
159
|
+
|
|
160
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
161
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
162
|
+
unless required by applicable law (such as deliberate and grossly
|
|
163
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
164
|
+
liable to You for damages, including any direct, indirect, special,
|
|
165
|
+
incidental, or consequential damages of any character arising as a
|
|
166
|
+
result of this License or out of the use or inability to use the
|
|
167
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
168
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
169
|
+
other commercial damages or losses), even if such Contributor
|
|
170
|
+
has been advised of the possibility of such damages.
|
|
171
|
+
|
|
172
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
173
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
174
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
175
|
+
or other liability obligations and/or rights consistent with this
|
|
176
|
+
License. However, in accepting such obligations, You may act only
|
|
177
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
178
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
179
|
+
defend, and hold each Contributor harmless for any liability
|
|
180
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
181
|
+
of your accepting any such warranty or additional liability.
|
|
182
|
+
|
|
183
|
+
END OF TERMS AND CONDITIONS
|
|
184
|
+
|
|
185
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
186
|
+
|
|
187
|
+
To apply the Apache License to your work, attach the following
|
|
188
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
189
|
+
replaced with your own identifying information. (Don't include
|
|
190
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
191
|
+
comment syntax for the file format. We also recommend that a
|
|
192
|
+
file or class name and description of purpose be included on the
|
|
193
|
+
same "printed page" as the copyright notice for easier
|
|
194
|
+
identification within third-party archives.
|
|
195
|
+
|
|
196
|
+
Copyright [yyyy] [name of copyright owner]
|
|
197
|
+
|
|
198
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
199
|
+
you may not use this file except in compliance with the License.
|
|
200
|
+
You may obtain a copy of the License at
|
|
201
|
+
|
|
202
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
203
|
+
|
|
204
|
+
Unless required by applicable law or agreed to in writing, software
|
|
205
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
206
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
207
|
+
See the License for the specific language governing permissions and
|
|
208
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# frontend-agent
|
|
2
|
+
|
|
3
|
+
Drive the **LFM2.5-230M frontend-agent** model in the browser - a tiny, on-device web agent that
|
|
4
|
+
calls real tools and answers grounded in retrieved context. Fully typed, framework-agnostic, loads
|
|
5
|
+
the GGUF from Hugging Face via [wllama](https://github.com/ngxson/wllama) (no server-side inference).
|
|
6
|
+
|
|
7
|
+
The model is trained for **patterns, not facts**: you supply the tools and the grounding context at
|
|
8
|
+
runtime, and the library reproduces the exact v1.0.0 model contract (system prompt, tool-call format,
|
|
9
|
+
tool-result shapes, and a GBNF grammar that pins tool ids to real search results at decode time).
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm i frontend-agent @wllama/wllama
|
|
15
|
+
npm i minisearch stemmer # optional: the in-browser RAG adapter (./rag)
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Quickstart
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
import { createAgent, buildRegistry, WllamaEngine, buildSystemPrompt } from 'frontend-agent'
|
|
22
|
+
import { referenceTools } from 'frontend-agent/reference'
|
|
23
|
+
import { LocalMiniSearchRAG } from 'frontend-agent/rag'
|
|
24
|
+
|
|
25
|
+
const rag = new LocalMiniSearchRAG({ catalog, knowledge }) // your indexed data
|
|
26
|
+
const tools = referenceTools({
|
|
27
|
+
rag,
|
|
28
|
+
cart: myCartHandlers, // add/remove/view/clear over your own state
|
|
29
|
+
navigate: (target, id) => router.push(pathFor(target, id)),
|
|
30
|
+
})
|
|
31
|
+
const registry = buildRegistry(tools) // schemas + handlers, what createAgent expects
|
|
32
|
+
|
|
33
|
+
const engine = new WllamaEngine({
|
|
34
|
+
// loads https://huggingface.co/lazos/lfm2.5-230m-frontend-agent/resolve/main/...-v1.0.0-Q6_K.gguf
|
|
35
|
+
model: { repo: 'lazos/lfm2.5-230m-frontend-agent', version: 'v1.0.0', quant: 'Q6_K' },
|
|
36
|
+
wllamaAssets, // wllama single/multi-thread WASM URLs
|
|
37
|
+
onProgress: (p) => {},
|
|
38
|
+
})
|
|
39
|
+
|
|
40
|
+
const session = createAgent({
|
|
41
|
+
engine,
|
|
42
|
+
tools: registry,
|
|
43
|
+
systemPrompt: () => buildSystemPrompt({ persona, catalogHint: () => rag.hint(6), toolSchemas: registry.schemas }),
|
|
44
|
+
})
|
|
45
|
+
|
|
46
|
+
session.on((e) => {
|
|
47
|
+
if (e.type === 'assistant') console.log(e.text)
|
|
48
|
+
})
|
|
49
|
+
|
|
50
|
+
// one entry point - feed it from a text box, an API, or a speech-to-text transcript:
|
|
51
|
+
await session.submit('do you have any espresso grinders?')
|
|
52
|
+
session.abort() // cancel an in-flight turn
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
`submit(text)` is the whole input channel - the library is agnostic to where the text comes from.
|
|
56
|
+
Wire your own source (typed box, an external API, or a speech-to-text engine like Whisper) and call
|
|
57
|
+
`submit` with the resulting text. The demo shows a Whisper → `submit` voice path.
|
|
58
|
+
|
|
59
|
+
## Model source
|
|
60
|
+
|
|
61
|
+
`WllamaEngine`'s `model` resolves a Hugging Face GGUF by default:
|
|
62
|
+
`https://huggingface.co/{repo}/resolve/main/{repo-basename}-{version}-{quant}.gguf`. Override any of
|
|
63
|
+
`{ repo, version, quant }`, or pass `modelUrl` to self-host. Cross-origin loading under COOP/COEP
|
|
64
|
+
requires the page to be cross-origin-isolated; the HF `resolve` CDN sends permissive CORS.
|
|
65
|
+
|
|
66
|
+
## Cross-origin isolation (multi-threading)
|
|
67
|
+
|
|
68
|
+
wllama runs **multi-threaded** when the page is cross-origin isolated (`SharedArrayBuffer`), and
|
|
69
|
+
**falls back to single-thread** otherwise - slower, but works with no action required. To enable
|
|
70
|
+
threads, make the page cross-origin isolated by either:
|
|
71
|
+
|
|
72
|
+
- serving it with `Cross-Origin-Opener-Policy: same-origin` + `Cross-Origin-Embedder-Policy:
|
|
73
|
+
require-corp` (or `credentialless`) headers, or
|
|
74
|
+
- on a static host that can't set headers (e.g. GitHub Pages), registering a COI service worker such
|
|
75
|
+
as [`coi-serviceworker`](https://github.com/gzuidhof/coi-serviceworker) - the demo does this.
|
|
76
|
+
|
|
77
|
+
The library deliberately **does not register a service worker** - an SW hijacks your whole origin's
|
|
78
|
+
fetches and is a deployment concern you own. Note: under COEP `require-corp`, the cross-origin HF
|
|
79
|
+
model load needs the response to send CORP or be fetched CORS/credentialless; `coi-serviceworker`'s
|
|
80
|
+
**credentialless** mode handles this (so threads + the HF default compose on Pages).
|
|
81
|
+
|
|
82
|
+
## Exports
|
|
83
|
+
|
|
84
|
+
- `.` - core: `createAgent`, `buildRegistry`, `WllamaEngine`, `StubEngine`, `buildSystemPrompt`,
|
|
85
|
+
`parseToolCalls`, `renderToolCalls`, `buildToolGrammar`, and all types.
|
|
86
|
+
- `./reference` - `referenceTools({ rag, cart, navigate })`: the 7 canonical tools
|
|
87
|
+
(search_catalog, search_knowledge, add/remove/view/clear cart, navigate) with trained result shapes.
|
|
88
|
+
- `./rag` - `LocalMiniSearchRAG` (in-browser BM25) + `createRagClient` (bring-your-own `POST /search`).
|
|
89
|
+
|
|
90
|
+
Input is source-agnostic: `session.submit(text)` is the only feed point - connect a text box, an API,
|
|
91
|
+
or a speech-to-text transcript. (The library ships no STT/TTS; the demo shows a Whisper voice path.)
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
Apache-2.0. The model weights it drives are under the LFM Open License v1.0 (see the model repo).
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
import { T as ToolSchema, a as ToolHandler, b as ToolDefinition } from './types-ChI5DrVS.js';
|
|
2
|
+
import { AssetsPathConfig } from '@wllama/wllama';
|
|
3
|
+
|
|
4
|
+
interface ChatMessage {
|
|
5
|
+
role: 'system' | 'user' | 'assistant' | 'tool';
|
|
6
|
+
content: string;
|
|
7
|
+
name?: string;
|
|
8
|
+
}
|
|
9
|
+
interface EngineGenerateResult {
|
|
10
|
+
/** Plain-text portion of the reply (tool-call markers stripped). */
|
|
11
|
+
text: string;
|
|
12
|
+
/** Parsed tool calls, if the model emitted any. */
|
|
13
|
+
toolCalls: {
|
|
14
|
+
name: string;
|
|
15
|
+
args: Record<string, unknown>;
|
|
16
|
+
}[];
|
|
17
|
+
/**
|
|
18
|
+
* The assistant turn exactly as it should be replayed into the next generation's
|
|
19
|
+
* context - includes the raw <|tool_call_start|>...<|tool_call_end|> markers when the
|
|
20
|
+
* model called tools, so multi-turn context matches how the model was trained.
|
|
21
|
+
*/
|
|
22
|
+
raw: string;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Implemented by both the stub engine and the real wllama engine so useAgentLoop
|
|
26
|
+
* doesn't need to know which it's driving. `messages` is the full model-format
|
|
27
|
+
* conversation (including the system message).
|
|
28
|
+
*/
|
|
29
|
+
interface AgentEngine {
|
|
30
|
+
/** Eagerly download/initialize the model (and detect the backend) at activation time. */
|
|
31
|
+
load?(): Promise<void>;
|
|
32
|
+
/**
|
|
33
|
+
* `grammar` (GBNF) constrains decoding to valid tool-call structure + id-grounding when provided;
|
|
34
|
+
* the loop rebuilds it each turn from the tool schema and the ids seen in results so far.
|
|
35
|
+
*/
|
|
36
|
+
generate(messages: ChatMessage[], grammar?: string): Promise<EngineGenerateResult>;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
interface ToolRegistry {
|
|
40
|
+
/** Tool schemas, in order - injected into the system prompt (order is contract-significant). */
|
|
41
|
+
schemas: ToolSchema[];
|
|
42
|
+
/** name → handler dispatch map. */
|
|
43
|
+
handlers: Record<string, ToolHandler>;
|
|
44
|
+
}
|
|
45
|
+
/** Build a registry from a consumer-supplied tool set. Bring your own tools, or use `referenceTools`. */
|
|
46
|
+
declare function buildRegistry(definitions: ToolDefinition[]): ToolRegistry;
|
|
47
|
+
|
|
48
|
+
interface ToolCall {
|
|
49
|
+
name: string;
|
|
50
|
+
args: Record<string, unknown>;
|
|
51
|
+
}
|
|
52
|
+
/** Events emitted while a turn runs. Subscribe with `session.on(...)`. */
|
|
53
|
+
type AgentEvent = {
|
|
54
|
+
type: 'status';
|
|
55
|
+
status: 'thinking' | 'ready' | 'aborted' | 'error';
|
|
56
|
+
} | {
|
|
57
|
+
type: 'assistant';
|
|
58
|
+
text: string;
|
|
59
|
+
} | {
|
|
60
|
+
type: 'tool_call';
|
|
61
|
+
call: ToolCall;
|
|
62
|
+
} | {
|
|
63
|
+
type: 'tool_result';
|
|
64
|
+
name: string;
|
|
65
|
+
result: unknown;
|
|
66
|
+
} | {
|
|
67
|
+
type: 'done';
|
|
68
|
+
} | {
|
|
69
|
+
type: 'error';
|
|
70
|
+
error: unknown;
|
|
71
|
+
};
|
|
72
|
+
interface AgentConfig {
|
|
73
|
+
engine: AgentEngine;
|
|
74
|
+
/** The tool set (schemas + handlers). Build with `buildRegistry(referenceTools(...))` or `buildRegistry(yourTools)`. */
|
|
75
|
+
tools: ToolRegistry;
|
|
76
|
+
/** The system prompt, or a provider called once per `submit`. */
|
|
77
|
+
systemPrompt: string | (() => string | Promise<string>);
|
|
78
|
+
/** Max tool-loop cycles per turn. Default 8 (the longest trained multi-step flow). */
|
|
79
|
+
maxIterations?: number;
|
|
80
|
+
/** Arg keys constrained to seen result ids by the grammar. Default `['id']`. */
|
|
81
|
+
idKeys?: string[];
|
|
82
|
+
/** History token budget (system prompt excluded). Default derived from N_CTX. */
|
|
83
|
+
historyBudgetTokens?: number;
|
|
84
|
+
/**
|
|
85
|
+
* Per-generation watchdog (ms). Some WASM engines can hang or crash a worker thread without
|
|
86
|
+
* ever rejecting the in-flight promise (e.g. a trap on a secondary compute thread that leaves
|
|
87
|
+
* the main thread waiting on a futex forever) - without this, that turn would sit in
|
|
88
|
+
* 'thinking' indefinitely with no error surfaced. Default 90s; set 0 to disable.
|
|
89
|
+
*/
|
|
90
|
+
generationTimeoutMs?: number;
|
|
91
|
+
}
|
|
92
|
+
interface SubmitOptions {
|
|
93
|
+
signal?: AbortSignal;
|
|
94
|
+
}
|
|
95
|
+
interface Session {
|
|
96
|
+
/**
|
|
97
|
+
* The single programmatic entry point: feed user text from anywhere - a text box, an external
|
|
98
|
+
* API, or STT output - and run the tool loop to completion. Emits events as it goes.
|
|
99
|
+
*/
|
|
100
|
+
submit(text: string, opts?: SubmitOptions): Promise<void>;
|
|
101
|
+
/** Abort the in-flight turn (best-effort: stops between generations/tool calls). */
|
|
102
|
+
abort(): void;
|
|
103
|
+
/** Subscribe to events. Returns an unsubscribe function. */
|
|
104
|
+
on(listener: (event: AgentEvent) => void): () => void;
|
|
105
|
+
/** The model-format conversation so far (assistant turns include raw tool-call markers). */
|
|
106
|
+
readonly history: ChatMessage[];
|
|
107
|
+
/** Clear the conversation. */
|
|
108
|
+
reset(): void;
|
|
109
|
+
}
|
|
110
|
+
declare function createAgent(config: AgentConfig): Session;
|
|
111
|
+
|
|
112
|
+
/** Reference to a GGUF published on the Hugging Face Hub. */
|
|
113
|
+
interface HFModelRef {
|
|
114
|
+
/** `owner/name`. Default `lazos/lfm2.5-230m-frontend-agent`. */
|
|
115
|
+
repo?: string;
|
|
116
|
+
/** Release/version tag embedded in the filename. Default `v1.0.0`. */
|
|
117
|
+
version?: string;
|
|
118
|
+
/** Quantization suffix. Default `Q4_K_M`. */
|
|
119
|
+
quant?: string;
|
|
120
|
+
}
|
|
121
|
+
type EngineStatus = 'idle' | 'downloading' | 'loading' | 'ready';
|
|
122
|
+
interface WllamaEngineConfig {
|
|
123
|
+
/** Load the GGUF from Hugging Face (default). Ignored if `modelUrl` is set. */
|
|
124
|
+
model?: HFModelRef;
|
|
125
|
+
/** Full GGUF URL - self-host escape hatch; overrides `model`. */
|
|
126
|
+
modelUrl?: string;
|
|
127
|
+
/** wllama WASM asset config, e.g. `{ 'single-thread/wllama.wasm': url, 'multi-thread/wllama.wasm': url }`. */
|
|
128
|
+
wllamaAssets: AssetsPathConfig;
|
|
129
|
+
/** Context window. Default 8192. */
|
|
130
|
+
nCtx?: number;
|
|
131
|
+
/** Max tokens per assistant turn. Default 320. */
|
|
132
|
+
maxTokens?: number;
|
|
133
|
+
/** Backend preference. `'auto'` uses WebGPU when a real adapter is present. Default `'auto'`. */
|
|
134
|
+
backend?: 'auto' | 'webgpu' | 'cpu';
|
|
135
|
+
onStatus?: (status: EngineStatus) => void;
|
|
136
|
+
onProgress?: (progress: {
|
|
137
|
+
loaded: number;
|
|
138
|
+
total: number;
|
|
139
|
+
}) => void;
|
|
140
|
+
/** Reports whether a usable WebGPU adapter was detected (after load). */
|
|
141
|
+
onBackend?: (info: {
|
|
142
|
+
webgpu: boolean;
|
|
143
|
+
using: 'webgpu' | 'cpu';
|
|
144
|
+
}) => void;
|
|
145
|
+
}
|
|
146
|
+
/** Resolve a HF model ref to its `resolve/main` GGUF URL: `{basename}-{version}-{quant}.gguf`. */
|
|
147
|
+
declare function resolveModelUrl(ref?: HFModelRef): string;
|
|
148
|
+
/**
|
|
149
|
+
* Real engine: runs the GGUF in-browser via wllama (llama.cpp WASM/WebGPU). Loads the model from
|
|
150
|
+
* Hugging Face by default (configurable), caches it in OPFS, and applies the GBNF grammar at decode.
|
|
151
|
+
* Framework-agnostic - reports lifecycle via callbacks, no store coupling.
|
|
152
|
+
*/
|
|
153
|
+
declare class WllamaEngine implements AgentEngine {
|
|
154
|
+
private readonly config;
|
|
155
|
+
private wllamaPromise;
|
|
156
|
+
private warnedSystemSize;
|
|
157
|
+
private readonly url;
|
|
158
|
+
private readonly nCtx;
|
|
159
|
+
private readonly maxTokens;
|
|
160
|
+
constructor(config: WllamaEngineConfig);
|
|
161
|
+
load(): Promise<void>;
|
|
162
|
+
/** Tear down the loaded model so it can be reloaded (e.g. on a backend switch). OPFS-cached. */
|
|
163
|
+
reset(): Promise<void>;
|
|
164
|
+
private getWllama;
|
|
165
|
+
generate(messages: ChatMessage[], grammar?: string): Promise<EngineGenerateResult>;
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* Fixture engine with no model weights - for building/testing the loop, tools, and UI without
|
|
170
|
+
* loading the real model. Emits calls on the current v1.0.0 contract (`search_catalog`,
|
|
171
|
+
* `search_knowledge`, `add_to_cart(id)`). Ignores the grammar.
|
|
172
|
+
*/
|
|
173
|
+
declare class StubEngine implements AgentEngine {
|
|
174
|
+
generate(messages: ChatMessage[], _grammar?: string): Promise<EngineGenerateResult>;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
declare function buildToolGrammar(tools: ToolSchema[], validIds?: string[], idKeys?: string[], allowText?: boolean): string;
|
|
178
|
+
/** Collect string values under `id` keys from an arbitrary tool result (search results carry them). */
|
|
179
|
+
declare function collectIds(value: unknown, into: Set<string>): void;
|
|
180
|
+
|
|
181
|
+
interface SystemPromptConfig {
|
|
182
|
+
/** 1-2 line persona/rules for this deployment (who the assistant is, grounding + refusal rules). */
|
|
183
|
+
persona: string;
|
|
184
|
+
/** The tool schemas to advertise (same array the loop dispatches). */
|
|
185
|
+
toolSchemas: ToolSchema[];
|
|
186
|
+
/** A short "headline entities" hint (`Title [id]; ...`) or a provider for it. Optional. */
|
|
187
|
+
catalogHint?: string | (() => string | Promise<string>);
|
|
188
|
+
/** Label before the hint. Defaults to the trained `"Example catalog items"`. */
|
|
189
|
+
hintLabel?: string;
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Reproduce the exact v1.0.0 system message the model was trained on:
|
|
193
|
+
* `{persona}\n\n{hintLabel}: {hint}\nList of tools: [{fn-json}, ...]`
|
|
194
|
+
* The tool list uses Python `json.dumps` separators (`pyJson`) for byte-for-byte train/inference
|
|
195
|
+
* parity. The full system text is baked here (pass NO `tools` array to the engine's chat template).
|
|
196
|
+
*/
|
|
197
|
+
declare function buildSystemPrompt(cfg: SystemPromptConfig): Promise<string>;
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* Serialize a value the way Python's json.dumps (and Jinja2's `tojson`) does by default:
|
|
201
|
+
* ", " between items and ": " after keys. The model's chat template renders the tool list
|
|
202
|
+
* with these separators, so the browser must match them byte-for-byte for train/inference
|
|
203
|
+
* parity. (Our tool schemas are ASCII with no <,>,& so htmlsafe escaping never triggers.)
|
|
204
|
+
*/
|
|
205
|
+
declare function pyJson(v: unknown): string;
|
|
206
|
+
|
|
207
|
+
interface ParsedToolCall {
|
|
208
|
+
name: string;
|
|
209
|
+
args: Record<string, unknown>;
|
|
210
|
+
}
|
|
211
|
+
interface ParseResult {
|
|
212
|
+
text: string;
|
|
213
|
+
toolCalls: ParsedToolCall[];
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* Extracts pythonic tool calls (e.g. `[search_products(query="x"), add_to_cart(slug="y", quantity=2)]`)
|
|
217
|
+
* from LFM2.5's tool_call_start/end markers, and returns the remaining plain text.
|
|
218
|
+
* Never uses eval - parses the restricted call grammar by hand.
|
|
219
|
+
*/
|
|
220
|
+
declare function parseToolCalls(raw: string): ParseResult;
|
|
221
|
+
|
|
222
|
+
declare function renderToolCalls(calls: ParsedToolCall[]): string;
|
|
223
|
+
|
|
224
|
+
declare const N_CTX = 8192;
|
|
225
|
+
declare const MAX_OUTPUT_TOKENS = 320;
|
|
226
|
+
declare const SYSTEM_CTX_WARN_FRACTION = 0.15;
|
|
227
|
+
declare const HISTORY_TOKEN_BUDGET: number;
|
|
228
|
+
declare const estimateTokens: (text: string | undefined) => number;
|
|
229
|
+
|
|
230
|
+
export { type AgentConfig, type AgentEngine, type AgentEvent, type ChatMessage, type EngineGenerateResult, type EngineStatus, type HFModelRef, HISTORY_TOKEN_BUDGET, MAX_OUTPUT_TOKENS, N_CTX, type ParseResult, type ParsedToolCall, SYSTEM_CTX_WARN_FRACTION, type Session, StubEngine, type SubmitOptions, type SystemPromptConfig, type ToolCall, ToolDefinition, ToolHandler, type ToolRegistry, ToolSchema, WllamaEngine, type WllamaEngineConfig, buildRegistry, buildSystemPrompt, buildToolGrammar, collectIds, createAgent, estimateTokens, parseToolCalls, pyJson, renderToolCalls, resolveModelUrl };
|