@ontos-ai/knowhere-sdk 2.0.0 → 2.1.2

package/dist/index.d.mts

@@ -118,176 +118,6 @@ interface JobResult {
     readonly isFailed: boolean;
 }
 
-/**
- * Parsing model options
- */
-type ParsingModel = 'base' | 'advanced';
-/**
- * Document type options
- */
-type DocType = 'auto' | 'pdf' | 'docx' | 'txt' | 'md';
-/**
- * Parsing configuration parameters
- */
-interface ParsingParams {
-    /** Parsing model to use (default: 'base') */
-    model?: ParsingModel;
-    /** Enable OCR for scanned documents (default: false) */
-    ocrEnabled?: boolean;
-    /** Knowledge base directory */
-    kbDir?: string;
-    /** Document type hint (default: 'auto') */
-    docType?: DocType;
-    /** Enable smart title parsing (default: false) */
-    smartTitleParse?: boolean;
-    /** Generate image summaries (default: false) */
-    summaryImage?: boolean;
-    /** Generate table summaries (default: false) */
-    summaryTable?: boolean;
-    /** Generate text summaries (default: false) */
-    summaryTxt?: boolean;
-    /** Additional fragment description */
-    addFragDesc?: string;
-}
-/**
- * Webhook configuration
- */
-interface WebhookConfig {
-    /** Webhook URL to notify on job completion */
-    url: string;
-}
-/**
- * Client-provided display metadata copied onto the published document.
- */
-type DocumentMetadata = Record<string, unknown>;
-/**
- * Job creation parameters
- */
-interface CreateJobParams {
-    /** Source type: 'file' for upload, 'url' for remote document */
-    sourceType: 'file' | 'url';
-    /** Source URL (required if sourceType is 'url') */
-    sourceUrl?: string;
-    /** File name (required if sourceType is 'file') */
-    fileName?: string;
-    /** Optional custom data identifier */
-    dataId?: string;
-    /** Retrieval namespace for the canonical document */
-    namespace?: string;
-    /** Existing document identifier when updating a published document */
-    documentId?: string;
-    /** Display metadata to copy onto the published document */
-    documentMetadata?: DocumentMetadata;
-    /** Parsing configuration */
-    parsingParams?: ParsingParams;
-    /** Webhook configuration */
-    webhook?: WebhookConfig;
-}
-/**
- * File upload parameters
- */
-interface UploadParams {
-    /** File to upload (path, Buffer, Stream, or Uint8Array) */
-    file: string | Buffer | ReadStream | Uint8Array;
-    /** Upload progress callback */
-    onProgress?: (progress: UploadProgress) => void;
-    /** Abort signal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Wait options for polling
- */
-interface WaitOptions {
-    /** Polling interval in milliseconds (default: 10000) */
-    pollInterval?: number;
-    /** Maximum wait time in milliseconds (default: 1800000 = 30 minutes) */
-    pollTimeout?: number;
-    /** Progress callback */
-    onProgress?: (status: PollProgress) => void;
-    /** Abort signal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Load options for result parsing
- */
-interface LoadOptions {
-    /** Whether to verify ZIP checksum (default: true) */
-    verifyChecksum?: boolean;
-}
-/**
- * High-level parse parameters
- */
-interface ParseParams {
-    /** Source URL (mutually exclusive with file) */
-    url?: string;
-    /** File to parse (path, Buffer, Stream, or Uint8Array) */
-    file?: string | Buffer | ReadStream | Uint8Array;
-    /** File name (auto-inferred for file paths and fs.ReadStream with a path) */
-    fileName?: string;
-    /** Parsing model (default: 'base') */
-    model?: ParsingModel;
-    /** Enable OCR (default: false) */
-    ocr?: boolean;
-    /** Document type hint */
-    docType?: DocType;
-    /** Enable smart title parsing */
-    smartTitleParse?: boolean;
-    /** Generate image summaries */
-    summaryImage?: boolean;
-    /** Generate table summaries */
-    summaryTable?: boolean;
-    /** Generate text summaries */
-    summaryTxt?: boolean;
-    /** Custom data identifier */
-    dataId?: string;
-    /** Retrieval namespace for the canonical document */
-    namespace?: string;
-    /** Existing document identifier when updating a published document */
-    documentId?: string;
-    /** Display metadata to copy onto the published document */
-    documentMetadata?: DocumentMetadata;
-    /** Additional fragment description */
-    addFragDesc?: string;
-    /** Knowledge base directory */
-    kbDir?: string;
-    /** Polling interval in milliseconds */
-    pollInterval?: number;
-    /** Maximum wait time in milliseconds */
-    pollTimeout?: number;
-    /** Whether to verify ZIP checksum (default: true) */
-    verifyChecksum?: boolean;
-    /** Webhook configuration */
-    webhook?: WebhookConfig;
-    /** Upload progress callback */
-    onUploadProgress?: (progress: UploadProgress) => void;
-    /** Poll progress callback */
-    onPollProgress?: (status: PollProgress) => void;
-    /** Abort signal */
-    signal?: AbortSignal;
-}
-/**
- * Upload progress information
- */
-interface UploadProgress {
-    /** Bytes uploaded */
-    loaded: number;
-    /** Total bytes (may be undefined for streams) */
-    total?: number;
-    /** Upload percentage (0-100) */
-    percent: number;
-}
-/**
- * Polling progress information
- */
-interface PollProgress {
-    /** Current job status */
-    status: JobStatus;
-    /** Elapsed time in seconds */
-    elapsedSeconds: number;
-    /** Current job result */
-    jobResult: JobResult;
-}
-
 /**
  * Statistics about the parsed document
  */
@@ -469,6 +299,8 @@ interface ImageChunk extends BaseChunk {
     type: 'image';
     /** Relative file path in ZIP */
     filePath: string;
+    /** Application-owned or server-provided display URL for the image asset. */
+    assetUrl?: string;
     /** Image data buffer */
     data: Buffer;
     /** Image format (derived from file extension) */
@@ -483,6 +315,8 @@ interface TableChunk extends BaseChunk {
     type: 'table';
     /** Relative file path in ZIP */
     filePath: string;
+    /** Application-owned or server-provided display URL for the table asset. */
+    assetUrl?: string;
     /** HTML representation */
     html: string;
     /** Save table HTML to disk */
@@ -544,6 +378,281 @@ interface ParseResult {
     save(directory: string): Promise<string>;
 }
 
+type KnowhereAssetStorageBody = Uint8Array;
+interface KnowhereAssetStorageObject {
+    readonly key: string;
+    readonly body: KnowhereAssetStorageBody;
+    readonly contentType: string;
+    readonly metadata?: Readonly<Record<string, string>>;
+}
+interface KnowhereAssetStorageHead {
+    readonly key: string;
+    readonly contentType?: string;
+    readonly contentLength?: number;
+    readonly metadata?: Readonly<Record<string, string>>;
+    readonly url?: string;
+}
+interface KnowhereAssetStorageWriteResult {
+    readonly key: string;
+    readonly url?: string;
+}
+interface KnowhereAssetStorageAdapter {
+    writeObject(input: KnowhereAssetStorageObject): Promise<KnowhereAssetStorageWriteResult>;
+    headObject?(key: string): Promise<KnowhereAssetStorageHead | null>;
+    getObjectUrl?(key: string): Promise<string | null>;
+}
+interface KnowhereAssetStorageOptions {
+    readonly adapter: KnowhereAssetStorageAdapter;
+    readonly keyPrefix: string;
+    readonly skipExisting?: boolean;
+}
+interface KnowhereAssetStorageResult {
+    readonly result: ParseResult;
+    readonly assetUrlsByFilePath: Readonly<Record<string, string>>;
+}
+interface ParsedDocumentStorageDocument {
+    readonly documentId: string;
+    readonly revisionKey: string;
+}
+type ParsedDocumentRevisionParams = ParsedDocumentStorageDocument;
+interface ParsedDocumentObjectParams extends ParsedDocumentRevisionParams {
+    readonly path: string;
+}
+interface ParsedDocumentObjectHead extends ParsedDocumentObjectParams {
+    readonly contentType?: string;
+    readonly contentLength?: number;
+    readonly metadata?: Readonly<Record<string, string>>;
+    readonly url?: string;
+}
+interface ParsedDocumentObject extends ParsedDocumentObjectHead {
+    readonly body: KnowhereAssetStorageBody;
+}
+interface ParsedDocumentWriteObjectParams extends ParsedDocumentObjectParams {
+    readonly body: KnowhereAssetStorageBody;
+    readonly contentType: string;
+    readonly metadata?: Readonly<Record<string, string>>;
+}
+interface ParsedDocumentWriteObjectResult extends ParsedDocumentObjectParams {
+    readonly url?: string;
+}
+type ParsedDocumentCommitSource = 'resultZip' | 'remoteReconstruction';
+interface ParsedDocumentCommit {
+    readonly version: 1;
+    readonly documentId: string;
+    readonly revisionKey: string;
+    readonly source: ParsedDocumentCommitSource;
+    readonly committedAt: string;
+}
+interface ParsedDocumentSyncProgress {
+    readonly documentId: string;
+    readonly revisionKey: string;
+    readonly nextChunkPage?: number;
+    readonly status: 'running' | 'completed' | 'failed';
+    readonly updatedAt: string;
+    readonly error?: string;
+}
+interface ParsedDocumentStorage {
+    readObject(params: ParsedDocumentObjectParams): Promise<ParsedDocumentObject | null>;
+    writeObject(params: ParsedDocumentWriteObjectParams): Promise<ParsedDocumentWriteObjectResult>;
+    headObject?(params: ParsedDocumentObjectParams): Promise<ParsedDocumentObjectHead | null>;
+    getObjectUrl?(params: ParsedDocumentObjectParams): Promise<string | null>;
+    deletePrefix?(params: ParsedDocumentRevisionParams): Promise<void>;
+    readSyncProgress(params: ParsedDocumentRevisionParams): Promise<ParsedDocumentSyncProgress | null>;
+    writeSyncProgress(params: ParsedDocumentSyncProgress): Promise<void>;
+}
+interface ParsedDocumentSyncScheduler {
+    schedule(task: () => Promise<void>): void | Promise<void>;
+}
+interface ParsedDocumentStorageLimits {
+    readonly remotePageSize?: number;
+    readonly maxPagesPerSync?: number;
+    readonly syncDeadlineMs?: number;
+    readonly grepMaxPages?: number;
+    readonly grepDeadlineMs?: number;
+    readonly outlineMaxPages?: number;
+    readonly outlineDeadlineMs?: number;
+}
+interface ParsedDocumentStorageConfig {
+    readonly storage: ParsedDocumentStorage;
+    readonly scheduler?: ParsedDocumentSyncScheduler;
+    readonly limits?: ParsedDocumentStorageLimits;
+}
+
+/**
+ * Parsing model options
+ */
+type ParsingModel = 'base' | 'advanced';
+/**
+ * Document type options
+ */
+type DocType = 'auto' | 'pdf' | 'docx' | 'txt' | 'md';
+/**
+ * Parsing configuration parameters
+ */
+interface ParsingParams {
+    /** Parsing model to use (default: 'base') */
+    model?: ParsingModel;
+    /** Enable OCR for scanned documents (default: false) */
+    ocrEnabled?: boolean;
+    /** Knowledge base directory */
+    kbDir?: string;
+    /** Document type hint (default: 'auto') */
+    docType?: DocType;
+    /** Enable smart title parsing (default: false) */
+    smartTitleParse?: boolean;
+    /** Generate image summaries (default: false) */
+    summaryImage?: boolean;
+    /** Generate table summaries (default: false) */
+    summaryTable?: boolean;
+    /** Generate text summaries (default: false) */
+    summaryTxt?: boolean;
+    /** Additional fragment description */
+    addFragDesc?: string;
+}
+/**
+ * Webhook configuration
+ */
+interface WebhookConfig {
+    /** Webhook URL to notify on job completion */
+    url: string;
+}
+/**
+ * Client-provided display metadata copied onto the published document.
+ */
+type DocumentMetadata = Record<string, unknown>;
+/**
+ * Job creation parameters
+ */
+interface CreateJobParams {
+    /** Source type: 'file' for upload, 'url' for remote document */
+    sourceType: 'file' | 'url';
+    /** Source URL (required if sourceType is 'url') */
+    sourceUrl?: string;
+    /** File name (required if sourceType is 'file') */
+    fileName?: string;
+    /** Optional custom data identifier */
+    dataId?: string;
+    /** Retrieval namespace for the canonical document */
+    namespace?: string;
+    /** Existing document identifier when updating a published document */
+    documentId?: string;
+    /** Display metadata to copy onto the published document */
+    documentMetadata?: DocumentMetadata;
+    /** Parsing configuration */
+    parsingParams?: ParsingParams;
+    /** Webhook configuration */
+    webhook?: WebhookConfig;
+}
+/**
+ * File upload parameters
+ */
+interface UploadParams {
+    /** File to upload (path, Buffer, Stream, or Uint8Array) */
+    file: string | Buffer | ReadStream | Uint8Array;
+    /** Upload progress callback */
+    onProgress?: (progress: UploadProgress) => void;
+    /** Abort signal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Wait options for polling
+ */
+interface WaitOptions {
+    /** Polling interval in milliseconds (default: 10000) */
+    pollInterval?: number;
+    /** Maximum wait time in milliseconds (default: 1800000 = 30 minutes) */
+    pollTimeout?: number;
+    /** Progress callback */
+    onProgress?: (status: PollProgress) => void;
+    /** Abort signal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Load options for result parsing
+ */
+interface LoadOptions {
+    /** Whether to verify ZIP checksum (default: true) */
+    verifyChecksum?: boolean;
+}
+/**
+ * High-level parse parameters
+ */
+interface ParseParams {
+    /** Source URL (mutually exclusive with file) */
+    url?: string;
+    /** File to parse (path, Buffer, Stream, or Uint8Array) */
+    file?: string | Buffer | ReadStream | Uint8Array;
+    /** File name (auto-inferred for file paths and fs.ReadStream with a path) */
+    fileName?: string;
+    /** Parsing model (default: 'base') */
+    model?: ParsingModel;
+    /** Enable OCR (default: false) */
+    ocr?: boolean;
+    /** Document type hint */
+    docType?: DocType;
+    /** Enable smart title parsing */
+    smartTitleParse?: boolean;
+    /** Generate image summaries */
+    summaryImage?: boolean;
+    /** Generate table summaries */
+    summaryTable?: boolean;
+    /** Generate text summaries */
+    summaryTxt?: boolean;
+    /** Custom data identifier */
+    dataId?: string;
+    /** Retrieval namespace for the canonical document */
+    namespace?: string;
+    /** Existing document identifier when updating a published document */
+    documentId?: string;
+    /** Display metadata to copy onto the published document */
+    documentMetadata?: DocumentMetadata;
+    /** Additional fragment description */
+    addFragDesc?: string;
+    /** Knowledge base directory */
+    kbDir?: string;
+    /** Polling interval in milliseconds */
+    pollInterval?: number;
+    /** Maximum wait time in milliseconds */
+    pollTimeout?: number;
+    /** Whether to verify ZIP checksum (default: true) */
+    verifyChecksum?: boolean;
+    /**
+     * Optional asset storage adapter used to copy parsed media and page citation
+     * assets into application-owned storage before the result is returned.
+     */
+    storageAdapter?: KnowhereAssetStorageOptions;
+    /** Webhook configuration */
+    webhook?: WebhookConfig;
+    /** Upload progress callback */
+    onUploadProgress?: (progress: UploadProgress) => void;
+    /** Poll progress callback */
+    onPollProgress?: (status: PollProgress) => void;
+    /** Abort signal */
+    signal?: AbortSignal;
+}
+/**
+ * Upload progress information
+ */
+interface UploadProgress {
+    /** Bytes uploaded */
+    loaded: number;
+    /** Total bytes (may be undefined for streams) */
+    total?: number;
+    /** Upload percentage (0-100) */
+    percent: number;
+}
+/**
+ * Polling progress information
+ */
+interface PollProgress {
+    /** Current job status */
+    status: JobStatus;
+    /** Elapsed time in seconds */
+    elapsedSeconds: number;
+    /** Current job result */
+    jobResult: JobResult;
+}
+
 interface HttpClientOptions {
     baseURL: string;
     apiKey?: string;
@@ -894,14 +1003,14 @@ interface DocumentChunkListParams {
     pageSize?: number;
     /** Optional chunk type filter */
     chunkType?: DocumentChunkType;
-    /** Set true to include 7-day asset URLs for media chunks */
+    /** Set true to include 7-day asset URLs for media and page citation assets */
     includeAssetUrls?: boolean;
 }
 /**
  * Query parameters for GET /v2/documents/{document_id}/chunks/{document_chunk_id}.
  */
 interface DocumentChunkGetParams {
-    /** Set true to include 7-day asset URLs for media chunks */
+    /** Set true to include 7-day asset URLs for media and page citation assets */
     includeAssetUrls?: boolean;
 }
 /**
@@ -930,11 +1039,25 @@ interface DocumentChunk {
     sortOrder: number;
     /** Chunk metadata returned by the API */
     metadata: Record<string, unknown>;
-    /** 7-day asset URL for media chunks when available */
+    /** 7-day asset URL for media or page citation assets when available */
     assetUrl?: string | null;
     /** Chunk creation timestamp */
     createdAt?: Date;
 }
+/**
+ * Response from GET /v2/documents/{document_id}/files/page-citation-source.
+ */
+interface DocumentPageCitationSource {
+    documentId: string;
+    namespace?: string;
+    jobId?: string;
+    jobResultId?: string;
+    variant?: string;
+    fileName: string;
+    contentType: string;
+    url: string;
+    expiresAt?: Date;
+}
 /**
  * Response from GET /v2/documents/{document_id}/chunks.
  */
@@ -988,6 +1111,10 @@ declare class Documents extends BaseResource {
      * Get one current-revision chunk for one canonical document.
      */
     getChunk(documentId: string, documentChunkId: string, params?: DocumentChunkGetParams): Promise<DocumentChunkResponse>;
+    /**
+     * Get a signed normalized source-file URL for compatibility and debugging.
+     */
+    getPageCitationSource(documentId: string): Promise<DocumentPageCitationSource>;
     /**
      * Archive one canonical document by ID.
      */
@@ -998,6 +1125,18 @@ declare class Documents extends BaseResource {
     private createChunkGetRequestConfig;
 }
 
+type PageCitationAssetContentType = 'image/png' | 'image/jpeg';
+type PageCitationAssetSource = 'knowhere-rendered-page-citation-source';
+interface PageCitationAsset {
+    pageNum: number;
+    artifactRef: string;
+    assetUrl?: string;
+    contentType: PageCitationAssetContentType;
+    width?: number;
+    height?: number;
+    source: PageCitationAssetSource;
+}
+
 type KnowledgeChunkType = DocumentChunkType;
 interface KnowledgeParseParams extends ParseParams {
     /** Optional stable local identifier for this parsed result copy. */
@@ -1028,6 +1167,7 @@ interface LocalKnowledgeDocument {
 interface LocalKnowledgeParseResponse {
     document: LocalKnowledgeDocument;
     result: ParseResult;
+    assetUrlsByFilePath?: Readonly<Record<string, string>>;
 }
 interface KnowledgeAsyncParseParams extends ParseParams {
     /** Optional stable local identifier to use when this job result is cached later. */
@@ -1052,11 +1192,20 @@ interface KnowledgeStartupRecoveryResponse {
     checkedJobs: number;
     results: KnowledgeAsyncJobStatusResponse[];
 }
-interface KnowledgeCacheJobResultParams {
+interface KnowledgeLoadJobResultParams {
     jobId: string;
-    localDocumentId?: string;
     verifyChecksum?: boolean;
+    storageAdapter?: KnowhereAssetStorageOptions;
 }
+interface KnowledgeImportJobResultParams extends KnowledgeLoadJobResultParams {
+    localDocumentId?: string;
+}
+interface KnowledgeJobResultResponse {
+    result: ParseResult;
+    assetUrlsByFilePath?: Readonly<Record<string, string>>;
+}
+/** @deprecated Use KnowledgeImportJobResultParams with importJobResult instead. */
+type KnowledgeCacheJobResultParams = KnowledgeImportJobResultParams;
 interface KnowledgeCacheDocumentParams {
     /** Canonical Knowhere document identifier from published retrieval results. */
     documentId: string;
@@ -1070,6 +1219,16 @@ interface KnowledgeDocumentReference {
     documentId?: string;
     /** Server parse job identifier whose completed result should be cached before reading. */
     jobId?: string;
+    /** Current parsed revision key when the caller already has it. */
+    revisionKey?: string;
+}
+type KnowledgeParsedStorageOptions = ParsedDocumentStorageConfig;
+type KnowledgeSyncParsedDocumentParams = KnowledgeDocumentReference;
+interface KnowledgeSyncParsedDocumentResponse {
+    documentId: string;
+    revisionKey: string;
+    completed: boolean;
+    commit?: ParsedDocumentCommit;
 }
 interface KnowledgeSection {
     sectionPath: string;
@@ -1088,8 +1247,12 @@ interface KnowledgeOutline {
     typeCounts: Record<KnowledgeChunkType, number>;
     sections: KnowledgeSection[];
     sectionTree: KnowledgeSection[];
+    truncated?: boolean;
+    continuationCursor?: string;
 }
 interface KnowledgeReadParams extends KnowledgeDocumentReference {
+    page?: number;
+    pageSize?: number;
     sectionPath?: string;
     startChunk?: number;
     endChunk?: number;
@@ -1109,6 +1272,7 @@ interface KnowledgeReadChunk {
     sectionPath: string;
     sourceChunkPath: string;
     filePath?: string;
+    assetUrl?: string;
     pageNumbers?: number[];
     metadata: Record<string, unknown>;
 }
@@ -1116,9 +1280,14 @@ interface KnowledgeReadResponse {
     document: LocalKnowledgeDocument;
     chunks: KnowledgeReadChunk[];
     nextChunk?: number;
+    page?: number;
+    pageSize?: number;
+    totalChunks?: number;
+    totalPages?: number;
 }
 interface KnowledgeGrepParams extends KnowledgeDocumentReference {
     pattern: string;
+    continuationCursor?: string;
     isRegex?: boolean;
     isCaseSensitive?: boolean;
     maxResults?: number;
@@ -1142,6 +1311,7 @@ interface KnowledgeGrepResponse {
     matches: KnowledgeGrepMatch[];
     scannedChunks: number;
     truncated: boolean;
+    continuationCursor?: string;
 }
 interface KnowledgeSearchParams {
     query: string;
@@ -1180,15 +1350,27 @@ interface KnowledgeSearchResult {
 declare class Knowledge {
     private readonly client;
     private readonly store;
+    private readonly cacheDirectory;
+    private readonly parsedStorageConfig;
     constructor(client: Knowhere, options?: {
         cacheDirectory?: string;
+        parsedStorage?: ParsedDocumentStorageConfig;
     });
     withCacheDirectory(cacheDirectory: string): Knowledge;
+    withParsedStorage(parsedStorage: KnowledgeParsedStorageOptions): Knowledge;
+    parseToLocalCache(params: KnowledgeParseParams): Promise<LocalKnowledgeParseResponse>;
+    /** @deprecated Use parseToLocalCache for local cache imports or the top-level client.parse for server-safe parsing. */
     parse(params: KnowledgeParseParams): Promise<LocalKnowledgeParseResponse>;
     startParse(params: KnowledgeAsyncParseParams): Promise<KnowledgeAsyncParseResponse>;
     getJobStatus(jobId: string): Promise<KnowledgeAsyncJobStatusResponse>;
     recoverPendingAsyncParseJobs(): Promise<KnowledgeStartupRecoveryResponse>;
+    loadJobResult(params: KnowledgeLoadJobResultParams): Promise<KnowledgeJobResultResponse>;
+    importJobResult(params: KnowledgeImportJobResultParams): Promise<LocalKnowledgeParseResponse>;
+    /** @deprecated Use importJobResult for local cache imports or loadJobResult for server-safe loads. */
     cacheJobResult(params: KnowledgeCacheJobResultParams): Promise<LocalKnowledgeParseResponse>;
+    syncParsedDocument(params: KnowledgeSyncParsedDocumentParams): Promise<KnowledgeSyncParsedDocumentResponse>;
+    private syncParseResultToConfiguredStorage;
+    private parseWithoutClientStorageAdapter;
     cacheDocument(params: KnowledgeCacheDocumentParams): Promise<LocalKnowledgeParseResponse>;
     private resolveAsyncCache;
     listDocuments(): Promise<LocalKnowledgeDocument[]>;
@@ -1198,6 +1380,19 @@ declare class Knowledge {
     search(params: KnowledgeSearchParams): Promise<KnowledgeSearchResponse>;
     private resolveSearchDocuments;
     private loadReadableResult;
+    private readRemoteDocumentChunks;
+    private scanRemoteDocumentChunks;
+    private grepRemoteDocumentChunks;
+    private getRemoteDocumentOutline;
+    private tryReadChunksFromParsedStorage;
+    private tryGrepChunksFromParsedStorage;
+    private tryReadOutlineFromParsedStorage;
+    private readCommittedParsedStorageResult;
+    private scheduleParsedStorageSync;
+    private syncRemoteDocumentToParsedStorage;
+    private syncRemoteDocumentChunksToParsedStorage;
+    private readRemoteReconstructionChunks;
+    private requireParsedStorageConfig;
     private findLocalDocumentByRemoteId;
     private getPublishedDocumentJobId;
 }
@@ -1295,6 +1490,38 @@ declare class Knowhere {
 
 declare const VERSION = "0.1.0";
 
+declare function storeParseResultAssets(result: ParseResult, options?: KnowhereAssetStorageOptions): Promise<KnowhereAssetStorageResult>;
+
+declare class DiskParsedDocumentStorage implements ParsedDocumentStorage {
+    private readonly rootDirectory;
+    constructor(rootDirectory: string);
+    readObject(params: ParsedDocumentObjectParams): Promise<ParsedDocumentObject | null>;
+    writeObject(params: ParsedDocumentWriteObjectParams): Promise<ParsedDocumentWriteObjectResult>;
+    headObject(params: ParsedDocumentObjectParams): Promise<ParsedDocumentObjectHead | null>;
+    getObjectUrl(params: ParsedDocumentObjectParams): Promise<string | null>;
+    deletePrefix(params: ParsedDocumentRevisionParams): Promise<void>;
+    readSyncProgress(params: ParsedDocumentRevisionParams): Promise<ParsedDocumentSyncProgress | null>;
+    writeSyncProgress(params: ParsedDocumentSyncProgress): Promise<void>;
+    private getObjectPath;
+    private getRevisionDirectory;
+    private readOptionalJson;
+    private readObjectMetadata;
+    private writeObjectMetadata;
+}
+
+declare function syncParseResultToParsedDocumentStorage(params: {
+    readonly result: ParseResult;
+    readonly storage: ParsedDocumentStorage;
+    readonly documentId?: string;
+    readonly revisionKey?: string;
+    readonly source?: ParsedDocumentCommitSource;
+}): Promise<{
+    readonly result: ParseResult;
+    readonly documentId: string;
+    readonly revisionKey: string;
+    readonly commit: ParsedDocumentCommit;
+}>;
+
 /**
  * Base error class for all Knowhere SDK errors
  */
@@ -1424,4 +1651,4 @@ declare class JobFailedError extends KnowhereError {
     constructor(message: string, code: string, jobResult: JobResult);
 }
 
-export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListPagination, type DocumentListParams, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheDocumentParams, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeDocumentReference, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type PageChunk, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalChunkType, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };
+export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, DiskParsedDocumentStorage, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListPagination, type DocumentListParams, type DocumentListResponse, type DocumentMetadata, type DocumentPageCitationSource, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, type KnowhereAssetStorageAdapter, type KnowhereAssetStorageBody, type KnowhereAssetStorageHead, type KnowhereAssetStorageObject, type KnowhereAssetStorageOptions, type KnowhereAssetStorageResult, type KnowhereAssetStorageWriteResult, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheDocumentParams, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeDocumentReference, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeImportJobResultParams, type KnowledgeJobResultResponse, type KnowledgeLoadJobResultParams, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeParsedStorageOptions, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type KnowledgeSyncParsedDocumentParams, type KnowledgeSyncParsedDocumentResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type PageChunk, type PageCitationAsset, type PageCitationAssetContentType, type PageCitationAssetSource, type ParseParams, type ParseResult, type ParsedDocumentCommit, type ParsedDocumentCommitSource, type ParsedDocumentObject, type ParsedDocumentObjectHead, type ParsedDocumentObjectParams, type ParsedDocumentRevisionParams, type ParsedDocumentStorage, type ParsedDocumentStorageConfig, type ParsedDocumentStorageDocument, type ParsedDocumentStorageLimits, type ParsedDocumentSyncProgress, type ParsedDocumentSyncScheduler, type ParsedDocumentWriteObjectParams, type ParsedDocumentWriteObjectResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalChunkType, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default, storeParseResultAssets, syncParseResultToParsedDocumentStorage };