prompt

Documentation

Overview

Package prompt provides a easy way to format a prompt using the Go template engine. Prompts are defined using a template string and a list of inputs.

Index

• Variables
• type AudioResponseFormat
• type Prompt
  • func New(text string) *Prompt
  • func (p *Prompt) Format(input types.M) error
  • func (p *Prompt) String() string
• type Template
  • func NewPromptTemplate(text string) *Template
  • func (t *Template) Format(input types.M) error
  • func (t *Template) String() string
  • func (t *Template) WithInputs(inputs interface{}) *Template
• type WhisperPrompt
  • func NewPromptFromAudioFile(ctx context.Context, filePath string, audioResponseFormat AudioResponseFormat) (*WhisperPrompt, error)
  • func (p *WhisperPrompt) Format(input types.M) error
  • func (p *WhisperPrompt) String() string
  • func (p *WhisperPrompt) WithClient(client *openai.Client) *WhisperPrompt

Variables

var (
	ErrFormatting     = errors.New("formatting prompt error")
	ErrDecoding       = errors.New("decoding input error")
	ErrTemplateEngine = errors.New("template engine error")
)

Types

type AudioResponseFormat

type AudioResponseFormat string

const (
	AudioResponseFormatText AudioResponseFormat = ""
	AudioResponseFormatJSON AudioResponseFormat = "json"
	AudioResponseFormatSRT  AudioResponseFormat = "srt"
	AudioResponseFormatVTT  AudioResponseFormat = "vtt"
)

type Prompt

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

func New

func New(text string) *Prompt

func (*Prompt) Format

func (p *Prompt) Format(input types.M) error

func (*Prompt) String

func (p *Prompt) String() string

type Template

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

func NewPromptTemplate

func NewPromptTemplate(text string) *Template

func (*Template) Format

func (t *Template) Format(input types.M) error

Format formats the prompt using the template engine and the provided inputs.

func (*Template) String

func (t *Template) String() string

func (*Template) WithInputs

func (t *Template) WithInputs(inputs interface{}) *Template

type WhisperPrompt

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

func NewPromptFromAudioFile

func NewPromptFromAudioFile(
	ctx context.Context,
	filePath string,
	audioResponseFormat AudioResponseFormat,
) (*WhisperPrompt, error)

func (*WhisperPrompt) Format

func (p *WhisperPrompt) Format(input types.M) error

func (*WhisperPrompt) String

func (p *WhisperPrompt) String() string

func (*WhisperPrompt) WithClient

func (p *WhisperPrompt) WithClient(client *openai.Client) *WhisperPrompt