xmemory 3.12.0 → 3.13.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 +14 -1
- package/dist/cjs/instance.js +2 -0
- package/dist/cjs/types.d.ts +8 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/instance.js +2 -0
- package/dist/esm/types.d.ts +8 -0
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -249,7 +249,7 @@ const result = await inst.read("Who is on the team?");
|
|
|
249
249
|
console.log(result.reader_result);
|
|
250
250
|
```
|
|
251
251
|
|
|
252
|
-
Options: `{ readMode?, scope?, includeRelatedTypes?, relatedTypesDepth?, traceId?, timeoutMs? }` — `readMode` defaults to `"single-answer"`.
|
|
252
|
+
Options: `{ readMode?, scope?, includeRelatedTypes?, relatedTypesDepth?, skipSuggestionCapture?, traceId?, timeoutMs? }` — `readMode` defaults to `"single-answer"`.
|
|
253
253
|
|
|
254
254
|
#### What comes back
|
|
255
255
|
|
|
@@ -389,6 +389,19 @@ types needs the
|
|
|
389
389
|
endpoints need, on top of `data.read`: a key without it gets a 403 whose
|
|
390
390
|
message names the permission, and the plain read is unaffected.
|
|
391
391
|
|
|
392
|
+
#### Keeping a read out of schema suggestions
|
|
393
|
+
|
|
394
|
+
Every read feeds the [suggestion engine](#suggestion-engine-flow-review--decide--apply):
|
|
395
|
+
after answering, the server asks a model whether the schema could fully answer
|
|
396
|
+
the question, and a gap becomes a proposed schema change. For programmatic reads
|
|
397
|
+
— high-volume polling, read-your-write checks — whose question does not reflect
|
|
398
|
+
what a person wants from the memory, pass `skipSuggestionCapture: true`. The
|
|
399
|
+
answer is the same; the read proposes nothing and costs no judge call.
|
|
400
|
+
|
|
401
|
+
```typescript
|
|
402
|
+
const result = await inst.read("Does invoice INV-42 exist?", { skipSuggestionCapture: true });
|
|
403
|
+
```
|
|
404
|
+
|
|
392
405
|
#### Scoped writes
|
|
393
406
|
|
|
394
407
|
A write is normally free to touch anything in the instance: the extractor sees
|
package/dist/cjs/instance.js
CHANGED
|
@@ -238,6 +238,8 @@ class InstanceHandle {
|
|
|
238
238
|
body.include_related_types = options.includeRelatedTypes;
|
|
239
239
|
if (options?.relatedTypesDepth != null)
|
|
240
240
|
body.related_types_depth = options.relatedTypesDepth;
|
|
241
|
+
if (options?.skipSuggestionCapture)
|
|
242
|
+
body.skip_suggestion_capture = true;
|
|
241
243
|
if (options?.traceId != null)
|
|
242
244
|
body.trace_id = options.traceId;
|
|
243
245
|
// The wire shape omits `reader_results` on a server without question
|
package/dist/cjs/types.d.ts
CHANGED
|
@@ -734,6 +734,14 @@ export interface ReadOptions {
|
|
|
734
734
|
* serves one level; a value out of range is a 422.
|
|
735
735
|
*/
|
|
736
736
|
relatedTypesDepth?: number;
|
|
737
|
+
/**
|
|
738
|
+
* `true` keeps this read out of the suggestion engine: the server skips the
|
|
739
|
+
* post-read completeness judge, so the read proposes no schema change and costs
|
|
740
|
+
* no judge model call. Meant for programmatic reads — high-volume polling,
|
|
741
|
+
* read-your-write checks — whose question does not reflect what a person
|
|
742
|
+
* wants from the memory. Left unset, nothing is sent and the read is judged.
|
|
743
|
+
*/
|
|
744
|
+
skipSuggestionCapture?: boolean;
|
|
737
745
|
traceId?: string;
|
|
738
746
|
timeoutMs?: number;
|
|
739
747
|
}
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** Package version. Kept in sync with `package.json` — a test asserts they match. */
|
|
2
|
-
export declare const VERSION = "3.
|
|
2
|
+
export declare const VERSION = "3.13.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/instance.js
CHANGED
|
@@ -234,6 +234,8 @@ export class InstanceHandle {
|
|
|
234
234
|
body.include_related_types = options.includeRelatedTypes;
|
|
235
235
|
if (options?.relatedTypesDepth != null)
|
|
236
236
|
body.related_types_depth = options.relatedTypesDepth;
|
|
237
|
+
if (options?.skipSuggestionCapture)
|
|
238
|
+
body.skip_suggestion_capture = true;
|
|
237
239
|
if (options?.traceId != null)
|
|
238
240
|
body.trace_id = options.traceId;
|
|
239
241
|
// The wire shape omits `reader_results` on a server without question
|
package/dist/esm/types.d.ts
CHANGED
|
@@ -734,6 +734,14 @@ export interface ReadOptions {
|
|
|
734
734
|
* serves one level; a value out of range is a 422.
|
|
735
735
|
*/
|
|
736
736
|
relatedTypesDepth?: number;
|
|
737
|
+
/**
|
|
738
|
+
* `true` keeps this read out of the suggestion engine: the server skips the
|
|
739
|
+
* post-read completeness judge, so the read proposes no schema change and costs
|
|
740
|
+
* no judge model call. Meant for programmatic reads — high-volume polling,
|
|
741
|
+
* read-your-write checks — whose question does not reflect what a person
|
|
742
|
+
* wants from the memory. Left unset, nothing is sent and the read is judged.
|
|
743
|
+
*/
|
|
744
|
+
skipSuggestionCapture?: boolean;
|
|
737
745
|
traceId?: string;
|
|
738
746
|
timeoutMs?: number;
|
|
739
747
|
}
|
package/dist/esm/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** Package version. Kept in sync with `package.json` — a test asserts they match. */
|
|
2
|
-
export declare const VERSION = "3.
|
|
2
|
+
export declare const VERSION = "3.13.0";
|
package/dist/esm/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** Package version. Kept in sync with `package.json` — a test asserts they match. */
|
|
2
|
-
export const VERSION = "3.
|
|
2
|
+
export const VERSION = "3.13.0";
|