API Reference (KDocs)¶
The full API reference is generated from the source with Dokka and published alongside this site.
Entry points¶
| Declaration | What it is |
|---|---|
JevClient |
The client: builds the HTTP stack, holds the config, and runs queries |
BlockingJev |
jev.blocking, the non-suspending mirror of the same calls |
JevConfig |
Resolved settings: API key, base URL, model, timeout, retries |
RetryPolicy |
Which failures are retried, and how long the backoff waits |
Defining questions¶
| Declaration | What it is |
|---|---|
JevQuery |
Base class for a reusable, typed query object |
QueryBuilder |
The receiver inside jev.query(state) { ... } |
QuestionRef |
The handle a property or builder call returns, used to read its answer |
JevOption |
Implemented by an enum so choice<E>() can describe its constants |
Reading answers¶
| Declaration | What it is |
|---|---|
JevResult |
One response: result[ref], the by-id accessors, model and usage |
NoulAnswer |
A probability, plus isTrue() and band() |
ChoiceAnswer |
The selected option, the distribution over options, and confidence |
ScoreAnswer |
A position on the levels, with normalized and the per-level probabilities |
JevException |
The root of the error hierarchy every call can throw |
The published KDocs live at jev4k.com/kdocs, next to this site.
Serving the docs locally
make site-build copies the KDocs into the site, so the links above resolve. make site (live reload)
serves only the Markdown pages: run make kdocs and open build/dokka/html/index.html separately.