llmz 0.8.0 → 1.0.1

package/dist/truncator.d.ts

@@ -1,118 +0,0 @@
-import { LLMzPrompts } from './prompts/prompt.js';
-type MessageLike = LLMzPrompts.Message;
-type Options<T> = {
-    messages: T[];
-    tokenLimit: number;
-    throwOnFailure?: boolean;
-};
-type TruncateOptions = {
-    preserve: 'top' | 'bottom' | 'both';
-    /**
-     * A number of 2 means that the content can shrink twice as much as the other parts
-     * @default: 1
-     * */
-    flex: number;
-    /** If provided, the message will never truncate below that number */
-    minTokens: number;
-};
-/**
- * Wraps content with truncation tags to mark it as truncatable when using `truncateWrappedContent`.
- *
- * This function encases the provided content within special truncation tags that contain metadata
- * about how the content should be truncated. The wrapped content becomes eligible for intelligent
- * truncation while preserving non-wrapped content intact.
- *
- * @param content - The string content to wrap with truncation tags
- * @param options - Optional truncation configuration
- * @param options.preserve - Which part of the content to preserve when truncating:
- *   - 'top': Keep the beginning, remove from the end (default)
- *   - 'bottom': Keep the end, remove from the beginning
- *   - 'both': Keep both ends, remove from the middle
- * @param options.flex - Priority factor for truncation (default: 1). Higher values make this
- *   content more likely to be truncated. A flex of 2 means this content can shrink twice as
- *   much as content with flex of 1.
- * @param options.minTokens - Minimum number of tokens to preserve (default: 0). Content will
- *   never be truncated below this threshold.
- *
- * @returns The content wrapped with truncation tags and embedded metadata
- *
- * @example
- * ```typescript
- * // Basic usage - content will be truncated from the end if needed
- * const wrapped = wrapContent("This is some long content that might need truncation")
- *
- * // Preserve the end of the content
- * const bottomPreserved = wrapContent("Error log: ... important error details", {
- *   preserve: 'bottom'
- * })
- *
- * // High priority for truncation with minimum preservation
- * const flexible = wrapContent("Optional context information", {
- *   flex: 3,
- *   minTokens: 50
- * })
- * ```
- */
-export declare function wrapContent(content: string, options?: Partial<TruncateOptions>): string;
-/**
- * Intelligently truncates message content to fit within a token limit while preserving important parts.
- *
- * This function processes an array of messages and reduces their total token count to fit within the
- * specified limit. It only truncates content that has been wrapped with `wrapContent()`, leaving
- * unwrapped content completely intact. The truncation algorithm prioritizes content based on flex
- * values and respects preservation preferences and minimum token requirements.
- *
- * ## How it works:
- * 1. **Parsing**: Scans each message for wrapped content sections and unwrapped sections
- * 2. **Token counting**: Calculates tokens for each section using the configured tokenizer
- * 3. **Prioritization**: Identifies the largest truncatable sections based on flex values
- * 4. **Intelligent truncation**: Removes content according to preservation preferences
- * 5. **Reconstruction**: Rebuilds messages with truncated content and removes wrapper tags
- *
- * ## Truncation strategy:
- * - **Priority**: Higher flex values = higher truncation priority
- * - **Minimum tokens**: Content is never truncated below its `minTokens` threshold
- * - **Preservation modes**:
- *   - `'top'`: Removes from the end, keeps the beginning
- *   - `'bottom'`: Removes from the beginning, keeps the end
- *   - `'both'`: Removes from the middle, keeps both ends
- *
- * @template T - Type extending MessageLike (must have a content property)
- * @param options - Configuration object
- * @param options.messages - Array of messages to truncate
- * @param options.tokenLimit - Maximum total tokens allowed across all messages
- * @param options.throwOnFailure - Whether to throw an error if truncation fails (default: true).
- *   If false, returns the best effort result even if over the token limit.
- *
- * @returns Array of messages with content truncated to fit the token limit
- *
- * @throws Error if unable to truncate enough content to meet the token limit (when throwOnFailure is true)
- *
- * @example
- * ```typescript
- * const messages = [
- *   {
- *     role: 'system',
- *     content: 'You are a helpful assistant. ' + wrapContent('Here is some background info...', { flex: 2 })
- *   },
- *   {
- *     role: 'user',
- *     content: 'Please help me with: ' + wrapContent('detailed context and examples', { preserve: 'both' })
- *   }
- * ]
- *
- * // Truncate to fit within 1000 tokens
- * const truncated = truncateWrappedContent({
- *   messages,
- *   tokenLimit: 1000,
- *   throwOnFailure: false
- * })
- *
- * // The system message background info will be truncated first (higher flex),
- * // and user context will be truncated from the middle if needed (preserve: 'both')
- * ```
- */
-export declare function truncateWrappedContent<T extends MessageLike>({ messages, tokenLimit, throwOnFailure, }: Options<T>): T[];
-/** Removes truncation wrapper tags from content, leaving the wrapped content intact. */
-export declare const stripTruncationTags: (content: string) => string;
-export {};