cmds

Documentation

Index

• func HelpersParameterLayer() (layers.ParameterLayer, error)
• type GeppettoCommand
  • func NewGeppettoCommand(description *glazedcmds.CommandDescription, stepFactory chat.StepFactory, ...) (*GeppettoCommand, error)
  • func (g *GeppettoCommand) RunIntoWriter(ctx context.Context, parsedLayers map[string]*layers.ParsedParameterLayer, ...) error
• type GeppettoCommandDescription
• type GeppettoCommandLoader
  • func (g *GeppettoCommandLoader) LoadCommandAliasFromYAML(s io.Reader, options ...alias.Option) ([]*alias.CommandAlias, error)
  • func (g *GeppettoCommandLoader) LoadCommandFromYAML(s io.Reader, options ...cmds.CommandDescriptionOption) ([]cmds.Command, error)
• type GeppettoCommandOption
  • func WithMessages(messages []*geppetto_context.Message) GeppettoCommandOption
  • func WithPrompt(prompt string) GeppettoCommandOption
  • func WithSystemPrompt(systemPrompt string) GeppettoCommandOption

Functions

func HelpersParameterLayer

func HelpersParameterLayer() (layers.ParameterLayer, error)

Types

type GeppettoCommand

type GeppettoCommand struct {
	*glazedcmds.CommandDescription
	StepFactory  chat.StepFactory `yaml:"-"` // this is not serialized
	Prompt       string
	Messages     []*geppetto_context.Message
	SystemPrompt string
}

func NewGeppettoCommand

func NewGeppettoCommand(
	description *glazedcmds.CommandDescription,
	stepFactory chat.StepFactory,
	options ...GeppettoCommandOption,
) (*GeppettoCommand, error)

func (*GeppettoCommand) RunIntoWriter

func (g *GeppettoCommand) RunIntoWriter(
	ctx context.Context,
	parsedLayers map[string]*layers.ParsedParameterLayer,
	ps map[string]interface{},
	w io.Writer,
) error

RunIntoWriter runs the command and writes the output into the given writer. It first:

• configures the factories with the given parameters (for example to override the temperature or other openai settings)
• configures the context manager with the configured Messages and SystemPrompt (per default, from the command definition, but can be overloaded through the --system, --message-file and --append-message-file flags)
• if --print-prompt is given, it prints the prompt and exits

It then instantiates a

type GeppettoCommandDescription

type GeppettoCommandDescription struct {
	Name      string                            `yaml:"name"`
	Short     string                            `yaml:"short"`
	Long      string                            `yaml:"long,omitempty"`
	Flags     []*parameters.ParameterDefinition `yaml:"flags,omitempty"`
	Arguments []*parameters.ParameterDefinition `yaml:"arguments,omitempty"`
	Layers    []layers.ParameterLayer           `yaml:"layers,omitempty"`

	Prompt       string                      `yaml:"prompt,omitempty"`
	Messages     []*geppetto_context.Message `yaml:"messages,omitempty"`
	SystemPrompt string                      `yaml:"system-prompt,omitempty"`
}

type GeppettoCommandLoader

type GeppettoCommandLoader struct {
}

func (*GeppettoCommandLoader) LoadCommandAliasFromYAML

func (g *GeppettoCommandLoader) LoadCommandAliasFromYAML(s io.Reader, options ...alias.Option) ([]*alias.CommandAlias, error)

func (*GeppettoCommandLoader) LoadCommandFromYAML

func (g *GeppettoCommandLoader) LoadCommandFromYAML(
	s io.Reader,
	options ...cmds.CommandDescriptionOption,
) ([]cmds.Command, error)

type GeppettoCommandOption

type GeppettoCommandOption func(*GeppettoCommand)

func WithMessages

func WithMessages(messages []*geppetto_context.Message) GeppettoCommandOption

func WithPrompt

func WithPrompt(prompt string) GeppettoCommandOption

func WithSystemPrompt

func WithSystemPrompt(systemPrompt string) GeppettoCommandOption