text

package

v1.3.4 Latest Latest Go to latest Published: May 3, 2024 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/baalimago/clai

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Configurations
- func (c *Configurations) SetupPrompts() error
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 ¶

View Source

const (
	TOKEN_COUNT_FACTOR     = 1.1
	MAX_SHORTENED_NEWLINES = 5
)

Variables ¶

View Source

var DEFAULT = Configurations{
	Model:        "gpt-4-turbo",
	SystemPrompt: "You are an assistant for a CLI interface. Answer concisely and informatively. Prefer markdown if possible.",
	Raw:          false,
	UseTools:     false,

	TokenWarnLimit: 17000,
}

Functions ¶

This section is empty.

Types ¶

type Configurations ¶

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

Configurations used to setup the requirements of text models

func (*Configurations) SetupPrompts ¶

func (c *Configurations) SetupPrompts() error

type Querier ¶ added in v1.2.0

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

	Model C
	// contains filtered or unexported fields
}

func NewQuerier ¶ added in v1.2.0

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

func (*Querier[C]) Query ¶ added in v1.2.0

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 ¶ added in v1.2.0

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
generic

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL