@robosystems/client 0.2.4 → 0.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +141 -10
- package/sdk/sdk.gen.js +157 -10
- package/sdk/sdk.gen.ts +157 -10
- package/sdk/types.gen.d.ts +294 -18
- package/sdk/types.gen.ts +307 -18
- package/sdk.gen.d.ts +141 -10
- package/sdk.gen.js +157 -10
- package/sdk.gen.ts +157 -10
- package/types.gen.d.ts +294 -18
- package/types.gen.ts +307 -18
package/sdk/types.gen.ts
CHANGED
|
@@ -379,7 +379,7 @@ export type AgentResponse = {
|
|
|
379
379
|
} | null;
|
|
380
380
|
/**
|
|
381
381
|
* Confidence Score
|
|
382
|
-
* Confidence score of the response
|
|
382
|
+
* Confidence score of the response (0.0-1.0 scale)
|
|
383
383
|
*/
|
|
384
384
|
confidence_score?: number | null;
|
|
385
385
|
/**
|
|
@@ -510,6 +510,60 @@ export type BackupCreateRequest = {
|
|
|
510
510
|
schedule?: string | null;
|
|
511
511
|
};
|
|
512
512
|
|
|
513
|
+
/**
|
|
514
|
+
* BackupDownloadUrlResponse
|
|
515
|
+
* Response model for backup download URL generation.
|
|
516
|
+
*/
|
|
517
|
+
export type BackupDownloadUrlResponse = {
|
|
518
|
+
/**
|
|
519
|
+
* Download Url
|
|
520
|
+
* Pre-signed S3 URL for downloading the backup file
|
|
521
|
+
*/
|
|
522
|
+
download_url: string;
|
|
523
|
+
/**
|
|
524
|
+
* Expires In
|
|
525
|
+
* URL expiration time in seconds from now
|
|
526
|
+
*/
|
|
527
|
+
expires_in: number;
|
|
528
|
+
/**
|
|
529
|
+
* Expires At
|
|
530
|
+
* Unix timestamp when the URL expires
|
|
531
|
+
*/
|
|
532
|
+
expires_at: number;
|
|
533
|
+
/**
|
|
534
|
+
* Backup Id
|
|
535
|
+
* Backup identifier
|
|
536
|
+
*/
|
|
537
|
+
backup_id: string;
|
|
538
|
+
/**
|
|
539
|
+
* Graph Id
|
|
540
|
+
* Graph database identifier
|
|
541
|
+
*/
|
|
542
|
+
graph_id: string;
|
|
543
|
+
};
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* BackupLimits
|
|
547
|
+
* Backup operation limits.
|
|
548
|
+
*/
|
|
549
|
+
export type BackupLimits = {
|
|
550
|
+
/**
|
|
551
|
+
* Max Backup Size Gb
|
|
552
|
+
* Maximum backup size in GB
|
|
553
|
+
*/
|
|
554
|
+
max_backup_size_gb: number;
|
|
555
|
+
/**
|
|
556
|
+
* Backup Retention Days
|
|
557
|
+
* Backup retention period in days
|
|
558
|
+
*/
|
|
559
|
+
backup_retention_days: number;
|
|
560
|
+
/**
|
|
561
|
+
* Max Backups Per Day
|
|
562
|
+
* Maximum backups per day
|
|
563
|
+
*/
|
|
564
|
+
max_backups_per_day: number;
|
|
565
|
+
};
|
|
566
|
+
|
|
513
567
|
/**
|
|
514
568
|
* BackupListResponse
|
|
515
569
|
* Response model for backup list.
|
|
@@ -681,7 +735,7 @@ export type BackupStatsResponse = {
|
|
|
681
735
|
export type BatchAgentRequest = {
|
|
682
736
|
/**
|
|
683
737
|
* Queries
|
|
684
|
-
* List of queries to process
|
|
738
|
+
* List of queries to process (max 10)
|
|
685
739
|
*/
|
|
686
740
|
queries: Array<AgentRequest>;
|
|
687
741
|
/**
|
|
@@ -698,12 +752,12 @@ export type BatchAgentRequest = {
|
|
|
698
752
|
export type BatchAgentResponse = {
|
|
699
753
|
/**
|
|
700
754
|
* Results
|
|
701
|
-
* List of agent responses
|
|
755
|
+
* List of agent responses (includes successes and failures)
|
|
702
756
|
*/
|
|
703
757
|
results: Array<AgentResponse>;
|
|
704
758
|
/**
|
|
705
759
|
* Total Execution Time
|
|
706
|
-
* Total execution time
|
|
760
|
+
* Total execution time in seconds
|
|
707
761
|
*/
|
|
708
762
|
total_execution_time: number;
|
|
709
763
|
/**
|
|
@@ -935,6 +989,43 @@ export type ConnectionResponse = {
|
|
|
935
989
|
};
|
|
936
990
|
};
|
|
937
991
|
|
|
992
|
+
/**
|
|
993
|
+
* CopyOperationLimits
|
|
994
|
+
* Copy/ingestion operation limits.
|
|
995
|
+
*/
|
|
996
|
+
export type CopyOperationLimits = {
|
|
997
|
+
/**
|
|
998
|
+
* Max File Size Gb
|
|
999
|
+
* Maximum file size in GB
|
|
1000
|
+
*/
|
|
1001
|
+
max_file_size_gb: number;
|
|
1002
|
+
/**
|
|
1003
|
+
* Timeout Seconds
|
|
1004
|
+
* Operation timeout in seconds
|
|
1005
|
+
*/
|
|
1006
|
+
timeout_seconds: number;
|
|
1007
|
+
/**
|
|
1008
|
+
* Concurrent Operations
|
|
1009
|
+
* Maximum concurrent operations
|
|
1010
|
+
*/
|
|
1011
|
+
concurrent_operations: number;
|
|
1012
|
+
/**
|
|
1013
|
+
* Max Files Per Operation
|
|
1014
|
+
* Maximum files per operation
|
|
1015
|
+
*/
|
|
1016
|
+
max_files_per_operation: number;
|
|
1017
|
+
/**
|
|
1018
|
+
* Daily Copy Operations
|
|
1019
|
+
* Daily operation limit
|
|
1020
|
+
*/
|
|
1021
|
+
daily_copy_operations: number;
|
|
1022
|
+
/**
|
|
1023
|
+
* Supported Formats
|
|
1024
|
+
* Supported file formats
|
|
1025
|
+
*/
|
|
1026
|
+
supported_formats: Array<string>;
|
|
1027
|
+
};
|
|
1028
|
+
|
|
938
1029
|
/**
|
|
939
1030
|
* CreateAPIKeyRequest
|
|
940
1031
|
* Request model for creating a new API key.
|
|
@@ -996,6 +1087,10 @@ export type CreateConnectionRequest = {
|
|
|
996
1087
|
/**
|
|
997
1088
|
* CreateGraphRequest
|
|
998
1089
|
* Request model for creating a new graph.
|
|
1090
|
+
*
|
|
1091
|
+
* Use this to create either:
|
|
1092
|
+
* - **Entity graphs**: Standard graphs with entity schema and optional extensions
|
|
1093
|
+
* - **Custom graphs**: Generic graphs with fully custom schema definitions
|
|
999
1094
|
*/
|
|
1000
1095
|
export type CreateGraphRequest = {
|
|
1001
1096
|
/**
|
|
@@ -1008,11 +1103,11 @@ export type CreateGraphRequest = {
|
|
|
1008
1103
|
*/
|
|
1009
1104
|
instance_tier?: string;
|
|
1010
1105
|
/**
|
|
1011
|
-
* Custom schema definition to apply
|
|
1106
|
+
* Custom schema definition to apply. If provided, creates a generic custom graph. If omitted, creates an entity graph using schema_extensions.
|
|
1012
1107
|
*/
|
|
1013
1108
|
custom_schema?: CustomSchemaDefinition | null;
|
|
1014
1109
|
/**
|
|
1015
|
-
* Optional initial entity to create in the graph. If provided,
|
|
1110
|
+
* Optional initial entity to create in the graph. If provided with entity graph, populates the first entity node.
|
|
1016
1111
|
*/
|
|
1017
1112
|
initial_entity?: InitialEntityData | null;
|
|
1018
1113
|
/**
|
|
@@ -1065,6 +1160,33 @@ export type CreateSubgraphRequest = {
|
|
|
1065
1160
|
} | null;
|
|
1066
1161
|
};
|
|
1067
1162
|
|
|
1163
|
+
/**
|
|
1164
|
+
* CreditLimits
|
|
1165
|
+
* AI credit limits (optional).
|
|
1166
|
+
*/
|
|
1167
|
+
export type CreditLimits = {
|
|
1168
|
+
/**
|
|
1169
|
+
* Monthly Ai Credits
|
|
1170
|
+
* Monthly AI credits allocation
|
|
1171
|
+
*/
|
|
1172
|
+
monthly_ai_credits: number;
|
|
1173
|
+
/**
|
|
1174
|
+
* Current Balance
|
|
1175
|
+
* Current credit balance
|
|
1176
|
+
*/
|
|
1177
|
+
current_balance: number;
|
|
1178
|
+
/**
|
|
1179
|
+
* Storage Billing Enabled
|
|
1180
|
+
* Whether storage billing is enabled
|
|
1181
|
+
*/
|
|
1182
|
+
storage_billing_enabled: boolean;
|
|
1183
|
+
/**
|
|
1184
|
+
* Storage Rate Per Gb Per Day
|
|
1185
|
+
* Storage billing rate per GB per day
|
|
1186
|
+
*/
|
|
1187
|
+
storage_rate_per_gb_per_day: number;
|
|
1188
|
+
};
|
|
1189
|
+
|
|
1068
1190
|
/**
|
|
1069
1191
|
* CreditSummary
|
|
1070
1192
|
* Credit balance summary.
|
|
@@ -1188,7 +1310,11 @@ export type CreditsSummaryResponse = {
|
|
|
1188
1310
|
|
|
1189
1311
|
/**
|
|
1190
1312
|
* CustomSchemaDefinition
|
|
1191
|
-
* Custom schema definition for
|
|
1313
|
+
* Custom schema definition for generic graphs.
|
|
1314
|
+
*
|
|
1315
|
+
* This model allows you to define custom node types, relationship types, and properties
|
|
1316
|
+
* for graphs that don't fit the standard entity-based schema. Perfect for domain-specific
|
|
1317
|
+
* applications like inventory systems, org charts, project management, etc.
|
|
1192
1318
|
*/
|
|
1193
1319
|
export type CustomSchemaDefinition = {
|
|
1194
1320
|
/**
|
|
@@ -1208,7 +1334,7 @@ export type CustomSchemaDefinition = {
|
|
|
1208
1334
|
description?: string | null;
|
|
1209
1335
|
/**
|
|
1210
1336
|
* Extends
|
|
1211
|
-
* Base schema to extend (e.g., 'base')
|
|
1337
|
+
* Base schema to extend (e.g., 'base' for common utilities)
|
|
1212
1338
|
*/
|
|
1213
1339
|
extends?: string | null;
|
|
1214
1340
|
/**
|
|
@@ -1847,6 +1973,57 @@ export type GraphInfo = {
|
|
|
1847
1973
|
createdAt: string;
|
|
1848
1974
|
};
|
|
1849
1975
|
|
|
1976
|
+
/**
|
|
1977
|
+
* GraphLimitsResponse
|
|
1978
|
+
* Response model for comprehensive graph operational limits.
|
|
1979
|
+
*/
|
|
1980
|
+
export type GraphLimitsResponse = {
|
|
1981
|
+
/**
|
|
1982
|
+
* Graph Id
|
|
1983
|
+
* Graph database identifier
|
|
1984
|
+
*/
|
|
1985
|
+
graph_id: string;
|
|
1986
|
+
/**
|
|
1987
|
+
* Subscription Tier
|
|
1988
|
+
* User's subscription tier
|
|
1989
|
+
*/
|
|
1990
|
+
subscription_tier: string;
|
|
1991
|
+
/**
|
|
1992
|
+
* Graph Tier
|
|
1993
|
+
* Graph's database tier
|
|
1994
|
+
*/
|
|
1995
|
+
graph_tier: string;
|
|
1996
|
+
/**
|
|
1997
|
+
* Is Shared Repository
|
|
1998
|
+
* Whether this is a shared repository
|
|
1999
|
+
*/
|
|
2000
|
+
is_shared_repository: boolean;
|
|
2001
|
+
/**
|
|
2002
|
+
* Storage limits and usage
|
|
2003
|
+
*/
|
|
2004
|
+
storage: StorageLimits;
|
|
2005
|
+
/**
|
|
2006
|
+
* Query operation limits
|
|
2007
|
+
*/
|
|
2008
|
+
queries: QueryLimits;
|
|
2009
|
+
/**
|
|
2010
|
+
* Copy/ingestion operation limits
|
|
2011
|
+
*/
|
|
2012
|
+
copy_operations: CopyOperationLimits;
|
|
2013
|
+
/**
|
|
2014
|
+
* Backup operation limits
|
|
2015
|
+
*/
|
|
2016
|
+
backups: BackupLimits;
|
|
2017
|
+
/**
|
|
2018
|
+
* API rate limits
|
|
2019
|
+
*/
|
|
2020
|
+
rate_limits: RateLimits;
|
|
2021
|
+
/**
|
|
2022
|
+
* AI credit limits (if applicable)
|
|
2023
|
+
*/
|
|
2024
|
+
credits?: CreditLimits | null;
|
|
2025
|
+
};
|
|
2026
|
+
|
|
1850
2027
|
/**
|
|
1851
2028
|
* GraphMetadata
|
|
1852
2029
|
* Metadata for graph creation.
|
|
@@ -2013,7 +2190,10 @@ export type HealthStatus = {
|
|
|
2013
2190
|
|
|
2014
2191
|
/**
|
|
2015
2192
|
* InitialEntityData
|
|
2016
|
-
* Initial entity data for graph creation.
|
|
2193
|
+
* Initial entity data for entity-focused graph creation.
|
|
2194
|
+
*
|
|
2195
|
+
* When creating an entity graph with an initial entity node, this model defines
|
|
2196
|
+
* the entity's identifying information and metadata.
|
|
2017
2197
|
*/
|
|
2018
2198
|
export type InitialEntityData = {
|
|
2019
2199
|
/**
|
|
@@ -2404,6 +2584,33 @@ export type PlaidConnectionConfig = {
|
|
|
2404
2584
|
}> | null;
|
|
2405
2585
|
};
|
|
2406
2586
|
|
|
2587
|
+
/**
|
|
2588
|
+
* QueryLimits
|
|
2589
|
+
* Query operation limits.
|
|
2590
|
+
*/
|
|
2591
|
+
export type QueryLimits = {
|
|
2592
|
+
/**
|
|
2593
|
+
* Max Timeout Seconds
|
|
2594
|
+
* Maximum query timeout in seconds
|
|
2595
|
+
*/
|
|
2596
|
+
max_timeout_seconds: number;
|
|
2597
|
+
/**
|
|
2598
|
+
* Chunk Size
|
|
2599
|
+
* Maximum chunk size for result streaming
|
|
2600
|
+
*/
|
|
2601
|
+
chunk_size: number;
|
|
2602
|
+
/**
|
|
2603
|
+
* Max Rows Per Query
|
|
2604
|
+
* Maximum rows returned per query
|
|
2605
|
+
*/
|
|
2606
|
+
max_rows_per_query: number;
|
|
2607
|
+
/**
|
|
2608
|
+
* Concurrent Queries
|
|
2609
|
+
* Maximum concurrent queries allowed
|
|
2610
|
+
*/
|
|
2611
|
+
concurrent_queries: number;
|
|
2612
|
+
};
|
|
2613
|
+
|
|
2407
2614
|
/**
|
|
2408
2615
|
* QuickBooksConnectionConfig
|
|
2409
2616
|
* QuickBooks-specific connection configuration.
|
|
@@ -2421,6 +2628,28 @@ export type QuickBooksConnectionConfig = {
|
|
|
2421
2628
|
refresh_token?: string | null;
|
|
2422
2629
|
};
|
|
2423
2630
|
|
|
2631
|
+
/**
|
|
2632
|
+
* RateLimits
|
|
2633
|
+
* API rate limits.
|
|
2634
|
+
*/
|
|
2635
|
+
export type RateLimits = {
|
|
2636
|
+
/**
|
|
2637
|
+
* Requests Per Minute
|
|
2638
|
+
* Requests per minute limit
|
|
2639
|
+
*/
|
|
2640
|
+
requests_per_minute: number;
|
|
2641
|
+
/**
|
|
2642
|
+
* Requests Per Hour
|
|
2643
|
+
* Requests per hour limit
|
|
2644
|
+
*/
|
|
2645
|
+
requests_per_hour: number;
|
|
2646
|
+
/**
|
|
2647
|
+
* Burst Capacity
|
|
2648
|
+
* Burst capacity for short spikes
|
|
2649
|
+
*/
|
|
2650
|
+
burst_capacity: number;
|
|
2651
|
+
};
|
|
2652
|
+
|
|
2424
2653
|
/**
|
|
2425
2654
|
* RegisterRequest
|
|
2426
2655
|
* Registration request model.
|
|
@@ -2818,6 +3047,28 @@ export type StorageLimitResponse = {
|
|
|
2818
3047
|
recommendations?: Array<string> | null;
|
|
2819
3048
|
};
|
|
2820
3049
|
|
|
3050
|
+
/**
|
|
3051
|
+
* StorageLimits
|
|
3052
|
+
* Storage limits information.
|
|
3053
|
+
*/
|
|
3054
|
+
export type StorageLimits = {
|
|
3055
|
+
/**
|
|
3056
|
+
* Current Usage Gb
|
|
3057
|
+
* Current storage usage in GB
|
|
3058
|
+
*/
|
|
3059
|
+
current_usage_gb?: number | null;
|
|
3060
|
+
/**
|
|
3061
|
+
* Max Storage Gb
|
|
3062
|
+
* Maximum storage limit in GB
|
|
3063
|
+
*/
|
|
3064
|
+
max_storage_gb: number;
|
|
3065
|
+
/**
|
|
3066
|
+
* Approaching Limit
|
|
3067
|
+
* Whether approaching storage limit (>80%)
|
|
3068
|
+
*/
|
|
3069
|
+
approaching_limit: boolean;
|
|
3070
|
+
};
|
|
3071
|
+
|
|
2821
3072
|
/**
|
|
2822
3073
|
* SubgraphQuotaResponse
|
|
2823
3074
|
* Response model for subgraph quota information.
|
|
@@ -5603,12 +5854,9 @@ export type GetBackupDownloadUrlError = GetBackupDownloadUrlErrors[keyof GetBack
|
|
|
5603
5854
|
|
|
5604
5855
|
export type GetBackupDownloadUrlResponses = {
|
|
5605
5856
|
/**
|
|
5606
|
-
* Response Getbackupdownloadurl
|
|
5607
5857
|
* Download URL generated successfully
|
|
5608
5858
|
*/
|
|
5609
|
-
200:
|
|
5610
|
-
[key: string]: unknown;
|
|
5611
|
-
};
|
|
5859
|
+
200: BackupDownloadUrlResponse;
|
|
5612
5860
|
};
|
|
5613
5861
|
|
|
5614
5862
|
export type GetBackupDownloadUrlResponse = GetBackupDownloadUrlResponses[keyof GetBackupDownloadUrlResponses];
|
|
@@ -5843,13 +6091,25 @@ export type ExecuteCypherQueryResponses = {
|
|
|
5843
6091
|
/**
|
|
5844
6092
|
* Query executed successfully
|
|
5845
6093
|
*/
|
|
5846
|
-
200:
|
|
6094
|
+
200: {
|
|
6095
|
+
success?: boolean;
|
|
6096
|
+
data?: Array<{
|
|
6097
|
+
[key: string]: unknown;
|
|
6098
|
+
}>;
|
|
6099
|
+
columns?: Array<string>;
|
|
6100
|
+
row_count?: number;
|
|
6101
|
+
execution_time_ms?: number;
|
|
6102
|
+
graph_id?: string;
|
|
6103
|
+
timestamp?: string;
|
|
6104
|
+
};
|
|
5847
6105
|
/**
|
|
5848
6106
|
* Query queued for execution
|
|
5849
6107
|
*/
|
|
5850
6108
|
202: unknown;
|
|
5851
6109
|
};
|
|
5852
6110
|
|
|
6111
|
+
export type ExecuteCypherQueryResponse = ExecuteCypherQueryResponses[keyof ExecuteCypherQueryResponses];
|
|
6112
|
+
|
|
5853
6113
|
export type GetGraphSchemaData = {
|
|
5854
6114
|
body?: never;
|
|
5855
6115
|
path: {
|
|
@@ -6588,12 +6848,9 @@ export type GetGraphLimitsError = GetGraphLimitsErrors[keyof GetGraphLimitsError
|
|
|
6588
6848
|
|
|
6589
6849
|
export type GetGraphLimitsResponses = {
|
|
6590
6850
|
/**
|
|
6591
|
-
* Response Getgraphlimits
|
|
6592
6851
|
* Limits retrieved successfully
|
|
6593
6852
|
*/
|
|
6594
|
-
200:
|
|
6595
|
-
[key: string]: unknown;
|
|
6596
|
-
};
|
|
6853
|
+
200: GraphLimitsResponse;
|
|
6597
6854
|
};
|
|
6598
6855
|
|
|
6599
6856
|
export type GetGraphLimitsResponse = GetGraphLimitsResponses[keyof GetGraphLimitsResponses];
|
|
@@ -7315,6 +7572,38 @@ export type GetAvailableExtensionsResponses = {
|
|
|
7315
7572
|
|
|
7316
7573
|
export type GetAvailableExtensionsResponse = GetAvailableExtensionsResponses[keyof GetAvailableExtensionsResponses];
|
|
7317
7574
|
|
|
7575
|
+
export type GetAvailableGraphTiersData = {
|
|
7576
|
+
body?: never;
|
|
7577
|
+
path?: never;
|
|
7578
|
+
query?: {
|
|
7579
|
+
/**
|
|
7580
|
+
* Include Disabled
|
|
7581
|
+
*/
|
|
7582
|
+
include_disabled?: boolean;
|
|
7583
|
+
};
|
|
7584
|
+
url: '/v1/graphs/tiers';
|
|
7585
|
+
};
|
|
7586
|
+
|
|
7587
|
+
export type GetAvailableGraphTiersErrors = {
|
|
7588
|
+
/**
|
|
7589
|
+
* Validation Error
|
|
7590
|
+
*/
|
|
7591
|
+
422: HttpValidationError;
|
|
7592
|
+
/**
|
|
7593
|
+
* Failed to retrieve tiers
|
|
7594
|
+
*/
|
|
7595
|
+
500: unknown;
|
|
7596
|
+
};
|
|
7597
|
+
|
|
7598
|
+
export type GetAvailableGraphTiersError = GetAvailableGraphTiersErrors[keyof GetAvailableGraphTiersErrors];
|
|
7599
|
+
|
|
7600
|
+
export type GetAvailableGraphTiersResponses = {
|
|
7601
|
+
/**
|
|
7602
|
+
* Tiers retrieved successfully
|
|
7603
|
+
*/
|
|
7604
|
+
200: unknown;
|
|
7605
|
+
};
|
|
7606
|
+
|
|
7318
7607
|
export type SelectGraphData = {
|
|
7319
7608
|
body?: never;
|
|
7320
7609
|
path: {
|
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Options as ClientOptions, TDataShape, Client } from './client';
|
|
2
|
-
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } from './types.gen';
|
|
2
|
+
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, GetAvailableGraphTiersData, GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -413,13 +413,46 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
|
|
|
413
413
|
* Auto-select agent for query
|
|
414
414
|
* Automatically select the best agent for your query.
|
|
415
415
|
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
416
|
+
* **Agent Selection Process:**
|
|
417
|
+
*
|
|
418
|
+
* The orchestrator intelligently routes your query by:
|
|
419
|
+
* 1. Analyzing query intent and complexity
|
|
420
|
+
* 2. Enriching context with RAG if enabled
|
|
421
|
+
* 3. Evaluating all available agents against selection criteria
|
|
422
|
+
* 4. Selecting the best match based on confidence scores
|
|
423
|
+
* 5. Executing the query with the selected agent
|
|
424
|
+
*
|
|
425
|
+
* **Available Agent Types:**
|
|
426
|
+
* - `financial`: Financial analysis, SEC filings, company metrics
|
|
427
|
+
* - `research`: General research, data exploration, trend analysis
|
|
428
|
+
* - `rag`: Knowledge base search using RAG enrichment
|
|
429
|
+
*
|
|
430
|
+
* **Execution Modes:**
|
|
431
|
+
* - `quick`: Fast responses (~2-5s), suitable for simple queries
|
|
432
|
+
* - `standard`: Balanced approach (~5-15s), default mode
|
|
433
|
+
* - `extended`: Comprehensive analysis (~15-60s), deep research
|
|
434
|
+
* - `streaming`: Real-time response streaming
|
|
435
|
+
*
|
|
436
|
+
* **Confidence Score Interpretation:**
|
|
437
|
+
* - `0.9-1.0`: High confidence, agent is ideal match
|
|
438
|
+
* - `0.7-0.9`: Good confidence, agent is suitable
|
|
439
|
+
* - `0.5-0.7`: Moderate confidence, agent can handle but may not be optimal
|
|
440
|
+
* - `0.3-0.5`: Low confidence, fallback agent used
|
|
441
|
+
* - `<0.3`: Very low confidence, consider using specific agent endpoint
|
|
442
|
+
*
|
|
443
|
+
* **Credit Costs:**
|
|
444
|
+
* - Quick mode: 5-10 credits per query
|
|
445
|
+
* - Standard mode: 15-25 credits per query
|
|
446
|
+
* - Extended mode: 30-75 credits per query
|
|
447
|
+
* - RAG enrichment: +5-15 credits (if enabled)
|
|
421
448
|
*
|
|
422
|
-
* Use
|
|
449
|
+
* **Use Cases:**
|
|
450
|
+
* - Ask questions without specifying agent type
|
|
451
|
+
* - Get intelligent routing for complex multi-domain queries
|
|
452
|
+
* - Leverage conversation history for contextual understanding
|
|
453
|
+
* - Enable RAG for knowledge base enrichment
|
|
454
|
+
*
|
|
455
|
+
* See request/response examples in the "Examples" dropdown below.
|
|
423
456
|
*/
|
|
424
457
|
export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
|
|
425
458
|
/**
|
|
@@ -578,6 +611,23 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
|
|
|
578
611
|
* - **Download Support**: Unencrypted backups can be downloaded
|
|
579
612
|
* - **Restore Support**: Future support for encrypted backup restoration
|
|
580
613
|
*
|
|
614
|
+
* **Operation State Machine:**
|
|
615
|
+
* ```
|
|
616
|
+
* pending → processing → completed
|
|
617
|
+
* ↘ failed
|
|
618
|
+
* ```
|
|
619
|
+
* - **pending**: Backup queued, waiting to start
|
|
620
|
+
* - **processing**: Actively backing up database
|
|
621
|
+
* - **completed**: Backup successfully created and stored
|
|
622
|
+
* - **failed**: Backup failed (check error message)
|
|
623
|
+
*
|
|
624
|
+
* **Expected Durations:**
|
|
625
|
+
* Operation times vary by database size:
|
|
626
|
+
* - **Small** (<1GB): 30 seconds - 2 minutes
|
|
627
|
+
* - **Medium** (1-10GB): 2-10 minutes
|
|
628
|
+
* - **Large** (10-100GB): 10-30 minutes
|
|
629
|
+
* - **Very Large** (>100GB): 30+ minutes
|
|
630
|
+
*
|
|
581
631
|
* **Progress Monitoring:**
|
|
582
632
|
* Use the returned operation_id to connect to the SSE stream:
|
|
583
633
|
* ```javascript
|
|
@@ -585,6 +635,7 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
|
|
|
585
635
|
* eventSource.addEventListener('operation_progress', (event) => {
|
|
586
636
|
* const data = JSON.parse(event.data);
|
|
587
637
|
* console.log('Backup progress:', data.progress_percent + '%');
|
|
638
|
+
* console.log('Status:', data.status); // pending, processing, completed, failed
|
|
588
639
|
* });
|
|
589
640
|
* ```
|
|
590
641
|
*
|
|
@@ -629,6 +680,28 @@ export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false
|
|
|
629
680
|
* - **Data Integrity**: Verification ensures successful restore
|
|
630
681
|
* - **Security**: Only encrypted backups to prevent data tampering
|
|
631
682
|
*
|
|
683
|
+
* **Operation State Machine:**
|
|
684
|
+
* ```
|
|
685
|
+
* pending → backing_up_current → downloading → restoring → verifying → completed
|
|
686
|
+
* ↘ failed
|
|
687
|
+
* ```
|
|
688
|
+
* - **pending**: Restore queued, waiting to start
|
|
689
|
+
* - **backing_up_current**: Creating safety backup of existing database
|
|
690
|
+
* - **downloading**: Downloading backup from storage
|
|
691
|
+
* - **restoring**: Replacing database with backup contents
|
|
692
|
+
* - **verifying**: Verifying database integrity (if enabled)
|
|
693
|
+
* - **completed**: Restore successful, database operational
|
|
694
|
+
* - **failed**: Restore failed (rollback may be available)
|
|
695
|
+
*
|
|
696
|
+
* **Expected Durations:**
|
|
697
|
+
* Operation times vary by database size (includes backup + restore):
|
|
698
|
+
* - **Small** (<1GB): 1-3 minutes
|
|
699
|
+
* - **Medium** (1-10GB): 5-15 minutes
|
|
700
|
+
* - **Large** (10-100GB): 20-45 minutes
|
|
701
|
+
* - **Very Large** (>100GB): 45+ minutes
|
|
702
|
+
*
|
|
703
|
+
* Note: Restore operations take longer than backups due to safety backup step.
|
|
704
|
+
*
|
|
632
705
|
* **Progress Monitoring:**
|
|
633
706
|
* Use the returned operation_id to connect to the SSE stream:
|
|
634
707
|
* ```javascript
|
|
@@ -636,6 +709,7 @@ export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false
|
|
|
636
709
|
* eventSource.addEventListener('operation_progress', (event) => {
|
|
637
710
|
* const data = JSON.parse(event.data);
|
|
638
711
|
* console.log('Restore progress:', data.message);
|
|
712
|
+
* console.log('Status:', data.status); // Shows current state
|
|
639
713
|
* });
|
|
640
714
|
* ```
|
|
641
715
|
*
|
|
@@ -1559,9 +1633,35 @@ export declare const getGraphs: <ThrowOnError extends boolean = false>(options?:
|
|
|
1559
1633
|
* This endpoint starts an asynchronous graph creation operation and returns
|
|
1560
1634
|
* connection details for monitoring progress via Server-Sent Events (SSE).
|
|
1561
1635
|
*
|
|
1562
|
-
* **
|
|
1563
|
-
*
|
|
1564
|
-
*
|
|
1636
|
+
* **Graph Creation Options:**
|
|
1637
|
+
*
|
|
1638
|
+
* 1. **Entity Graph with Initial Entity** (`initial_entity` provided, `create_entity=True`):
|
|
1639
|
+
* - Creates graph structure with entity schema extensions
|
|
1640
|
+
* - Populates an initial entity node with provided data
|
|
1641
|
+
* - Useful when you want a pre-configured entity to start with
|
|
1642
|
+
* - Example: Creating a company graph with the company already populated
|
|
1643
|
+
*
|
|
1644
|
+
* 2. **Entity Graph without Initial Entity** (`initial_entity=None`, `create_entity=False`):
|
|
1645
|
+
* - Creates graph structure with entity schema extensions
|
|
1646
|
+
* - Graph starts empty, ready for data import
|
|
1647
|
+
* - Useful for bulk data imports or custom workflows
|
|
1648
|
+
* - Example: Creating a graph structure before importing from CSV/API
|
|
1649
|
+
*
|
|
1650
|
+
* 3. **Generic Graph** (no `initial_entity` provided):
|
|
1651
|
+
* - Creates empty graph with custom schema extensions
|
|
1652
|
+
* - General-purpose knowledge graph
|
|
1653
|
+
* - Example: Analytics graphs, custom data models
|
|
1654
|
+
*
|
|
1655
|
+
* **Required Fields:**
|
|
1656
|
+
* - `metadata.graph_name`: Unique name for the graph
|
|
1657
|
+
* - `instance_tier`: Resource tier (kuzu-standard, kuzu-large, kuzu-xlarge)
|
|
1658
|
+
*
|
|
1659
|
+
* **Optional Fields:**
|
|
1660
|
+
* - `metadata.description`: Human-readable description of the graph's purpose
|
|
1661
|
+
* - `metadata.schema_extensions`: List of schema extensions (roboledger, roboinvestor, etc.)
|
|
1662
|
+
* - `tags`: Organizational tags (max 10)
|
|
1663
|
+
* - `initial_entity`: Entity data (required for entity graphs with initial data)
|
|
1664
|
+
* - `create_entity`: Whether to populate initial entity (default: true when initial_entity provided)
|
|
1565
1665
|
*
|
|
1566
1666
|
* **Monitoring Progress:**
|
|
1567
1667
|
* Use the returned `operation_id` to connect to the SSE stream:
|
|
@@ -1628,6 +1728,37 @@ export declare const createGraph: <ThrowOnError extends boolean = false>(options
|
|
|
1628
1728
|
* Extension listing is included - no credit consumption required.
|
|
1629
1729
|
*/
|
|
1630
1730
|
export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => import("./client").RequestResult<GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, ThrowOnError, "fields">;
|
|
1731
|
+
/**
|
|
1732
|
+
* Get Available Graph Tiers
|
|
1733
|
+
* List all available graph database tier configurations.
|
|
1734
|
+
*
|
|
1735
|
+
* This endpoint provides comprehensive technical specifications for each available
|
|
1736
|
+
* graph database tier, including instance types, resource limits, and features.
|
|
1737
|
+
*
|
|
1738
|
+
* **Tier Information:**
|
|
1739
|
+
* Each tier includes:
|
|
1740
|
+
* - Technical specifications (instance type, memory, storage)
|
|
1741
|
+
* - Resource limits (subgraphs, credits, rate limits)
|
|
1742
|
+
* - Feature list with capabilities
|
|
1743
|
+
* - Availability status
|
|
1744
|
+
*
|
|
1745
|
+
* **Available Tiers:**
|
|
1746
|
+
* - **kuzu-standard**: Multi-tenant entry-level tier
|
|
1747
|
+
* - **kuzu-large**: Dedicated professional tier with subgraph support
|
|
1748
|
+
* - **kuzu-xlarge**: Enterprise tier with maximum resources
|
|
1749
|
+
* - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
|
|
1750
|
+
* - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
|
|
1751
|
+
*
|
|
1752
|
+
* **Use Cases:**
|
|
1753
|
+
* - Display tier options in graph creation UI
|
|
1754
|
+
* - Show technical specifications for tier selection
|
|
1755
|
+
* - Validate tier availability before graph creation
|
|
1756
|
+
* - Display feature comparisons
|
|
1757
|
+
*
|
|
1758
|
+
* **Note:**
|
|
1759
|
+
* Tier listing is included - no credit consumption required.
|
|
1760
|
+
*/
|
|
1761
|
+
export declare const getAvailableGraphTiers: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableGraphTiersData, ThrowOnError>) => import("./client").RequestResult<GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, ThrowOnError, "fields">;
|
|
1631
1762
|
/**
|
|
1632
1763
|
* Select Graph
|
|
1633
1764
|
* Select a specific graph as the active workspace for the user.
|