pipeline

Documentation

Overview

Package pipeline provides a way to chain multiple llm executions.

Index

• Variables
• func New(pipes ...Pipe) pipeline
• func NewSplitter(name string, llm Llm, outputDecoder Decoder, memory Memory, ...) *splitter
• type Decoder
• type Llm
• type LlmEngine
• type LlmMode
• type Memory
• type Pipe
• type Prompt
• type QATube
  • func NewQATube(llmEngine LlmEngine) *QATube
  • func (t *QATube) Run(ctx context.Context, query string, documents []document.Document) (types.M, error)
  • func (t *QATube) WithPrompt(chat *chat.Chat) *QATube
• type SplitterFn
• type Tube
  • func NewTube(llm Llm) *Tube
  • func (t *Tube) Namespace() string
  • func (s *Tube) Run(ctx context.Context, input types.M) (types.M, error)
  • func (t *Tube) WithDecoder(decoder Decoder) *Tube
  • func (t *Tube) WithMemory(namespace string, memory Memory) *Tube

Variables

var (
	ErrDecoding       = errors.New("decoding input error")
	ErrInvalidLmmMode = errors.New("invalid LLM mode")
	ErrLLMExecution   = errors.New("llm execution error")
)

var (
	ErrSplitFunction = fmt.Errorf("split function error")
)

Functions

func New

func New(pipes ...Pipe) pipeline

func NewSplitter

func NewSplitter(
	name string,
	llm Llm,
	outputDecoder Decoder,
	memory Memory,
	splitterFn SplitterFn,
) *splitter

Types

type Decoder

type Decoder interface {
	Decode(input string) (types.M, error)
}

type Llm

type Llm struct {
	LlmEngine LlmEngine
	LlmMode   LlmMode
	Prompt    Prompt
	Chat      *chat.Chat
}

type LlmEngine

type LlmEngine interface {
	Completion(ctx context.Context, prompt string) (string, error)
	Chat(ctx context.Context, chat *chat.Chat) (string, error)
}

type LlmMode

type LlmMode int

const (
	LlmModeChat LlmMode = iota
	LlmModeCompletion
)

type Memory

type Memory interface {
	Get(key string) interface{}
	Set(key string, value interface{}) error
	All() types.M
	Delete(key string) error
	Clear() error
}

type Pipe

type Pipe interface {
	Run(ctx context.Context, input types.M) (types.M, error)
}

type Prompt

type Prompt interface {
	String() string
	Format(input types.M) error
}

type QATube

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

func NewQATube

func NewQATube(llmEngine LlmEngine) *QATube

func (*QATube) Run

func (t *QATube) Run(ctx context.Context, query string, documents []document.Document) (types.M, error)

func (*QATube) WithPrompt

func (t *QATube) WithPrompt(chat *chat.Chat) *QATube

type SplitterFn

type SplitterFn func(input types.M) ([]types.M, error)

type Tube

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

func NewTube

func NewTube(
	llm Llm,
) *Tube

func (*Tube) Namespace

func (t *Tube) Namespace() string

func (*Tube) Run

func (s *Tube) Run(ctx context.Context, input types.M) (types.M, error)

Run execute the step and return the output. The prompt is formatted with the input and the output of the prompt is used as input for the LLM. If the step has a memory, the output is stored in the memory.

func (*Tube) WithDecoder

func (t *Tube) WithDecoder(decoder Decoder) *Tube

func (*Tube) WithMemory

func (t *Tube) WithMemory(namespace string, memory Memory) *Tube