@delali/narsil 0.2.2 → 0.2.3-next.33

package/dist/embeddings/openai.d.ts

@@ -1,4 +1,4 @@
-import { E as EmbeddingAdapter } from '../adapters-CVqI5NBt.js';
+import { E as EmbeddingAdapter } from '../adapters-79OIa4xm.js';
 
 /**
  * How {@link createOpenAIEmbedding} reaches an embeddings endpoint.

package/dist/embeddings/openai.mjs

@@ -1,4 +1,4 @@
-import { NarsilError, ErrorCodes } from '../chunk-UNJZ7ZDB.mjs';
+import { NarsilError, ErrorCodes } from '../chunk-EMI63EXP.mjs';
 
 // src/embeddings/openai.ts
 var RETRYABLE_STATUS_CODES = /* @__PURE__ */ new Set([429, 500, 502, 503]);

package/dist/{engine-CO9Wnfie.d.ts → engine-DScGlT2Z.d.ts}

@@ -1,6 +1,6 @@
-import { E as EmbeddingAdapter } from './adapters-CVqI5NBt.js';
-import { I as IndexInfo, m as IndexStats, P as PartitionStatsResult, B as BatchResult, Q as QueryParams, q as QueryResult, n as PreflightResult, t as SuggestParams, u as SuggestResult, M as MemoryStats, V as VectorMaintenanceResult } from './search-DLBtiPdQ.js';
-import { I as IndexConfig, A as AnyDocument, a as InsertOptions, P as PartitionConfig } from './schema-CE6S_aAr.js';
+import { E as EmbeddingAdapter } from './adapters-79OIa4xm.js';
+import { I as IndexInfo, f as IndexStats, P as PartitionStatsResult, B as BatchResult, L as ListParams, g as ListResult, Q as QueryParams, e as QueryResult, h as PreflightResult, i as SuggestParams, j as SuggestResult, M as MemoryStats, V as VectorMaintenanceResult } from './search-CQ-9bKxo.js';
+import { I as IndexConfig, A as AnyDocument, a as InsertOptions, P as PartitionConfig } from './schema-emTQfEiX.js';
 
 /**
  * Every event the engine emits, with the payload each one carries.
@@ -251,6 +251,33 @@ interface Narsil {
      * @returns The document count across every partition.
      */
     countDocuments(indexName: string): Promise<number>;
+    /**
+     * Reads one page of stored documents in document-id order, without
+     * searching, which is how you page through a whole index.
+     *
+     * Leave `cursor` out for the first page, pass the returned cursor back for
+     * each page after it, and stop when the cursor comes back null. A document
+     * that stays in the index for the whole listing comes back exactly once. The
+     * engine skips a document you remove part-way through. It returns one you
+     * insert part-way through once that document's id sorts above the cursor.
+     * The cursor holds no engine state, so it stays valid after a restart, a
+     * snapshot restore, and a rebalance.
+     *
+     * The engine compares document ids by their UTF-16 code units, so `"10"`
+     * sorts ahead of `"9"`.
+     *
+     * Set `document` to drop a vector field, because the engine otherwise reads
+     * every listed document's vector back out of the index.
+     *
+     * @typeParam T - Shape of the stored documents, which flows through to each
+     * entry's `document`.
+     * @param indexName - The index to walk.
+     * @param params - These set the cursor, the page size, the filter, and how
+     * much of each document comes back.
+     * @returns The page, the cursor for the next page, how many documents the
+     * listing walks in total, and the time the page took.
+     */
+    listDocuments<T = AnyDocument>(indexName: string, params?: ListParams): Promise<ListResult<T>>;
     /**
      * Runs a search against an index and returns the ranked hits.
      *