import { z } from 'zod'; import { Document } from '../document/document.js'; import { DocumentMetadata } from '../document/metadata/index.js'; /** * The schema for the data envelope object. * The data envelope is used to describe the * original document being processed, its current * representation, and its metadata. */ declare const DataEnvelopeSchema: z.ZodObject<{ /** * An identifier identifying a pipeline chain * execution. */ chainId: z.ZodString; /** * The description associated with the * original document. */ source: z.ZodEffects, Document, unknown>; /** * The description associated with the * current document representation. */ document: z.ZodEffects, Document, unknown>; /** * The metadata extracted from the document * by the middlewares in the chain. */ metadata: z.ZodDefault; createdAt: z.ZodOptional; updatedAt: z.ZodOptional; image: z.ZodOptional; authors: z.ZodOptional>; publisher: z.ZodOptional; name: z.ZodString; url: z.ZodOptional; logo: z.ZodOptional; }, "strip", z.ZodTypeAny, { name: string; url?: string | undefined; type?: string | undefined; logo?: string | undefined; }, { name: string; url?: string | undefined; type?: string | undefined; logo?: string | undefined; }>>; title: z.ZodOptional; description: z.ZodOptional; keywords: z.ZodOptional>; topics: z.ZodOptional>; rating: z.ZodOptional; language: z.ZodOptional; ontology: z.ZodOptional>, string>>; custom: z.ZodOptional>>; properties: z.ZodOptional; attrs: z.ZodObject<{ dimensions: z.ZodOptional>; format: z.ZodOptional; dominantColor: z.ZodOptional>; thumbnail: z.ZodOptional; orientation: z.ZodOptional; exif: z.ZodOptional>; geolocation: z.ZodOptional>; faces: z.ZodOptional, string>>; labels: z.ZodOptional, string>>; objects: z.ZodOptional, string>>; text: z.ZodOptional, string>>; embeddings: z.ZodOptional, string>; model: z.ZodString; dimensions: z.ZodNumber; }, "strip", z.ZodTypeAny, { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; }, { vectors: string; model: string; dimensions: number; }>>; ppe: z.ZodOptional, string>>; }, "strip", z.ZodTypeAny, { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: import("../../pointer/index.js").Pointer | undefined; }, { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: string | undefined; }>>; stats: z.ZodOptional; objects: z.ZodOptional; labels: z.ZodOptional; moderations: z.ZodOptional; text: z.ZodOptional; }, "strip", z.ZodTypeAny, { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; }, { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; }>>; variance: z.ZodOptional; hashes: z.ZodOptional; average: z.ZodOptional; median: z.ZodOptional; difference: z.ZodOptional; cropResistant: z.ZodOptional; wavelet: z.ZodOptional; color: z.ZodOptional; }, "strip", z.ZodTypeAny, { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; }, { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; }>>; custom: z.ZodOptional>; }, "strip", z.ZodTypeAny, { custom?: Record | undefined; format?: string | undefined; text?: import("../../pointer/index.js").Pointer | undefined; faces?: import("../../pointer/index.js").Pointer | undefined; objects?: import("../../pointer/index.js").Pointer | undefined; labels?: import("../../pointer/index.js").Pointer | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: import("../../pointer/index.js").Pointer | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }, { custom?: Record | undefined; format?: string | undefined; text?: string | undefined; faces?: string | undefined; objects?: string | undefined; labels?: string | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: string | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }>; }, "strip", z.ZodTypeAny, { kind: "image"; attrs: { custom?: Record | undefined; format?: string | undefined; text?: import("../../pointer/index.js").Pointer | undefined; faces?: import("../../pointer/index.js").Pointer | undefined; objects?: import("../../pointer/index.js").Pointer | undefined; labels?: import("../../pointer/index.js").Pointer | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: import("../../pointer/index.js").Pointer | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }; }, { kind: "image"; attrs: { custom?: Record | undefined; format?: string | undefined; text?: string | undefined; faces?: string | undefined; objects?: string | undefined; labels?: string | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: string | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }; }>, z.ZodObject<{ kind: z.ZodLiteral<"text">; attrs: z.ZodObject<{ pages: z.ZodOptional; page: z.ZodOptional; chapters: z.ZodOptional; chapter: z.ZodOptional; layout: z.ZodOptional; imageCount: z.ZodOptional; }, "strip", z.ZodTypeAny, { tableCount?: number | undefined; imageCount?: number | undefined; }, { tableCount?: number | undefined; imageCount?: number | undefined; }>>; readingTime: z.ZodOptional; sentiment: z.ZodOptional>; pos: z.ZodOptional, string>>; pii: z.ZodOptional, string>>; entities: z.ZodOptional, string>>; embeddings: z.ZodOptional, string>; model: z.ZodString; dimensions: z.ZodNumber; }, "strip", z.ZodTypeAny, { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; }, { vectors: string; model: string; dimensions: number; }>>; /** * The builder for the data envelope. */ stats: z.ZodOptional; sentences: z.ZodOptional; piis: z.ZodOptional; entities: z.ZodOptional; pos: z.ZodOptional; }, "strip", z.ZodTypeAny, { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; }, { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; }>>; chunk: z.ZodOptional; /** * The description associated with the * original document. */ startOffset: z.ZodOptional; endOffset: z.ZodOptional; /** * The description associated with the * current document representation. */ }, "strip", z.ZodTypeAny, { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; }, { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; }>>; encoding: z.ZodOptional>; custom: z.ZodOptional>; }, "strip", z.ZodTypeAny, { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: import("../../pointer/index.js").Pointer | undefined; pos?: import("../../pointer/index.js").Pointer | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: import("../../pointer/index.js").Pointer | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }, { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: string | undefined; pos?: string | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: string | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }>; }, "strip", z.ZodTypeAny, { kind: "text"; attrs: { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: import("../../pointer/index.js").Pointer | undefined; pos?: import("../../pointer/index.js").Pointer | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: import("../../pointer/index.js").Pointer | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }; }, { kind: "text"; attrs: { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: string | undefined; pos?: string | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: string | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }; }>, z.ZodObject<{ kind: z.ZodLiteral<"video">; attrs: z.ZodObject<{ resolution: z.ZodOptional>; format: z.ZodOptional; duration: z.ZodOptional; codec: z.ZodOptional; fps: z.ZodOptional; thumbnail: z.ZodOptional; aspectRatio: z.ZodOptional; audioTracks: z.ZodOptional; codec: z.ZodOptional; bitrate: z.ZodOptional; sampleRate: z.ZodOptional; channels: z.ZodOptional; lossless: z.ZodOptional; embeddings: z.ZodOptional, string>; model: z.ZodString; dimensions: z.ZodNumber; }, "strip", z.ZodTypeAny, { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; }, { vectors: string; model: string; dimensions: number; }>>; custom: z.ZodOptional>; }, "strip", z.ZodTypeAny, { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }, { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }>, "many">>; embeddings: z.ZodOptional, string>; model: z.ZodString; dimensions: z.ZodNumber; }, "strip", z.ZodTypeAny, { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; }, { vectors: string; model: string; dimensions: number; }>>; scenes: z.ZodOptional, string>>; custom: z.ZodOptional>; }, "strip", z.ZodTypeAny, { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: import("../../pointer/index.js").Pointer | undefined; }, { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: string | undefined; }>; }, "strip", z.ZodTypeAny, { kind: "video"; attrs: { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: import("../../pointer/index.js").Pointer | undefined; }; }, { kind: "video"; attrs: { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: string | undefined; }; }>, z.ZodObject<{ kind: z.ZodLiteral<"audio">; attrs: z.ZodObject<{ duration: z.ZodOptional; codec: z.ZodOptional; bitrate: z.ZodOptional; sampleRate: z.ZodOptional; channels: z.ZodOptional; lossless: z.ZodOptional; embeddings: z.ZodOptional, string>; model: z.ZodString; dimensions: z.ZodNumber; }, "strip", z.ZodTypeAny, { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; }, { vectors: string; model: string; dimensions: number; }>>; custom: z.ZodOptional>; }, "strip", z.ZodTypeAny, { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }, { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }>; }, "strip", z.ZodTypeAny, { kind: "audio"; attrs: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }; }, { kind: "audio"; attrs: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }; }>]>>; }, "strict", z.ZodTypeAny, { language?: string | undefined; custom?: Record | undefined; type?: string | undefined; description?: string | undefined; image?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; authors?: string[] | undefined; publisher?: { name: string; url?: string | undefined; type?: string | undefined; logo?: string | undefined; } | undefined; title?: string | undefined; keywords?: string[] | undefined; topics?: string[] | undefined; rating?: number | undefined; ontology?: import("../../pointer/index.js").Pointer> | undefined; properties?: { kind: "image"; attrs: { custom?: Record | undefined; format?: string | undefined; text?: import("../../pointer/index.js").Pointer | undefined; faces?: import("../../pointer/index.js").Pointer | undefined; objects?: import("../../pointer/index.js").Pointer | undefined; labels?: import("../../pointer/index.js").Pointer | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: import("../../pointer/index.js").Pointer | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }; } | { kind: "text"; attrs: { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: import("../../pointer/index.js").Pointer | undefined; pos?: import("../../pointer/index.js").Pointer | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: import("../../pointer/index.js").Pointer | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }; } | { kind: "video"; attrs: { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: import("../../pointer/index.js").Pointer | undefined; }; } | { kind: "audio"; attrs: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }; } | undefined; }, { language?: string | undefined; custom?: Record | undefined; type?: string | undefined; description?: string | undefined; image?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; authors?: string[] | undefined; publisher?: { name: string; url?: string | undefined; type?: string | undefined; logo?: string | undefined; } | undefined; title?: string | undefined; keywords?: string[] | undefined; topics?: string[] | undefined; rating?: number | undefined; ontology?: string | undefined; properties?: { kind: "image"; attrs: { custom?: Record | undefined; format?: string | undefined; text?: string | undefined; faces?: string | undefined; objects?: string | undefined; labels?: string | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: string | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }; } | { kind: "text"; attrs: { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: string | undefined; pos?: string | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: string | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }; } | { kind: "video"; attrs: { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: string | undefined; }; } | { kind: "audio"; attrs: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }; } | undefined; }>>; /** * The call stack keeping track of the * middlewares invoked along a chain. */ callStack: z.ZodDefault>; }, "strip", z.ZodTypeAny, { document: Document; source: Document; metadata: { language?: string | undefined; custom?: Record | undefined; type?: string | undefined; description?: string | undefined; image?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; authors?: string[] | undefined; publisher?: { name: string; url?: string | undefined; type?: string | undefined; logo?: string | undefined; } | undefined; title?: string | undefined; keywords?: string[] | undefined; topics?: string[] | undefined; rating?: number | undefined; ontology?: import("../../pointer/index.js").Pointer> | undefined; properties?: { kind: "image"; attrs: { custom?: Record | undefined; format?: string | undefined; text?: import("../../pointer/index.js").Pointer | undefined; faces?: import("../../pointer/index.js").Pointer | undefined; objects?: import("../../pointer/index.js").Pointer | undefined; labels?: import("../../pointer/index.js").Pointer | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: import("../../pointer/index.js").Pointer | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }; } | { kind: "text"; attrs: { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: import("../../pointer/index.js").Pointer | undefined; pos?: import("../../pointer/index.js").Pointer | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: import("../../pointer/index.js").Pointer | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }; } | { kind: "video"; attrs: { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: import("../../pointer/index.js").Pointer | undefined; }; } | { kind: "audio"; attrs: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }; } | undefined; }; chainId: string; callStack: string[]; }, { chainId: string; document?: unknown; source?: unknown; metadata?: { language?: string | undefined; custom?: Record | undefined; type?: string | undefined; description?: string | undefined; image?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; authors?: string[] | undefined; publisher?: { name: string; url?: string | undefined; type?: string | undefined; logo?: string | undefined; } | undefined; title?: string | undefined; keywords?: string[] | undefined; topics?: string[] | undefined; rating?: number | undefined; ontology?: string | undefined; properties?: { kind: "image"; attrs: { custom?: Record | undefined; format?: string | undefined; text?: string | undefined; faces?: string | undefined; objects?: string | undefined; labels?: string | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: string | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }; } | { kind: "text"; attrs: { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: string | undefined; pos?: string | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: string | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }; } | { kind: "video"; attrs: { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: string | undefined; }; } | { kind: "audio"; attrs: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: string; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }; } | undefined; } | undefined; callStack?: string[] | undefined; }>; /** * The data envelope properties type. */ type DataEnvelopeProps = z.infer; /** * Builder for the data envelope. */ declare class Builder { private props; /** * @param chainId the identifier of the chain. * @returns the builder instance. */ withChainId(chainId: string): this; /** * @param source the source document * associated with the data envelope. * @returns the builder instance. */ withSourceDocument(source: Document): this; /** * @param document the document associated with * the data envelope. * @returns the builder instance. */ withDocument(document: Document): this; /** * @param metadata the metadata associated with * the data envelope. * @returns the builder instance. */ withMetadata(metadata: DocumentMetadata): this; /** * @param callStack the call stack associated with * the data envelope. * @returns the builder instance. */ withCallStack(callStack: string[]): this; /** * @returns a new cloud event instance. */ build(): DataEnvelope; } /** * Represents the data envelope within a cloud event. * A data envelope wraps the information associated * with the event such as the source and the current * document being processed, the pipeline chain execution * identifier, and the call stack of middlewares having * been invoked. */ export declare class DataEnvelope { props: DataEnvelopeProps; /** * The builder for the data envelope. */ static Builder: typeof Builder; /** * @param chainId the identifier of the chain. * @param source the document representing * the data provider source. * @param document the current document being processed. * @param metadata the metadata associated with the * source document. */ constructor(props: DataEnvelopeProps); /** * @param data an object representing the data * envelope. This can be a JSON string or an object. * @returns a data envelope instance. * @throws an error if the data envelope is invalid. */ static from(data: string | object): DataEnvelope; /** * @returns the unique identifier of the pipeline * chain execution. */ chainId(): string; /** * @returns the source document associated with * the data envelope. */ source(): Document; /** * @returns the current document to be processed. */ document(): Document; /** * @returns the metadata associated with the * source document. */ metadata(): DocumentMetadata; /** * @returns the call stack associated with the * chain execution. */ callStack(): string[]; /** * @returns a new instance of the current data envelope * consisting of a deep copy of values associated with it. */ clone(): DataEnvelope; /** * Describes how the document should be serialized. * @returns an object with the properties associated * with the JSON representation of the data envelope. */ toJSON(): { chainId: string; source: { url: string; type: string; size: number | undefined; etag: string | undefined; }; document: { url: string; type: string; size: number | undefined; etag: string | undefined; }; metadata: { language?: string | undefined; custom?: Record | undefined; type?: string | undefined; description?: string | undefined; image?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; authors?: string[] | undefined; publisher?: { name: string; url?: string | undefined; type?: string | undefined; logo?: string | undefined; } | undefined; title?: string | undefined; keywords?: string[] | undefined; topics?: string[] | undefined; rating?: number | undefined; ontology?: import("../../pointer/index.js").Pointer> | undefined; properties?: { kind: "image"; attrs: { custom?: Record | undefined; format?: string | undefined; text?: import("../../pointer/index.js").Pointer | undefined; faces?: import("../../pointer/index.js").Pointer | undefined; objects?: import("../../pointer/index.js").Pointer | undefined; labels?: import("../../pointer/index.js").Pointer | undefined; dimensions?: { width: number; height: number; } | undefined; dominantColor?: { blue: number; green: number; red: number; } | undefined; thumbnail?: string | undefined; orientation?: any; exif?: Record | undefined; geolocation?: { latitude: number; longitude: number; } | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; ppe?: { personsWithRequiredEquipment: number; personsWithoutRequiredEquipment: number; personsIndeterminate: number; persons?: import("../../pointer/index.js").Pointer | undefined; } | undefined; stats?: { text?: number | undefined; faces?: number | undefined; objects?: number | undefined; labels?: number | undefined; moderations?: number | undefined; } | undefined; variance?: number | undefined; hashes?: { perceptual?: string | undefined; average?: string | undefined; median?: string | undefined; difference?: string | undefined; cropResistant?: string | undefined; wavelet?: string | undefined; color?: string | undefined; } | undefined; }; } | { kind: "text"; attrs: { custom?: Record | undefined; encoding?: "base64" | "ascii" | "utf-8" | "hex" | "utf-7" | "utf-7-imap" | "utf-16" | "utf16-le" | "utf16-be" | "utf32" | "utf32-le" | "utf32-be" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-10" | "iso-8859-11" | "iso-8859-12" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; stats?: { words?: number | undefined; sentences?: number | undefined; piis?: number | undefined; entities?: number | undefined; pos?: number | undefined; } | undefined; entities?: import("../../pointer/index.js").Pointer | undefined; pos?: import("../../pointer/index.js").Pointer | undefined; pages?: number | undefined; page?: number | undefined; chapters?: number | undefined; chapter?: number | undefined; layout?: { tableCount?: number | undefined; imageCount?: number | undefined; } | undefined; readingTime?: number | undefined; sentiment?: import("../document/metadata/index.js").Sentiment | undefined; pii?: import("../../pointer/index.js").Pointer | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }; } | { kind: "video"; attrs: { custom?: Record | undefined; duration?: number | undefined; format?: string | undefined; thumbnail?: string | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; resolution?: { width: number; height: number; } | undefined; fps?: number | undefined; aspectRatio?: number | undefined; audioTracks?: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }[] | undefined; scenes?: import("../../pointer/index.js").Pointer | undefined; }; } | { kind: "audio"; attrs: { custom?: Record | undefined; duration?: number | undefined; embeddings?: { vectors: import("../../pointer/index.js").Pointer; model: string; dimensions: number; } | undefined; codec?: string | undefined; bitrate?: number | undefined; sampleRate?: number | undefined; channels?: number | undefined; lossless?: boolean | undefined; }; } | undefined; }; callStack: string[]; }; } export {};