@ego-z/contracts 0.15.14 → 0.15.15
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/package.json +1 -1
- package/src/ask.d.ts +43 -0
package/package.json
CHANGED
package/src/ask.d.ts
CHANGED
|
@@ -301,6 +301,49 @@ export interface AskRequestBody {
|
|
|
301
301
|
* Optional and additive: omit it and nothing changes.
|
|
302
302
|
*/
|
|
303
303
|
machineOutput?: AskMachineOutput[];
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* A one-shot COMPLETION: `message` is the whole instruction, and EgoZ adds
|
|
307
|
+
* nothing from the project around it.
|
|
308
|
+
*
|
|
309
|
+
* ── What it switches off ─────────────────────────────────────────────
|
|
310
|
+
*
|
|
311
|
+
* The project's prompt, personality, session context, greeting, knowledge
|
|
312
|
+
* base, tools, memory and conversation title. Nothing is stored either:
|
|
313
|
+
* `true` implies `noStore`. The project still supplies the provider key,
|
|
314
|
+
* the quota and the model menu, so `model` works as usual.
|
|
315
|
+
*
|
|
316
|
+
* What remains is what you put on this request for a program to read:
|
|
317
|
+
* with `responseFormat: 'json_object'`, the `jsonSchema` instructions; and
|
|
318
|
+
* any `machineOutput`.
|
|
319
|
+
*
|
|
320
|
+
* ── Why it exists ────────────────────────────────────────────────────
|
|
321
|
+
*
|
|
322
|
+
* A project that serves a chat agent also answers one-off program calls
|
|
323
|
+
* (a classifier, a planner). Without this, such a call runs AS the agent —
|
|
324
|
+
* its persona, every enabled tool, a knowledge-base lookup and the
|
|
325
|
+
* project's conversation temperature — which is slower, costlier and less
|
|
326
|
+
* predictable than the call needs.
|
|
327
|
+
*
|
|
328
|
+
* ── Why it is explicit ───────────────────────────────────────────────
|
|
329
|
+
*
|
|
330
|
+
* A JSON turn is not implicitly a completion, stored or not: testing the
|
|
331
|
+
* agent itself answering in JSON is a real use. Only `true` changes
|
|
332
|
+
* anything.
|
|
333
|
+
*
|
|
334
|
+
* Optional and additive: omit it and nothing changes.
|
|
335
|
+
*/
|
|
336
|
+
completion?: boolean;
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* The sampling temperature for a `completion`, from 0 to 2. Omit it to use
|
|
340
|
+
* the project's own.
|
|
341
|
+
*
|
|
342
|
+
* Accepted ONLY together with `completion: true`; on any other turn it is a
|
|
343
|
+
* 400. It is not a general per-call override: a conversation's temperature
|
|
344
|
+
* belongs to the project.
|
|
345
|
+
*/
|
|
346
|
+
temperature?: number;
|
|
304
347
|
}
|
|
305
348
|
|
|
306
349
|
/**
|