defmodule LangExtract do @moduledoc """ Extracts structured data from text with source grounding. Maps extraction strings back to exact byte positions in source text. This module is the main entry point: `new/2` builds a client, `template/2` builds a validated task definition, `run/4` executes the full pipeline, and `align/3` / `extract/3` expose the lower-level steps. Beyond the facade: * `LangExtract.Prompt.Validator` — pre-flight check that few-shot examples align against their own source text * `LangExtract.Serializer` — convert results to plain maps and JSONL for storage or interop * `LangExtract.Extraction` — the extraction struct used in template examples and parsed LLM output """ alias LangExtract.Alignment.{Aligner, Span} alias LangExtract.{Client, Extraction, Orchestrator, Pipeline, Prompt, Provider, Template} alias Pipeline.ChunkError @doc """ Aligns extraction strings to byte spans in source text. Returns a list of `%LangExtract.Alignment.Span{}` structs, one per extraction. ## Options * `:fuzzy_threshold` - minimum overlap ratio for fuzzy match (default `0.75`) ## Examples iex> LangExtract.align("the quick brown fox", ["quick brown"]) [%LangExtract.Alignment.Span{text: "quick brown", byte_start: 4, byte_end: 15, status: :exact}] """ @spec align(String.t(), [String.t()], keyword()) :: [LangExtract.Alignment.Span.t()] def align(source, extractions, opts \\ []) do Aligner.align(source, extractions, opts) end @doc """ Parses LLM output, aligns extractions against source text, and returns enriched spans with class and attributes. Accepts both canonical and dynamic-key format (where each entry uses the class name as the key). JSON only (since 0.7.0). Strips markdown fences and think tags before parsing. ## Options * `:fuzzy_threshold` - minimum overlap ratio for fuzzy match (default `0.75`) ## Examples iex> raw = ~s({"extractions": [{"class": "word", "text": "fox"}]}) iex> {:ok, [span]} = LangExtract.extract("the quick brown fox", raw) iex> span.status :exact """ @spec extract(String.t(), String.t(), keyword()) :: {:ok, [Span.t()]} | {:error, {:invalid_format, String.t()} | :missing_extractions} defdelegate extract(source, raw_llm_output, opts \\ []), to: Pipeline @doc """ Runs the full extraction pipeline: prompt → LLM → parse → align. Returns `{:ok, {spans, chunk_errors}}` on success. When some chunks fail to parse, the successful spans are still returned alongside the errors. Returns `{:error, reason}` only for infrastructure failures (task exits, timeouts). ## Options * `:max_chunk_chars` - chunk size in characters (default `1000`) * `:max_concurrency` - parallel chunk requests (default `10`) * `:task_timeout` - per-chunk task timeout (default `:infinity`) * `:fuzzy_threshold` - minimum LCS coverage for fuzzy match (default `0.75`) * `:min_density` - minimum matched-token density of a fuzzy span (default `1/3`) * `:accept_lesser` - allow prefix-fragment grounding (default `true`) * `:exact_algorithm` - `:dp` (occurrence DP, default) or `:first_occurrence` See the "Alignment and Spans" guide for what the alignment options tune. ## Examples client = LangExtract.new(:claude, api_key: "sk-...") template = LangExtract.template("Extract entities.") {:ok, {spans, errors}} = LangExtract.run(client, "the quick brown fox", template) """ @spec run(Client.t(), String.t(), Template.t(), keyword()) :: {:ok, {[Span.t()], [ChunkError.t()]}} | {:error, {:task_exit, term()}} def run(%Client{} = client, source, %Template{} = template, opts \\ []) do Orchestrator.run(client, source, template, opts) end @doc """ Streams per-chunk extraction results as each chunk completes. Returns a lazy stream of `{:ok, %Pipeline.ChunkResult{}}` and `{:error, %Pipeline.ChunkError{}}` events in **completion order**, not document order — consumers who need latency don't wait for slow chunks; consumers who need order sort by the byte ranges every event carries. Nothing runs until the stream is consumed, and a slow consumer naturally limits how many chunk requests are in flight. Failure semantics differ from `run/4` deliberately: every failure stays per-chunk. A chunk whose task times out is reported as `{:error, %ChunkError{reason: {:task_exit, :timeout}}}` with its byte range, and the remaining chunks keep flowing — where `run/4` abandons the document and returns `{:error, {:task_exit, reason}}`. Takes the same options as `run/4`. ## Examples client |> LangExtract.stream(document, template) |> Enum.each(fn {:ok, chunk_result} -> handle_spans(chunk_result.spans) {:error, chunk_error} -> log_failure(chunk_error) end) """ @spec stream(Client.t(), String.t(), Template.t(), keyword()) :: Enumerable.t() def stream(%Client{} = client, source, %Template{} = template, opts \\ []) do Orchestrator.stream(client, source, template, opts) end @doc """ Builds a validated extraction template. Examples are given as plain maps (string or atom keys, so JSON-loaded task definitions work verbatim) or as ready-made structs. Each example's extraction texts are validated against the example text using the production aligner; misaligned examples raise `LangExtract.Prompt.Validator.ValidationError` — a template that constructs is a template whose examples align. Pass `validate: false` to skip. ## Examples iex> template = ...> LangExtract.template("Extract conditions.", ...> examples: [ ...> %{text: "Patient has diabetes.", ...> extractions: [%{class: "condition", text: "diabetes"}]} ...> ] ...> ) iex> [example] = template.examples iex> example.extractions [%LangExtract.Extraction{class: "condition", text: "diabetes", attributes: %{}}] """ @spec template(String.t(), keyword()) :: Template.t() def template(description, opts \\ []) when is_binary(description) do examples = opts |> Keyword.get(:examples, []) |> Enum.map(&normalize_example/1) template = %Template{description: description, examples: examples} if Keyword.get(opts, :validate, true) do Prompt.Validator.validate!(template) end template end defp normalize_example(%Template.Example{} = example), do: example defp normalize_example(%{} = map) do %Template.Example{ text: fetch_field!(map, :text, "example"), extractions: map |> get_field(:extractions, []) |> Enum.map(&normalize_extraction/1) } end defp normalize_extraction(%Extraction{} = extraction), do: extraction defp normalize_extraction(%{} = map) do %Extraction{ class: fetch_field!(map, :class, "extraction"), text: fetch_field!(map, :text, "extraction"), attributes: get_field(map, :attributes, %{}) } end defp fetch_field!(map, key, owner) do get_field(map, key, nil) || raise ArgumentError, "#{owner} is missing required key #{inspect(key)}: #{inspect(map)}" end defp get_field(map, key, default) do Map.get(map, key) || Map.get(map, Atom.to_string(key)) || default end @doc """ Creates a configured LLM client for extraction. Raises `ArgumentError` on an unknown provider or unbuildable HTTP client (e.g. missing API key). The raise is deliberate: misconfiguration here is a programmer error caught at client construction, while runtime failures during extraction (`run/4`, `extract/3`) return tagged tuples. ## Examples client = LangExtract.new(:claude, api_key: "sk-...") client = LangExtract.new(:openai, api_key: "sk-...", model: "gpt-4o") client = LangExtract.new(:gemini, api_key: "gm-...") """ @type provider :: :claude | :openai | :gemini @spec new(provider(), keyword()) :: Client.t() def new(provider, opts \\ []) do module = resolve_provider(provider) case module.build_http_client(opts) do {:ok, req} -> %Client{provider: module, options: opts, http_client: req} {:error, reason} -> raise ArgumentError, "failed to build HTTP client: #{inspect(reason)}" end end defp resolve_provider(:claude), do: Provider.Claude defp resolve_provider(:openai), do: Provider.OpenAI defp resolve_provider(:gemini), do: Provider.Gemini defp resolve_provider(other) do raise ArgumentError, "unknown provider: #{inspect(other)}. Expected :claude, :openai, or :gemini" end end