langextract/dist/index.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.
 */
/**
 * LangExtract TypeScript: A TypeScript library for extracting structured and grounded information from text using LLMs.
 * Translated from the original Python implementation by Google LLC.
 */
export * from "./types";
export * from "./schema";
export * from "./tokenizer";
export * from "./prompting";
export * from "./inference";
export * from "./resolver";
export * from "./annotation";
export * from "./visualization";
import { Document, AnnotatedDocument, ExampleData, FormatType } from "./types";
export type ModelType = "gemini" | "openai" | "ollama";
/**
 * Main extraction function that provides a high-level API for extracting structured information from text.
 */
export declare function extract(textOrDocuments: string | Document | Document[], options?: {
    promptDescription?: string;
    examples?: ExampleData[];
    modelId?: string;
    modelType?: ModelType;
    apiKey?: string;
    formatType?: FormatType;
    maxCharBuffer?: number;
    temperature?: number;
    fenceOutput?: boolean;
    useSchemaConstraints?: boolean;
    batchLength?: number;
    maxWorkers?: number;
    additionalContext?: string;
    debug?: boolean;
    modelUrl?: string;
    baseURL?: string;
    extractionPasses?: number;
    maxTokens?: number;
}): Promise<AnnotatedDocument | AnnotatedDocument[]>;
export { extract as lx };
declare const _default: {
    extract: typeof extract;
    lx: typeof extract;
};
export default _default;
//# sourceMappingURL=index.d.ts.map