Documentation
¶
Overview ¶
Package voice is the Writing Voice: the instructions an LLM follows to write as a person writes, one Markdown file, VOICE.md, at most MaxBytes. It is not a knowledge pack: it has no wiki, no sources and no name, and a person keeps one. A run reads it through the one tool voice_read, granted only when a voice is attached, and the System Prompt's head says what it governs and what it never does.
This package is the format: what a VOICE.md must be, its digest, and the record kept beside it. The local store keeps it sealed (pkg/knowledge/store), the Voice Writer writes it (pkg/voice/writer, pkg/voice/build), and the engine stages it into a run.
Index ¶
Constants ¶
const ( // File is the voice's one file. File = "VOICE.md" // MaxBytes caps a VOICE.md: the drafted instruction's cap, so a // full LLM skill fits and AI Review reads it in one chunk. MaxBytes = 32 << 10 // MetaSchema is the format of the record kept beside a voice. MetaSchema = "agentry-voice/v1" )
Variables ¶
var ErrNoVoice = errors.New("no Writing Voice is kept on this computer; make one with `agentry voice create --file SAMPLE`")
ErrNoVoice is what a store that keeps no voice answers.
Functions ¶
Types ¶
type Meta ¶
type Meta struct {
Schema string `json:"schema"`
// ID names the voice's sealed copy and wraps its key ("vo_" and 32
// hex digits). A new version keeps it.
ID string `json:"id"`
SHA256 string `json:"sha256"`
Bytes int `json:"bytes"`
Source Source `json:"source"`
Created string `json:"created"`
Updated string `json:"updated"`
// AlwaysAttach is this computer's voice's own flag: every run
// here attaches it unless the run says not to. On when a voice is
// first made.
AlwaysAttach bool `json:"alwaysAttach"`
// Creator is the client and model that wrote the last version; empty
// for the person's own text.
Creator *Creator `json:"creator,omitempty"`
}
Meta is the record kept in the clear beside a sealed voice: what it is, never what it says.
type Source ¶
type Source string
Source is how a version of the voice came to be.
const ( // SourceCreate is the Voice Writer over writing samples and a brief. SourceCreate Source = "create" // SourceImprove is the Voice Writer over the current voice, more // samples and a brief. SourceImprove Source = "improve" // SourceAIEdit is the Voice Writer over the current voice and a note. SourceAIEdit Source = "ai-edit" // SourceEdit is the person's own text. SourceEdit Source = "edit" // SourceDownload is the account's live voice, downloaded: AI Review // passed it in the account before it was live there. SourceDownload Source = "download" )
Directories
¶
| Path | Synopsis |
|---|---|
|
Package build writes a Writing Voice with the Voice Writer: it stages the person's writing samples, decodes them before any agent sees them (pkg/runner/decode, the Knowledge Creator's decode step), runs the built-in Voice Writer over their text with the current voice when there is one (pkg/runner/localrun), and returns the VOICE.md it wrote, held to the format.
|
Package build writes a Writing Voice with the Voice Writer: it stages the person's writing samples, decodes them before any agent sees them (pkg/runner/decode, the Knowledge Creator's decode step), runs the built-in Voice Writer over their text with the current voice when there is one (pkg/runner/localrun), and returns the VOICE.md it wrote, held to the format. |
|
Package remote is the client of a registry's Writing Voice routes (the core's docs/voice.md): read the account's voice, put a new version for review, and set the account's always-attach flag, for the account a session token or a personal access token with voice:read and voice:write speaks for.
|
Package remote is the client of a registry's Writing Voice routes (the core's docs/voice.md): read the account's voice, put a new version for review, and set the account's always-attach flag, for the account a session token or a personal access token with voice:read and voice:write speaks for. |
|
Package writer is the Voice Writer: the QuickAgent package that writes a person's Writing Voice from samples of their writing, embedded in the CLI and run by the runner as a built-in package, the third beside the Knowledge Creator and the Drafter.
|
Package writer is the Voice Writer: the QuickAgent package that writes a person's Writing Voice from samples of their writing, embedded in the CLI and run by the runner as a built-in package, the third beside the Knowledge Creator and the Drafter. |