text

Documentation

Index

• Constants
• Variables
• type Configurations
  • func (c *Configurations) ProfileOverrides() error
  • func (c *Configurations) SetupPrompts(args []string) error
• type Profile
• type Querier
  • func NewQuerier[C models.StreamCompleter](userConf Configurations, dfault C) (Querier[C], error)
  • func (q *Querier[C]) Query(ctx context.Context) error
  • func (q *Querier[C]) TextQuery(ctx context.Context, chat models.Chat) (models.Chat, error)

Constants

const (
	TOKEN_COUNT_FACTOR     = 1.1
	MAX_SHORTENED_NEWLINES = 5
)

Variables

var DEFAULT = Configurations{
	Model:         "gpt-4o",
	SystemPrompt:  "You are an assistant for a CLI tool. Answer concisely and informatively. Prefer markdown if possible.",
	CmdModePrompt: "You are an assistant for a CLI tool aiding with cli tool suggestions. Write ONLY the command and nothing else. Disregard any queries asking for anything except a bash command. Do not shell escape single or double quotes.",
	Raw:           false,
	UseTools:      false,

	TokenWarnLimit:  17000,
	SaveReplyAsConv: true,
}

var DEFAULT_PROFILE = Profile{
	UseTools:        true,
	SaveReplyAsConv: true,
	Tools:           []string{},
}

Types

type Configurations

type Configurations struct {
	Model           string      `json:"model"`
	SystemPrompt    string      `json:"system-prompt"`
	CmdModePrompt   string      `json:"cmd-mode-prompt"`
	Raw             bool        `json:"raw"`
	UseTools        bool        `json:"use-tools"`
	TokenWarnLimit  int         `json:"token-warn-limit"`
	SaveReplyAsConv bool        `json:"save-reply-as-prompt"`
	ConfigDir       string      `json:"-"`
	StdinReplace    string      `json:"-"`
	Stream          bool        `json:"-"`
	ReplyMode       bool        `json:"-"`
	ChatMode        bool        `json:"-"`
	CmdMode         bool        `json:"-"`
	Glob            string      `json:"-"`
	InitialPrompt   models.Chat `json:"-"`
	UseProfile      string      `json:"-"`
	Tools           []string    `json:"-"`
	// PostProccessedPrompt which has had it's strings replaced etc
	PostProccessedPrompt string `json:"-"`
}

Configurations used to setup the requirements of text models

func (*Configurations) ProfileOverrides

func (c *Configurations) ProfileOverrides() error

func (*Configurations) SetupPrompts

func (c *Configurations) SetupPrompts(args []string) error

type Profile

type Profile struct {
	Model           string   `json:"model"`
	UseTools        bool     `json:"use_tools"`
	Tools           []string `json:"tools"`
	Prompt          string   `json:"prompt"`
	SaveReplyAsConv bool     `json:"save-reply-as-conv"`
}

Profile which allows for specialized ai configurations for specific tasks

type Querier

type Querier[C models.StreamCompleter] struct {
	Url string
	Raw bool

	Model C
	// contains filtered or unexported fields
}

func NewQuerier

func NewQuerier[C models.StreamCompleter](userConf Configurations, dfault C) (Querier[C], error)

func (*Querier[C]) Query

func (q *Querier[C]) Query(ctx context.Context) error

Query using the underlying model to stream completions and then print the output from the model to stdout. Blocking operation.

func (*Querier[C]) TextQuery

func (q *Querier[C]) TextQuery(ctx context.Context, chat models.Chat) (models.Chat, error)