client

type Client struct {
	BaseURL string
	HTTP    *http.Client
}

type Doc struct {
	Index string `json:"index"`
	Path  string `json:"path"`
	Title string `json:"title,omitempty"`
	Pages []Page `json:"pages,omitempty"`
	Text  string `json:"text,omitempty"`
	// Truncated reports that Text is not the whole document. A consumer checking
	// whether a quotation appears MUST NOT read a miss as absence when this is
	// set: the passage may be in the part that was cut.
	Truncated bool `json:"truncated,omitempty"`
}

type DocSummary struct {
	Index string `json:"index"`
	Path  string `json:"path"`
	Title string `json:"title,omitempty"`
	// Fragments is the indexed text: zero means nothing readable came out of it.
	Fragments int `json:"fragments"`
	// Pages is the page COUNT, not the pages. A document may have pages and no
	// fragments, which is exactly the un-OCR'd scan.
	Pages int `json:"pages"`
	// Vision counts what was read by a vision model rather than a text layer.
	Vision   int    `json:"vision"`
	FragMode string `json:"frag_mode,omitempty"`
}

type Hit struct {
	Index   string  `json:"index"`
	Doc     string  `json:"doc_id"`
	Title   string  `json:"title,omitempty"`
	Page    int     `json:"page,omitempty"`
	Score   float64 `json:"score"`
	Snippet string  `json:"snippet,omitempty"`
	// Caveat is the one line to show beside the snippet when it cannot be read
	// as the record — a model's description of an image, or a read nobody
	// measured. EMPTY for an ordinary transcription, because a caveat on every
	// row is a caveat on none.
	//
	// A consumer that shows the snippet and drops this is showing a model's
	// account of a picture as though somebody wrote it down.
	Caveat string `json:"caveat,omitempty"`
	// Trust is the same fact structured: what produced the text, whether a
	// person has ruled on it, and the per-facet confidences. Nil when raglit
	// recorded nothing about how the document was read — which is NOT a claim
	// that it is reliable, and is why Caveat is non-empty in that case.
	Trust *HitTrust `json:"trust,omitempty"`
}

type HitTrust struct {
	// Method is what produced the text: text-layer, vision-ocr, oidio-asr, pandoc…
	Method string `json:"method,omitempty"`
	// Level is machine, adapted or attested — whether a person has been through it.
	Level string `json:"level,omitempty"`
	// DescribedPct is how much of the document a model DESCRIBED rather than
	// transcribed. -1 means it was never measured, which is distinct from 0.
	DescribedPct int `json:"described_pct,omitempty"`
	// Facets is the per-facet confidence, 0-100: text, speaker, layout, subject.
	// A facet that is ABSENT is not claimed, rather than distrusted.
	Facets map[string]int `json:"facets,omitempty"`
	// Summary renders Facets weakest-first for a reader ("subject 80%", "text 90%").
	Summary []string `json:"summary,omitempty"`
	// RuledBy is the person who ruled, when one has.
	RuledBy string `json:"ruled_by,omitempty"`
}

type Page struct {
	Page int    `json:"page"`
	Text string `json:"text"`
}

type Relation struct {
	A          string  `json:"a"`
	B          string  `json:"b"`
	Kind       string  `json:"kind"` // copy | version | unrelated
	Supersedes string  `json:"supersedes,omitempty"`
	Note       string  `json:"note,omitempty"`
	By         string  `json:"by,omitempty"`
	At         string  `json:"at,omitempty"`
	Relation   string  `json:"relation,omitempty"`
	Coverage   float64 `json:"coverage,omitempty"`
}

type Slice struct {
	ID     string `json:"id"`
	Parent string `json:"parent"`
	From   int    `json:"from"`
	To     int    `json:"to"`
	Title  string `json:"title,omitempty"`
	Note   string `json:"note,omitempty"`
	By     string `json:"by,omitempty"`
	At     string `json:"at,omitempty"`
}

type TokenSource struct {
	// contains filtered or unexported fields
}

type Transport struct {
	Base  http.RoundTripper
	Src   *TokenSource
	Allow func(host string) bool
}

type Withdrawal struct {
	Path   string `json:"path"`
	Reason string `json:"reason"`
}