@nebula-ai/sdk 1.2.2 → 1.3.0

package/src/resources/snapshots.ts

@@ -0,0 +1,387 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Snapshots extends APIResource {
+  /**
+   * Export a collection's full graph state as a portable SnapshotEnvelope.
+   */
+  export(body: SnapshotExportParams, options?: RequestOptions): APIPromise<SnapshotExportResponse> {
+    return this._client.post('/v1/device-memory/snapshot/export', { body, ...options });
+  }
+
+  /**
+   * Import a SnapshotEnvelope into an ephemeral collection. Returns the ephemeral
+   * collection UUID.
+   */
+  import(body: SnapshotImportParams, options?: RequestOptions): APIPromise<SnapshotImportResponse> {
+    return this._client.post('/v1/device-memory/snapshot/import', { body, ...options });
+  }
+}
+
+export interface SnapshotExportResponse {
+  /**
+   * Portable full snapshot owned by the client.
+   */
+  results: SnapshotExportResponse.Results;
+}
+
+export namespace SnapshotExportResponse {
+  /**
+   * Portable full snapshot owned by the client.
+   */
+  export interface Results {
+    collection_id: string;
+
+    root_hash: string;
+
+    created_at?: string;
+
+    format_version?: number;
+
+    generation?: number;
+
+    /**
+     * A complete graph payload or a context subgraph payload.
+     */
+    graph?: Results.Graph;
+  }
+
+  export namespace Results {
+    /**
+     * A complete graph payload or a context subgraph payload.
+     */
+    export interface Graph {
+      entities?: Array<Graph.Entity>;
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      entity_description_embeddings?: Graph.EntityDescriptionEmbeddings;
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      relationship_description_embeddings?: Graph.RelationshipDescriptionEmbeddings;
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      relationship_relation_embeddings?: Graph.RelationshipRelationEmbeddings;
+
+      relationships?: Array<Graph.Relationship>;
+    }
+
+    export namespace Graph {
+      /**
+       * Canonical entity record used in snapshots, WAL ops, and segments.
+       */
+      export interface Entity {
+        id: string;
+
+        created_at: string;
+
+        engram_id: string;
+
+        name: string;
+
+        updated_at: string;
+
+        category?: string | null;
+
+        chunk_ids?: Array<string>;
+
+        collection_id?: string;
+
+        description?: string | null;
+
+        fts_terms?: { [key: string]: number } | null;
+
+        metadata?: { [key: string]: unknown };
+
+        relationship_count?: number;
+      }
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      export interface EntityDescriptionEmbeddings {
+        dim?: number;
+
+        encoding?: 'npy-base64';
+
+        mask_b64?: string;
+
+        values_b64?: string;
+      }
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      export interface RelationshipDescriptionEmbeddings {
+        dim?: number;
+
+        encoding?: 'npy-base64';
+
+        mask_b64?: string;
+
+        values_b64?: string;
+      }
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      export interface RelationshipRelationEmbeddings {
+        dim?: number;
+
+        encoding?: 'npy-base64';
+
+        mask_b64?: string;
+
+        values_b64?: string;
+      }
+
+      /**
+       * Canonical relationship record used in snapshots, WAL ops, and segments.
+       */
+      export interface Relationship {
+        id: string;
+
+        created_at: string;
+
+        object_id: string;
+
+        subject_id: string;
+
+        updated_at: string;
+
+        category?: string | null;
+
+        chunk_ids?: Array<string>;
+
+        collection_id?: string;
+
+        description?: string | null;
+
+        engram_id?: string | null;
+
+        inference_metadata?: { [key: string]: unknown } | null;
+
+        metadata?: { [key: string]: unknown };
+
+        object?: string | null;
+
+        predicate?: string;
+
+        relationship_type?: string | null;
+
+        subject?: string | null;
+
+        temporal_precision?: string | null;
+
+        valid_span?: { [key: string]: unknown } | null;
+
+        weight?: number | null;
+      }
+    }
+  }
+}
+
+export interface SnapshotImportResponse {
+  /**
+   * Ephemeral collection handle returned after importing a snapshot.
+   */
+  results: SnapshotImportResponse.Results;
+}
+
+export namespace SnapshotImportResponse {
+  /**
+   * Ephemeral collection handle returned after importing a snapshot.
+   */
+  export interface Results {
+    ephemeral_collection_id: string;
+  }
+}
+
+export interface SnapshotExportParams {
+  collection_id: string;
+}
+
+export interface SnapshotImportParams {
+  /**
+   * Portable full snapshot owned by the client.
+   */
+  snapshot: SnapshotImportParams.Snapshot;
+}
+
+export namespace SnapshotImportParams {
+  /**
+   * Portable full snapshot owned by the client.
+   */
+  export interface Snapshot {
+    collection_id: string;
+
+    root_hash: string;
+
+    created_at?: string;
+
+    format_version?: number;
+
+    generation?: number;
+
+    /**
+     * A complete graph payload or a context subgraph payload.
+     */
+    graph?: Snapshot.Graph;
+  }
+
+  export namespace Snapshot {
+    /**
+     * A complete graph payload or a context subgraph payload.
+     */
+    export interface Graph {
+      entities?: Array<Graph.Entity>;
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      entity_description_embeddings?: Graph.EntityDescriptionEmbeddings;
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      relationship_description_embeddings?: Graph.RelationshipDescriptionEmbeddings;
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      relationship_relation_embeddings?: Graph.RelationshipRelationEmbeddings;
+
+      relationships?: Array<Graph.Relationship>;
+    }
+
+    export namespace Graph {
+      /**
+       * Canonical entity record used in snapshots, WAL ops, and segments.
+       */
+      export interface Entity {
+        id: string;
+
+        created_at: string;
+
+        engram_id: string;
+
+        name: string;
+
+        updated_at: string;
+
+        category?: string | null;
+
+        chunk_ids?: Array<string>;
+
+        collection_id?: string;
+
+        description?: string | null;
+
+        fts_terms?: { [key: string]: number } | null;
+
+        metadata?: { [key: string]: unknown };
+
+        relationship_count?: number;
+      }
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      export interface EntityDescriptionEmbeddings {
+        dim?: number;
+
+        encoding?: 'npy-base64';
+
+        mask_b64?: string;
+
+        values_b64?: string;
+      }
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      export interface RelationshipDescriptionEmbeddings {
+        dim?: number;
+
+        encoding?: 'npy-base64';
+
+        mask_b64?: string;
+
+        values_b64?: string;
+      }
+
+      /**
+       * A positionally-aligned masked embedding matrix.
+       */
+      export interface RelationshipRelationEmbeddings {
+        dim?: number;
+
+        encoding?: 'npy-base64';
+
+        mask_b64?: string;
+
+        values_b64?: string;
+      }
+
+      /**
+       * Canonical relationship record used in snapshots, WAL ops, and segments.
+       */
+      export interface Relationship {
+        id: string;
+
+        created_at: string;
+
+        object_id: string;
+
+        subject_id: string;
+
+        updated_at: string;
+
+        category?: string | null;
+
+        chunk_ids?: Array<string>;
+
+        collection_id?: string;
+
+        description?: string | null;
+
+        engram_id?: string | null;
+
+        inference_metadata?: { [key: string]: unknown } | null;
+
+        metadata?: { [key: string]: unknown };
+
+        object?: string | null;
+
+        predicate?: string;
+
+        relationship_type?: string | null;
+
+        subject?: string | null;
+
+        temporal_precision?: string | null;
+
+        valid_span?: { [key: string]: unknown } | null;
+
+        weight?: number | null;
+      }
+    }
+  }
+}
+
+export declare namespace Snapshots {
+  export {
+    type SnapshotExportResponse as SnapshotExportResponse,
+    type SnapshotImportResponse as SnapshotImportResponse,
+    type SnapshotExportParams as SnapshotExportParams,
+    type SnapshotImportParams as SnapshotImportParams,
+  };
+}

package/src/resources/top-level.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export interface HealthResponse {
+  results: HealthResponse.Results;
+}
+
+export namespace HealthResponse {
+  export interface Results {
+    message: string;
+
+    id?: string | null;
+
+    memory_id?: string | null;
+  }
+}
+
+export declare namespace TopLevel {
+  export { type HealthResponse as HealthResponse };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '1.3.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "1.3.0";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "1.3.0";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '1.3.0'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '1.3.0'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}