@vectorize-io/hindsight-client 0.3.0 → 0.4.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.
@@ -7,7 +7,7 @@ export type ClientOptions = {
7
7
  /**
8
8
  * AddBackgroundRequest
9
9
  *
10
- * Request model for adding/merging background information.
10
+ * Request model for adding/merging background information. Deprecated: use SetMissionRequest instead.
11
11
  */
12
12
  export type AddBackgroundRequest = {
13
13
  /**
@@ -19,21 +19,43 @@ export type AddBackgroundRequest = {
19
19
  /**
20
20
  * Update Disposition
21
21
  *
22
- * If true, infer disposition traits from the merged background (default: true)
22
+ * Deprecated - disposition is no longer auto-inferred from mission
23
23
  */
24
24
  update_disposition?: boolean;
25
25
  };
26
26
 
27
+ /**
28
+ * AsyncOperationSubmitResponse
29
+ *
30
+ * Response model for submitting an async operation.
31
+ */
32
+ export type AsyncOperationSubmitResponse = {
33
+ /**
34
+ * Operation Id
35
+ */
36
+ operation_id: string;
37
+ /**
38
+ * Status
39
+ */
40
+ status: string;
41
+ };
42
+
27
43
  /**
28
44
  * BackgroundResponse
29
45
  *
30
- * Response model for background update.
46
+ * Response model for background update. Deprecated: use MissionResponse instead.
31
47
  */
32
48
  export type BackgroundResponse = {
49
+ /**
50
+ * Mission
51
+ */
52
+ mission: string;
33
53
  /**
34
54
  * Background
55
+ *
56
+ * Deprecated: same as mission
35
57
  */
36
- background: string;
58
+ background?: string | null;
37
59
  disposition?: DispositionTraits | null;
38
60
  };
39
61
 
@@ -53,9 +75,9 @@ export type BankListItem = {
53
75
  name?: string | null;
54
76
  disposition: DispositionTraits;
55
77
  /**
56
- * Background
78
+ * Mission
57
79
  */
58
- background?: string | null;
80
+ mission?: string | null;
59
81
  /**
60
82
  * Created At
61
83
  */
@@ -93,10 +115,18 @@ export type BankProfileResponse = {
93
115
  */
94
116
  name: string;
95
117
  disposition: DispositionTraits;
118
+ /**
119
+ * Mission
120
+ *
121
+ * The agent's mission - who they are and what they're trying to accomplish
122
+ */
123
+ mission: string;
96
124
  /**
97
125
  * Background
126
+ *
127
+ * Deprecated: use mission instead
98
128
  */
99
- background: string;
129
+ background?: string | null;
100
130
  };
101
131
 
102
132
  /**
@@ -155,6 +185,24 @@ export type BankStatsResponse = {
155
185
  * Failed Operations
156
186
  */
157
187
  failed_operations: number;
188
+ /**
189
+ * Last Consolidated At
190
+ *
191
+ * When consolidation last ran (ISO format)
192
+ */
193
+ last_consolidated_at?: string | null;
194
+ /**
195
+ * Pending Consolidation
196
+ *
197
+ * Number of memories not yet processed into observations
198
+ */
199
+ pending_consolidation?: number;
200
+ /**
201
+ * Total Observations
202
+ *
203
+ * Total number of observations
204
+ */
205
+ total_observations?: number;
158
206
  };
159
207
 
160
208
  /**
@@ -256,6 +304,26 @@ export type ChunkResponse = {
256
304
  created_at: string;
257
305
  };
258
306
 
307
+ /**
308
+ * ConsolidationResponse
309
+ *
310
+ * Response model for consolidation trigger endpoint.
311
+ */
312
+ export type ConsolidationResponse = {
313
+ /**
314
+ * Operation Id
315
+ *
316
+ * ID of the async consolidation operation
317
+ */
318
+ operation_id: string;
319
+ /**
320
+ * Deduplicated
321
+ *
322
+ * True if an existing pending task was reused
323
+ */
324
+ deduplicated?: boolean;
325
+ };
326
+
259
327
  /**
260
328
  * CreateBankRequest
261
329
  *
@@ -267,12 +335,108 @@ export type CreateBankRequest = {
267
335
  */
268
336
  name?: string | null;
269
337
  disposition?: DispositionTraits | null;
338
+ /**
339
+ * Mission
340
+ *
341
+ * The agent's mission
342
+ */
343
+ mission?: string | null;
270
344
  /**
271
345
  * Background
346
+ *
347
+ * Deprecated: use mission instead
272
348
  */
273
349
  background?: string | null;
274
350
  };
275
351
 
