API reference · Kjarni 0.2.7
Namespace Kjarni
Classes
Token to cancel long-running operations.
High-level chat interface for conversational AI using local decoder models.
Stateful conversation that maintains chat history automatically. The parent Chat must outlive this object.
Result of classifying a single text.
Text classification model.
Text embedding model.
An image matching a search.
Photos searched by description, with CLIP. Searching is safe from several threads; adding is not.
Information about an existing index.
Statistics returned after indexing operations.
Document indexer.
Library-wide functions.
Thrown when a call into the native engine fails.
Progress update during indexing operations.
Text reranking model using cross-encoders.
What scanning a directory did.
A single search result.
Document searcher for RAG applications.
Summarizes article-length text.
Speech to text with Whisper.
The result of transcribing audio.
One timed piece of a transcript, in seconds from the start.
Translates text between languages.
Structs
One turn of a conversation, for callers that own the transcript themselves.
Generation parameters for decoder models. Use -1 sentinel values to keep model defaults.
Single rerank result
Enums
Preset sampling defaults for a
The author of a turn in a conversation history.
Where a model runs.
Why a call into the native engine failed, carried by
The step an indexing or search operation is on, reported through progress callbacks.
How a
Search mode determining how queries are processed.
Kjarni runs the same engine on every platform: