@molecule/api-ai 1.0.1 → 1.2.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 +27 -3
- package/dist/types.d.ts +17 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
|
3
3
|
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
4
|
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
5
|
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
-
Generated: 2026-08-
|
|
6
|
+
Generated: 2026-08-28T09:23:55.215Z
|
|
7
7
|
-->
|
|
8
8
|
|
|
9
9
|
# @molecule/api-ai
|
|
@@ -223,6 +223,21 @@ interface ChatParams {
|
|
|
223
223
|
* Bonds whose provider has no equivalent field ignore it.
|
|
224
224
|
*/
|
|
225
225
|
endUserId?: string
|
|
226
|
+
/**
|
|
227
|
+
* Extra provider-native request-body params, shallow-merged into the outgoing
|
|
228
|
+
* request body as a BASE — the bond's own structural fields (model, messages,
|
|
229
|
+
* tools, stream, and its computed token limit) are applied AFTER and always
|
|
230
|
+
* win, so this can add or override tunables the SDK does not model
|
|
231
|
+
* (`reasoning_effort`, `enable_thinking`, `top_k`, `top_p`, penalties, …)
|
|
232
|
+
* without ever corrupting the wire protocol.
|
|
233
|
+
*
|
|
234
|
+
* Primarily for "bring your own AI" endpoints whose server accepts params
|
|
235
|
+
* this SDK has no typed field for. Bonds merge it at the request-body ROOT;
|
|
236
|
+
* for a nested-config wire format (Gemini) a `generationConfig` object here is
|
|
237
|
+
* merged INTO the bond's `generationConfig` rather than replacing it. Values
|
|
238
|
+
* must be JSON-serializable. Bonds that build a fixed body ignore it.
|
|
239
|
+
*/
|
|
240
|
+
extraBody?: Record<string, unknown>
|
|
226
241
|
}
|
|
227
242
|
```
|
|
228
243
|
|
|
@@ -311,7 +326,10 @@ Streaming event from an AI chat call.
|
|
|
311
326
|
type ChatEvent =
|
|
312
327
|
| { type: 'text'; content: string }
|
|
313
328
|
| { type: 'thinking'; content: string }
|
|
314
|
-
|
|
329
|
+
// `signature`: provider-opaque replay token for this tool call (see the
|
|
330
|
+
// ContentBlock tool_use variant) — consumers must persist it alongside
|
|
331
|
+
// id/name/input and echo it on the replayed tool_use block.
|
|
332
|
+
| { type: 'tool_use'; id: string; name: string; input: unknown; signature?: string }
|
|
315
333
|
// Emitted as soon as the model BEGINS a tool call — id + name are known but the
|
|
316
334
|
// input is still streaming. Lets consumers show what's happening immediately
|
|
317
335
|
// (e.g. "Writing the plan") instead of staring at a frozen spinner for the
|
|
@@ -369,7 +387,13 @@ type ContentBlock =
|
|
|
369
387
|
| { type: 'document'; mediaType: string; data: string; filename?: string }
|
|
370
388
|
| { type: 'audio'; mediaType: string; data: string }
|
|
371
389
|
| { type: 'video'; mediaType: string; data: string }
|
|
372
|
-
|
|
390
|
+
// `signature` is a provider-opaque replay token attached to the tool call
|
|
391
|
+
// (Gemini 3.x `thoughtSignature`). Callers that persist tool calls and replay
|
|
392
|
+
// them in later requests MUST carry it back on the replayed block verbatim —
|
|
393
|
+
// Gemini rejects a replayed functionCall without it (400 "Function call is
|
|
394
|
+
// missing a thought_signature"). Providers without such a token omit it, and
|
|
395
|
+
// every bond ignores it when it has no native equivalent.
|
|
396
|
+
| { type: 'tool_use'; id: string; name: string; input: unknown; signature?: string }
|
|
373
397
|
| { type: 'tool_result'; tool_use_id: string; content: string | unknown }
|
|
374
398
|
```
|
|
375
399
|
|
package/dist/types.d.ts
CHANGED
|
@@ -55,6 +55,7 @@ export type ContentBlock = {
|
|
|
55
55
|
id: string;
|
|
56
56
|
name: string;
|
|
57
57
|
input: unknown;
|
|
58
|
+
signature?: string;
|
|
58
59
|
} | {
|
|
59
60
|
type: 'tool_result';
|
|
60
61
|
tool_use_id: string;
|
|
@@ -74,6 +75,7 @@ export type ChatEvent = {
|
|
|
74
75
|
id: string;
|
|
75
76
|
name: string;
|
|
76
77
|
input: unknown;
|
|
78
|
+
signature?: string;
|
|
77
79
|
} | {
|
|
78
80
|
type: 'tool_use_start';
|
|
79
81
|
id: string;
|
|
@@ -270,6 +272,21 @@ export interface ChatParams {
|
|
|
270
272
|
* Bonds whose provider has no equivalent field ignore it.
|
|
271
273
|
*/
|
|
272
274
|
endUserId?: string;
|
|
275
|
+
/**
|
|
276
|
+
* Extra provider-native request-body params, shallow-merged into the outgoing
|
|
277
|
+
* request body as a BASE — the bond's own structural fields (model, messages,
|
|
278
|
+
* tools, stream, and its computed token limit) are applied AFTER and always
|
|
279
|
+
* win, so this can add or override tunables the SDK does not model
|
|
280
|
+
* (`reasoning_effort`, `enable_thinking`, `top_k`, `top_p`, penalties, …)
|
|
281
|
+
* without ever corrupting the wire protocol.
|
|
282
|
+
*
|
|
283
|
+
* Primarily for "bring your own AI" endpoints whose server accepts params
|
|
284
|
+
* this SDK has no typed field for. Bonds merge it at the request-body ROOT;
|
|
285
|
+
* for a nested-config wire format (Gemini) a `generationConfig` object here is
|
|
286
|
+
* merged INTO the bond's `generationConfig` rather than replacing it. Values
|
|
287
|
+
* must be JSON-serializable. Bonds that build a fixed body ignore it.
|
|
288
|
+
*/
|
|
289
|
+
extraBody?: Record<string, unknown>;
|
|
273
290
|
}
|
|
274
291
|
/**
|
|
275
292
|
* AI provider interface.
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAA;IACrC,OAAO,EAAE,MAAM,GAAG,YAAY,EAAE,CAAA;IAChC;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GACpB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAA;IACrC,OAAO,EAAE,MAAM,GAAG,YAAY,EAAE,CAAA;IAChC;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GACpB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAOlD;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAClF;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAA;AAE3E;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACjC;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAIrC;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAKlF;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAapD;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAWtE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GASrD;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,CAAA;AAE1B;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,0DAA0D;IAC1D,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,yDAAyD;IACzD,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,UAAU,GAAG,MAAM,CAAA;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAA;IACd,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAA;IACf,wEAAwE;IACxE,SAAS,EAAE,OAAO,CAAA;IAClB,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAA;IACjB,qFAAqF;IACrF,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAA;AAEnE;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvC,KAAK,CAAC,EAAE,UAAU,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAC9C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,kEAAkE;IAClE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,WAAW,EAAE,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,iGAAiG;IACjG,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACrE;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,UAAU,GAAG,MAAM,CAAA;IAC3B,4FAA4F;IAC5F,YAAY,CAAC,EAAE;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,CAAA;IACpC,iFAAiF;IACjF,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACjE;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACpC;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC,CAAA;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}
|