352
+ /**
353
+ * CreateDirectiveRequest
354
+ *
355
+ * Request model for creating a directive.
356
+ */
357
+ export type CreateDirectiveRequest = {
358
+ /**
359
+ * Name
360
+ *
361
+ * Human-readable name for the directive
362
+ */
363
+ name: string;
364
+ /**
365
+ * Content
366
+ *
367
+ * The directive text to inject into prompts
368
+ */
369
+ content: string;
370
+ /**
371
+ * Priority
372
+ *
373
+ * Higher priority directives are injected first
374
+ */
375
+ priority?: number;
376
+ /**
377
+ * Is Active
378
+ *
379
+ * Whether this directive is active
380
+ */
381
+ is_active?: boolean;
382
+ /**
383
+ * Tags
384
+ *
385
+ * Tags for filtering
386
+ */
387
+ tags?: Array<string>;
388
+ };
389
+
390
+ /**
391
+ * CreateMentalModelRequest
392
+ *
393
+ * Request model for creating a mental model.
394
+ */
395
+ export type CreateMentalModelRequest = {
396
+ /**
397
+ * Name
398
+ *
399
+ * Human-readable name for the mental model
400
+ */
401
+ name: string;
402
+ /**
403
+ * Source Query
404
+ *
405
+ * The query to run to generate content
406
+ */
407
+ source_query: string;
408
+ /**
409
+ * Tags
410
+ *
411
+ * Tags for scoped visibility
412
+ */
413
+ tags?: Array<string>;
414
+ /**
415
+ * Max Tokens
416
+ *
417
+ * Maximum tokens for generated content
418
+ */
419
+ max_tokens?: number;
420
+ /**
421
+ * Trigger settings
422
+ */
423
+ trigger?: MentalModelTrigger;
424
+ };
425
+
426
+ /**
427
+ * CreateMentalModelResponse
428
+ *
429
+ * Response model for mental model creation.
430
+ */
431
+ export type CreateMentalModelResponse = {
432
+ /**
433
+ * Operation Id
434
+ *
435
+ * Operation ID to track progress
436
+ */
437
+ operation_id: string;
438
+ };
439
+
276
440
  /**
277
441
  * DeleteDocumentResponse
278
442
  *
@@ -317,6 +481,62 @@ export type DeleteResponse = {
317
481
  deleted_count?: number | null;
318
482
  };
319
483
 
484
+ /**
485
+ * DirectiveListResponse
486
+ *
487
+ * Response model for listing directives.
488
+ */
489
+ export type DirectiveListResponse = {
490
+ /**
491
+ * Items
492
+ */
493
+ items: Array<DirectiveResponse>;
494
+ };
495
+
496
+ /**
497
+ * DirectiveResponse
498
+ *
499
+ * Response model for a directive.
500
+ */
501
+ export type DirectiveResponse = {
502
+ /**
503
+ * Id
504
+ */
505
+ id: string;
506
+ /**
507
+ * Bank Id
508
+ */
509
+ bank_id: string;
510
+ /**
511
+ * Name
512
+ */
513
+ name: string;
514
+ /**
515
+ * Content
516
+ */
517
+ content: string;
518
+ /**
519
+ * Priority
520
+ */
521
+ priority?: number;
522
+ /**
523
+ * Is Active
524
+ */
525
+ is_active?: boolean;
526
+ /**
527
+ * Tags
528
+ */
529
+ tags?: Array<string>;
530
+ /**
531
+ * Created At
532
+ */
533
+ created_at?: string | null;
534
+ /**
535
+ * Updated At
536
+ */
537
+ updated_at?: string | null;
538
+ };
539
+
320
540
  /**
321
541
  * DispositionTraits
322
542
  *
@@ -560,6 +780,32 @@ export type FactsIncludeOptions = {
560
780
  [key: string]: unknown;
561
781
  };
562
782
 
783
+ /**
784
+ * FeaturesInfo
785
+ *
786
+ * Feature flags indicating which capabilities are enabled.
787
+ */
788
+ export type FeaturesInfo = {
789
+ /**
790
+ * Observations
791
+ *
792
+ * Whether observations (auto-consolidation) are enabled
793
+ */
794
+ observations: boolean;
795
+ /**
796
+ * Mcp
797
+ *
798
+ * Whether MCP (Model Context Protocol) server is enabled
799
+ */
800
+ mcp: boolean;
801
+ /**
802
+ * Worker
803
+ *
804
+ * Whether the background worker is enabled
805
+ */
806
+ worker: boolean;
807
+ };
808
+
563
809
  /**
564
810
  * GraphDataResponse
565
811
  *
@@ -740,6 +986,85 @@ export type MemoryItem = {
740
986
  tags?: Array<string> | null;
741
987
  };
742
988
 
989
+ /**
990
+ * MentalModelListResponse
991
+ *
992
+ * Response model for listing mental models.
993
+ */
994
+ export type MentalModelListResponse = {
995
+ /**
996
+ * Items
997
+ */
998
+ items: Array<MentalModelResponse>;
999
+ };
1000
+
1001
+ /**
1002
+ * MentalModelResponse
1003
+ *
1004
+ * Response model for a mental model (stored reflect response).
1005
+ */
1006
+ export type MentalModelResponse = {
1007
+ /**
1008
+ * Id
1009
+ */
1010
+ id: string;
1011
+ /**
1012
+ * Bank Id
1013
+ */
1014
+ bank_id: string;
1015
+ /**
1016
+ * Name
1017
+ */
1018
+ name: string;
1019
+ /**
1020
+ * Source Query
1021
+ */
1022
+ source_query: string;
1023
+ /**
1024
+ * Content
1025
+ */
1026
+ content: string;
1027
+ /**
1028
+ * Tags
1029
+ */
1030
+ tags?: Array<string>;
1031
+ /**
1032
+ * Max Tokens
1033
+ */
1034
+ max_tokens?: number;
1035
+ trigger?: MentalModelTrigger;
1036
+ /**
1037
+ * Last Refreshed At
1038
+ */
1039
+ last_refreshed_at?: string | null;
1040
+ /**
1041
+ * Created At
1042
+ */
1043
+ created_at?: string | null;
1044
+ /**
1045
+ * Reflect Response
1046
+ *
1047
+ * Full reflect API response payload including based_on facts and observations
1048
+ */
1049
+ reflect_response?: {
1050
+ [key: string]: unknown;
1051
+ } | null;
1052
+ };
1053
+
1054
+ /**
1055
+ * MentalModelTrigger
1056
+ *
1057
+ * Trigger settings for a mental model.
1058
+ */
1059
+ export type MentalModelTrigger = {
1060
+ /**
1061
+ * Refresh After Consolidation
1062
+ *
1063
+ * If true, refresh this mental model after observations consolidation (real-time mode)
1064
+ */
1065
+ refresh_after_consolidation?: boolean;
1066
+ };
1067
+
743
1068
  /**
744
1069
  * OperationResponse
745
1070
  *
@@ -761,7 +1086,7 @@ export type OperationResponse = {
761
1086
  /**
762
1087
  * Document Id
763
1088
  */
764
- document_id: string | null;
1089
+ document_id?: string | null;
765
1090
  /**
766
1091
  * Created At
767
1092
  */
@@ -777,38 +1102,86 @@ export type OperationResponse = {
777
1102
  };
778
1103
 
779
1104
  /**
780
- * OperationsListResponse
1105
+ * OperationStatusResponse
781
1106
  *
782
- * Response model for list operations endpoint.
1107
+ * Response model for getting a single operation status.
783
1108
  */
