import { z } from 'zod'; import { Sentiment } from './attributes/sentiment.js'; import { PartOfSpeech } from './attributes/pos.js'; import { Pii } from './attributes/pii.js'; import { Entity } from './attributes/entities.js'; /** * Represents additional metadata associated with * a text document. */ export declare const TextMetadataSchema: z.ZodObject<{ /** * The number of pages in the text document. */ pages: z.ZodOptional; /** * The page number associated with the text document. */ page: z.ZodOptional; /** * The number of chapters in the text document. */ chapters: z.ZodOptional; /** * The chapter number associated with the text document. */ chapter: z.ZodOptional; /** * Describes the layout of the document. */ layout: z.ZodOptional; imageCount: z.ZodOptional; }, "strip", z.ZodTypeAny, { tableCount?: number | undefined; imageCount?: number | undefined; }, { tableCount?: number | undefined; imageCount?: number | undefined; }>>; /** * The estimated reading time of the text document. */ readingTime: z.ZodOptional; /** * The detected sentiment across the text document. */ sentiment: z.ZodOptional>; /** * The parts of speech (POS) tags in the text document. * @note This property represents a URL that is transformed into * a pointer to the array of POS at parse time. */ pos: z.ZodOptional, string>>; /** * The personally identifiable information (PII) entities * in the text document. * @note This property represents a URL that is transformed into * a pointer to the array of PII at parse time. */ pii: z.ZodOptional, string>>; /** * The entities in the text document. * @note This property represents a URL that is transformed into * a pointer to the array of entities at parse time. */ entities: z.ZodOptional, string>>; /** * The vector embeddings associated with the text document. */ embeddings: z.ZodOptional, string>; model: z.ZodString; dimensions: z.ZodNumber; }, "strip", z.ZodTypeAny, { vectors: import("../../../../pointer").Pointer; model: string; dimensions: number; }, { vectors: string; model: string; dimensions: number; }>>; /** * A set of statistics associated with the text document. */ 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; }>>; /** * The chunk information the text document is part of. */ chunk: z.ZodOptional; startOffset: z.ZodOptional; endOffset: z.ZodOptional; }, "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; }>>; /** * The encoding of the text document. */ encoding: z.ZodOptional>; /** * Custom metadata associated with the text document. * This is a free form object that can contain any * custom metadata. */ 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").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").Pointer | undefined; pos?: import("../../../../pointer").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?: Sentiment | undefined; pii?: import("../../../../pointer").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?: Sentiment | undefined; pii?: string | undefined; chunk?: { id: string; order: number; total?: number | undefined; startOffset?: number | undefined; endOffset?: number | undefined; } | undefined; }>; export type TextMetadata = z.infer; export * from './attributes';