libsql-search 0.1.5 → 0.2.0

package/dist/index.d.ts

@@ -1,14 +1,56 @@
 import { Client } from '@libsql/client';
 
 type EmbeddingProvider = 'local' | 'gemini' | 'openai';
+type EmbeddingIntent = 'document' | 'query';
+type EmbeddingBatchMode = 'native' | 'sequential';
+interface EmbeddingBatchBehavior {
+    mode: EmbeddingBatchMode;
+    maxSize?: number;
+}
+interface EmbeddingProviderMetadata {
+    name: EmbeddingProvider;
+    model: string;
+    dimensions: number;
+    batch: EmbeddingBatchBehavior;
+}
+interface EmbeddingRequestOptions {
+    intent?: EmbeddingIntent;
+    signal?: AbortSignal;
+}
+interface EmbeddingProviderClient {
+    readonly metadata: EmbeddingProviderMetadata;
+    embed(texts: string[], options?: EmbeddingRequestOptions): Promise<EmbeddingBatchResult>;
+}
+interface EmbeddingBatchResult {
+    embeddings: number[][];
+    provider: EmbeddingProvider;
+    model: string;
+    dimensions: number;
+    intent: EmbeddingIntent;
+}
 interface EmbeddingOptions {
     provider?: EmbeddingProvider;
     apiKey?: string;
     dimensions?: number;
     maxLength?: number;
+    intent?: EmbeddingIntent;
+    timeoutMs?: number;
+    signal?: AbortSignal;
 }
+interface EmbeddingBatchItemResult {
+    embedding: number[];
+    index?: unknown;
+}
+type EmbeddingBatchItem = number[] | EmbeddingBatchItemResult;
+declare function validateEmbeddingBatch(items: EmbeddingBatchItem[], expectedCount: number, expectedDimensions: number, provider: EmbeddingProvider): number[][];
+declare function createEmbeddingProvider(options?: EmbeddingOptions): EmbeddingProviderClient;
+declare function getEmbeddingProviderMetadata(options?: EmbeddingOptions): EmbeddingProviderMetadata;
+/**
+ * Generate embeddings using the specified provider.
+ */
+declare function generateEmbeddings(texts: string[], options?: EmbeddingOptions): Promise<number[][]>;
 /**
- * Generate embeddings using the specified provider
+ * Generate an embedding using the specified provider.
  */
 declare function generateEmbedding(text: string, options?: EmbeddingOptions): Promise<number[]>;
 /**
@@ -23,7 +65,7 @@ declare function prepareTextForEmbedding(fields: {
     description?: string;
     content?: string;
     tags?: string[];
-    [key: string]: any;
+    [key: string]: unknown;
 }): string;
 
 /**
@@ -126,5 +168,5 @@ declare function getArticlesByFolder(client: Client, folder: string, tableName?:
  */
 declare function getFolders(client: Client, tableName?: string): Promise<string[]>;
 
-export { createTable, generateEmbedding, getAllArticles, getArticleBySlug, getArticlesByFolder, getFolders, indexContent, padEmbedding, prepareTextForEmbedding, search };
-export type { EmbeddingOptions, EmbeddingProvider, IndexedDocument, IndexerOptions, SearchOptions, SearchResult };
+export { createEmbeddingProvider, createTable, generateEmbedding, generateEmbeddings, getAllArticles, getArticleBySlug, getArticlesByFolder, getEmbeddingProviderMetadata, getFolders, indexContent, padEmbedding, prepareTextForEmbedding, search, validateEmbeddingBatch };
+export type { EmbeddingBatchBehavior, EmbeddingBatchItem, EmbeddingBatchItemResult, EmbeddingBatchMode, EmbeddingBatchResult, EmbeddingIntent, EmbeddingOptions, EmbeddingProvider, EmbeddingProviderClient, EmbeddingProviderMetadata, EmbeddingRequestOptions, IndexedDocument, IndexerOptions, SearchOptions, SearchResult };