assistant

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

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

type Attachment struct {
	MediaType string // image/png, image/jpeg, image/webp, application/pdf
	Data      []byte
}

type Config struct {
	Provider string
	APIKey   string
	Model    string
	BaseURL  string
	Enabled  bool
}

type Env struct {
	Provider string // EXHALE_ASSISTANT_PROVIDER
	APIKey   string // EXHALE_ASSISTANT_API_KEY
	Model    string // EXHALE_ASSISTANT_MODEL
	BaseURL  string // EXHALE_ASSISTANT_BASE_URL
}

type Error struct {
	Kind   Kind
	Status int
	Detail string
}

type Fake struct {

	// Steps are answered in order. A step may look at the request (to
	// read an id from a tool result, say) before answering.
	Steps []func(Request) (Response, error)
	// Requests records every call, for assertions.
	Requests []Request
	// Loop, when set, answers every call after the script ran out.
	Loop func(Request) (Response, error)
	// contains filtered or unexported fields
}

type Kind int

type Mention struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type Message struct {
	Role        Role
	Text        string
	Attachments []Attachment // user messages
	ToolCalls   []ToolCall   // assistant messages
	ToolResults []ToolResult // tool messages
	// Raw is the provider's own form of an assistant message. It is sent
	// back as it came while the same question is being answered, because
	// providers that return reasoning blocks reject a history that was
	// rebuilt without them. It is never kept between questions.
	Raw json.RawMessage
}

type MonthUsage struct {
	Month        string  `json:"month" doc:"e.g. 2026-11, in the household's time zone"`
	Questions    int     `json:"questions" doc:"questions and imports read by a model"`
	InputTokens  int     `json:"inputTokens"`
	OutputTokens int     `json:"outputTokens"`
	CostUSD      *string `json:"costUsd,omitempty" doc:"estimated cost in US dollars of the entries whose price is known"`
	Unpriced     int     `json:"unpriced" doc:"entries whose model has no price: their tokens count, their cost does not"`
}

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

type Outcome struct {
	ID      string        `json:"id"`
	Status  string        `json:"status" enum:"pending,applied,discarded,failed,undone"`
	Title   domain.Text   `json:"title"`
	Lines   []domain.Text `json:"lines"`
	CanUndo bool          `json:"canUndo" doc:"an applied change that Undo can revert"`
	// SubscriptionID is the subscription the change was about, for a link.
	SubscriptionID string `json:"subscriptionId,omitempty"`
}

type Price struct {
	Input  string `json:"input" doc:"US dollars per million input tokens, e.g. 4 or 0.10"`
	Output string `json:"output" doc:"US dollars per million output tokens, e.g. 20 or 0.50"`
}

type Progress func(text string)

type Proposal struct {
	ID          string        `json:"id"`
	Tool        string        `json:"tool" doc:"the use case that would run, e.g. create_subscription"`
	Title       domain.Text   `json:"title" doc:"what would happen, e.g. Add Netflix, as a translatable text"`
	Lines       []domain.Text `json:"lines" doc:"the details of the change, as translatable texts"`
	Destructive bool          `json:"destructive" doc:"it deletes or cancels"`
}

type Provider interface {
	// Name is the provider id: "anthropic" or "openai".
	Name() string
	Complete(ctx context.Context, req Request) (Response, error)
}

type Request struct {
	System    string
	Messages  []Message
	Tools     []Tool
	MaxTokens int
}

type Response struct {
	Text      string
	ToolCalls []ToolCall
	Raw       json.RawMessage
	Stop      Stop
	Usage     Usage
	Model     string
}

type Review struct {
	ID      string          `json:"id" doc:"changes when another file replaces the review"`
	Channel string          `json:"channel" doc:"the chat it came from, e.g. telegram"`
	Result  importer.Result `json:"result"`
	// Outcomes is the dry run of importing Result.Items.
	Outcomes []app.ImportOutcome `json:"outcomes"`
	// Off are the lines the person unticked in the chat.
	Off       map[int]bool `json:"off,omitempty"`
	CreatedAt time.Time    `json:"createdAt"`
}

type Role string

type Screen struct {
	Kind          string                 `json:"kind" enum:"subscriptions,charges,total"`
	Subscriptions []app.SubscriptionView `json:"subscriptions,omitempty" doc:"kind subscriptions: in the order the model chose"`
	Charges       *app.ChargeList        `json:"charges,omitempty" doc:"kind charges: the period and its charges"`
	Total         *app.Breakdown         `json:"total,omitempty" doc:"kind total"`
	More          int                    `json:"more,omitempty" doc:"records left out because the screen is full"`
}

