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