@nebula-ai/sdk 1.6.0-rc.0 → 1.6.2
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 +2 -8
- package/dist/index.cjs +141 -100
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +214 -84
- package/dist/index.d.ts +214 -84
- package/dist/index.js +141 -100
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -13,7 +13,6 @@ declare function sleep(ms: number, signal?: AbortSignal): Promise<void>;
|
|
|
13
13
|
interface ClientOptions {
|
|
14
14
|
baseUrl?: string;
|
|
15
15
|
apiKey?: string;
|
|
16
|
-
bearerToken?: string;
|
|
17
16
|
defaultHeaders?: Record<string, string>;
|
|
18
17
|
fetchImpl?: typeof fetch;
|
|
19
18
|
fetchOptions?: Omit<RequestInit, "method" | "headers" | "body" | "signal">;
|
|
@@ -31,10 +30,13 @@ interface RequestArgs {
|
|
|
31
30
|
idempotent?: boolean;
|
|
32
31
|
signal?: AbortSignal;
|
|
33
32
|
}
|
|
33
|
+
/** Per-call options every generated resource method accepts. */
|
|
34
|
+
interface RequestOptions {
|
|
35
|
+
signal?: AbortSignal;
|
|
36
|
+
}
|
|
34
37
|
declare class NebulaCore {
|
|
35
38
|
readonly baseUrl: string;
|
|
36
39
|
readonly apiKey?: string;
|
|
37
|
-
readonly bearerToken?: string;
|
|
38
40
|
readonly defaultHeaders: Record<string, string>;
|
|
39
41
|
readonly fetchImpl: typeof fetch;
|
|
40
42
|
readonly fetchOptions: Omit<RequestInit, "method" | "headers" | "body" | "signal">;
|
|
@@ -120,8 +122,8 @@ interface components {
|
|
|
120
122
|
* ActivatedProcedure
|
|
121
123
|
* @description A procedure-like memory activated during memory traversal.
|
|
122
124
|
*
|
|
123
|
-
* This includes preference procedures
|
|
124
|
-
*
|
|
125
|
+
* This includes preference procedures and atomic traces. Distinct from facts
|
|
126
|
+
* which are descriptive assertions.
|
|
125
127
|
*/
|
|
126
128
|
ActivatedProcedure: {
|
|
127
129
|
/**
|
|
@@ -154,8 +156,11 @@ interface components {
|
|
|
154
156
|
is_negated?: boolean; /** Metadata */
|
|
155
157
|
metadata?: {
|
|
156
158
|
[key: string]: unknown;
|
|
157
|
-
} | null; /**
|
|
158
|
-
|
|
159
|
+
} | null; /** Stability Confidence */
|
|
160
|
+
stability_confidence?: number | null; /** Statement */
|
|
161
|
+
statement: string; /** Truth Confidence */
|
|
162
|
+
truth_confidence?: number | null; /** Use Confidence */
|
|
163
|
+
use_confidence?: number | null;
|
|
159
164
|
};
|
|
160
165
|
/**
|
|
161
166
|
* ActivatedSemantic
|
|
@@ -515,7 +520,8 @@ interface components {
|
|
|
515
520
|
*/
|
|
516
521
|
preview_query_limit?: number | null; /** Purchase Price Usd */
|
|
517
522
|
purchase_price_usd?: string | null; /** Rental Price Monthly Usd */
|
|
518
|
-
rental_price_monthly_usd?: string | null;
|
|
523
|
+
rental_price_monthly_usd?: string | null; /** Storage Target Id */
|
|
524
|
+
storage_target_id?: string | null;
|
|
519
525
|
/**
|
|
520
526
|
* Updated At
|
|
521
527
|
* Format: date-time
|
|
@@ -679,11 +685,20 @@ interface components {
|
|
|
679
685
|
CreateCollectionRequest: {
|
|
680
686
|
/** Description */description?: string | null; /** Name */
|
|
681
687
|
name: string;
|
|
688
|
+
/**
|
|
689
|
+
* Storage Target Id
|
|
690
|
+
* @description BYOC storage target to host this collection's graph data. Requires a team workspace and an active target provisioned through the dashboard or workspace storage-target APIs.
|
|
691
|
+
*/
|
|
692
|
+
storage_target_id?: string | null;
|
|
682
693
|
/**
|
|
683
694
|
* Workflows Enabled
|
|
684
695
|
* @default false
|
|
685
696
|
*/
|
|
686
|
-
workflows_enabled?: boolean;
|
|
697
|
+
workflows_enabled?: boolean;
|
|
698
|
+
/**
|
|
699
|
+
* Workspace Id
|
|
700
|
+
* @description Workspace this collection belongs to. Provisioned via the dashboard / management API, not minted through the public SDK.
|
|
701
|
+
*/
|
|
687
702
|
workspace_id?: string | null;
|
|
688
703
|
};
|
|
689
704
|
/**
|
|
@@ -755,7 +770,8 @@ interface components {
|
|
|
755
770
|
* @description Raw text content for document kind
|
|
756
771
|
*/
|
|
757
772
|
raw_text?: string | null; /** @description Device-memory snapshot (mutually exclusive with collection_id). */
|
|
758
|
-
snapshot?: components["schemas"]["SnapshotEnvelope-Input"] | null;
|
|
773
|
+
snapshot?: components["schemas"]["SnapshotEnvelope-Input"] | null; /** @description Device-memory snapshot reference for customer-owned object storage. Mutually exclusive with collection_id and snapshot. */
|
|
774
|
+
snapshot_ref?: components["schemas"]["SnapshotObjectReference"] | null;
|
|
759
775
|
/**
|
|
760
776
|
* Speaker Id
|
|
761
777
|
* @description UUID of the SourceRole entity creating this memory
|
|
@@ -1358,7 +1374,10 @@ interface components {
|
|
|
1358
1374
|
episodic?: components["schemas"]["ActivatedEpisode"][]; /** Inference Hints */
|
|
1359
1375
|
inference_hints?: components["schemas"]["InferenceHint"][]; /** Procedural */
|
|
1360
1376
|
procedural?: components["schemas"]["ActivatedProcedure"][]; /** Query */
|
|
1361
|
-
query: string; /**
|
|
1377
|
+
query: string; /** Search Timing Ms */
|
|
1378
|
+
search_timing_ms?: {
|
|
1379
|
+
[key: string]: number;
|
|
1380
|
+
} | null; /** Semantic */
|
|
1362
1381
|
semantic?: components["schemas"]["ActivatedSemantic"][]; /** Sources */
|
|
1363
1382
|
sources?: components["schemas"]["GroundedSource"][]; /** Total Traversal Time Ms */
|
|
1364
1383
|
total_traversal_time_ms?: number | null; /** Workflows */
|
|
@@ -1397,7 +1416,8 @@ interface components {
|
|
|
1397
1416
|
*/
|
|
1398
1417
|
query?: string | null; /** @description Advanced search settings. */
|
|
1399
1418
|
search_settings?: components["schemas"]["SearchSettings"] | null; /** @description Device-memory snapshot for stateless search. */
|
|
1400
|
-
snapshot?: components["schemas"]["SnapshotEnvelope-Input"] | null;
|
|
1419
|
+
snapshot?: components["schemas"]["SnapshotEnvelope-Input"] | null; /** @description Device-memory snapshot reference for stateless search. */
|
|
1420
|
+
snapshot_ref?: components["schemas"]["SnapshotObjectReference"] | null;
|
|
1401
1421
|
};
|
|
1402
1422
|
/**
|
|
1403
1423
|
* Message
|
|
@@ -1770,9 +1790,11 @@ interface components {
|
|
|
1770
1790
|
* Format: uuid
|
|
1771
1791
|
*/
|
|
1772
1792
|
collection_id: string;
|
|
1793
|
+
destination?: components["schemas"]["SnapshotObjectReference"] | null;
|
|
1773
1794
|
}; /** SnapshotImportRequest */
|
|
1774
1795
|
SnapshotImportRequest: {
|
|
1775
|
-
snapshot
|
|
1796
|
+
snapshot?: components["schemas"]["SnapshotEnvelope-Input"] | null;
|
|
1797
|
+
snapshot_ref?: components["schemas"]["SnapshotObjectReference"] | null;
|
|
1776
1798
|
};
|
|
1777
1799
|
/**
|
|
1778
1800
|
* SnapshotImportResult
|
|
@@ -1790,7 +1812,42 @@ interface components {
|
|
|
1790
1812
|
* @description Updated snapshot returned by snapshot-mode memory writes.
|
|
1791
1813
|
*/
|
|
1792
1814
|
SnapshotMutationResult: {
|
|
1793
|
-
snapshot
|
|
1815
|
+
snapshot?: components["schemas"]["SnapshotEnvelope-Output"] | null;
|
|
1816
|
+
snapshot_ref?: components["schemas"]["SnapshotObjectReference"] | null;
|
|
1817
|
+
};
|
|
1818
|
+
/**
|
|
1819
|
+
* SnapshotObjectReference
|
|
1820
|
+
* @description Customer-owned snapshot object transport for device memory.
|
|
1821
|
+
*/
|
|
1822
|
+
SnapshotObjectReference: {
|
|
1823
|
+
/**
|
|
1824
|
+
* Collection Id
|
|
1825
|
+
* Format: uuid
|
|
1826
|
+
* @description Collection UUID the referenced snapshot belongs to. Nebula authorizes this collection before fetching customer-owned URLs.
|
|
1827
|
+
*/
|
|
1828
|
+
collection_id: string; /** Get Headers */
|
|
1829
|
+
get_headers?: {
|
|
1830
|
+
[key: string]: string;
|
|
1831
|
+
};
|
|
1832
|
+
/**
|
|
1833
|
+
* Get Url
|
|
1834
|
+
* @description Short-lived signed URL Nebula can GET to load the snapshot.
|
|
1835
|
+
*/
|
|
1836
|
+
get_url?: string | null; /** Put Headers */
|
|
1837
|
+
put_headers?: {
|
|
1838
|
+
[key: string]: string;
|
|
1839
|
+
};
|
|
1840
|
+
/**
|
|
1841
|
+
* Put Url
|
|
1842
|
+
* @description Short-lived signed URL Nebula can PUT to store an updated snapshot.
|
|
1843
|
+
*/
|
|
1844
|
+
put_url?: string | null;
|
|
1845
|
+
/**
|
|
1846
|
+
* Type
|
|
1847
|
+
* @default signed_url
|
|
1848
|
+
* @constant
|
|
1849
|
+
*/
|
|
1850
|
+
type?: "signed_url";
|
|
1794
1851
|
}; /** SnapshotSearchEntityResponse */
|
|
1795
1852
|
SnapshotSearchEntityResponse: {
|
|
1796
1853
|
/** Category */category?: string | null; /** Description */
|
|
@@ -1831,6 +1888,67 @@ interface components {
|
|
|
1831
1888
|
/** Entities */entities?: components["schemas"]["SnapshotSearchEntityResponse"][]; /** Relationships */
|
|
1832
1889
|
relationships?: components["schemas"]["SnapshotSearchRelationshipResponse"][];
|
|
1833
1890
|
};
|
|
1891
|
+
/**
|
|
1892
|
+
* StorageTargetCreateRequest
|
|
1893
|
+
* @description Hosted SaaS storage target registration. Use AWS S3 and omit custom endpoint configuration.
|
|
1894
|
+
*/
|
|
1895
|
+
StorageTargetCreateRequest: {
|
|
1896
|
+
/** Bucket */bucket: string; /** Kms Key Id */
|
|
1897
|
+
kms_key_id?: string; /** Name */
|
|
1898
|
+
name: string;
|
|
1899
|
+
/**
|
|
1900
|
+
* Prefix
|
|
1901
|
+
* @default
|
|
1902
|
+
*/
|
|
1903
|
+
prefix?: string; /** Region */
|
|
1904
|
+
region: string;
|
|
1905
|
+
/**
|
|
1906
|
+
* Role Arn
|
|
1907
|
+
* @description AWS IAM role ARN Nebula assumes to access the bucket.
|
|
1908
|
+
*/
|
|
1909
|
+
role_arn: string;
|
|
1910
|
+
}; /** StorageTargetResponse */
|
|
1911
|
+
StorageTargetResponse: {
|
|
1912
|
+
/** Bucket */bucket: string;
|
|
1913
|
+
/**
|
|
1914
|
+
* Created At
|
|
1915
|
+
* Format: date-time
|
|
1916
|
+
*/
|
|
1917
|
+
created_at: string; /** External Id */
|
|
1918
|
+
external_id: string;
|
|
1919
|
+
/**
|
|
1920
|
+
* Id
|
|
1921
|
+
* Format: uuid
|
|
1922
|
+
*/
|
|
1923
|
+
id: string;
|
|
1924
|
+
/**
|
|
1925
|
+
* Kind
|
|
1926
|
+
* @constant
|
|
1927
|
+
*/
|
|
1928
|
+
kind: "customer_s3"; /** Kms Key Id */
|
|
1929
|
+
kms_key_id?: string | null; /** Last Validated At */
|
|
1930
|
+
last_validated_at?: string | null; /** Name */
|
|
1931
|
+
name: string; /** Prefix */
|
|
1932
|
+
prefix: string; /** Region */
|
|
1933
|
+
region?: string | null; /** Role Arn */
|
|
1934
|
+
role_arn?: string | null;
|
|
1935
|
+
/**
|
|
1936
|
+
* Status
|
|
1937
|
+
* @enum {string}
|
|
1938
|
+
*/
|
|
1939
|
+
status: "pending" | "active" | "validation_failed" | "disabled";
|
|
1940
|
+
/**
|
|
1941
|
+
* Updated At
|
|
1942
|
+
* Format: date-time
|
|
1943
|
+
*/
|
|
1944
|
+
updated_at: string; /** Validation Error */
|
|
1945
|
+
validation_error?: string | null;
|
|
1946
|
+
/**
|
|
1947
|
+
* Workspace Id
|
|
1948
|
+
* Format: uuid
|
|
1949
|
+
*/
|
|
1950
|
+
workspace_id: string;
|
|
1951
|
+
};
|
|
1834
1952
|
/**
|
|
1835
1953
|
* TextContentRequest
|
|
1836
1954
|
* @description Text content block.
|
|
@@ -1945,6 +2063,9 @@ interface components {
|
|
|
1945
2063
|
}; /** NebulaResults[list[ConnectorConnectionResponse]] */
|
|
1946
2064
|
WrappedListOfConnectorConnectionResponse: {
|
|
1947
2065
|
/** Results */results: components["schemas"]["ConnectorConnectionResponse"][];
|
|
2066
|
+
}; /** NebulaResults[list[StorageTargetResponse]] */
|
|
2067
|
+
WrappedListOfStorageTargetResponse: {
|
|
2068
|
+
/** Results */results: components["schemas"]["StorageTargetResponse"][];
|
|
1948
2069
|
}; /** NebulaResults[list[str]] */
|
|
1949
2070
|
WrappedListOfStr: {
|
|
1950
2071
|
/** Results */results: string[];
|
|
@@ -1957,9 +2078,9 @@ interface components {
|
|
|
1957
2078
|
}; /** NebulaResults[PresignedUploadResponse] */
|
|
1958
2079
|
WrappedPresignedUploadResponse: {
|
|
1959
2080
|
results: components["schemas"]["PresignedUploadResponse"];
|
|
1960
|
-
}; /** NebulaResults[SnapshotEnvelope] */
|
|
1961
|
-
|
|
1962
|
-
results: components["schemas"]["SnapshotEnvelope-Output"];
|
|
2081
|
+
}; /** NebulaResults[Union[SnapshotEnvelope, SnapshotObjectReference]] */
|
|
2082
|
+
WrappedSnapshotEnvelopeOrSnapshotObjectReference: {
|
|
2083
|
+
/** Results */results: components["schemas"]["SnapshotEnvelope-Output"] | components["schemas"]["SnapshotObjectReference"];
|
|
1963
2084
|
}; /** NebulaResults[SnapshotImportResult] */
|
|
1964
2085
|
WrappedSnapshotImportResult: {
|
|
1965
2086
|
results: components["schemas"]["SnapshotImportResult"];
|
|
@@ -1969,6 +2090,9 @@ interface components {
|
|
|
1969
2090
|
}; /** NebulaResults[SnapshotSearchResult] */
|
|
1970
2091
|
WrappedSnapshotSearchResult: {
|
|
1971
2092
|
results: components["schemas"]["SnapshotSearchResult"];
|
|
2093
|
+
}; /** NebulaResults[StorageTargetResponse] */
|
|
2094
|
+
WrappedStorageTargetResponse: {
|
|
2095
|
+
results: components["schemas"]["StorageTargetResponse"];
|
|
1972
2096
|
};
|
|
1973
2097
|
};
|
|
1974
2098
|
responses: never;
|
|
@@ -1979,32 +2103,24 @@ interface components {
|
|
|
1979
2103
|
}
|
|
1980
2104
|
//#endregion
|
|
1981
2105
|
//#region src/resources/client.d.ts
|
|
1982
|
-
interface RequestOptions$4 {
|
|
1983
|
-
signal?: AbortSignal;
|
|
1984
|
-
}
|
|
1985
2106
|
declare class ClientResource {
|
|
1986
2107
|
private readonly core;
|
|
1987
2108
|
constructor(core: NebulaCore);
|
|
1988
2109
|
/**
|
|
1989
|
-
*
|
|
1990
2110
|
* Health probe
|
|
1991
2111
|
*
|
|
1992
2112
|
* Lightweight liveness probe. Returns a 200 with a fixed message when the API process is up. Does not verify downstream dependencies (database, storage, workers) — use the internal status endpoints for those.
|
|
1993
2113
|
* @operationId client.health
|
|
1994
2114
|
* @endpoint GET /v1/health
|
|
1995
2115
|
*/
|
|
1996
|
-
health(options?: RequestOptions
|
|
2116
|
+
health(options?: RequestOptions): Promise<components["schemas"]["GenericMessageResponse"]>;
|
|
1997
2117
|
}
|
|
1998
2118
|
//#endregion
|
|
1999
2119
|
//#region src/resources/collections.d.ts
|
|
2000
|
-
interface RequestOptions$3 {
|
|
2001
|
-
signal?: AbortSignal;
|
|
2002
|
-
}
|
|
2003
2120
|
declare class CollectionsResource {
|
|
2004
2121
|
private readonly core;
|
|
2005
2122
|
constructor(core: NebulaCore);
|
|
2006
2123
|
/**
|
|
2007
|
-
*
|
|
2008
2124
|
* Create a new collection
|
|
2009
2125
|
*
|
|
2010
2126
|
* Create a new collection and automatically add the creating user
|
|
@@ -2016,9 +2132,8 @@ declare class CollectionsResource {
|
|
|
2016
2132
|
* @operationId collections.create
|
|
2017
2133
|
* @endpoint POST /v1/collections
|
|
2018
2134
|
*/
|
|
2019
|
-
create(body: components["schemas"]["CreateCollectionRequest"], options?: RequestOptions
|
|
2135
|
+
create(body: components["schemas"]["CreateCollectionRequest"], options?: RequestOptions): Promise<components["schemas"]["CollectionResponse"]>;
|
|
2020
2136
|
/**
|
|
2021
|
-
*
|
|
2022
2137
|
* Delete collection
|
|
2023
2138
|
*
|
|
2024
2139
|
* Delete an existing collection.
|
|
@@ -2030,9 +2145,8 @@ declare class CollectionsResource {
|
|
|
2030
2145
|
* @operationId collections.delete
|
|
2031
2146
|
* @endpoint DELETE /v1/collections/{id}
|
|
2032
2147
|
*/
|
|
2033
|
-
delete(id: string, options?: RequestOptions
|
|
2148
|
+
delete(id: string, options?: RequestOptions): Promise<components["schemas"]["GenericBooleanResponse"]>;
|
|
2034
2149
|
/**
|
|
2035
|
-
*
|
|
2036
2150
|
* List collections
|
|
2037
2151
|
*
|
|
2038
2152
|
* Returns a cursor-paginated list of collections the authenticated
|
|
@@ -2054,9 +2168,8 @@ declare class CollectionsResource {
|
|
|
2054
2168
|
limit?: number; /** If true, only returns collections owned by the user, not all accessible collections. */
|
|
2055
2169
|
ownerOnly?: boolean; /** Filter by workspace ID. Pass a UUID to scope to a workspace, or omit for all. */
|
|
2056
2170
|
workspaceId?: string | null;
|
|
2057
|
-
}, options?: RequestOptions
|
|
2171
|
+
}, options?: RequestOptions): Promise<components["schemas"]["PaginatedCollectionResponse"]>;
|
|
2058
2172
|
/**
|
|
2059
|
-
*
|
|
2060
2173
|
* Get collection details
|
|
2061
2174
|
*
|
|
2062
2175
|
* Get details of a specific collection.
|
|
@@ -2067,9 +2180,8 @@ declare class CollectionsResource {
|
|
|
2067
2180
|
* @operationId collections.retrieve
|
|
2068
2181
|
* @endpoint GET /v1/collections/{id}
|
|
2069
2182
|
*/
|
|
2070
|
-
retrieve(id: string, options?: RequestOptions
|
|
2183
|
+
retrieve(id: string, options?: RequestOptions): Promise<components["schemas"]["CollectionResponse"]>;
|
|
2071
2184
|
/**
|
|
2072
|
-
*
|
|
2073
2185
|
* Get a collection by name
|
|
2074
2186
|
*
|
|
2075
2187
|
* Retrieve a collection by its (owner_id, name) combination.
|
|
@@ -2082,9 +2194,8 @@ declare class CollectionsResource {
|
|
|
2082
2194
|
retrieveByName(params: {
|
|
2083
2195
|
/** The name of the collection */collectionName: string; /** (Superuser only) Specify the owner_id to retrieve a collection by name */
|
|
2084
2196
|
ownerId?: string | null;
|
|
2085
|
-
}, options?: RequestOptions
|
|
2197
|
+
}, options?: RequestOptions): Promise<components["schemas"]["CollectionResponse"]>;
|
|
2086
2198
|
/**
|
|
2087
|
-
*
|
|
2088
2199
|
* Update collection
|
|
2089
2200
|
*
|
|
2090
2201
|
* Update an existing collection's configuration.
|
|
@@ -2098,18 +2209,14 @@ declare class CollectionsResource {
|
|
|
2098
2209
|
update(params: {
|
|
2099
2210
|
/** The unique identifier of the collection to update */id: string;
|
|
2100
2211
|
body: components["schemas"]["UpdateCollectionRequest"];
|
|
2101
|
-
}, options?: RequestOptions
|
|
2212
|
+
}, options?: RequestOptions): Promise<components["schemas"]["CollectionResponse"]>;
|
|
2102
2213
|
}
|
|
2103
2214
|
//#endregion
|
|
2104
2215
|
//#region src/resources/connectors.d.ts
|
|
2105
|
-
interface RequestOptions$2 {
|
|
2106
|
-
signal?: AbortSignal;
|
|
2107
|
-
}
|
|
2108
2216
|
declare class ConnectorsResource {
|
|
2109
2217
|
private readonly core;
|
|
2110
2218
|
constructor(core: NebulaCore);
|
|
2111
2219
|
/**
|
|
2112
|
-
*
|
|
2113
2220
|
* Start OAuth connection flow
|
|
2114
2221
|
*
|
|
2115
2222
|
* Start the OAuth connection flow for the given external provider. Returns the authorization URL the user should visit to grant Nebula access. After consent the provider redirects back to Nebula and the connection becomes active.
|
|
@@ -2119,9 +2226,8 @@ declare class ConnectorsResource {
|
|
|
2119
2226
|
connect(params: {
|
|
2120
2227
|
provider: string;
|
|
2121
2228
|
body: components["schemas"]["ConnectRequest"];
|
|
2122
|
-
}, options?: RequestOptions
|
|
2229
|
+
}, options?: RequestOptions): Promise<components["schemas"]["ConnectorConnectResponse"]>;
|
|
2123
2230
|
/**
|
|
2124
|
-
*
|
|
2125
2231
|
* Disconnect an external data source
|
|
2126
2232
|
*
|
|
2127
2233
|
* Disconnect the named connection, revoking the stored OAuth credentials and stopping future syncs. Optionally pass `delete_memories=true` to also remove every memory this connection had ingested.
|
|
@@ -2131,9 +2237,8 @@ declare class ConnectorsResource {
|
|
|
2131
2237
|
disconnect(params: {
|
|
2132
2238
|
connectionId: string;
|
|
2133
2239
|
deleteMemories?: boolean;
|
|
2134
|
-
}, options?: RequestOptions
|
|
2240
|
+
}, options?: RequestOptions): Promise<components["schemas"]["ConnectorDisconnectResponse"]>;
|
|
2135
2241
|
/**
|
|
2136
|
-
*
|
|
2137
2242
|
* List active connections for a collection
|
|
2138
2243
|
*
|
|
2139
2244
|
* Return every connector connection associated with the given collection, with encrypted credentials redacted. Useful for showing the user which third-party data sources are wired up to a collection.
|
|
@@ -2142,45 +2247,38 @@ declare class ConnectorsResource {
|
|
|
2142
2247
|
*/
|
|
2143
2248
|
list(params: {
|
|
2144
2249
|
collectionId: string;
|
|
2145
|
-
}, options?: RequestOptions
|
|
2250
|
+
}, options?: RequestOptions): Promise<Array<components["schemas"]["ConnectorConnectionResponse"]>>;
|
|
2146
2251
|
/**
|
|
2147
|
-
*
|
|
2148
2252
|
* List available connector providers
|
|
2149
2253
|
*
|
|
2150
2254
|
* Return the set of connector provider identifiers (e.g. `google_drive`, `slack`) that this Nebula instance is configured to expose. Pass one of these to `POST /connectors/{provider}/connect` to start an OAuth flow.
|
|
2151
2255
|
* @operationId connectors.listProviders
|
|
2152
2256
|
* @endpoint GET /v1/connectors/providers
|
|
2153
2257
|
*/
|
|
2154
|
-
listProviders(options?: RequestOptions
|
|
2258
|
+
listProviders(options?: RequestOptions): Promise<Array<string>>;
|
|
2155
2259
|
/**
|
|
2156
|
-
*
|
|
2157
2260
|
* Get a single connection by ID
|
|
2158
2261
|
*
|
|
2159
2262
|
* Fetch a single connector connection by its UUID. Returns the connection metadata plus whether the underlying subscription is active. Encrypted credentials are never returned to clients.
|
|
2160
2263
|
* @operationId connectors.retrieve
|
|
2161
2264
|
* @endpoint GET /v1/connectors/{connection_id}
|
|
2162
2265
|
*/
|
|
2163
|
-
retrieve(connectionId: string, options?: RequestOptions
|
|
2266
|
+
retrieve(connectionId: string, options?: RequestOptions): Promise<components["schemas"]["ConnectorConnectionResponse"]>;
|
|
2164
2267
|
/**
|
|
2165
|
-
*
|
|
2166
2268
|
* Manually trigger a sync
|
|
2167
2269
|
*
|
|
2168
2270
|
* Schedule an immediate sync for an active connection, bypassing the normal cadence. Returns 409 if a sync is already in progress and 400 if the connection isn't in the `active` state.
|
|
2169
2271
|
* @operationId connectors.sync
|
|
2170
2272
|
* @endpoint POST /v1/connectors/{connection_id}/sync
|
|
2171
2273
|
*/
|
|
2172
|
-
sync(connectionId: string, options?: RequestOptions
|
|
2274
|
+
sync(connectionId: string, options?: RequestOptions): Promise<components["schemas"]["ConnectorSyncResponse"]>;
|
|
2173
2275
|
}
|
|
2174
2276
|
//#endregion
|
|
2175
2277
|
//#region src/resources/memories.d.ts
|
|
2176
|
-
interface RequestOptions$1 {
|
|
2177
|
-
signal?: AbortSignal;
|
|
2178
|
-
}
|
|
2179
2278
|
declare class MemoriesResource {
|
|
2180
2279
|
private readonly core;
|
|
2181
2280
|
constructor(core: NebulaCore);
|
|
2182
2281
|
/**
|
|
2183
|
-
*
|
|
2184
2282
|
* Append content to an engram
|
|
2185
2283
|
*
|
|
2186
2284
|
* Append content to an existing engram.
|
|
@@ -2198,9 +2296,8 @@ declare class MemoriesResource {
|
|
|
2198
2296
|
append(params: {
|
|
2199
2297
|
/** The unique identifier of the engram */id: string;
|
|
2200
2298
|
body: components["schemas"]["AppendMemoryRequest"];
|
|
2201
|
-
}, options?: RequestOptions
|
|
2299
|
+
}, options?: RequestOptions): Promise<components["schemas"]["AppendMemoryResponse"] | components["schemas"]["IngestionResponse"]>;
|
|
2202
2300
|
/**
|
|
2203
|
-
*
|
|
2204
2301
|
* Create a new memory (conversation or document)
|
|
2205
2302
|
*
|
|
2206
2303
|
* Create a new memory (conversation or document) using clean JSON body.
|
|
@@ -2215,9 +2312,8 @@ declare class MemoriesResource {
|
|
|
2215
2312
|
* @operationId memories.create
|
|
2216
2313
|
* @endpoint POST /v1/memories
|
|
2217
2314
|
*/
|
|
2218
|
-
create(body: components["schemas"]["CreateMemoryRequest"], options?: RequestOptions
|
|
2315
|
+
create(body: components["schemas"]["CreateMemoryRequest"], options?: RequestOptions): Promise<components["schemas"]["MemoryCreateAcceptedResponse"] | components["schemas"]["SnapshotMutationResult"]>;
|
|
2219
2316
|
/**
|
|
2220
|
-
*
|
|
2221
2317
|
* Get presigned URL for large file upload
|
|
2222
2318
|
*
|
|
2223
2319
|
* Get a presigned URL for uploading large files directly to S3.
|
|
@@ -2245,9 +2341,8 @@ declare class MemoriesResource {
|
|
|
2245
2341
|
/** Original filename (e.g., 'image.jpg') */filename: string; /** MIME type (e.g., 'image/jpeg', 'application/pdf') */
|
|
2246
2342
|
contentType: string; /** Expected file size in bytes (max 100MB) */
|
|
2247
2343
|
fileSize: number;
|
|
2248
|
-
}, options?: RequestOptions
|
|
2344
|
+
}, options?: RequestOptions): Promise<components["schemas"]["PresignedUploadResponse"]>;
|
|
2249
2345
|
/**
|
|
2250
|
-
*
|
|
2251
2346
|
* Delete an engram
|
|
2252
2347
|
*
|
|
2253
2348
|
* Delete a specific engram with graph awareness. All chunks corresponding to the
|
|
@@ -2259,9 +2354,8 @@ declare class MemoriesResource {
|
|
|
2259
2354
|
* @operationId memories.delete
|
|
2260
2355
|
* @endpoint DELETE /v1/memories/{id}
|
|
2261
2356
|
*/
|
|
2262
|
-
delete(id: string, options?: RequestOptions
|
|
2357
|
+
delete(id: string, options?: RequestOptions): Promise<components["schemas"]["GenericBooleanResponse"]>;
|
|
2263
2358
|
/**
|
|
2264
|
-
*
|
|
2265
2359
|
* Delete one or more engrams
|
|
2266
2360
|
*
|
|
2267
2361
|
* Delete one or more engrams.
|
|
@@ -2278,9 +2372,8 @@ declare class MemoriesResource {
|
|
|
2278
2372
|
* @operationId memories.deleteMany
|
|
2279
2373
|
* @endpoint POST /v1/memories/delete
|
|
2280
2374
|
*/
|
|
2281
|
-
deleteMany(body: components["schemas"]["DeleteMemoriesRequest"], options?: RequestOptions
|
|
2375
|
+
deleteMany(body: components["schemas"]["DeleteMemoriesRequest"], options?: RequestOptions): Promise<unknown>;
|
|
2282
2376
|
/**
|
|
2283
|
-
*
|
|
2284
2377
|
* Delete a previously uploaded S3 file
|
|
2285
2378
|
*
|
|
2286
2379
|
* Delete a file from S3 that was uploaded via a presigned URL.
|
|
@@ -2290,9 +2383,8 @@ declare class MemoriesResource {
|
|
|
2290
2383
|
*/
|
|
2291
2384
|
deleteUpload(params: {
|
|
2292
2385
|
/** S3 key of the file to delete (returned by POST /memories/upload) */s3Key: string;
|
|
2293
|
-
}, options?: RequestOptions
|
|
2386
|
+
}, options?: RequestOptions): Promise<components["schemas"]["GenericMessageResponse"]>;
|
|
2294
2387
|
/**
|
|
2295
|
-
*
|
|
2296
2388
|
* List engrams
|
|
2297
2389
|
*
|
|
2298
2390
|
* Returns a cursor-paginated list of engrams the authenticated user
|
|
@@ -2316,9 +2408,8 @@ declare class MemoriesResource {
|
|
|
2316
2408
|
collectionIds?: Array<string> | null; /** JSON string for metadata filtering. Example: '{"metadata.source": {"$eq": "playground"}}' */
|
|
2317
2409
|
metadataFilters?: string | null; /** Read-your-writes assertion: the WAL-tail overlay path waits for at least this seq to be applied before serving (or returns 503 Unavailable on timeout). REQUIRES exactly one collection_ids entry — without a collection scope the request returns 422 (the per-WAL-shard scalar applied_wal_seq is meaningless across collections). When the served shard has not been migrated to wal_compaction_enabled, the field is accepted but the served path is the legacy overlay (the assertion has no effect — the response's applied_wal_seq will be 0). Pass back the value the matching upload response surfaced. */
|
|
2318
2410
|
minAppliedWalSeq?: number | null;
|
|
2319
|
-
}, options?: RequestOptions
|
|
2411
|
+
}, options?: RequestOptions): Promise<components["schemas"]["PaginatedListedEngram"]>;
|
|
2320
2412
|
/**
|
|
2321
|
-
*
|
|
2322
2413
|
* Recall workflow patterns by intent
|
|
2323
2414
|
*
|
|
2324
2415
|
* Workflow-pattern recall over 5 intents.
|
|
@@ -2334,9 +2425,8 @@ declare class MemoriesResource {
|
|
|
2334
2425
|
* @operationId memories.recallWorkflow
|
|
2335
2426
|
* @endpoint POST /v1/memories/workflow/recall
|
|
2336
2427
|
*/
|
|
2337
|
-
recallWorkflow(body: components["schemas"]["CursorRecallRequest"] | components["schemas"]["PredictRecallRequest"] | components["schemas"]["ResumeRecallRequest"] | components["schemas"]["EvidenceRecallRequest"] | components["schemas"]["BootstrapRecallRequest"], options?: RequestOptions
|
|
2428
|
+
recallWorkflow(body: components["schemas"]["CursorRecallRequest"] | components["schemas"]["PredictRecallRequest"] | components["schemas"]["ResumeRecallRequest"] | components["schemas"]["EvidenceRecallRequest"] | components["schemas"]["BootstrapRecallRequest"], options?: RequestOptions): Promise<Record<string, unknown>>;
|
|
2338
2429
|
/**
|
|
2339
|
-
*
|
|
2340
2430
|
* Retrieve an engram
|
|
2341
2431
|
*
|
|
2342
2432
|
* Retrieves detailed information about a specific engram by its
|
|
@@ -2350,9 +2440,8 @@ declare class MemoriesResource {
|
|
|
2350
2440
|
* @operationId memories.retrieve
|
|
2351
2441
|
* @endpoint GET /v1/memories/{id}
|
|
2352
2442
|
*/
|
|
2353
|
-
retrieve(id: string, options?: RequestOptions
|
|
2443
|
+
retrieve(id: string, options?: RequestOptions): Promise<components["schemas"]["Engram"]>;
|
|
2354
2444
|
/**
|
|
2355
|
-
*
|
|
2356
2445
|
* Search memories
|
|
2357
2446
|
*
|
|
2358
2447
|
* Perform a search query across your memories.
|
|
@@ -2365,9 +2454,8 @@ declare class MemoriesResource {
|
|
|
2365
2454
|
* @operationId memories.search
|
|
2366
2455
|
* @endpoint POST /v1/memories/search
|
|
2367
2456
|
*/
|
|
2368
|
-
search(body: components["schemas"]["MemorySearchRequest"], options?: RequestOptions
|
|
2457
|
+
search(body: components["schemas"]["MemorySearchRequest"], options?: RequestOptions): Promise<components["schemas"]["CompactMemoryRecallResponse"] | components["schemas"]["MemoryRecall"] | components["schemas"]["SnapshotSearchResult"]>;
|
|
2369
2458
|
/**
|
|
2370
|
-
*
|
|
2371
2459
|
* Update a memory
|
|
2372
2460
|
*
|
|
2373
2461
|
* Update memory-level properties including name, metadata, and collection associations.
|
|
@@ -2390,18 +2478,14 @@ declare class MemoriesResource {
|
|
|
2390
2478
|
/** 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. */
|
|
2391
2479
|
collectionId?: string | null;
|
|
2392
2480
|
body: components["schemas"]["UpdateMemoryRequest"];
|
|
2393
|
-
}, options?: RequestOptions
|
|
2481
|
+
}, options?: RequestOptions): Promise<components["schemas"]["Engram"]>;
|
|
2394
2482
|
}
|
|
2395
2483
|
//#endregion
|
|
2396
2484
|
//#region src/resources/snapshots.d.ts
|
|
2397
|
-
interface RequestOptions {
|
|
2398
|
-
signal?: AbortSignal;
|
|
2399
|
-
}
|
|
2400
2485
|
declare class SnapshotsResource {
|
|
2401
2486
|
private readonly core;
|
|
2402
2487
|
constructor(core: NebulaCore);
|
|
2403
2488
|
/**
|
|
2404
|
-
*
|
|
2405
2489
|
* Export a collection snapshot
|
|
2406
2490
|
*
|
|
2407
2491
|
* Export a collection's full graph state as a
|
|
@@ -2409,9 +2493,8 @@ declare class SnapshotsResource {
|
|
|
2409
2493
|
* @operationId snapshots.export
|
|
2410
2494
|
* @endpoint POST /v1/device-memory/snapshot/export
|
|
2411
2495
|
*/
|
|
2412
|
-
export(body: components["schemas"]["SnapshotExportRequest"], options?: RequestOptions): Promise<components["schemas"]["SnapshotEnvelope-Output"]>;
|
|
2496
|
+
export(body: components["schemas"]["SnapshotExportRequest"], options?: RequestOptions): Promise<components["schemas"]["SnapshotEnvelope-Output"] | components["schemas"]["SnapshotObjectReference"]>;
|
|
2413
2497
|
/**
|
|
2414
|
-
*
|
|
2415
2498
|
* Import a snapshot into an ephemeral collection
|
|
2416
2499
|
*
|
|
2417
2500
|
* Import a SnapshotEnvelope into an ephemeral
|
|
@@ -2422,6 +2505,53 @@ declare class SnapshotsResource {
|
|
|
2422
2505
|
import(body: components["schemas"]["SnapshotImportRequest"], options?: RequestOptions): Promise<components["schemas"]["SnapshotImportResult"]>;
|
|
2423
2506
|
}
|
|
2424
2507
|
//#endregion
|
|
2508
|
+
//#region src/resources/workspaces.d.ts
|
|
2509
|
+
declare class WorkspacesResource {
|
|
2510
|
+
private readonly core;
|
|
2511
|
+
constructor(core: NebulaCore);
|
|
2512
|
+
/**
|
|
2513
|
+
* Create workspace storage target
|
|
2514
|
+
*
|
|
2515
|
+
* Register a customer S3 bucket for hosted BYOC storage.
|
|
2516
|
+
* @operationId workspaces.createStorageTarget
|
|
2517
|
+
* @endpoint POST /v1/workspaces/{workspace_id}/storage-targets
|
|
2518
|
+
*/
|
|
2519
|
+
createStorageTarget(params: {
|
|
2520
|
+
workspaceId: string;
|
|
2521
|
+
body: components["schemas"]["StorageTargetCreateRequest"];
|
|
2522
|
+
}, options?: RequestOptions): Promise<components["schemas"]["StorageTargetResponse"]>;
|
|
2523
|
+
/**
|
|
2524
|
+
* Disable workspace storage target
|
|
2525
|
+
*
|
|
2526
|
+
* Disable a customer storage target for future collection binds.
|
|
2527
|
+
* @operationId workspaces.disableStorageTarget
|
|
2528
|
+
* @endpoint DELETE /v1/workspaces/{workspace_id}/storage-targets/{target_id}
|
|
2529
|
+
*/
|
|
2530
|
+
disableStorageTarget(params: {
|
|
2531
|
+
workspaceId: string;
|
|
2532
|
+
targetId: string;
|
|
2533
|
+
}, options?: RequestOptions): Promise<components["schemas"]["StorageTargetResponse"]>;
|
|
2534
|
+
/**
|
|
2535
|
+
* List workspace storage targets
|
|
2536
|
+
*
|
|
2537
|
+
* List customer-owned object storage targets for a workspace.
|
|
2538
|
+
* @operationId workspaces.listStorageTargets
|
|
2539
|
+
* @endpoint GET /v1/workspaces/{workspace_id}/storage-targets
|
|
2540
|
+
*/
|
|
2541
|
+
listStorageTargets(workspaceId: string, options?: RequestOptions): Promise<Array<components["schemas"]["StorageTargetResponse"]>>;
|
|
2542
|
+
/**
|
|
2543
|
+
* Validate workspace storage target
|
|
2544
|
+
*
|
|
2545
|
+
* Probe a customer storage target and mark it active on success.
|
|
2546
|
+
* @operationId workspaces.validateStorageTarget
|
|
2547
|
+
* @endpoint POST /v1/workspaces/{workspace_id}/storage-targets/{target_id}/validate
|
|
2548
|
+
*/
|
|
2549
|
+
validateStorageTarget(params: {
|
|
2550
|
+
workspaceId: string;
|
|
2551
|
+
targetId: string;
|
|
2552
|
+
}, options?: RequestOptions): Promise<components["schemas"]["StorageTargetResponse"]>;
|
|
2553
|
+
}
|
|
2554
|
+
//#endregion
|
|
2425
2555
|
//#region src/client.d.ts
|
|
2426
2556
|
declare class NebulaClient {
|
|
2427
2557
|
protected readonly core: NebulaCore;
|
|
@@ -2430,6 +2560,7 @@ declare class NebulaClient {
|
|
|
2430
2560
|
readonly connectors: ConnectorsResource;
|
|
2431
2561
|
readonly memories: MemoriesResource;
|
|
2432
2562
|
readonly snapshots: SnapshotsResource;
|
|
2563
|
+
readonly workspaces: WorkspacesResource;
|
|
2433
2564
|
constructor(options?: ClientOptions);
|
|
2434
2565
|
}
|
|
2435
2566
|
//#endregion
|
|
@@ -2498,7 +2629,6 @@ type CompatClientOptions = ClientOptions & {
|
|
|
2498
2629
|
baseUrl?: string | null;
|
|
2499
2630
|
baseURL?: string | null;
|
|
2500
2631
|
timeout?: number | null;
|
|
2501
|
-
bearerToken?: string | null;
|
|
2502
2632
|
};
|
|
2503
2633
|
interface MemoryCommonInput {
|
|
2504
2634
|
collection_id?: string | null;
|
|
@@ -2579,5 +2709,5 @@ declare class Nebula extends NebulaClient {
|
|
|
2579
2709
|
}): Promise<unknown>;
|
|
2580
2710
|
}
|
|
2581
2711
|
//#endregion
|
|
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 };
|
|
2712
|
+
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 RequestOptions, type RetryPolicy, backoffMs, type components, errorFromResponse, isRetryableStatus, sleep };
|
|
2583
2713
|
//# sourceMappingURL=index.d.ts.map
|