784
- export type OperationsListResponse = {
1109
+ export type OperationStatusResponse = {
785
1110
  /**
786
- * Bank Id
1111
+ * Operation Id
787
1112
  */
788
- bank_id: string;
1113
+ operation_id: string;
789
1114
  /**
790
- * Operations
1115
+ * Status
791
1116
  */
792
- operations: Array<OperationResponse>;
793
- };
794
-
795
- /**
796
- * RecallRequest
797
- *
798
- * Request model for recall endpoint.
799
- */
800
- export type RecallRequest = {
1117
+ status: "pending" | "completed" | "failed" | "not_found";
801
1118
  /**
802
- * Query
1119
+ * Operation Type
803
1120
  */
804
- query: string;
1121
+ operation_type?: string | null;
805
1122
  /**
806
- * Types
807
- *
808
- * List of fact types to recall (defaults to all if not specified)
1123
+ * Created At
809
1124
  */
810
- types?: Array<string> | null;
811
- budget?: Budget;
1125
+ created_at?: string | null;
1126
+ /**
1127
+ * Updated At
1128
+ */
1129
+ updated_at?: string | null;
1130
+ /**
1131
+ * Completed At
1132
+ */
1133
+ completed_at?: string | null;
1134
+ /**
1135
+ * Error Message
1136
+ */
1137
+ error_message?: string | null;
1138
+ };
1139
+
1140
+ /**
1141
+ * OperationsListResponse
1142
+ *
1143
+ * Response model for list operations endpoint.
1144
+ */
1145
+ export type OperationsListResponse = {
1146
+ /**
1147
+ * Bank Id
1148
+ */
1149
+ bank_id: string;
1150
+ /**
1151
+ * Total
1152
+ */
1153
+ total: number;
1154
+ /**
1155
+ * Limit
1156
+ */
1157
+ limit: number;
1158
+ /**
1159
+ * Offset
1160
+ */
1161
+ offset: number;
1162
+ /**
1163
+ * Operations
1164
+ */
1165
+ operations: Array<OperationResponse>;
1166
+ };
1167
+
1168
+ /**
1169
+ * RecallRequest
1170
+ *
1171
+ * Request model for recall endpoint.
1172
+ */
1173
+ export type RecallRequest = {
1174
+ /**
1175
+ * Query
1176
+ */
1177
+ query: string;
1178
+ /**
1179
+ * Types
1180
+ *
1181
+ * List of fact types to recall: 'world', 'experience', 'observation'. Defaults to world and experience if not specified. Note: 'opinion' is accepted but ignored (opinions are excluded from recall).
1182
+ */
1183
+ types?: Array<string> | null;
1184
+ budget?: Budget;
812
1185
  /**
813
1186
  * Max Tokens
814
1187
  */
@@ -933,6 +1306,58 @@ export type RecallResult = {
933
1306
  tags?: Array<string> | null;
934
1307
  };
935
1308
 
1309
+ /**
1310
+ * ReflectBasedOn
1311
+ *
1312
+ * Evidence the response is based on: memories, mental models, and directives.
1313
+ */
1314
+ export type ReflectBasedOn = {
1315
+ /**
1316
+ * Memories
1317
+ *
1318
+ * Memory facts used to generate the response
1319
+ */
1320
+ memories?: Array<ReflectFact>;
1321
+ /**
1322
+ * Mental Models
1323
+ *
1324
+ * Mental models used during reflection
1325
+ */
1326
+ mental_models?: Array<ReflectMentalModel>;
1327
+ /**
1328
+ * Directives
1329
+ *
1330
+ * Directives applied during reflection
1331
+ */
1332
+ directives?: Array<ReflectDirective>;
1333
+ };
1334
+
1335
+ /**
1336
+ * ReflectDirective
1337
+ *
1338
+ * A directive applied during reflect.
1339
+ */
1340
+ export type ReflectDirective = {
1341
+ /**
1342
+ * Id
1343
+ *
1344
+ * Directive ID
1345
+ */
1346
+ id: string;
1347
+ /**
1348
+ * Name
1349
+ *
1350
+ * Directive name
1351
+ */
1352
+ name: string;
1353
+ /**
1354
+ * Content
1355
+ *
1356
+ * Directive content
1357
+ */
1358
+ content: string;
1359
+ };
1360
+
936
1361
  /**
937
1362
  * ReflectFact
938
1363
  *
@@ -975,6 +1400,56 @@ export type ReflectIncludeOptions = {
975
1400
  * Include facts that the answer is based on. Set to {} to enable, null to disable (default: disabled).
976
1401
  */
977
1402
  facts?: FactsIncludeOptions | null;
1403
+ /**
1404
+ * Include tool calls trace. Set to {} for full trace (input+output), {output: false} for inputs only.
1405
+ */
1406
+ tool_calls?: ToolCallsIncludeOptions | null;
1407
+ };
1408
+
1409
+ /**
1410
+ * ReflectLLMCall
1411
+ *
1412
+ * An LLM call made during reflect agent execution.
1413
+ */
1414
+ export type ReflectLlmCall = {
1415
+ /**
1416
+ * Scope
1417
+ *
1418
+ * Call scope: agent_1, agent_2, final, etc.
1419
+ */
1420
+ scope: string;
1421
+ /**
1422
+ * Duration Ms
1423
+ *
1424
+ * Execution time in milliseconds
1425
+ */
1426
+ duration_ms: number;
1427
+ };
1428
+
1429
+ /**
1430
+ * ReflectMentalModel
1431
+ *
1432
+ * A mental model used during reflect.
1433
+ */
1434
+ export type ReflectMentalModel = {
1435
+ /**
1436
+ * Id
1437
+ *
1438
+ * Mental model ID
1439
+ */
1440
+ id: string;
1441
+ /**
1442
+ * Text
1443
+ *
1444
+ * Mental model content
1445
+ */
1446
+ text: string;
1447
+ /**
1448
+ * Context
1449
+ *
1450
+ * Additional context
1451
+ */
1452
+ context?: string | null;
978
1453
  };
979
1454
 
980
1455
  /**
@@ -990,6 +1465,10 @@ export type ReflectRequest = {
990
1465
  budget?: Budget;
991
1466
  /**
992
1467
  * Context
1468
+ *
1469
+ * DEPRECATED: Additional context is now concatenated with the query. Pass context directly in the query field instead. If provided, it will be appended to the query for backward compatibility.
1470
+ *
1471
+ * @deprecated
993
1472
  */
994
1473
  context?: string | null;
995
1474
  /**
@@ -1035,9 +1514,9 @@ export type ReflectResponse = {
1035
1514
  */
1036
1515
  text: string;
1037
1516
  /**
1038
- * Based On
1517
+ * Evidence used to generate the response. Only present when include.facts is set.
1039
1518
  */
1040
- based_on?: Array<ReflectFact>;
1519
+ based_on?: ReflectBasedOn | null;
1041
1520
  /**
1042
1521
  * Structured Output
1043
1522
  *
@@ -1050,6 +1529,72 @@ export type ReflectResponse = {
1050
1529
  * Token usage metrics for LLM calls during reflection.
1051
1530
  */
1052
1531
  usage?: TokenUsage | null;
1532
+ /**
1533
+ * Execution trace of tool and LLM calls. Only present when include.tool_calls is set.
1534
+ */
1535
+ trace?: ReflectTrace | null;
1536
+ };
1537
+
1538
+ /**
1539
+ * ReflectToolCall
1540
+ *
1541
+ * A tool call made during reflect agent execution.
1542
+ */
1543
+ export type ReflectToolCall = {
1544
+ /**
1545
+ * Tool
1546
+ *
1547
+ * Tool name: lookup, recall, learn, expand
1548
+ */
1549
+ tool: string;
1550
+ /**
1551
+ * Input
1552
+ *
1553
+ * Tool input parameters
1554
+ */
1555
+ input: {
1556
+ [key: string]: unknown;
1557
+ };
1558
+ /**
1559
+ * Output
1560
+ *
1561
+ * Tool output (only included when include.tool_calls.output is true)
1562
+ */
1563
+ output?: {
1564
+ [key: string]: unknown;
1565
+ } | null;
1566
+ /**
1567
+ * Duration Ms
1568
+ *
1569
+ * Execution time in milliseconds
1570
+ */
1571
+ duration_ms: number;
1572
+ /**
1573
+ * Iteration
1574
+ *
1575
+ * Iteration number (1-based) when this tool was called
1576
+ */
1577
+ iteration?: number;
1578
+ };
1579
+
1580
+ /**
1581
+ * ReflectTrace
1582
+ *
1583
+ * Execution trace of LLM and tool calls during reflection.
1584
+ */
1585
+ export type ReflectTrace = {
1586
+ /**
1587
+ * Tool Calls
1588
+ *
1589
+ * Tool calls made during reflection
1590
+ */
1591
+ tool_calls?: Array<ReflectToolCall>;
1592
+ /**
1593
+ * Llm Calls
1594
+ *
1595
+ * LLM calls made during reflection
1596
+ */
1597
+ llm_calls?: Array<ReflectLlmCall>;
1053
1598
  };
