Documentation index for AI agents: see /llms.txt. Markdown versions of every page are available at <path>.md or via Accept: text/markdown.
Reference

Glimpse

Schema-neutral summary helper. Customer code supplies the domain-specific fields; glimpse(...) only normalizes the result into JSON-compatible values and produces a {count...

Schema-neutral summary helper. Customer code supplies the domain-specific fields; glimpse(...) only normalizes the result into JSON-compatible values and produces a {count, sample} fallback for sequence inputs.

glimpse

glimpse(value: 'Any', *, max_items: 'int' = 3) -> 'dict[str, Any]'

ParameterTypeDefault
valueAnyrequired
max_itemsint3

Returns: dict[str, Any]

Build a small schema-neutral glimpse from customer-provided data.

Domain-specific fields belong in customer code. For example, a customer can pass a hand-built summary dict from ReferenceSpec.glimpse and this helper will only normalize it to JSON-compatible values.

On this page