type Settings struct {
	Provider string `` /* 152-byte string literal not displayed */
	APIKey   string `json:"apiKey,omitempty" doc:"leave empty to keep the saved key"`
	Model    string `json:"model,omitempty" doc:"model id; required for openai, optional for anthropic"`
	BaseURL  string `` /* 131-byte string literal not displayed */
	Enabled  *bool  `json:"enabled,omitempty" doc:"on/off switch; on when omitted"`
	Price    *Price `json:"price,omitempty" doc:"the price of the model, to estimate costs; both empty forgets it. Omit to keep it"`
}

type Status struct {
	Enabled      bool        `json:"enabled" doc:"the assistant answers: it is configured and switched on"`
	Configured   bool        `json:"configured" doc:"a provider, and what it needs, is set"`
	On           bool        `json:"on" doc:"the on/off switch, whatever the configuration"`
	Provider     string      `json:"provider,omitempty" enum:"anthropic,openai"`
	Model        string      `json:"model,omitempty"`
	BaseURL      string      `json:"baseUrl,omitempty"`
	HasKey       bool        `json:"hasKey" doc:"an API key is saved; it is never returned"`
	Locked       []string    `json:"locked" doc:"fields set by environment variables on the server, not editable here: provider, apiKey, model, baseUrl"`
	DefaultModel string      `json:"defaultModel" doc:"the model used with Anthropic when none is given"`
	Price        *Price      `json:"price,omitempty" doc:"the price used to estimate the cost of the current model; absent when it is not known"`
	PriceSource  string      `` /* 136-byte string literal not displayed */
	Month        *MonthUsage `json:"month,omitempty" doc:"what the assistant was asked this month"`
}

type Stop string

type Streamer interface {
	Stream(ctx context.Context, req Request, onText func(delta string)) (Response, error)
}

type TermsField struct {
	Field   string `json:"field" enum:"noticeDays,cancelUrl,startedOn,trialEndsOn,account" doc:"the update_subscription field it fills"`
	Value   string `json:"value" doc:"the checked value; noticeDays as a whole number"`
	Current string `json:"current,omitempty" doc:"what Exhale has now, if anything"`
	Quote   string `json:"quote,omitempty" doc:"the words of the document it is based on, as the model reported them"`
}

type TermsProposal struct {
	SubscriptionID string       `json:"subscriptionId"`
	DocumentID     string       `json:"documentId"`
	Fields         []TermsField `json:"fields"`
	Notes          []string     `json:"notes"`
	Model          string       `json:"model"`
}

type TestResult struct {
	OK      bool        `json:"ok"`
	Message domain.Text `json:"message" doc:"a translatable text"`
	Model   string      `json:"model,omitempty" doc:"the model that answered"`
}

type Tool struct {
	Name        string
	Description string
	Schema      json.RawMessage // JSON Schema of the arguments
}

type ToolCall struct {
	ID        string
	Name      string
	Arguments json.RawMessage
}

type ToolResult struct {
	CallID  string
	Name    string
	Content string
	IsError bool
}

type Turn struct {
	Text      string       `json:"text" doc:"the answer, plain text"`
	Proposals []Proposal   `json:"proposals" doc:"changes prepared for the person to confirm or discard; nothing is applied until they confirm"`
	Mentions  []Mention    `json:"mentions" doc:"subscriptions the answer talks about, for links"`
	Screens   []Screen     `json:"screens" doc:"screens the model chose to show; every name and number in them comes from the database"`
	Note      *domain.Text `json:"note,omitempty" doc:"why the answer may be incomplete, e.g. the step limit was reached; a translatable text"`
}

type Usage struct {
	Input  int
	Output int
}

type UsageEntry struct {
	ID           string    `json:"id"`
	At           time.Time `json:"at"`
	Member       string    `json:"member" doc:"who asked"`
	Kind         string    `json:"kind" enum:"question,import"`
	Surface      string    `json:"surface" doc:"web, telegram, slack or import"`
	Provider     string    `json:"provider"`
	Model        string    `json:"model"`
	Rounds       int       `json:"rounds" doc:"calls to the model"`
	InputTokens  int       `json:"inputTokens"`
	OutputTokens int       `json:"outputTokens"`
	CostUSD      *string   `json:"costUsd,omitempty" doc:"estimated cost in US dollars; absent when the model's price is not known"`
	Failed       bool      `json:"failed"`
}

type UsageList struct {
	Entries []UsageEntry `json:"entries"`
}