1054
1599
 
1055
1600
  /**
@@ -1161,6 +1706,58 @@ export type TokenUsage = {
1161
1706
  total_tokens?: number;
1162
1707
  };
1163
1708
 
1709
+ /**
1710
+ * ToolCallsIncludeOptions
1711
+ *
1712
+ * Options for including tool calls in reflect results.
1713
+ */
1714
+ export type ToolCallsIncludeOptions = {
1715
+ /**
1716
+ * Output
1717
+ *
1718
+ * Include tool outputs in the trace. Set to false to only include inputs (smaller payload).
1719
+ */
1720
+ output?: boolean;
1721
+ };
1722
+
1723
+ /**
1724
+ * UpdateDirectiveRequest
1725
+ *
1726
+ * Request model for updating a directive.
1727
+ */
1728
+ export type UpdateDirectiveRequest = {
1729
+ /**
1730
+ * Name
1731
+ *
1732
+ * New name
1733
+ */
1734
+ name?: string | null;
1735
+ /**
1736
+ * Content
1737
+ *
1738
+ * New content
1739
+ */
1740
+ content?: string | null;
1741
+ /**
1742
+ * Priority
1743
+ *
1744
+ * New priority
1745
+ */
1746
+ priority?: number | null;
1747
+ /**
1748
+ * Is Active
1749
+ *
1750
+ * New active status
1751
+ */
1752
+ is_active?: boolean | null;
1753
+ /**
1754
+ * Tags
1755
+ *
1756
+ * New tags
1757
+ */
1758
+ tags?: Array<string> | null;
1759
+ };
1760
+
1164
1761
  /**
1165
1762
  * UpdateDispositionRequest
1166
1763
  *
@@ -1170,6 +1767,42 @@ export type UpdateDispositionRequest = {
1170
1767
  disposition: DispositionTraits;
1171
1768
  };
1172
1769
 
1770
+ /**
1771
+ * UpdateMentalModelRequest
1772
+ *
1773
+ * Request model for updating a mental model.
1774
+ */
1775
+ export type UpdateMentalModelRequest = {
1776
+ /**
1777
+ * Name
1778
+ *
1779
+ * New name for the mental model
1780
+ */
1781
+ name?: string | null;
1782
+ /**
1783
+ * Source Query
1784
+ *
1785
+ * New source query for the mental model
1786
+ */
1787
+ source_query?: string | null;
1788
+ /**
1789
+ * Max Tokens
1790
+ *
1791
+ * Maximum tokens for generated content
1792
+ */
1793
+ max_tokens?: number | null;
1794
+ /**
1795
+ * Tags
1796
+ *
1797
+ * Tags for scoped visibility
1798
+ */
1799
+ tags?: Array<string> | null;
1800
+ /**
1801
+ * Trigger settings
1802
+ */
1803
+ trigger?: MentalModelTrigger | null;
1804
+ };
1805
+
1173
1806
  /**
1174
1807
  * ValidationError
1175
1808
  */
@@ -1188,6 +1821,24 @@ export type ValidationError = {
1188
1821
  type: string;
1189
1822
  };
1190
1823
 
