langextract/dist/visualization.d.ts

A TypeScript library for extracting structured and grounded information from text using LLMs

/**
 * Copyright 2025 kmbro.
 *
 * This is a TypeScript translation of the original Python LangExtract library
 * by Google LLC (https://github.com/google/langextract).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * Utility functions for visualizing LangExtract extractions in web browsers and Node.js environments.
 */
import { AnnotatedDocument } from "./types";
interface VisualizationOptions {
    animationSpeed?: number;
    showLegend?: boolean;
    gifOptimized?: boolean;
    contextChars?: number;
}
/**
 * Visualizes extraction data as animated highlighted HTML.
 */
export declare function visualize(dataSource: AnnotatedDocument | string, options?: VisualizationOptions): string;
/**
 * Saves visualization HTML to a file.
 */
export declare function saveVisualization(dataSource: AnnotatedDocument | string, outputPath: string, options?: VisualizationOptions): void;
/**
 * Creates a simple HTML page with the visualization.
 */
export declare function createVisualizationPage(dataSource: AnnotatedDocument | string, options?: VisualizationOptions): string;
/**
 * Saves a complete HTML page with the visualization.
 */
export declare function saveVisualizationPage(dataSource: AnnotatedDocument | string, outputPath: string, options?: VisualizationOptions): void;
export {};
//# sourceMappingURL=visualization.d.ts.map