LangExtract.ChunkResult (LangExtract v0.9.0)

A successfully processed chunk: its byte range in the source and the spans extracted from it.

The per-chunk success unit yielded by LangExtract.stream/4, sibling of LangExtract.ChunkError. Span byte offsets are already adjusted to the original document, not the chunk.

Summary

Types

t()

Functions

from_chunk(chunk, spans, usage \\ nil)

Builds a result carrying chunk's byte range and the request's usage.

Types

t()

@type t() :: %LangExtract.ChunkResult{
  byte_end: non_neg_integer(),
  byte_start: non_neg_integer(),
  spans: [LangExtract.Span.t()],
  usage: LangExtract.Provider.Response.usage() | nil
}

Functions

from_chunk(chunk, spans, usage \\ nil)

@spec from_chunk(
  LangExtract.Chunker.Chunk.t(),
  [LangExtract.Span.t()],
  LangExtract.Provider.Response.usage() | nil
) :: t()

Builds a result carrying chunk's byte range and the request's usage.