1824
+ /**
1825
+ * VersionResponse
1826
+ *
1827
+ * Response model for the version/info endpoint.
1828
+ */
1829
+ export type VersionResponse = {
1830
+ /**
1831
+ * Api Version
1832
+ *
1833
+ * API version string
1834
+ */
1835
+ api_version: string;
1836
+ /**
1837
+ * Enabled feature flags
1838
+ */
1839
+ features: FeaturesInfo;
1840
+ };
1841
+
1191
1842
  export type HealthEndpointHealthGetData = {
1192
1843
  body?: never;
1193
1844
  path?: never;
@@ -1202,6 +1853,22 @@ export type HealthEndpointHealthGetResponses = {
1202
1853
  200: unknown;
1203
1854
  };
1204
1855
 
1856
+ export type GetVersionData = {
1857
+ body?: never;
1858
+ path?: never;
1859
+ query?: never;
1860
+ url: "/version";
1861
+ };
1862
+
1863
+ export type GetVersionResponses = {
1864
+ /**
1865
+ * Successful Response
1866
+ */
1867
+ 200: VersionResponse;
1868
+ };
1869
+
1870
+ export type GetVersionResponse = GetVersionResponses[keyof GetVersionResponses];
1871
+
1205
1872
  export type MetricsEndpointMetricsGetData = {
1206
1873
  body?: never;
1207
1874
  path?: never;
@@ -1627,7 +2294,7 @@ export type RegenerateEntityObservationsResponses = {
1627
2294
  export type RegenerateEntityObservationsResponse =
1628
2295
  RegenerateEntityObservationsResponses[keyof RegenerateEntityObservationsResponses];
1629
2296
 
1630
- export type ListDocumentsData = {
2297
+ export type ListMentalModelsData = {
1631
2298
  body?: never;
1632
2299
  headers?: {
1633
2300
  /**
@@ -1643,9 +2310,17 @@ export type ListDocumentsData = {
1643
2310
  };
1644
2311
  query?: {
1645
2312
  /**
1646
- * Q
2313
+ * Tags
2314
+ *
2315
+ * Filter by tags
1647
2316
  */
1648
- q?: string | null;
2317
+ tags?: Array<string> | null;
2318
+ /**
2319
+ * Tags Match
2320
+ *
2321
+ * How to match tags
2322
+ */
2323
+ tags_match?: "any" | "all" | "exact";
1649
2324
  /**
1650
2325
  * Limit
1651
2326
  */
@@ -1655,30 +2330,31 @@ export type ListDocumentsData = {
1655
2330
  */
1656
2331
  offset?: number;
1657
2332
  };
1658
- url: "/v1/default/banks/{bank_id}/documents";
2333
+ url: "/v1/default/banks/{bank_id}/mental-models";
1659
2334
  };
1660
2335
 
1661
- export type ListDocumentsErrors = {
2336
+ export type ListMentalModelsErrors = {
1662
2337
  /**
1663
2338
  * Validation Error
1664
2339
  */
1665
2340
  422: HttpValidationError;
1666
2341
  };
1667
2342
 
1668
- export type ListDocumentsError = ListDocumentsErrors[keyof ListDocumentsErrors];
2343
+ export type ListMentalModelsError =
2344
+ ListMentalModelsErrors[keyof ListMentalModelsErrors];
1669
2345
 
1670
- export type ListDocumentsResponses = {
2346
+ export type ListMentalModelsResponses = {
1671
2347
  /**
1672
2348
  * Successful Response
1673
2349
  */
1674
- 200: ListDocumentsResponse;
2350
+ 200: MentalModelListResponse;
1675
2351
  };
1676
2352
 
1677
- export type ListDocumentsResponse2 =
1678
- ListDocumentsResponses[keyof ListDocumentsResponses];
2353
+ export type ListMentalModelsResponse =
2354
+ ListMentalModelsResponses[keyof ListMentalModelsResponses];
1679
2355
 
1680
- export type DeleteDocumentData = {
1681
- body?: never;
2356
+ export type CreateMentalModelData = {
2357
+ body: CreateMentalModelRequest;
1682
2358
  headers?: {
1683
2359
  /**
1684
2360
  * Authorization
@@ -1690,7 +2366,485 @@ export type DeleteDocumentData = {
1690
2366
  * Bank Id
1691
2367
  */
1692
2368
  bank_id: string;
1693
- /**
2369
+ };
2370
+ query?: never;
2371
+ url: "/v1/default/banks/{bank_id}/mental-models";
2372
+ };
2373
+
2374
+ export type CreateMentalModelErrors = {
2375
+ /**
2376
+ * Validation Error
2377
+ */
2378
+ 422: HttpValidationError;
2379
+ };
2380
+
2381
+ export type CreateMentalModelError =
2382
+ CreateMentalModelErrors[keyof CreateMentalModelErrors];
2383
+
2384
+ export type CreateMentalModelResponses = {
2385
+ /**
2386
+ * Successful Response
2387
+ */
2388
+ 200: CreateMentalModelResponse;
2389
+ };
2390
+
2391
+ export type CreateMentalModelResponse2 =
2392
+ CreateMentalModelResponses[keyof CreateMentalModelResponses];
2393
+
2394
+ export type DeleteMentalModelData = {
2395
+ body?: never;
2396
+ headers?: {
2397
+ /**
2398
+ * Authorization
2399
+ */
2400
+ authorization?: string | null;
2401
+ };
2402
+ path: {
2403
+ /**
2404
+ * Bank Id
2405
+ */
2406
+ bank_id: string;
2407
+ /**
2408
+ * Mental Model Id
2409
+ */
2410
+ mental_model_id: string;
2411
+ };
2412
+ query?: never;
2413
+ url: "/v1/default/banks/{bank_id}/mental-models/{mental_model_id}";
2414
+ };
2415
+
2416
+ export type DeleteMentalModelErrors = {
2417
+ /**
2418
+ * Validation Error
2419
+ */
2420
+ 422: HttpValidationError;
2421
+ };
2422
+
2423
+ export type DeleteMentalModelError =
2424
+ DeleteMentalModelErrors[keyof DeleteMentalModelErrors];
2425
+
2426
+ export type DeleteMentalModelResponses = {
2427
+ /**
2428
+ * Successful Response
2429
+ */
2430
+ 200: unknown;
2431
+ };
2432
+
2433
+ export type GetMentalModelData = {
2434
+ body?: never;
2435
+ headers?: {
2436
+ /**
2437
+ * Authorization
2438
+ */
2439
+ authorization?: string | null;
2440
+ };
2441
+ path: {
2442
+ /**
2443
+ * Bank Id
2444
+ */
2445
+ bank_id: string;
2446
+ /**
2447
+ * Mental Model Id
2448
+ */
2449
+ mental_model_id: string;
2450
+ };
2451
+ query?: never;
2452
+ url: "/v1/default/banks/{bank_id}/mental-models/{mental_model_id}";
2453
+ };
2454
+
2455
+ export type GetMentalModelErrors = {
2456
+ /**
2457
+ * Validation Error
2458
+ */
2459
+ 422: HttpValidationError;
2460
+ };
2461
+
2462
+ export type GetMentalModelError =
2463
+ GetMentalModelErrors[keyof GetMentalModelErrors];
2464
+
2465
+ export type GetMentalModelResponses = {
2466
+ /**
2467
+ * Successful Response
2468
+ */
2469
+ 200: MentalModelResponse;
2470
+ };
2471
+
2472
+ export type GetMentalModelResponse =
2473
+ GetMentalModelResponses[keyof GetMentalModelResponses];
2474
+
2475
+ export type UpdateMentalModelData = {
2476
+ body: UpdateMentalModelRequest;
2477
+ headers?: {
2478
+ /**
2479
+ * Authorization
2480
+ */
2481
+ authorization?: string | null;
2482
+ };
2483
+ path: {
2484
+ /**
2485
+ * Bank Id
2486
+ */
2487
+ bank_id: string;
2488
+ /**
2489
+ * Mental Model Id
2490
+ */
2491
+ mental_model_id: string;
2492
+ };
2493
+ query?: never;
2494
+ url: "/v1/default/banks/{bank_id}/mental-models/{mental_model_id}";
2495
+ };
2496
+
2497
+ export type UpdateMentalModelErrors = {
2498
+ /**
2499
+ * Validation Error
2500
+ */
2501
+ 422: HttpValidationError;
2502
+ };
2503
+
2504
+ export type UpdateMentalModelError =
2505
+ UpdateMentalModelErrors[keyof UpdateMentalModelErrors];
2506
+
2507
+ export type UpdateMentalModelResponses = {
2508
+ /**
2509
+ * Successful Response
2510
+ */
2511
+ 200: MentalModelResponse;
2512
+ };
2513
+
2514
+ export type UpdateMentalModelResponse =
2515
+ UpdateMentalModelResponses[keyof UpdateMentalModelResponses];
2516
+
2517
+ export type RefreshMentalModelData = {
2518
+ body?: never;
2519
+ headers?: {
2520
+ /**
2521
+ * Authorization
2522
+ */
2523
+ authorization?: string | null;
2524
+ };
2525
+ path: {
2526
+ /**
2527
+ * Bank Id
2528
+ */
2529
+ bank_id: string;
2530
+ /**
2531
+ * Mental Model Id
2532
+ */
2533
+ mental_model_id: string;
2534
+ };
2535
+ query?: never;
2536
+ url: "/v1/default/banks/{bank_id}/mental-models/{mental_model_id}/refresh";
2537
+ };
2538
+
2539
+ export type RefreshMentalModelErrors = {
2540
+ /**
2541
+ * Validation Error
2542
+ */
2543
+ 422: HttpValidationError;
2544
+ };
2545
+
2546
+ export type RefreshMentalModelError =
2547
+ RefreshMentalModelErrors[keyof RefreshMentalModelErrors];
2548
+
2549
+ export type RefreshMentalModelResponses = {
2550
+ /**
2551
+ * Successful Response
2552
+ */
2553
+ 200: AsyncOperationSubmitResponse;
2554
+ };
2555
+
2556
+ export type RefreshMentalModelResponse =
2557
+ RefreshMentalModelResponses[keyof RefreshMentalModelResponses];
2558
+
2559
+ export type ListDirectivesData = {
2560
+ body?: never;
2561
+ headers?: {
2562
+ /**
2563
+ * Authorization
2564
+ */
2565
+ authorization?: string | null;
2566
+ };
2567
+ path: {
2568
+ /**
2569
+ * Bank Id
2570
+ */
2571
+ bank_id: string;
2572
+ };
2573
+ query?: {
2574
+ /**
2575
+ * Tags
2576
+ *
2577
+ * Filter by tags
2578
+ */
2579
+ tags?: Array<string> | null;
2580
+ /**
2581
+ * Tags Match
2582
+ *
2583
+ * How to match tags
2584
+ */
2585
+ tags_match?: "any" | "all" | "exact";
2586
+ /**
2587
+ * Active Only
2588
+ *
2589
+ * Only return active directives
2590
+ */
2591
+ active_only?: boolean;
2592
+ /**
2593
+ * Limit
2594
+ */
2595
+ limit?: number;
2596
+ /**
2597
+ * Offset
2598
+ */
2599
+ offset?: number;
2600
+ };
2601
+ url: "/v1/default/banks/{bank_id}/directives";
2602
+ };
2603
+
2604
+ export type ListDirectivesErrors = {
2605
+ /**
2606
+ * Validation Error
2607
+ */
2608
+ 422: HttpValidationError;
2609
+ };
2610
+
2611
+ export type ListDirectivesError =
2612
+ ListDirectivesErrors[keyof ListDirectivesErrors];
2613
+
2614
+ export type ListDirectivesResponses = {
2615
+ /**
2616
+ * Successful Response
2617
+ */
2618
+ 200: DirectiveListResponse;
2619
+ };
2620
+
2621
+ export type ListDirectivesResponse =
2622
+ ListDirectivesResponses[keyof ListDirectivesResponses];
2623
+
2624
+ export type CreateDirectiveData = {
2625
+ body: CreateDirectiveRequest;
2626
+ headers?: {
2627
+ /**
2628
+ * Authorization
2629
+ */
2630
+ authorization?: string | null;
2631
+ };
2632
+ path: {
2633
+ /**
2634
+ * Bank Id
2635
+ */
2636
+ bank_id: string;
2637
+ };
2638
+ query?: never;
2639
+ url: "/v1/default/banks/{bank_id}/directives";
2640
+ };
2641
+
2642
+ export type CreateDirectiveErrors = {
2643
+ /**
2644
+ * Validation Error
2645
+ */
2646
+ 422: HttpValidationError;
2647
+ };
2648
+
2649
+ export type CreateDirectiveError =
2650
+ CreateDirectiveErrors[keyof CreateDirectiveErrors];
2651
+
2652
+ export type CreateDirectiveResponses = {
2653
+ /**
2654
+ * Successful Response
2655
+ */
2656
+ 200: DirectiveResponse;
2657
+ };
2658
+
2659
+ export type CreateDirectiveResponse =
2660
+ CreateDirectiveResponses[keyof CreateDirectiveResponses];
2661
+
2662
+ export type DeleteDirectiveData = {
2663
+ body?: never;
2664
+ headers?: {
2665
+ /**
2666
+ * Authorization
2667
+ */
2668
+ authorization?: string | null;
2669
+ };
2670
+ path: {
2671
+ /**
2672
+ * Bank Id
2673
+ */
2674
+ bank_id: string;
2675
+ /**
2676
+ * Directive Id
2677
+ */
2678
+ directive_id: string;
2679
+ };
2680
+ query?: never;
2681
+ url: "/v1/default/banks/{bank_id}/directives/{directive_id}";
2682
+ };
2683
+
2684
+ export type DeleteDirectiveErrors = {
2685
+ /**
2686
+ * Validation Error
2687
+ */
2688
+ 422: HttpValidationError;
2689
+ };
2690
+
2691
+ export type DeleteDirectiveError =
2692
+ DeleteDirectiveErrors[keyof DeleteDirectiveErrors];
2693
+
2694
+ export type DeleteDirectiveResponses = {
2695
+ /**
2696
+ * Successful Response
2697
+ */
2698
+ 200: unknown;
2699
+ };
2700
+
2701
+ export type GetDirectiveData = {
2702
+ body?: never;
2703
+ headers?: {
2704
+ /**
2705
+ * Authorization
2706
+ */
2707
+ authorization?: string | null;
2708
+ };
2709
+ path: {
2710
+ /**
2711
+ * Bank Id
2712
+ */
2713
+ bank_id: string;
2714
+ /**
2715
+ * Directive Id
2716
+ */
2717
+ directive_id: string;
2718
+ };
2719
+ query?: never;
2720
+ url: "/v1/default/banks/{bank_id}/directives/{directive_id}";
2721
+ };
2722
+
2723
+ export type GetDirectiveErrors = {
2724
+ /**
2725
+ * Validation Error
2726
+ */
2727
+ 422: HttpValidationError;
2728
+ };
2729
+
2730
+ export type GetDirectiveError = GetDirectiveErrors[keyof GetDirectiveErrors];
2731
+
2732
+ export type GetDirectiveResponses = {
2733
+ /**
2734
+ * Successful Response
2735
+ */
2736
+ 200: DirectiveResponse;
2737
+ };
2738
+
2739
+ export type GetDirectiveResponse =
2740
+ GetDirectiveResponses[keyof GetDirectiveResponses];
2741
+
2742
+ export type UpdateDirectiveData = {
2743
+ body: UpdateDirectiveRequest;
2744
+ headers?: {
2745
+ /**
2746
+ * Authorization
2747
+ */
2748
+ authorization?: string | null;
2749
+ };
2750
+ path: {
2751
+ /**
2752
+ * Bank Id
2753
+ */
2754
+ bank_id: string;
2755
+ /**
2756
+ * Directive Id
2757
+ */
2758
+ directive_id: string;
2759
+ };
2760
+ query?: never;
2761
+ url: "/v1/default/banks/{bank_id}/directives/{directive_id}";
2762
+ };
2763
+
2764
+ export type UpdateDirectiveErrors = {
2765
+ /**
2766
+ * Validation Error
2767
+ */
2768
+ 422: HttpValidationError;
2769
+ };
2770
+
2771
+ export type UpdateDirectiveError =
2772
+ UpdateDirectiveErrors[keyof UpdateDirectiveErrors];
2773
+
2774
+ export type UpdateDirectiveResponses = {
2775
+ /**
2776
+ * Successful Response
2777
+ */
2778
+ 200: DirectiveResponse;
2779
+ };
2780
+
2781
+ export type UpdateDirectiveResponse =
2782
+ UpdateDirectiveResponses[keyof UpdateDirectiveResponses];
2783
+
2784
+ export type ListDocumentsData = {
2785
+ body?: never;
2786
+ headers?: {
2787
+ /**
2788
+ * Authorization
2789
+ */
2790
+ authorization?: string | null;
2791
+ };
2792
+ path: {
2793
+ /**
2794
+ * Bank Id
2795
+ */
2796
+ bank_id: string;
2797
+ };
2798
+ query?: {
2799
+ /**
2800
+ * Q
2801
+ */
2802
+ q?: string | null;
2803
+ /**
2804
+ * Limit
2805
+ */
2806
+ limit?: number;
2807
+ /**
2808
+ * Offset
2809
+ */
2810
+ offset?: number;
2811
+ };
2812
+ url: "/v1/default/banks/{bank_id}/documents";
2813
+ };
2814
+
2815
+ export type ListDocumentsErrors = {
2816
+ /**
2817
+ * Validation Error
2818
+ */
2819
+ 422: HttpValidationError;
2820
+ };
2821
+
2822
+ export type ListDocumentsError = ListDocumentsErrors[keyof ListDocumentsErrors];
2823
+
2824
+ export type ListDocumentsResponses = {
2825
+ /**
2826
+ * Successful Response
2827
+ */
2828
+ 200: ListDocumentsResponse;
2829
+ };
2830
+
2831
+ export type ListDocumentsResponse2 =
2832
+ ListDocumentsResponses[keyof ListDocumentsResponses];
2833
+
2834
+ export type DeleteDocumentData = {
2835
+ body?: never;
2836
+ headers?: {
2837
+ /**
2838
+ * Authorization
2839
+ */
2840
+ authorization?: string | null;
2841
+ };
2842
+ path: {
2843
+ /**
2844
+ * Bank Id
2845
+ */
2846
+ bank_id: string;
2847
+ /**
1694
2848
  * Document Id
1695
2849
  */
1696
2850
  document_id: string;
@@ -1865,7 +3019,26 @@ export type ListOperationsData = {
1865
3019
  */
1866
3020
  bank_id: string;
1867
3021
  };
1868
- query?: never;
3022
+ query?: {
3023
+ /**
3024
+ * Status
3025
+ *
3026
+ * Filter by status: pending, completed, or failed
3027
+ */
3028
+ status?: string | null;
3029
+ /**
3030
+ * Limit
3031
+ *
3032
+ * Maximum number of operations to return
3033
+ */
3034
+ limit?: number;
3035
+ /**
3036
+ * Offset
3037
+ *
3038
+ * Number of operations to skip
3039
+ */
3040
+ offset?: number;
3041
+ };
1869
3042
  url: "/v1/default/banks/{bank_id}/operations";
1870
3043
  };
1871
3044
 
@@ -1931,6 +3104,48 @@ export type CancelOperationResponses = {
1931
3104
  export type CancelOperationResponse2 =
1932
3105
  CancelOperationResponses[keyof CancelOperationResponses];
1933
3106
 
3107
+ export type GetOperationStatusData = {
3108
+ body?: never;
3109
+ headers?: {
3110
+ /**
3111
+ * Authorization
3112
+ */
3113
+ authorization?: string | null;
3114
+ };
3115
+ path: {
3116
+ /**
3117
+ * Bank Id
3118
+ */
3119
+ bank_id: string;
3120
+ /**
3121
+ * Operation Id
3122
+ */
3123
+ operation_id: string;
3124
+ };
3125
+ query?: never;
3126
+ url: "/v1/default/banks/{bank_id}/operations/{operation_id}";
3127
+ };
3128
+
3129
+ export type GetOperationStatusErrors = {
3130
+ /**
3131
+ * Validation Error
3132
+ */
3133
+ 422: HttpValidationError;
3134
+ };
3135
+
3136
+ export type GetOperationStatusError =
3137
+ GetOperationStatusErrors[keyof GetOperationStatusErrors];
3138
+
3139
+ export type GetOperationStatusResponses = {
3140
+ /**
3141
+ * Successful Response
3142
+ */
3143
+ 200: OperationStatusResponse;
3144
+ };
3145
+
3146
+ export type GetOperationStatusResponse =
3147
+ GetOperationStatusResponses[keyof GetOperationStatusResponses];
3148
+
1934
3149
  export type GetBankProfileData = {
1935
3150
  body?: never;
1936
3151
  headers?: {
@@ -2081,6 +3296,42 @@ export type DeleteBankResponses = {
2081
3296
 
2082
3297
  export type DeleteBankResponse = DeleteBankResponses[keyof DeleteBankResponses];
2083
3298
 
3299
+ export type UpdateBankData = {
3300
+ body: CreateBankRequest;
3301
+ headers?: {
3302
+ /**
3303
+ * Authorization
3304
+ */
3305
+ authorization?: string | null;
3306
+ };
3307
+ path: {
3308
+ /**
3309
+ * Bank Id
3310
+ */
3311
+ bank_id: string;
3312
+ };
3313
+ query?: never;
3314
+ url: "/v1/default/banks/{bank_id}";
3315
+ };
3316
+
3317
+ export type UpdateBankErrors = {
3318
+ /**
3319
+ * Validation Error
3320
+ */
3321
+ 422: HttpValidationError;
3322
+ };
3323
+
3324
+ export type UpdateBankError = UpdateBankErrors[keyof UpdateBankErrors];
3325
+
3326
+ export type UpdateBankResponses = {
3327
+ /**
3328
+ * Successful Response
3329
+ */
3330
+ 200: BankProfileResponse;
3331
+ };
3332
+
3333
+ export type UpdateBankResponse = UpdateBankResponses[keyof UpdateBankResponses];
3334
+
2084
3335
  export type CreateOrUpdateBankData = {
2085
3336
  body: CreateBankRequest;
2086
3337
  headers?: {
@@ -2119,6 +3370,82 @@ export type CreateOrUpdateBankResponses = {
2119
3370
  export type CreateOrUpdateBankResponse =
2120
3371
  CreateOrUpdateBankResponses[keyof CreateOrUpdateBankResponses];
2121
3372
 
3373
+ export type ClearObservationsData = {
3374
+ body?: never;
3375
+ headers?: {
3376
+ /**
3377
+ * Authorization
3378
+ */
3379
+ authorization?: string | null;
3380
+ };
3381
+ path: {
3382
+ /**
3383
+ * Bank Id
3384
+ */
3385
+ bank_id: string;
3386
+ };
3387
+ query?: never;
3388
+ url: "/v1/default/banks/{bank_id}/observations";
3389
+ };
3390
+
3391
+ export type ClearObservationsErrors = {
3392
+ /**
3393
+ * Validation Error
3394
+ */
3395
+ 422: HttpValidationError;
3396
+ };
3397
+
3398
+ export type ClearObservationsError =
3399
+ ClearObservationsErrors[keyof ClearObservationsErrors];
3400
+
3401
+ export type ClearObservationsResponses = {
3402
+ /**
3403
+ * Successful Response
3404
+ */
3405
+ 200: DeleteResponse;
3406
+ };
3407
+
3408
+ export type ClearObservationsResponse =
3409
+ ClearObservationsResponses[keyof ClearObservationsResponses];
3410
+
3411
+ export type TriggerConsolidationData = {
3412
+ body?: never;
3413
+ headers?: {
3414
+ /**
3415
+ * Authorization
3416
+ */
3417
+ authorization?: string | null;
3418
+ };
3419
+ path: {
3420
+ /**
3421
+ * Bank Id
3422
+ */
3423
+ bank_id: string;
3424
+ };
3425
+ query?: never;
3426
+ url: "/v1/default/banks/{bank_id}/consolidate";
3427
+ };
3428
+
3429
+ export type TriggerConsolidationErrors = {
3430
+ /**
3431
+ * Validation Error
3432
+ */
3433
+ 422: HttpValidationError;
3434
+ };
3435
+
3436
+ export type TriggerConsolidationError =
3437
+ TriggerConsolidationErrors[keyof TriggerConsolidationErrors];
3438
+
3439
+ export type TriggerConsolidationResponses = {
3440
+ /**
3441
+ * Successful Response
3442
+ */
3443
+ 200: ConsolidationResponse;
3444
+ };
3445
+
3446
+ export type TriggerConsolidationResponse =
3447
+ TriggerConsolidationResponses[keyof TriggerConsolidationResponses];
3448
+
2122
3449
  export type ClearBankMemoriesData = {
2123
3450
  body?: never;
2124
3451
  headers?: {