rag-lite-ts 1.0.2 → 2.0.0

package/dist/file-processor.d.ts

@@ -13,6 +13,10 @@ export interface FileProcessorOptions {
  * Default options for file processing
  */
 export declare const DEFAULT_FILE_PROCESSOR_OPTIONS: FileProcessorOptions;
+/**
+ * Default options for image-to-text processing
+ */
+export declare const DEFAULT_IMAGE_TO_TEXT_OPTIONS: ImageToTextOptions;
 /**
  * Result of file discovery operation
  */
@@ -37,6 +41,54 @@ export interface DocumentProcessingResult {
         error: string;
     }>;
 }
+/**
+ * Image description generation result
+ */
+export interface ImageDescriptionResult {
+    /** Generated text description */
+    description: string;
+    /** Confidence score (0-1) */
+    confidence?: number;
+    /** Model used for generation */
+    model: string;
+}
+/**
+ * Options for image-to-text processing
+ */
+export interface ImageToTextOptions {
+    /** Model to use for image captioning */
+    model?: string;
+    /** Maximum description length */
+    maxLength?: number;
+    /** Batch size for processing multiple images */
+    batchSize?: number;
+    /** Whether to include confidence scores */
+    includeConfidence?: boolean;
+}
+/**
+ * Image metadata extracted from image files
+ */
+export interface ImageMetadata {
+    /** Original file path */
+    originalPath: string;
+    /** Image dimensions */
+    dimensions: {
+        width: number;
+        height: number;
+    };
+    /** File size in bytes */
+    fileSize: number;
+    /** Image format (jpeg, png, gif, webp, bmp) */
+    format: string;
+    /** File creation date */
+    createdAt?: Date;
+    /** Generated text description (if available) */
+    description?: string;
+    /** Model used for description generation */
+    descriptionModel?: string;
+    /** Confidence score for description */
+    descriptionConfidence?: number;
+}
 /**
  * Discover files for ingestion
  * Supports both single files and directories (with optional recursion)
@@ -46,14 +98,48 @@ export declare function discoverFiles(path: string, options?: FileProcessorOptio
  * Process multiple files into Documents
  * Handles errors gracefully by skipping problematic files
  */
-export declare function processFiles(filePaths: string[], pathManager: DocumentPathManager): Promise<DocumentProcessingResult>;
+export declare function processFiles(filePaths: string[], pathManager: DocumentPathManager, imageToTextOptions?: ImageToTextOptions): Promise<DocumentProcessingResult>;
 /**
  * Complete file discovery and processing pipeline
  * Discovers files and processes them into Documents
  */
-export declare function discoverAndProcessFiles(path: string, options?: FileProcessorOptions, pathManager?: DocumentPathManager): Promise<{
+export declare function discoverAndProcessFiles(path: string, options?: FileProcessorOptions, pathManager?: DocumentPathManager, imageToTextOptions?: ImageToTextOptions): Promise<{
     documents: Document[];
     discoveryResult: FileDiscoveryResult;
     processingResult: DocumentProcessingResult;
 }>;
+/**
+ * Clean up image processing resources
+ * Call this when shutting down the application to free memory
+ */
+export declare function cleanupImageProcessingResources(): Promise<void>;
+/**
+ * Clean up image-to-text pipeline resources (legacy function for backward compatibility)
+ * @deprecated Use cleanupImageProcessingResources() instead
+ */
+export declare function cleanupImageToTextPipeline(): Promise<void>;
+/**
+ * Generate description for a single image (exported for external use)
+ */
+export declare function generateImageDescriptionForFile(imagePath: string, options?: ImageToTextOptions): Promise<ImageDescriptionResult>;
+/**
+ * Generate descriptions for multiple images (exported for external use)
+ */
+export declare function generateImageDescriptionsForFiles(imagePaths: string[], options?: ImageToTextOptions): Promise<Array<{
+    path: string;
+    result?: ImageDescriptionResult;
+    error?: string;
+}>>;
+/**
+ * Extract metadata from a single image file (exported for external use)
+ */
+export declare function extractImageMetadataForFile(imagePath: string): Promise<ImageMetadata>;
+/**
+ * Extract metadata from multiple image files (exported for external use)
+ */
+export declare function extractImageMetadataForFiles(imagePaths: string[]): Promise<Array<{
+    path: string;
+    metadata?: ImageMetadata;
+    error?: string;
+}>>;
 //# sourceMappingURL=file-processor.d.ts.map