Changelog

Copy Markdown View Source

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.1.0 - 2026-09-27

Added

  • use Cite.Policy: a policy declared once in a module, built on Spark. Filters, concerns (screened directly with a detect and an optional confirm, or built from factors with roles and checks), factors, and Score or Choice descriptors. A passage is evidence for every concern it matches. Questions name what they read by placeholder ({passage}, {household}) and Cite replaces each with a path in the request. Any question may add a one-line focus. Every mistake in a policy is a compile error.
  • A DSL reference in Cite.Policy's docs, generated from the DSL by Spark.
  • Cite.source/2: the caller's passages, kept byte for byte, with as: for the word they sit under and show: for the meta the model sees.
  • Cite.judge/4: two fixed rounds. A screen of every passage for every detect in windows, fixed rules that gather matches into findings, and one judgment per finding on all of its evidence, gated by a review band. Options: threshold, review_band, window. A client, source, policy, or options of the wrong kind raise ArgumentError.
  • Replies are checked before they count: a reply that skips a question or answers out of range makes its whole request an error, never a verdict. Errors are reported beside the findings, one per failed request.
  • Cite.Report, Cite.Finding, Cite.Citation, Cite.Passage, and Cite.Error as the outputs, encodable with Jason. A finding carries its verdict, the raw answers to its checks and descriptors, the passages it cites and those its confirm dropped; the report keeps every round-1 score, token usage, and the model ids that answered.
  • Cite.Provider behaviour and Cite.Provider.TypeSafe, a Req client for TypeSafe System One; Cite.client/2 builds the client function judge/4 takes. A request's "state" may hold Cite.Wire.Object values, JSON objects that keep their key order. The TypeSafe client takes api_key, model, base_url, max_retry_delay, and req_options. It retries 429, 529, 500–504, and connection failures up to three times, honouring Retry-After, with delays capped at 30 seconds; timeouts are not retried.
  • Round-1 windows over the provider's size cap ({:error, :request_too_large}) are halved and retried; only a lone passage still over the cap becomes an error. A round-2 request refused as too large is that finding's error.
  • Guides: Writing policies, and How judging works. Tutorials, each building a policy from scratch: Triaging logs, Finding sponsor segments, Labelling allergens in recipes, and Checking support calls against procedure.
  • Stability tiers, named in the README and grouping the docs: Core API (the SemVer contract), Providers, and Internal.
  • Requires Elixir ~> 1.18.