endee 1.7.1 → 1.8.0-dev.2

package/dist/collection.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Collection client for Endee-DB (v2 Collections API).
+ *
+ * A collection holds objects, each carrying values for one or more named, typed
+ * fields (dense `vector`, `sparse`, or `multi_vector`). Obtain a Collection via
+ * `Endee.getCollection()` (or after `Endee.createCollection()`).
+ */
+import { type AxiosInstance } from 'axios';
+import { type CollectionMetadata, type FieldDefinition, type FullObject, type ObjectInput, type RebuildOptions, type SearchOptions, type SearchResponse, type UpdateFilterEntry } from './types/index.js';
+export declare class Collection {
+    readonly name: string;
+    private token;
+    private v2Url;
+    fields: FieldDefinition[];
+    createdAt?: number | string;
+    layoutVersion: number;
+    private http;
+    constructor(name: string, token: string, v2Url: string, metadata: CollectionMetadata, http?: AxiosInstance);
+    toString(): string;
+    /** name → { type, space_type, dimension } from the collection metadata. */
+    private fieldIndex;
+    private authHeaders;
+    /**
+     * Insert or update objects. Cosine `vector`/`multi_vector` values are
+     * L2-normalized client-side; the batch is serialized as msgpack into the
+     * server ObjectBatch layout and POSTed as `application/msgpack`.
+     *
+     * Wire layout (maps keyed by field name):
+     *   ObjectBatch   = [ objects ]
+     *   Object        = [ id, meta, filter, vectors, sparses, multi_vectors ]
+     *   vectors       = { fieldName: [float, ...] }
+     *   sparses       = { fieldName: [indices, values] }
+     *   multi_vectors = { fieldName: [[float, ...], ...] }
+     *
+     * Returns `{ upserted: <count> }`.
+     */
+    upsert(objects: ObjectInput[]): Promise<Record<string, unknown>>;
+    /**
+     * Search the collection across one or more fields in a single request.
+     *
+     * Each field is queried with the unified config `{ query, limit?, ef_search? }`,
+     * where `limit` is the max number of hits to return for that field (defaults
+     * to `DEFAULT_TOP_K`). The result is always one ranked list per field:
+     * `{ results: { [field]: SearchHit[] } }`. Use `rerank()` to fuse these into a
+     * single ranked list.
+     *
+     * For filtered searches, `prefilterCardinalityThreshold` and
+     * `filterBoostPercentage` tune the speed/recall trade-off; when either is
+     * set they're sent to the server as `filter_params`.
+     */
+    search(options: SearchOptions): Promise<SearchResponse>;
+    /** Delete a single object by id. Returns `{ deleted: "<id>" }`. */
+    deleteObject(id: string): Promise<Record<string, unknown>>;
+    /**
+     * Fetch full objects (meta, filter, and stored vectors) by id. Ids that don't
+     * exist are skipped by the server.
+     */
+    getObjects(ids: string[]): Promise<FullObject[]>;
+    /**
+     * Delete all objects matching a filter. Returns `{ deleted: <count> }`.
+     * `filter` uses the array format, e.g. `[{ category: { $eq: 'news' } }]`.
+     */
+    deleteByFilter(filter: Array<Record<string, unknown>>): Promise<Record<string, unknown>>;
+    /**
+     * Update filter tags on existing objects (no re-upsert of vectors).
+     * Returns `{ updated: <count> }`. `updates` is a list of `{ id, filter }`.
+     */
+    updateFilters(updates: UpdateFilterEntry[]): Promise<Record<string, unknown>>;
+    /** Return collection metadata: `{ name, fields, created_at, layout_version }`. */
+    describe(): Promise<CollectionMetadata>;
+    /**
+     * Rebuild a vector field's HNSW graph with new M / ef_con (async).
+     * Only M/ef_con may change; dimension/space_type/precision are immutable.
+     * Poll progress with `rebuildStatus()`.
+     */
+    rebuild(options: RebuildOptions): Promise<Record<string, unknown>>;
+    /** Poll rebuild progress. */
+    rebuildStatus(): Promise<Record<string, unknown>>;
+    /** Defragment the collection's storage in place. */
+    shrink(): Promise<Record<string, unknown>>;
+    /**
+     * Start an async backup of this collection. Returns
+     * `{ backup_name, status: "in_progress" }`. Poll `Endee.activeBackup()` /
+     * `Endee.listBackups()` for completion.
+     */
+    createBackup(name: string): Promise<Record<string, unknown>>;
+}
+//# sourceMappingURL=collection.d.ts.map

package/dist/collection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../src/collection.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAc,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAoBlD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,eAAe,EAEpB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,cAAc,EAEnB,KAAK,aAAa,EAClB,KAAK,cAAc,EAEnB,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAC;AAkT1B,qBAAa,UAAU;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,KAAK,CAAS;IACtB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,IAAI,CAAgB;gBAG1B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,kBAAkB,EAC5B,IAAI,CAAC,EAAE,aAAa;IAWtB,QAAQ,IAAI,MAAM;IAIlB,2EAA2E;IAC3E,OAAO,CAAC,UAAU;IAalB,OAAO,CAAC,WAAW;IAMnB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IA6GtE;;;;;;;;;;;;OAYG;IACG,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAoH7D,mEAAmE;IAC7D,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAehE;;;OAGG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAgCtD;;;OAGG;IACG,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAmB9F;;;OAGG;IACG,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAsBnF,kFAAkF;IAC5E,QAAQ,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAe7C;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoBxE,6BAA6B;IACvB,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAevD,oDAAoD;IAC9C,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAehD;;;;OAIG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAiBnE"}