@nebula-ai/sdk 1.4.0 → 1.5.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 +7 -7
- package/dist/index.cjs +75 -198
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +112 -353
- package/dist/index.d.ts +112 -353
- package/dist/index.js +75 -198
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
package/dist/index.d.ts
CHANGED
|
@@ -62,7 +62,7 @@ interface components {
|
|
|
62
62
|
* Activation Score
|
|
63
63
|
* @default 0
|
|
64
64
|
*/
|
|
65
|
-
activation_score
|
|
65
|
+
activation_score?: number; /** Category */
|
|
66
66
|
category?: string | null;
|
|
67
67
|
/**
|
|
68
68
|
* Id
|
|
@@ -84,12 +84,12 @@ interface components {
|
|
|
84
84
|
* Activation Score
|
|
85
85
|
* @default 0
|
|
86
86
|
*/
|
|
87
|
-
activation_score
|
|
87
|
+
activation_score?: number;
|
|
88
88
|
/**
|
|
89
89
|
* Category
|
|
90
90
|
* @default episodic
|
|
91
91
|
*/
|
|
92
|
-
category
|
|
92
|
+
category?: string; /** Description */
|
|
93
93
|
description?: string | null; /** Entity Names */
|
|
94
94
|
entity_names?: string[]; /** Evidence Ids */
|
|
95
95
|
evidence_ids?: string[];
|
|
@@ -102,14 +102,14 @@ interface components {
|
|
|
102
102
|
* Is Obligation
|
|
103
103
|
* @default false
|
|
104
104
|
*/
|
|
105
|
-
is_obligation
|
|
105
|
+
is_obligation?: boolean; /** Member Semantic Ids */
|
|
106
106
|
member_semantic_ids?: string[]; /** Modality */
|
|
107
107
|
modality?: string | null;
|
|
108
108
|
/**
|
|
109
109
|
* N Facts
|
|
110
110
|
* @default 0
|
|
111
111
|
*/
|
|
112
|
-
n_facts
|
|
112
|
+
n_facts?: number; /** Name */
|
|
113
113
|
name: string; /** Resolved At */
|
|
114
114
|
resolved_at?: string | null; /** Status */
|
|
115
115
|
status?: string | null; /** T Last */
|
|
@@ -128,18 +128,18 @@ interface components {
|
|
|
128
128
|
* Activation Score
|
|
129
129
|
* @default 0
|
|
130
130
|
*/
|
|
131
|
-
activation_score
|
|
131
|
+
activation_score?: number; /** Belief Kind */
|
|
132
132
|
belief_kind?: string | null;
|
|
133
133
|
/**
|
|
134
134
|
* Confidence
|
|
135
135
|
* @default 0
|
|
136
136
|
*/
|
|
137
|
-
confidence
|
|
137
|
+
confidence?: number;
|
|
138
138
|
/**
|
|
139
139
|
* Derivation Type
|
|
140
140
|
* @default trivial
|
|
141
141
|
*/
|
|
142
|
-
derivation_type
|
|
142
|
+
derivation_type?: string; /** Entity Id */
|
|
143
143
|
entity_id?: string | null; /** Entity Name */
|
|
144
144
|
entity_name?: string | null;
|
|
145
145
|
/**
|
|
@@ -151,7 +151,7 @@ interface components {
|
|
|
151
151
|
* Is Negated
|
|
152
152
|
* @default false
|
|
153
153
|
*/
|
|
154
|
-
is_negated
|
|
154
|
+
is_negated?: boolean; /** Metadata */
|
|
155
155
|
metadata?: {
|
|
156
156
|
[key: string]: unknown;
|
|
157
157
|
} | null; /** Statement */
|
|
@@ -170,18 +170,18 @@ interface components {
|
|
|
170
170
|
* Activation Score
|
|
171
171
|
* @default 0
|
|
172
172
|
*/
|
|
173
|
-
activation_score
|
|
173
|
+
activation_score?: number; /** Belief Kind */
|
|
174
174
|
belief_kind?: string | null;
|
|
175
175
|
/**
|
|
176
176
|
* Category
|
|
177
177
|
* @default fact
|
|
178
178
|
*/
|
|
179
|
-
category
|
|
179
|
+
category?: string;
|
|
180
180
|
/**
|
|
181
181
|
* Corroboration Count
|
|
182
182
|
* @default 1
|
|
183
183
|
*/
|
|
184
|
-
corroboration_count
|
|
184
|
+
corroboration_count?: number; /** Description */
|
|
185
185
|
description?: string | null; /** Entity Id */
|
|
186
186
|
entity_id?: string | null; /** Entity Name */
|
|
187
187
|
entity_name?: string | null; /** Evidence Ids */
|
|
@@ -191,7 +191,7 @@ interface components {
|
|
|
191
191
|
* Extraction Confidence
|
|
192
192
|
* @default 0
|
|
193
193
|
*/
|
|
194
|
-
extraction_confidence
|
|
194
|
+
extraction_confidence?: number;
|
|
195
195
|
/**
|
|
196
196
|
* Id
|
|
197
197
|
* Format: uuid
|
|
@@ -226,12 +226,12 @@ interface components {
|
|
|
226
226
|
* Activation Score
|
|
227
227
|
* @default 0
|
|
228
228
|
*/
|
|
229
|
-
activation_score
|
|
229
|
+
activation_score?: number;
|
|
230
230
|
/**
|
|
231
231
|
* Active Instance Count
|
|
232
232
|
* @default 0
|
|
233
233
|
*/
|
|
234
|
-
active_instance_count
|
|
234
|
+
active_instance_count?: number; /** Backbone Signature Hash */
|
|
235
235
|
backbone_signature_hash?: string | null; /** Branches */
|
|
236
236
|
branches?: {
|
|
237
237
|
[key: string]: unknown;
|
|
@@ -240,7 +240,7 @@ interface components {
|
|
|
240
240
|
* Confidence
|
|
241
241
|
* @default 0
|
|
242
242
|
*/
|
|
243
|
-
confidence
|
|
243
|
+
confidence?: number; /** Current Step Index */
|
|
244
244
|
current_step_index?: number | null; /** Goal */
|
|
245
245
|
goal: string;
|
|
246
246
|
/**
|
|
@@ -252,7 +252,7 @@ interface components {
|
|
|
252
252
|
* Instance Count
|
|
253
253
|
* @default 0
|
|
254
254
|
*/
|
|
255
|
-
instance_count
|
|
255
|
+
instance_count?: number; /** Last Observed At */
|
|
256
256
|
last_observed_at?: string | null; /** Metadata */
|
|
257
257
|
metadata?: {
|
|
258
258
|
[key: string]: unknown;
|
|
@@ -264,7 +264,7 @@ interface components {
|
|
|
264
264
|
* Taxonomy Version
|
|
265
265
|
* @default 1
|
|
266
266
|
*/
|
|
267
|
-
taxonomy_version
|
|
267
|
+
taxonomy_version?: number; /** Variable Slots */
|
|
268
268
|
variable_slots?: {
|
|
269
269
|
[key: string]: unknown;
|
|
270
270
|
};
|
|
@@ -292,7 +292,7 @@ interface components {
|
|
|
292
292
|
* Optional
|
|
293
293
|
* @default false
|
|
294
294
|
*/
|
|
295
|
-
optional
|
|
295
|
+
optional?: boolean; /** Typical Entities */
|
|
296
296
|
typical_entities?: string[]; /** Typical Tools */
|
|
297
297
|
typical_tools?: string[]; /** Variable Slots */
|
|
298
298
|
variable_slots?: string[]; /** Verb Class */
|
|
@@ -355,7 +355,7 @@ interface components {
|
|
|
355
355
|
* @description Ingestion mode for document content.
|
|
356
356
|
* @default custom
|
|
357
357
|
*/
|
|
358
|
-
ingestion_mode
|
|
358
|
+
ingestion_mode?: components["schemas"]["IngestionMode"];
|
|
359
359
|
/**
|
|
360
360
|
* Messages
|
|
361
361
|
* @description Messages to append for conversation memories. Each message has content, role, and optional metadata.
|
|
@@ -386,7 +386,7 @@ interface components {
|
|
|
386
386
|
* Metadata
|
|
387
387
|
* @default {}
|
|
388
388
|
*/
|
|
389
|
-
metadata
|
|
389
|
+
metadata?: {
|
|
390
390
|
[key: string]: unknown;
|
|
391
391
|
};
|
|
392
392
|
}; /** AppendedMessageResponse */
|
|
@@ -426,13 +426,13 @@ interface components {
|
|
|
426
426
|
* @default bootstrap
|
|
427
427
|
* @constant
|
|
428
428
|
*/
|
|
429
|
-
intent
|
|
429
|
+
intent?: "bootstrap";
|
|
430
430
|
/**
|
|
431
431
|
* Top K
|
|
432
432
|
* @description Maximum number of pattern hits to return.
|
|
433
433
|
* @default 10
|
|
434
434
|
*/
|
|
435
|
-
top_k
|
|
435
|
+
top_k?: number;
|
|
436
436
|
};
|
|
437
437
|
/**
|
|
438
438
|
* ChunkEnrichmentSettings
|
|
@@ -448,31 +448,31 @@ interface components {
|
|
|
448
448
|
* @description The prompt to use for chunk enrichment
|
|
449
449
|
* @default chunk_enrichment
|
|
450
450
|
*/
|
|
451
|
-
chunk_enrichment_prompt
|
|
451
|
+
chunk_enrichment_prompt?: string | null;
|
|
452
452
|
/**
|
|
453
453
|
* Enable Chunk Enrichment
|
|
454
454
|
* @description Whether to enable chunk enrichment or not
|
|
455
455
|
* @default false
|
|
456
456
|
*/
|
|
457
|
-
enable_chunk_enrichment
|
|
457
|
+
enable_chunk_enrichment?: boolean;
|
|
458
458
|
/**
|
|
459
459
|
* N Chunks
|
|
460
460
|
* @description The number of preceding and succeeding chunks to include. Defaults to 2.
|
|
461
461
|
* @default 2
|
|
462
462
|
*/
|
|
463
|
-
n_chunks
|
|
463
|
+
n_chunks?: number;
|
|
464
464
|
}; /** CollectionResponse */
|
|
465
465
|
CollectionResponse: {
|
|
466
466
|
/**
|
|
467
467
|
* Access Tier
|
|
468
468
|
* @default private
|
|
469
469
|
*/
|
|
470
|
-
access_tier
|
|
470
|
+
access_tier?: string | null;
|
|
471
471
|
/**
|
|
472
472
|
* Cache Policy
|
|
473
473
|
* @default lazy
|
|
474
474
|
*/
|
|
475
|
-
cache_policy
|
|
475
|
+
cache_policy?: string | null; /** Chain Type */
|
|
476
476
|
chain_type?: string | null; /** Contract Address */
|
|
477
477
|
contract_address?: string | null;
|
|
478
478
|
/**
|
|
@@ -484,7 +484,7 @@ interface components {
|
|
|
484
484
|
* Creator Royalty Bps
|
|
485
485
|
* @default 250
|
|
486
486
|
*/
|
|
487
|
-
creator_royalty_bps
|
|
487
|
+
creator_royalty_bps?: number | null; /** Description */
|
|
488
488
|
description: string | null; /** Engram Count */
|
|
489
489
|
engram_count: number; /** Graph Collection Status */
|
|
490
490
|
graph_collection_status: string; /** Graph Sync Status */
|
|
@@ -503,7 +503,7 @@ interface components {
|
|
|
503
503
|
* Memory Count
|
|
504
504
|
* @default 0
|
|
505
505
|
*/
|
|
506
|
-
memory_count
|
|
506
|
+
memory_count?: number | null; /** Name */
|
|
507
507
|
name: string; /** Nft Collection Address */
|
|
508
508
|
nft_collection_address?: string | null; /** Owner Email */
|
|
509
509
|
owner_email?: string | null; /** Owner Id */
|
|
@@ -513,7 +513,7 @@ interface components {
|
|
|
513
513
|
* Preview Query Limit
|
|
514
514
|
* @default 0
|
|
515
515
|
*/
|
|
516
|
-
preview_query_limit
|
|
516
|
+
preview_query_limit?: number | null; /** Purchase Price Usd */
|
|
517
517
|
purchase_price_usd?: string | null; /** Rental Price Monthly Usd */
|
|
518
518
|
rental_price_monthly_usd?: string | null;
|
|
519
519
|
/**
|
|
@@ -526,7 +526,7 @@ interface components {
|
|
|
526
526
|
* Workflows Enabled
|
|
527
527
|
* @default false
|
|
528
528
|
*/
|
|
529
|
-
workflows_enabled
|
|
529
|
+
workflows_enabled?: boolean; /** Workspace Id */
|
|
530
530
|
workspace_id?: string | null;
|
|
531
531
|
};
|
|
532
532
|
/**
|
|
@@ -551,7 +551,7 @@ interface components {
|
|
|
551
551
|
* Token Count
|
|
552
552
|
* @default 0
|
|
553
553
|
*/
|
|
554
|
-
token_count
|
|
554
|
+
token_count?: number;
|
|
555
555
|
}; /** ConnectRequest */
|
|
556
556
|
ConnectRequest: {
|
|
557
557
|
/**
|
|
@@ -683,7 +683,7 @@ interface components {
|
|
|
683
683
|
* Workflows Enabled
|
|
684
684
|
* @default false
|
|
685
685
|
*/
|
|
686
|
-
workflows_enabled
|
|
686
|
+
workflows_enabled?: boolean; /** Workspace Id */
|
|
687
687
|
workspace_id?: string | null;
|
|
688
688
|
};
|
|
689
689
|
/**
|
|
@@ -727,12 +727,12 @@ interface components {
|
|
|
727
727
|
* @description Ingestion mode for documents
|
|
728
728
|
* @default fast
|
|
729
729
|
*/
|
|
730
|
-
ingestion_mode
|
|
730
|
+
ingestion_mode?: components["schemas"]["IngestionMode"] | null;
|
|
731
731
|
/**
|
|
732
732
|
* @description Engram discriminator: ``document`` or ``conversation``. When omitted, ``conversation`` is inferred if ``messages`` is present; otherwise defaults to ``document``.
|
|
733
733
|
* @default document
|
|
734
734
|
*/
|
|
735
|
-
kind
|
|
735
|
+
kind?: components["schemas"]["EngramKind"];
|
|
736
736
|
/**
|
|
737
737
|
* Messages
|
|
738
738
|
* @description Messages for conversation kind
|
|
@@ -787,7 +787,7 @@ interface components {
|
|
|
787
787
|
* @default cursor
|
|
788
788
|
* @constant
|
|
789
789
|
*/
|
|
790
|
-
intent
|
|
790
|
+
intent?: "cursor";
|
|
791
791
|
/**
|
|
792
792
|
* State Id
|
|
793
793
|
* @description Anchor: the user's current state nodegroup id.
|
|
@@ -798,7 +798,7 @@ interface components {
|
|
|
798
798
|
* @description Maximum number of pattern hits to return.
|
|
799
799
|
* @default 10
|
|
800
800
|
*/
|
|
801
|
-
top_k
|
|
801
|
+
top_k?: number;
|
|
802
802
|
/**
|
|
803
803
|
* Trace Id
|
|
804
804
|
* @description Anchor: the user's most recent trace id. The handler resolves this trace's state_before automatically.
|
|
@@ -835,23 +835,23 @@ interface components {
|
|
|
835
835
|
* Dim
|
|
836
836
|
* @default 0
|
|
837
837
|
*/
|
|
838
|
-
dim
|
|
838
|
+
dim?: number;
|
|
839
839
|
/**
|
|
840
840
|
* Encoding
|
|
841
841
|
* @default npy-base64
|
|
842
842
|
* @constant
|
|
843
843
|
*/
|
|
844
|
-
encoding
|
|
844
|
+
encoding?: "npy-base64";
|
|
845
845
|
/**
|
|
846
846
|
* Mask B64
|
|
847
847
|
* @default
|
|
848
848
|
*/
|
|
849
|
-
mask_b64
|
|
849
|
+
mask_b64?: string;
|
|
850
850
|
/**
|
|
851
851
|
* Values B64
|
|
852
852
|
* @default
|
|
853
853
|
*/
|
|
854
|
-
values_b64
|
|
854
|
+
values_b64?: string;
|
|
855
855
|
};
|
|
856
856
|
/**
|
|
857
857
|
* Engram
|
|
@@ -894,14 +894,14 @@ interface components {
|
|
|
894
894
|
conversation?: components["schemas"]["ConversationFields"] | null; /** Created At */
|
|
895
895
|
created_at?: string | null;
|
|
896
896
|
document?: components["schemas"]["DocumentFields"] | null; /** @default pending */
|
|
897
|
-
extraction_status
|
|
897
|
+
extraction_status?: components["schemas"]["GraphExtractionStatus"];
|
|
898
898
|
/**
|
|
899
899
|
* Id
|
|
900
900
|
* Format: uuid
|
|
901
901
|
*/
|
|
902
902
|
id?: string; /** Ingestion Attempt Number */
|
|
903
903
|
ingestion_attempt_number?: number | null; /** @default pending */
|
|
904
|
-
ingestion_status
|
|
904
|
+
ingestion_status?: components["schemas"]["IngestionStatus"];
|
|
905
905
|
kind: components["schemas"]["EngramKind"]; /** Merkle Root */
|
|
906
906
|
merkle_root?: string | null; /** Metadata */
|
|
907
907
|
metadata?: {
|
|
@@ -944,7 +944,7 @@ interface components {
|
|
|
944
944
|
* Collection Id
|
|
945
945
|
* @default
|
|
946
946
|
*/
|
|
947
|
-
collection_id
|
|
947
|
+
collection_id?: string;
|
|
948
948
|
/**
|
|
949
949
|
* Created At
|
|
950
950
|
* Format: date-time
|
|
@@ -964,7 +964,7 @@ interface components {
|
|
|
964
964
|
* Relationship Count
|
|
965
965
|
* @default 0
|
|
966
966
|
*/
|
|
967
|
-
relationship_count
|
|
967
|
+
relationship_count?: number;
|
|
968
968
|
/**
|
|
969
969
|
* Updated At
|
|
970
970
|
* Format: date-time
|
|
@@ -998,7 +998,7 @@ interface components {
|
|
|
998
998
|
* @default evidence
|
|
999
999
|
* @constant
|
|
1000
1000
|
*/
|
|
1001
|
-
intent
|
|
1001
|
+
intent?: "evidence";
|
|
1002
1002
|
/**
|
|
1003
1003
|
* Pattern Id
|
|
1004
1004
|
* Format: uuid
|
|
@@ -1010,7 +1010,7 @@ interface components {
|
|
|
1010
1010
|
* @description Maximum number of pattern hits to return.
|
|
1011
1011
|
* @default 10
|
|
1012
1012
|
*/
|
|
1013
|
-
top_k
|
|
1013
|
+
top_k?: number;
|
|
1014
1014
|
};
|
|
1015
1015
|
/**
|
|
1016
1016
|
* EvidenceRef
|
|
@@ -1055,7 +1055,7 @@ interface components {
|
|
|
1055
1055
|
* @description MIME type
|
|
1056
1056
|
* @default application/octet-stream
|
|
1057
1057
|
*/
|
|
1058
|
-
media_type
|
|
1058
|
+
media_type?: string;
|
|
1059
1059
|
/**
|
|
1060
1060
|
* @description Content kind: file, image, audio, or document. (enum property replaced by openapi-typescript)
|
|
1061
1061
|
* @enum {string}
|
|
@@ -1103,7 +1103,7 @@ interface components {
|
|
|
1103
1103
|
* Activation Score
|
|
1104
1104
|
* @default 0
|
|
1105
1105
|
*/
|
|
1106
|
-
activation_score
|
|
1106
|
+
activation_score?: number; /** Display Name */
|
|
1107
1107
|
display_name?: string | null; /** Engram Id */
|
|
1108
1108
|
engram_id?: string | null;
|
|
1109
1109
|
evidence_ref?: components["schemas"]["EvidenceRef"] | null;
|
|
@@ -1142,7 +1142,7 @@ interface components {
|
|
|
1142
1142
|
* Inferred
|
|
1143
1143
|
* @default false
|
|
1144
1144
|
*/
|
|
1145
|
-
inferred
|
|
1145
|
+
inferred?: boolean; /** Ledger P Stable */
|
|
1146
1146
|
ledger_p_stable?: number | null; /** Ledger P True */
|
|
1147
1147
|
ledger_p_true?: number | null; /** Ledger P Use */
|
|
1148
1148
|
ledger_p_use?: number | null; /** Metadata */
|
|
@@ -1159,12 +1159,12 @@ interface components {
|
|
|
1159
1159
|
* Usable For Rewrite
|
|
1160
1160
|
* @default false
|
|
1161
1161
|
*/
|
|
1162
|
-
usable_for_rewrite
|
|
1162
|
+
usable_for_rewrite?: boolean;
|
|
1163
1163
|
/**
|
|
1164
1164
|
* Used For Rewrite
|
|
1165
1165
|
* @default false
|
|
1166
1166
|
*/
|
|
1167
|
-
used_for_rewrite
|
|
1167
|
+
used_for_rewrite?: boolean;
|
|
1168
1168
|
};
|
|
1169
1169
|
/**
|
|
1170
1170
|
* IngestionConfig
|
|
@@ -1180,23 +1180,23 @@ interface components {
|
|
|
1180
1180
|
* Automatic Extraction
|
|
1181
1181
|
* @default false
|
|
1182
1182
|
*/
|
|
1183
|
-
automatic_extraction
|
|
1183
|
+
automatic_extraction?: boolean;
|
|
1184
1184
|
chunk_enrichment_settings?: components["schemas"]["ChunkEnrichmentSettings"];
|
|
1185
1185
|
/**
|
|
1186
1186
|
* Chunk Overlap
|
|
1187
1187
|
* @default 512
|
|
1188
1188
|
*/
|
|
1189
|
-
chunk_overlap
|
|
1189
|
+
chunk_overlap?: number;
|
|
1190
1190
|
/**
|
|
1191
1191
|
* Chunk Size
|
|
1192
1192
|
* @default 1024
|
|
1193
1193
|
*/
|
|
1194
|
-
chunk_size
|
|
1194
|
+
chunk_size?: number;
|
|
1195
1195
|
/**
|
|
1196
1196
|
* Chunking Strategy
|
|
1197
1197
|
* @default recursive
|
|
1198
1198
|
*/
|
|
1199
|
-
chunking_strategy
|
|
1199
|
+
chunking_strategy?: string; /** Excluded Parsers */
|
|
1200
1200
|
excluded_parsers?: string[]; /** Extra Parsers */
|
|
1201
1201
|
extra_parsers?: {
|
|
1202
1202
|
[key: string]: unknown;
|
|
@@ -1205,7 +1205,7 @@ interface components {
|
|
|
1205
1205
|
* Max Concurrent Vlm Tasks
|
|
1206
1206
|
* @default 5
|
|
1207
1207
|
*/
|
|
1208
|
-
max_concurrent_vlm_tasks
|
|
1208
|
+
max_concurrent_vlm_tasks?: number; /** Parser Overrides */
|
|
1209
1209
|
parser_overrides?: {
|
|
1210
1210
|
[key: string]: string;
|
|
1211
1211
|
};
|
|
@@ -1213,23 +1213,23 @@ interface components {
|
|
|
1213
1213
|
* Provider
|
|
1214
1214
|
* @default nebula
|
|
1215
1215
|
*/
|
|
1216
|
-
provider
|
|
1216
|
+
provider?: string; /** Vlm */
|
|
1217
1217
|
vlm?: string | null;
|
|
1218
1218
|
/**
|
|
1219
1219
|
* Vlm Batch Size
|
|
1220
1220
|
* @default 5
|
|
1221
1221
|
*/
|
|
1222
|
-
vlm_batch_size
|
|
1222
|
+
vlm_batch_size?: number;
|
|
1223
1223
|
/**
|
|
1224
1224
|
* Vlm Max Tokens To Sample
|
|
1225
1225
|
* @default 1024
|
|
1226
1226
|
*/
|
|
1227
|
-
vlm_max_tokens_to_sample
|
|
1227
|
+
vlm_max_tokens_to_sample?: number;
|
|
1228
1228
|
/**
|
|
1229
1229
|
* Vlm Ocr One Page Per Chunk
|
|
1230
1230
|
* @default true
|
|
1231
1231
|
*/
|
|
1232
|
-
vlm_ocr_one_page_per_chunk
|
|
1232
|
+
vlm_ocr_one_page_per_chunk?: boolean;
|
|
1233
1233
|
};
|
|
1234
1234
|
/**
|
|
1235
1235
|
* IngestionMode
|
|
@@ -1279,14 +1279,14 @@ interface components {
|
|
|
1279
1279
|
conversation?: components["schemas"]["ConversationFields"] | null; /** Created At */
|
|
1280
1280
|
created_at?: string | null;
|
|
1281
1281
|
document?: components["schemas"]["DocumentFields"] | null; /** @default pending */
|
|
1282
|
-
extraction_status
|
|
1282
|
+
extraction_status?: components["schemas"]["GraphExtractionStatus"];
|
|
1283
1283
|
/**
|
|
1284
1284
|
* Id
|
|
1285
1285
|
* Format: uuid
|
|
1286
1286
|
*/
|
|
1287
1287
|
id?: string; /** Ingestion Attempt Number */
|
|
1288
1288
|
ingestion_attempt_number?: number | null; /** @default pending */
|
|
1289
|
-
ingestion_status
|
|
1289
|
+
ingestion_status?: components["schemas"]["IngestionStatus"];
|
|
1290
1290
|
kind: components["schemas"]["EngramKind"]; /** Merkle Root */
|
|
1291
1291
|
merkle_root?: string | null; /** Metadata */
|
|
1292
1292
|
metadata?: {
|
|
@@ -1317,7 +1317,7 @@ interface components {
|
|
|
1317
1317
|
* @description WAL committed sequence number from this placeholder write, for read-your-writes assertions on the next collection-scoped list call. A non-zero value indicates the request appended a WAL entry; pass it back as `min_applied_wal_seq` on GET /v1/memories to wait for the entry's visibility before serving. Zero on idempotent observe-existing replays and on multi-shard collections (per-shard scalars are not comparable across shards) — clients should treat zero as 'no assertion to make.' Single-shard collections only.
|
|
1318
1318
|
* @default 0
|
|
1319
1319
|
*/
|
|
1320
|
-
applied_wal_seq
|
|
1320
|
+
applied_wal_seq?: number; /** Engram Id */
|
|
1321
1321
|
engram_id?: string | null;
|
|
1322
1322
|
/**
|
|
1323
1323
|
* Id
|
|
@@ -1451,7 +1451,7 @@ interface components {
|
|
|
1451
1451
|
* @description Highest WAL committed sequence number reflected in this response. Non-zero only when the request was served via the WAL-tail fast path. Pair with ``min_applied_wal_seq`` on the request for read-your-writes assertions.
|
|
1452
1452
|
* @default 0
|
|
1453
1453
|
*/
|
|
1454
|
-
applied_wal_seq
|
|
1454
|
+
applied_wal_seq?: number;
|
|
1455
1455
|
data: components["schemas"]["ListedEngram"][]; /** @description Whether another page is available after this one. */
|
|
1456
1456
|
has_more: boolean; /** @description Opaque cursor for the next page. ``null`` when the caller has reached the end. */
|
|
1457
1457
|
next_cursor?: string | null;
|
|
@@ -1480,7 +1480,7 @@ interface components {
|
|
|
1480
1480
|
* @default predict
|
|
1481
1481
|
* @constant
|
|
1482
1482
|
*/
|
|
1483
|
-
intent
|
|
1483
|
+
intent?: "predict";
|
|
1484
1484
|
/**
|
|
1485
1485
|
* State Id
|
|
1486
1486
|
* @description Anchor: the user's current state nodegroup id.
|
|
@@ -1491,7 +1491,7 @@ interface components {
|
|
|
1491
1491
|
* @description Maximum number of pattern hits to return.
|
|
1492
1492
|
* @default 10
|
|
1493
1493
|
*/
|
|
1494
|
-
top_k
|
|
1494
|
+
top_k?: number;
|
|
1495
1495
|
/**
|
|
1496
1496
|
* Trace Id
|
|
1497
1497
|
* @description Anchor: the user's most recent trace id. The handler resolves this trace's state_before automatically.
|
|
@@ -1520,7 +1520,7 @@ interface components {
|
|
|
1520
1520
|
* Collection Id
|
|
1521
1521
|
* @default
|
|
1522
1522
|
*/
|
|
1523
|
-
collection_id
|
|
1523
|
+
collection_id?: string;
|
|
1524
1524
|
/**
|
|
1525
1525
|
* Created At
|
|
1526
1526
|
* Format: date-time
|
|
@@ -1541,7 +1541,7 @@ interface components {
|
|
|
1541
1541
|
* Predicate
|
|
1542
1542
|
* @default
|
|
1543
1543
|
*/
|
|
1544
|
-
predicate
|
|
1544
|
+
predicate?: string; /** Relationship Type */
|
|
1545
1545
|
relationship_type?: string | null; /** Subject */
|
|
1546
1546
|
subject?: string | null; /** Subject Id */
|
|
1547
1547
|
subject_id: string; /** Temporal Precision */
|
|
@@ -1572,7 +1572,7 @@ interface components {
|
|
|
1572
1572
|
* @default resume
|
|
1573
1573
|
* @constant
|
|
1574
1574
|
*/
|
|
1575
|
-
intent
|
|
1575
|
+
intent?: "resume";
|
|
1576
1576
|
/**
|
|
1577
1577
|
* State Id
|
|
1578
1578
|
* @description Anchor: the user's current state nodegroup id.
|
|
@@ -1583,7 +1583,7 @@ interface components {
|
|
|
1583
1583
|
* @description Maximum number of pattern hits to return.
|
|
1584
1584
|
* @default 10
|
|
1585
1585
|
*/
|
|
1586
|
-
top_k
|
|
1586
|
+
top_k?: number;
|
|
1587
1587
|
/**
|
|
1588
1588
|
* Trace Id
|
|
1589
1589
|
* @description Anchor: the user's most recent trace id. The handler resolves this trace's state_before automatically.
|
|
@@ -1610,7 +1610,7 @@ interface components {
|
|
|
1610
1610
|
* @description MIME type
|
|
1611
1611
|
* @default application/octet-stream
|
|
1612
1612
|
*/
|
|
1613
|
-
media_type
|
|
1613
|
+
media_type?: string;
|
|
1614
1614
|
/**
|
|
1615
1615
|
* S3 Key
|
|
1616
1616
|
* @description S3 object key
|
|
@@ -1656,13 +1656,13 @@ interface components {
|
|
|
1656
1656
|
* @description Compute effort budget (auto/low/medium/high). Controls traversal compute for memory search, not MemoryRecall size.
|
|
1657
1657
|
* @default auto
|
|
1658
1658
|
*/
|
|
1659
|
-
effort
|
|
1659
|
+
effort?: components["schemas"]["SearchEffort"];
|
|
1660
1660
|
/**
|
|
1661
1661
|
* Enable Conceptual Expansion
|
|
1662
1662
|
* @description Enable conceptual expansion for cross-domain discovery through overlapping concepts
|
|
1663
1663
|
* @default false
|
|
1664
1664
|
*/
|
|
1665
|
-
enable_conceptual_expansion
|
|
1665
|
+
enable_conceptual_expansion?: boolean;
|
|
1666
1666
|
/**
|
|
1667
1667
|
* Filters
|
|
1668
1668
|
* @description Internal: Filters populated by the API router
|
|
@@ -1675,7 +1675,7 @@ interface components {
|
|
|
1675
1675
|
* @description Weight for fulltext search in hybrid mode (0-1). Set to 0 for pure semantic search.
|
|
1676
1676
|
* @default 0.2
|
|
1677
1677
|
*/
|
|
1678
|
-
fulltext_weight
|
|
1678
|
+
fulltext_weight?: number;
|
|
1679
1679
|
/**
|
|
1680
1680
|
* Graph Settings
|
|
1681
1681
|
* @description Internal: Graph traversal settings (bfs_max_depth, semantic_threshold, etc.)
|
|
@@ -1688,25 +1688,25 @@ interface components {
|
|
|
1688
1688
|
* @description Internal: Set by select_search_filters when an owner_id $in partition-pruning wrapper has been added around the filter tree. Used by the in-memory graph read engine to strip the Postgres-only wrapper before evaluating delegation.
|
|
1689
1689
|
* @default false
|
|
1690
1690
|
*/
|
|
1691
|
-
has_pruning_gate
|
|
1691
|
+
has_pruning_gate?: boolean;
|
|
1692
1692
|
/**
|
|
1693
1693
|
* Include Scores
|
|
1694
1694
|
* @description Whether to include search score values in the search results
|
|
1695
1695
|
* @default true
|
|
1696
1696
|
*/
|
|
1697
|
-
include_scores
|
|
1697
|
+
include_scores?: boolean;
|
|
1698
1698
|
/**
|
|
1699
1699
|
* Semantic Weight
|
|
1700
1700
|
* @description Weight for semantic search in hybrid mode (0-1). Set to 0 for pure fulltext search.
|
|
1701
1701
|
* @default 0.8
|
|
1702
1702
|
*/
|
|
1703
|
-
semantic_weight
|
|
1703
|
+
semantic_weight?: number;
|
|
1704
1704
|
/**
|
|
1705
1705
|
* Verbose
|
|
1706
1706
|
* @description Include full internal metadata, UUIDs, and confidence fields in MemoryRecall responses. When False, returns compact LLM-optimized format.
|
|
1707
1707
|
* @default false
|
|
1708
1708
|
*/
|
|
1709
|
-
verbose
|
|
1709
|
+
verbose?: boolean;
|
|
1710
1710
|
};
|
|
1711
1711
|
/**
|
|
1712
1712
|
* SnapshotEnvelope
|
|
@@ -1727,12 +1727,12 @@ interface components {
|
|
|
1727
1727
|
* Format Version
|
|
1728
1728
|
* @default 3
|
|
1729
1729
|
*/
|
|
1730
|
-
format_version
|
|
1730
|
+
format_version?: number;
|
|
1731
1731
|
/**
|
|
1732
1732
|
* Generation
|
|
1733
1733
|
* @default 0
|
|
1734
1734
|
*/
|
|
1735
|
-
generation
|
|
1735
|
+
generation?: number;
|
|
1736
1736
|
graph?: components["schemas"]["GraphPayload"]; /** Root Hash */
|
|
1737
1737
|
root_hash: string;
|
|
1738
1738
|
};
|
|
@@ -1755,12 +1755,12 @@ interface components {
|
|
|
1755
1755
|
* Format Version
|
|
1756
1756
|
* @default 3
|
|
1757
1757
|
*/
|
|
1758
|
-
format_version
|
|
1758
|
+
format_version?: number;
|
|
1759
1759
|
/**
|
|
1760
1760
|
* Generation
|
|
1761
1761
|
* @default 0
|
|
1762
1762
|
*/
|
|
1763
|
-
generation
|
|
1763
|
+
generation?: number;
|
|
1764
1764
|
graph?: components["schemas"]["GraphPayload"]; /** Root Hash */
|
|
1765
1765
|
root_hash: string;
|
|
1766
1766
|
}; /** SnapshotExportRequest */
|
|
@@ -1854,7 +1854,7 @@ interface components {
|
|
|
1854
1854
|
* Generate Description
|
|
1855
1855
|
* @default false
|
|
1856
1856
|
*/
|
|
1857
|
-
generate_description
|
|
1857
|
+
generate_description?: boolean; /** Name */
|
|
1858
1858
|
name?: string | null; /** Workflows Enabled */
|
|
1859
1859
|
workflows_enabled?: boolean | null;
|
|
1860
1860
|
}; /** UpdateMemoryRequest */
|
|
@@ -1869,7 +1869,7 @@ interface components {
|
|
|
1869
1869
|
* @description Merge with existing metadata
|
|
1870
1870
|
* @default false
|
|
1871
1871
|
*/
|
|
1872
|
-
merge_metadata
|
|
1872
|
+
merge_metadata?: boolean;
|
|
1873
1873
|
/**
|
|
1874
1874
|
* Metadata
|
|
1875
1875
|
* @description Metadata to update
|
|
@@ -1993,7 +1993,7 @@ declare class ClientResource {
|
|
|
1993
1993
|
* @operationId client.health
|
|
1994
1994
|
* @endpoint GET /v1/health
|
|
1995
1995
|
*/
|
|
1996
|
-
health(options?: RequestOptions$4): Promise<components["schemas"]["
|
|
1996
|
+
health(options?: RequestOptions$4): Promise<components["schemas"]["GenericMessageResponse"]>;
|
|
1997
1997
|
}
|
|
1998
1998
|
//#endregion
|
|
1999
1999
|
//#region src/resources/collections.d.ts
|
|
@@ -2016,9 +2016,7 @@ declare class CollectionsResource {
|
|
|
2016
2016
|
* @operationId collections.create
|
|
2017
2017
|
* @endpoint POST /v1/collections
|
|
2018
2018
|
*/
|
|
2019
|
-
create(
|
|
2020
|
-
body: components["schemas"]["CreateCollectionRequest"];
|
|
2021
|
-
}, options?: RequestOptions$3): Promise<components["schemas"]["WrappedCollectionResponse"]>;
|
|
2019
|
+
create(body: components["schemas"]["CreateCollectionRequest"], options?: RequestOptions$3): Promise<components["schemas"]["CollectionResponse"]>;
|
|
2022
2020
|
/**
|
|
2023
2021
|
*
|
|
2024
2022
|
* Delete collection
|
|
@@ -2032,7 +2030,7 @@ declare class CollectionsResource {
|
|
|
2032
2030
|
* @operationId collections.delete
|
|
2033
2031
|
* @endpoint DELETE /v1/collections/{id}
|
|
2034
2032
|
*/
|
|
2035
|
-
delete(id: string, options?: RequestOptions$3): Promise<components["schemas"]["
|
|
2033
|
+
delete(id: string, options?: RequestOptions$3): Promise<components["schemas"]["GenericBooleanResponse"]>;
|
|
2036
2034
|
/**
|
|
2037
2035
|
*
|
|
2038
2036
|
* List collections
|
|
@@ -2069,7 +2067,7 @@ declare class CollectionsResource {
|
|
|
2069
2067
|
* @operationId collections.retrieve
|
|
2070
2068
|
* @endpoint GET /v1/collections/{id}
|
|
2071
2069
|
*/
|
|
2072
|
-
retrieve(id: string, options?: RequestOptions$3): Promise<components["schemas"]["
|
|
2070
|
+
retrieve(id: string, options?: RequestOptions$3): Promise<components["schemas"]["CollectionResponse"]>;
|
|
2073
2071
|
/**
|
|
2074
2072
|
*
|
|
2075
2073
|
* Get a collection by name
|
|
@@ -2084,7 +2082,7 @@ declare class CollectionsResource {
|
|
|
2084
2082
|
retrieveByName(params: {
|
|
2085
2083
|
/** The name of the collection */collectionName: string; /** (Superuser only) Specify the owner_id to retrieve a collection by name */
|
|
2086
2084
|
ownerId?: string | null;
|
|
2087
|
-
}, options?: RequestOptions$3): Promise<components["schemas"]["
|
|
2085
|
+
}, options?: RequestOptions$3): Promise<components["schemas"]["CollectionResponse"]>;
|
|
2088
2086
|
/**
|
|
2089
2087
|
*
|
|
2090
2088
|
* Update collection
|
|
@@ -2100,7 +2098,7 @@ declare class CollectionsResource {
|
|
|
2100
2098
|
update(params: {
|
|
2101
2099
|
/** The unique identifier of the collection to update */id: string;
|
|
2102
2100
|
body: components["schemas"]["UpdateCollectionRequest"];
|
|
2103
|
-
}, options?: RequestOptions$3): Promise<components["schemas"]["
|
|
2101
|
+
}, options?: RequestOptions$3): Promise<components["schemas"]["CollectionResponse"]>;
|
|
2104
2102
|
}
|
|
2105
2103
|
//#endregion
|
|
2106
2104
|
//#region src/resources/connectors.d.ts
|
|
@@ -2121,7 +2119,7 @@ declare class ConnectorsResource {
|
|
|
2121
2119
|
connect(params: {
|
|
2122
2120
|
provider: string;
|
|
2123
2121
|
body: components["schemas"]["ConnectRequest"];
|
|
2124
|
-
}, options?: RequestOptions$2): Promise<components["schemas"]["
|
|
2122
|
+
}, options?: RequestOptions$2): Promise<components["schemas"]["ConnectorConnectResponse"]>;
|
|
2125
2123
|
/**
|
|
2126
2124
|
*
|
|
2127
2125
|
* Disconnect an external data source
|
|
@@ -2133,7 +2131,7 @@ declare class ConnectorsResource {
|
|
|
2133
2131
|
disconnect(params: {
|
|
2134
2132
|
connectionId: string;
|
|
2135
2133
|
deleteMemories?: boolean;
|
|
2136
|
-
}, options?: RequestOptions$2): Promise<components["schemas"]["
|
|
2134
|
+
}, options?: RequestOptions$2): Promise<components["schemas"]["ConnectorDisconnectResponse"]>;
|
|
2137
2135
|
/**
|
|
2138
2136
|
*
|
|
2139
2137
|
* List active connections for a collection
|
|
@@ -2144,7 +2142,7 @@ declare class ConnectorsResource {
|
|
|
2144
2142
|
*/
|
|
2145
2143
|
list(params: {
|
|
2146
2144
|
collectionId: string;
|
|
2147
|
-
}, options?: RequestOptions$2): Promise<components["schemas"]["
|
|
2145
|
+
}, options?: RequestOptions$2): Promise<Array<components["schemas"]["ConnectorConnectionResponse"]>>;
|
|
2148
2146
|
/**
|
|
2149
2147
|
*
|
|
2150
2148
|
* List available connector providers
|
|
@@ -2153,7 +2151,7 @@ declare class ConnectorsResource {
|
|
|
2153
2151
|
* @operationId connectors.listProviders
|
|
2154
2152
|
* @endpoint GET /v1/connectors/providers
|
|
2155
2153
|
*/
|
|
2156
|
-
listProviders(options?: RequestOptions$2): Promise<
|
|
2154
|
+
listProviders(options?: RequestOptions$2): Promise<Array<string>>;
|
|
2157
2155
|
/**
|
|
2158
2156
|
*
|
|
2159
2157
|
* Get a single connection by ID
|
|
@@ -2162,7 +2160,7 @@ declare class ConnectorsResource {
|
|
|
2162
2160
|
* @operationId connectors.retrieve
|
|
2163
2161
|
* @endpoint GET /v1/connectors/{connection_id}
|
|
2164
2162
|
*/
|
|
2165
|
-
retrieve(connectionId: string, options?: RequestOptions$2): Promise<components["schemas"]["
|
|
2163
|
+
retrieve(connectionId: string, options?: RequestOptions$2): Promise<components["schemas"]["ConnectorConnectionResponse"]>;
|
|
2166
2164
|
/**
|
|
2167
2165
|
*
|
|
2168
2166
|
* Manually trigger a sync
|
|
@@ -2171,7 +2169,7 @@ declare class ConnectorsResource {
|
|
|
2171
2169
|
* @operationId connectors.sync
|
|
2172
2170
|
* @endpoint POST /v1/connectors/{connection_id}/sync
|
|
2173
2171
|
*/
|
|
2174
|
-
sync(connectionId: string, options?: RequestOptions$2): Promise<components["schemas"]["
|
|
2172
|
+
sync(connectionId: string, options?: RequestOptions$2): Promise<components["schemas"]["ConnectorSyncResponse"]>;
|
|
2175
2173
|
}
|
|
2176
2174
|
//#endregion
|
|
2177
2175
|
//#region src/resources/memories.d.ts
|
|
@@ -2200,7 +2198,7 @@ declare class MemoriesResource {
|
|
|
2200
2198
|
append(params: {
|
|
2201
2199
|
/** The unique identifier of the engram */id: string;
|
|
2202
2200
|
body: components["schemas"]["AppendMemoryRequest"];
|
|
2203
|
-
}, options?: RequestOptions$1): Promise<
|
|
2201
|
+
}, options?: RequestOptions$1): Promise<components["schemas"]["AppendMemoryResponse"] | components["schemas"]["IngestionResponse"]>;
|
|
2204
2202
|
/**
|
|
2205
2203
|
*
|
|
2206
2204
|
* Create a new memory (conversation or document)
|
|
@@ -2217,9 +2215,7 @@ declare class MemoriesResource {
|
|
|
2217
2215
|
* @operationId memories.create
|
|
2218
2216
|
* @endpoint POST /v1/memories
|
|
2219
2217
|
*/
|
|
2220
|
-
create(
|
|
2221
|
-
body: components["schemas"]["CreateMemoryRequest"];
|
|
2222
|
-
}, options?: RequestOptions$1): Promise<components["schemas"]["MemoryCreateResponse"]>;
|
|
2218
|
+
create(body: components["schemas"]["CreateMemoryRequest"], options?: RequestOptions$1): Promise<components["schemas"]["MemoryCreateAcceptedResponse"] | components["schemas"]["SnapshotMutationResult"]>;
|
|
2223
2219
|
/**
|
|
2224
2220
|
*
|
|
2225
2221
|
* Get presigned URL for large file upload
|
|
@@ -2249,7 +2245,7 @@ declare class MemoriesResource {
|
|
|
2249
2245
|
/** Original filename (e.g., 'image.jpg') */filename: string; /** MIME type (e.g., 'image/jpeg', 'application/pdf') */
|
|
2250
2246
|
contentType: string; /** Expected file size in bytes (max 100MB) */
|
|
2251
2247
|
fileSize: number;
|
|
2252
|
-
}, options?: RequestOptions$1): Promise<components["schemas"]["
|
|
2248
|
+
}, options?: RequestOptions$1): Promise<components["schemas"]["PresignedUploadResponse"]>;
|
|
2253
2249
|
/**
|
|
2254
2250
|
*
|
|
2255
2251
|
* Delete an engram
|
|
@@ -2263,7 +2259,7 @@ declare class MemoriesResource {
|
|
|
2263
2259
|
* @operationId memories.delete
|
|
2264
2260
|
* @endpoint DELETE /v1/memories/{id}
|
|
2265
2261
|
*/
|
|
2266
|
-
delete(id: string, options?: RequestOptions$1): Promise<components["schemas"]["
|
|
2262
|
+
delete(id: string, options?: RequestOptions$1): Promise<components["schemas"]["GenericBooleanResponse"]>;
|
|
2267
2263
|
/**
|
|
2268
2264
|
*
|
|
2269
2265
|
* Delete one or more engrams
|
|
@@ -2282,9 +2278,7 @@ declare class MemoriesResource {
|
|
|
2282
2278
|
* @operationId memories.deleteMany
|
|
2283
2279
|
* @endpoint POST /v1/memories/delete
|
|
2284
2280
|
*/
|
|
2285
|
-
deleteMany(
|
|
2286
|
-
body: components["schemas"]["DeleteMemoriesRequest"];
|
|
2287
|
-
}, options?: RequestOptions$1): Promise<unknown>;
|
|
2281
|
+
deleteMany(body: components["schemas"]["DeleteMemoriesRequest"], options?: RequestOptions$1): Promise<unknown>;
|
|
2288
2282
|
/**
|
|
2289
2283
|
*
|
|
2290
2284
|
* Delete a previously uploaded S3 file
|
|
@@ -2296,7 +2290,7 @@ declare class MemoriesResource {
|
|
|
2296
2290
|
*/
|
|
2297
2291
|
deleteUpload(params: {
|
|
2298
2292
|
/** S3 key of the file to delete (returned by POST /memories/upload) */s3Key: string;
|
|
2299
|
-
}, options?: RequestOptions$1): Promise<components["schemas"]["
|
|
2293
|
+
}, options?: RequestOptions$1): Promise<components["schemas"]["GenericMessageResponse"]>;
|
|
2300
2294
|
/**
|
|
2301
2295
|
*
|
|
2302
2296
|
* List engrams
|
|
@@ -2340,9 +2334,7 @@ declare class MemoriesResource {
|
|
|
2340
2334
|
* @operationId memories.recallWorkflow
|
|
2341
2335
|
* @endpoint POST /v1/memories/workflow/recall
|
|
2342
2336
|
*/
|
|
2343
|
-
recallWorkflow(
|
|
2344
|
-
body: components["schemas"]["CursorRecallRequest"] | components["schemas"]["PredictRecallRequest"] | components["schemas"]["ResumeRecallRequest"] | components["schemas"]["EvidenceRecallRequest"] | components["schemas"]["BootstrapRecallRequest"];
|
|
2345
|
-
}, options?: RequestOptions$1): Promise<components["schemas"]["WorkflowRecallResponse"]>;
|
|
2337
|
+
recallWorkflow(body: components["schemas"]["CursorRecallRequest"] | components["schemas"]["PredictRecallRequest"] | components["schemas"]["ResumeRecallRequest"] | components["schemas"]["EvidenceRecallRequest"] | components["schemas"]["BootstrapRecallRequest"], options?: RequestOptions$1): Promise<Record<string, unknown>>;
|
|
2346
2338
|
/**
|
|
2347
2339
|
*
|
|
2348
2340
|
* Retrieve an engram
|
|
@@ -2358,7 +2350,7 @@ declare class MemoriesResource {
|
|
|
2358
2350
|
* @operationId memories.retrieve
|
|
2359
2351
|
* @endpoint GET /v1/memories/{id}
|
|
2360
2352
|
*/
|
|
2361
|
-
retrieve(id: string, options?: RequestOptions$1): Promise<components["schemas"]["
|
|
2353
|
+
retrieve(id: string, options?: RequestOptions$1): Promise<components["schemas"]["Engram"]>;
|
|
2362
2354
|
/**
|
|
2363
2355
|
*
|
|
2364
2356
|
* Search memories
|
|
@@ -2373,9 +2365,7 @@ declare class MemoriesResource {
|
|
|
2373
2365
|
* @operationId memories.search
|
|
2374
2366
|
* @endpoint POST /v1/memories/search
|
|
2375
2367
|
*/
|
|
2376
|
-
search(
|
|
2377
|
-
body: components["schemas"]["MemorySearchRequest"];
|
|
2378
|
-
}, options?: RequestOptions$1): Promise<unknown>;
|
|
2368
|
+
search(body: components["schemas"]["MemorySearchRequest"], options?: RequestOptions$1): Promise<components["schemas"]["CompactMemoryRecallResponse"] | components["schemas"]["MemoryRecall"] | components["schemas"]["SnapshotSearchResult"]>;
|
|
2379
2369
|
/**
|
|
2380
2370
|
*
|
|
2381
2371
|
* Update a memory
|
|
@@ -2400,7 +2390,7 @@ declare class MemoriesResource {
|
|
|
2400
2390
|
/** The unique identifier of the memory */id: string; /** Collection context for copy-on-write. If provided and engram is shared, creates a copy before modification. */
|
|
2401
2391
|
collectionId?: string | null;
|
|
2402
2392
|
body: components["schemas"]["UpdateMemoryRequest"];
|
|
2403
|
-
}, options?: RequestOptions$1): Promise<components["schemas"]["
|
|
2393
|
+
}, options?: RequestOptions$1): Promise<components["schemas"]["Engram"]>;
|
|
2404
2394
|
}
|
|
2405
2395
|
//#endregion
|
|
2406
2396
|
//#region src/resources/snapshots.d.ts
|
|
@@ -2419,9 +2409,7 @@ declare class SnapshotsResource {
|
|
|
2419
2409
|
* @operationId snapshots.export
|
|
2420
2410
|
* @endpoint POST /v1/device-memory/snapshot/export
|
|
2421
2411
|
*/
|
|
2422
|
-
export(
|
|
2423
|
-
body: components["schemas"]["SnapshotExportRequest"];
|
|
2424
|
-
}, options?: RequestOptions): Promise<components["schemas"]["WrappedSnapshotEnvelope"]>;
|
|
2412
|
+
export(body: components["schemas"]["SnapshotExportRequest"], options?: RequestOptions): Promise<components["schemas"]["SnapshotEnvelope-Output"]>;
|
|
2425
2413
|
/**
|
|
2426
2414
|
*
|
|
2427
2415
|
* Import a snapshot into an ephemeral collection
|
|
@@ -2431,9 +2419,7 @@ declare class SnapshotsResource {
|
|
|
2431
2419
|
* @operationId snapshots.import
|
|
2432
2420
|
* @endpoint POST /v1/device-memory/snapshot/import
|
|
2433
2421
|
*/
|
|
2434
|
-
import(
|
|
2435
|
-
body: components["schemas"]["SnapshotImportRequest"];
|
|
2436
|
-
}, options?: RequestOptions): Promise<components["schemas"]["WrappedSnapshotImportResult"]>;
|
|
2422
|
+
import(body: components["schemas"]["SnapshotImportRequest"], options?: RequestOptions): Promise<components["schemas"]["SnapshotImportResult"]>;
|
|
2437
2423
|
}
|
|
2438
2424
|
//#endregion
|
|
2439
2425
|
//#region src/client.d.ts
|
|
@@ -2503,66 +2489,16 @@ declare class NebulaServerError extends NebulaAPIError {
|
|
|
2503
2489
|
}
|
|
2504
2490
|
declare function errorFromResponse(payload: APIErrorPayload, retryAfter?: number): NebulaAPIError;
|
|
2505
2491
|
//#endregion
|
|
2506
|
-
//#region src/lib/_dx_generated.d.ts
|
|
2507
|
-
/**
|
|
2508
|
-
* Conditional type matching the runtime envelope-unwrap. If T has a
|
|
2509
|
-
* `results` field, narrow to it; otherwise pass through.
|
|
2510
|
-
*/
|
|
2511
|
-
type Unwrapped<T> = T extends {
|
|
2512
|
-
results: infer R;
|
|
2513
|
-
} ? R : T;
|
|
2514
|
-
/**
|
|
2515
|
-
* Generated DX layer: simple unwrap/passthrough convenience methods.
|
|
2516
|
-
* Signatures are derived from the underlying resource methods so
|
|
2517
|
-
* callers see the same arg names + types in IDE hover.
|
|
2518
|
-
*/
|
|
2519
|
-
declare class NebulaDX extends NebulaClient {
|
|
2520
|
-
/** Retrieve a single memory by id and return just the data. (generated from dx-extensions.yaml). */
|
|
2521
|
-
getMemory(...args: Parameters<NebulaClient["memories"]["retrieve"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["memories"]["retrieve"]>>>>;
|
|
2522
|
-
/** Update a memory by id; returns the updated record. (generated from dx-extensions.yaml). */
|
|
2523
|
-
updateMemory(...args: Parameters<NebulaClient["memories"]["update"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["memories"]["update"]>>>>;
|
|
2524
|
-
/** Liveness probe with the wire envelope unwrapped. (generated from dx-extensions.yaml). */
|
|
2525
|
-
healthCheck(...args: Parameters<NebulaClient["client"]["health"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["client"]["health"]>>>>;
|
|
2526
|
-
/** unwrap → collections.create (generated from dx-extensions.yaml). */
|
|
2527
|
-
createCollection(...args: Parameters<NebulaClient["collections"]["create"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["collections"]["create"]>>>>;
|
|
2528
|
-
/** unwrap → collections.retrieve (generated from dx-extensions.yaml). */
|
|
2529
|
-
getCollection(...args: Parameters<NebulaClient["collections"]["retrieve"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["collections"]["retrieve"]>>>>;
|
|
2530
|
-
/** unwrap → collections.retrieveByName (generated from dx-extensions.yaml). */
|
|
2531
|
-
getCollectionByName(...args: Parameters<NebulaClient["collections"]["retrieveByName"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["collections"]["retrieveByName"]>>>>;
|
|
2532
|
-
/** unwrap → collections.list (generated from dx-extensions.yaml). */
|
|
2533
|
-
listCollections(...args: Parameters<NebulaClient["collections"]["list"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["collections"]["list"]>>>>;
|
|
2534
|
-
/** unwrap → collections.update (generated from dx-extensions.yaml). */
|
|
2535
|
-
updateCollection(...args: Parameters<NebulaClient["collections"]["update"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["collections"]["update"]>>>>;
|
|
2536
|
-
/** unwrap → connectors.listProviders (generated from dx-extensions.yaml). */
|
|
2537
|
-
listProviders(...args: Parameters<NebulaClient["connectors"]["listProviders"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["connectors"]["listProviders"]>>>>;
|
|
2538
|
-
/** unwrap → connectors.retrieve (generated from dx-extensions.yaml). */
|
|
2539
|
-
getConnection(...args: Parameters<NebulaClient["connectors"]["retrieve"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["connectors"]["retrieve"]>>>>;
|
|
2540
|
-
/** unwrap → connectors.sync (generated from dx-extensions.yaml). */
|
|
2541
|
-
triggerSync(...args: Parameters<NebulaClient["connectors"]["sync"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["connectors"]["sync"]>>>>;
|
|
2542
|
-
/** unwrap → memories.createUpload (generated from dx-extensions.yaml). */
|
|
2543
|
-
getUploadUrl(...args: Parameters<NebulaClient["memories"]["createUpload"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["memories"]["createUpload"]>>>>;
|
|
2544
|
-
/** unwrap → snapshots.export (generated from dx-extensions.yaml). */
|
|
2545
|
-
exportSnapshot(...args: Parameters<NebulaClient["snapshots"]["export"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["snapshots"]["export"]>>>>;
|
|
2546
|
-
/** unwrap → snapshots.import (generated from dx-extensions.yaml). */
|
|
2547
|
-
importSnapshot(...args: Parameters<NebulaClient["snapshots"]["import"]>): Promise<Unwrapped<Awaited<ReturnType<NebulaClient["snapshots"]["import"]>>>>;
|
|
2548
|
-
}
|
|
2549
|
-
//#endregion
|
|
2550
2492
|
//#region src/lib/dx.d.ts
|
|
2551
2493
|
type Schemas = components["schemas"];
|
|
2552
2494
|
type SnapshotEnvelopeInput = Schemas["SnapshotEnvelope-Input"];
|
|
2553
2495
|
type SnapshotEnvelopeOutput = Schemas["SnapshotEnvelope-Output"];
|
|
2554
|
-
type RequestPath = `/${string}` | `http://${string}` | `https://${string}`;
|
|
2555
2496
|
type CompatClientOptions = ClientOptions & {
|
|
2556
|
-
api_key?: string | null;
|
|
2557
2497
|
apiKey?: string | null;
|
|
2558
2498
|
baseUrl?: string | null;
|
|
2559
2499
|
baseURL?: string | null;
|
|
2560
|
-
base_url?: string | null;
|
|
2561
2500
|
timeout?: number | null;
|
|
2562
|
-
accessToken?: string | null;
|
|
2563
2501
|
bearerToken?: string | null;
|
|
2564
|
-
bearer_token?: string | null;
|
|
2565
|
-
access_token?: string | null;
|
|
2566
2502
|
};
|
|
2567
2503
|
interface MemoryCommonInput {
|
|
2568
2504
|
collection_id?: string | null;
|
|
@@ -2578,6 +2514,7 @@ interface MemoryCommonInput {
|
|
|
2578
2514
|
ingestion_mode?: string | null;
|
|
2579
2515
|
}
|
|
2580
2516
|
interface MemoryCreateInput extends MemoryCommonInput {
|
|
2517
|
+
kind?: Schemas["EngramKind"] | null;
|
|
2581
2518
|
name?: string | null;
|
|
2582
2519
|
speaker_id?: string | null;
|
|
2583
2520
|
speaker_name?: string | null;
|
|
@@ -2592,7 +2529,7 @@ interface MemoryAppendInput extends Omit<MemoryCommonInput, "ingestion_mode" | "
|
|
|
2592
2529
|
messages?: unknown[] | null;
|
|
2593
2530
|
}
|
|
2594
2531
|
type MemoryInput = MemoryCreateInput | MemoryAppendInput;
|
|
2595
|
-
declare class Nebula extends
|
|
2532
|
+
declare class Nebula extends NebulaClient {
|
|
2596
2533
|
constructor(options?: CompatClientOptions);
|
|
2597
2534
|
/**
|
|
2598
2535
|
* Polymorphic memory creator: dispatches to memories.create or memories.append
|
|
@@ -2621,167 +2558,6 @@ declare class Nebula extends NebulaDX {
|
|
|
2621
2558
|
listMemories(query: string | string[] | Record<string, unknown>, options?: {
|
|
2622
2559
|
signal?: AbortSignal;
|
|
2623
2560
|
}): Promise<unknown>;
|
|
2624
|
-
/**
|
|
2625
|
-
* Memory search shortcut: unwraps `results`. (Affinity-header injection
|
|
2626
|
-
* is a planned enhancement; currently delegates straight to the resource.)
|
|
2627
|
-
*/
|
|
2628
|
-
search(body: Schemas["MemorySearchRequest"], options?: {
|
|
2629
|
-
signal?: AbortSignal;
|
|
2630
|
-
}): Promise<unknown>;
|
|
2631
|
-
/**
|
|
2632
|
-
* deleteCollection coerces the wire {success: bool} envelope into a Python-
|
|
2633
|
-
* style boolean return.
|
|
2634
|
-
*/
|
|
2635
|
-
deleteCollection(id: string, options?: {
|
|
2636
|
-
signal?: AbortSignal;
|
|
2637
|
-
}): Promise<boolean>;
|
|
2638
|
-
createCluster: (params: {
|
|
2639
|
-
body: components["schemas"]["CreateCollectionRequest"];
|
|
2640
|
-
}, options?: RequestOptions$3 | undefined) => Promise<{
|
|
2641
|
-
access_tier: string | null;
|
|
2642
|
-
cache_policy: string | null;
|
|
2643
|
-
chain_type?: string | null;
|
|
2644
|
-
contract_address?: string | null;
|
|
2645
|
-
created_at: string;
|
|
2646
|
-
creator_royalty_bps: number | null;
|
|
2647
|
-
description: string | null;
|
|
2648
|
-
engram_count: number;
|
|
2649
|
-
graph_collection_status: string;
|
|
2650
|
-
graph_sync_status: string;
|
|
2651
|
-
has_preview_access?: boolean | null;
|
|
2652
|
-
id: string;
|
|
2653
|
-
is_forked?: boolean | null;
|
|
2654
|
-
marketplace_metadata?: {
|
|
2655
|
-
[key: string]: unknown;
|
|
2656
|
-
} | null;
|
|
2657
|
-
memory_count: number | null;
|
|
2658
|
-
name: string;
|
|
2659
|
-
nft_collection_address?: string | null;
|
|
2660
|
-
owner_email?: string | null;
|
|
2661
|
-
owner_id: string | null;
|
|
2662
|
-
owner_name?: string | null;
|
|
2663
|
-
preview_query_limit: number | null;
|
|
2664
|
-
purchase_price_usd?: string | null;
|
|
2665
|
-
rental_price_monthly_usd?: string | null;
|
|
2666
|
-
updated_at: string;
|
|
2667
|
-
user_count: number;
|
|
2668
|
-
workflows_enabled: boolean;
|
|
2669
|
-
workspace_id?: string | null;
|
|
2670
|
-
}>;
|
|
2671
|
-
getCluster: (id: string, options?: RequestOptions$3 | undefined) => Promise<{
|
|
2672
|
-
access_tier: string | null;
|
|
2673
|
-
cache_policy: string | null;
|
|
2674
|
-
chain_type?: string | null;
|
|
2675
|
-
contract_address?: string | null;
|
|
2676
|
-
created_at: string;
|
|
2677
|
-
creator_royalty_bps: number | null;
|
|
2678
|
-
description: string | null;
|
|
2679
|
-
engram_count: number;
|
|
2680
|
-
graph_collection_status: string;
|
|
2681
|
-
graph_sync_status: string;
|
|
2682
|
-
has_preview_access?: boolean | null;
|
|
2683
|
-
id: string;
|
|
2684
|
-
is_forked?: boolean | null;
|
|
2685
|
-
marketplace_metadata?: {
|
|
2686
|
-
[key: string]: unknown;
|
|
2687
|
-
} | null;
|
|
2688
|
-
memory_count: number | null;
|
|
2689
|
-
name: string;
|
|
2690
|
-
nft_collection_address?: string | null;
|
|
2691
|
-
owner_email?: string | null;
|
|
2692
|
-
owner_id: string | null;
|
|
2693
|
-
owner_name?: string | null;
|
|
2694
|
-
preview_query_limit: number | null;
|
|
2695
|
-
purchase_price_usd?: string | null;
|
|
2696
|
-
rental_price_monthly_usd?: string | null;
|
|
2697
|
-
updated_at: string;
|
|
2698
|
-
user_count: number;
|
|
2699
|
-
workflows_enabled: boolean;
|
|
2700
|
-
workspace_id?: string | null;
|
|
2701
|
-
}>;
|
|
2702
|
-
getClusterByName: (params: {
|
|
2703
|
-
collectionName: string;
|
|
2704
|
-
ownerId?: string | null;
|
|
2705
|
-
}, options?: RequestOptions$3 | undefined) => Promise<{
|
|
2706
|
-
access_tier: string | null;
|
|
2707
|
-
cache_policy: string | null;
|
|
2708
|
-
chain_type?: string | null;
|
|
2709
|
-
contract_address?: string | null;
|
|
2710
|
-
created_at: string;
|
|
2711
|
-
creator_royalty_bps: number | null;
|
|
2712
|
-
description: string | null;
|
|
2713
|
-
engram_count: number;
|
|
2714
|
-
graph_collection_status: string;
|
|
2715
|
-
graph_sync_status: string;
|
|
2716
|
-
has_preview_access?: boolean | null;
|
|
2717
|
-
id: string;
|
|
2718
|
-
is_forked?: boolean | null;
|
|
2719
|
-
marketplace_metadata?: {
|
|
2720
|
-
[key: string]: unknown;
|
|
2721
|
-
} | null;
|
|
2722
|
-
memory_count: number | null;
|
|
2723
|
-
name: string;
|
|
2724
|
-
nft_collection_address?: string | null;
|
|
2725
|
-
owner_email?: string | null;
|
|
2726
|
-
owner_id: string | null;
|
|
2727
|
-
owner_name?: string | null;
|
|
2728
|
-
preview_query_limit: number | null;
|
|
2729
|
-
purchase_price_usd?: string | null;
|
|
2730
|
-
rental_price_monthly_usd?: string | null;
|
|
2731
|
-
updated_at: string;
|
|
2732
|
-
user_count: number;
|
|
2733
|
-
workflows_enabled: boolean;
|
|
2734
|
-
workspace_id?: string | null;
|
|
2735
|
-
}>;
|
|
2736
|
-
listClusters: (params?: {
|
|
2737
|
-
ids?: Array<string>;
|
|
2738
|
-
name?: string | null;
|
|
2739
|
-
cursor?: string | null;
|
|
2740
|
-
limit?: number;
|
|
2741
|
-
ownerOnly?: boolean;
|
|
2742
|
-
workspaceId?: string | null;
|
|
2743
|
-
} | undefined, options?: RequestOptions$3 | undefined) => Promise<{
|
|
2744
|
-
data: components["schemas"]["CollectionResponse"][];
|
|
2745
|
-
has_more: boolean;
|
|
2746
|
-
next_cursor?: string | null;
|
|
2747
|
-
}>;
|
|
2748
|
-
updateCluster: (params: {
|
|
2749
|
-
id: string;
|
|
2750
|
-
body: components["schemas"]["UpdateCollectionRequest"];
|
|
2751
|
-
}, options?: RequestOptions$3 | undefined) => Promise<{
|
|
2752
|
-
access_tier: string | null;
|
|
2753
|
-
cache_policy: string | null;
|
|
2754
|
-
chain_type?: string | null;
|
|
2755
|
-
contract_address?: string | null;
|
|
2756
|
-
created_at: string;
|
|
2757
|
-
creator_royalty_bps: number | null;
|
|
2758
|
-
description: string | null;
|
|
2759
|
-
engram_count: number;
|
|
2760
|
-
graph_collection_status: string;
|
|
2761
|
-
graph_sync_status: string;
|
|
2762
|
-
has_preview_access?: boolean | null;
|
|
2763
|
-
id: string;
|
|
2764
|
-
is_forked?: boolean | null;
|
|
2765
|
-
marketplace_metadata?: {
|
|
2766
|
-
[key: string]: unknown;
|
|
2767
|
-
} | null;
|
|
2768
|
-
memory_count: number | null;
|
|
2769
|
-
name: string;
|
|
2770
|
-
nft_collection_address?: string | null;
|
|
2771
|
-
owner_email?: string | null;
|
|
2772
|
-
owner_id: string | null;
|
|
2773
|
-
owner_name?: string | null;
|
|
2774
|
-
preview_query_limit: number | null;
|
|
2775
|
-
purchase_price_usd?: string | null;
|
|
2776
|
-
rental_price_monthly_usd?: string | null;
|
|
2777
|
-
updated_at: string;
|
|
2778
|
-
user_count: number;
|
|
2779
|
-
workflows_enabled: boolean;
|
|
2780
|
-
workspace_id?: string | null;
|
|
2781
|
-
}>;
|
|
2782
|
-
deleteCluster: (id: string, options?: {
|
|
2783
|
-
signal?: AbortSignal;
|
|
2784
|
-
}) => Promise<boolean>;
|
|
2785
2561
|
/**
|
|
2786
2562
|
* Positional `connectProvider(provider, collectionID, config?)` — wraps the
|
|
2787
2563
|
* generated `connectors.connect({provider, body})` to build the body shape.
|
|
@@ -2801,23 +2577,6 @@ declare class Nebula extends NebulaDX {
|
|
|
2801
2577
|
disconnect(connectionID: string, deleteMemories?: boolean, options?: {
|
|
2802
2578
|
signal?: AbortSignal;
|
|
2803
2579
|
}): Promise<unknown>;
|
|
2804
|
-
/** Single-id delete; coerces 204 to boolean true. */
|
|
2805
|
-
deleteMemory(memoryID: string, options?: {
|
|
2806
|
-
signal?: AbortSignal;
|
|
2807
|
-
}): Promise<boolean>;
|
|
2808
|
-
/** Bulk delete by ids. */
|
|
2809
|
-
deleteMemories(memoryIDs: string[], options?: {
|
|
2810
|
-
signal?: AbortSignal;
|
|
2811
|
-
}): Promise<unknown>;
|
|
2812
|
-
/**
|
|
2813
|
-
* Polymorphic delete: dispatches based on argument type.
|
|
2814
|
-
* - `delete("/some/path")` -> raw HTTP DELETE (escape hatch; not implemented)
|
|
2815
|
-
* - `delete("memory-id")` -> deleteMemory
|
|
2816
|
-
* - `delete(["id1", "id2"])` -> deleteMemories (bulk)
|
|
2817
|
-
*/
|
|
2818
|
-
delete(pathOrMemoryIDs: RequestPath | string | string[], options?: {
|
|
2819
|
-
signal?: AbortSignal;
|
|
2820
|
-
}): Promise<unknown>;
|
|
2821
2580
|
}
|
|
2822
2581
|
//#endregion
|
|
2823
2582
|
export { type APIErrorPayload, type ClientOptions, type CompatClientOptions, DEFAULT_RETRY, Nebula, Nebula as default, NebulaAPIError, NebulaBadRequestError, NebulaClient, NebulaConflictError, NebulaConnectionError, NebulaCore, NebulaError, NebulaForbiddenError, NebulaNotFoundError, NebulaRateLimitError, NebulaServerError, NebulaTimeoutError, NebulaUnauthorizedError, NebulaValidationError, type RequestArgs, type RetryPolicy, backoffMs, type components, errorFromResponse, isRetryableStatus, sleep };
|