prompt

Documentation

Overview

Package prompt provides utilities for managing and optimizing prompts.

Index

• Variables
• func ListTemplateFields(t *template.Template) []string
• type AIMessageTemplate
  • func NewAIMessageTemplate(template string) *AIMessageTemplate
  • func (pt *AIMessageTemplate) Format(values map[string]any) (schema.ChatMessage, error)
  • func (mt *AIMessageTemplate) FormatPrompt(values map[string]any) (*ChatPromptValue, error)
• type ChatPromptValue
  • func NewChatPromptValue(messages schema.ChatMessages) *ChatPromptValue
  • func (v ChatPromptValue) Messages() schema.ChatMessages
  • func (v ChatPromptValue) String() string
• type ChatTemplate
  • func NewChatTemplate(messageTemplates []MessageTemplate) ChatTemplate
  • func NewChatTemplateWrapper(chatTemplates ...ChatTemplate) ChatTemplate
  • func NewMessagesPlaceholder(inputKey string) ChatTemplate
• type Formatter
  • func NewFormatter(text string) *Formatter
  • func (pt *Formatter) Fields() []string
  • func (pt *Formatter) Render(values map[string]any) (string, error)
• type HumanMessageTemplate
  • func NewHumanMessageTemplate(template string) *HumanMessageTemplate
  • func (pt *HumanMessageTemplate) Format(values map[string]any) (schema.ChatMessage, error)
  • func (mt *HumanMessageTemplate) FormatPrompt(values map[string]any) (*ChatPromptValue, error)
• type MessageTemplate
• type PartialValues
• type StringPromptValue
  • func (v StringPromptValue) Messages() schema.ChatMessages
  • func (v StringPromptValue) String() string
• type SystemMessageTemplate
  • func NewSystemMessageTemplate(template string) *SystemMessageTemplate
  • func (pt *SystemMessageTemplate) Format(values map[string]any) (schema.ChatMessage, error)
  • func (mt *SystemMessageTemplate) FormatPrompt(values map[string]any) (*ChatPromptValue, error)
• type Template
  • func NewTemplate(template string, optFns ...func(o *TemplateOptions)) *Template
  • func (p *Template) Format(values map[string]any) (string, error)
  • func (p *Template) FormatPrompt(values map[string]any) (schema.PromptValue, error)
  • func (p *Template) InputVariables() []string
  • func (p *Template) OutputParser() (schema.OutputParser[any], bool)
  • func (p *Template) Partial(values PartialValues) *Template
• type TemplateOptions

Variables

var (
	ErrInvalidPartialVariableType = errors.New("invalid partial variable type")
)

Functions

func ListTemplateFields

func ListTemplateFields(t *template.Template) []string

Types

type AIMessageTemplate

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

AIMessageTemplate represents an AI message template.

func NewAIMessageTemplate

func NewAIMessageTemplate(template string) *AIMessageTemplate

NewAIMessageTemplate creates a new AIMessageTemplate with the given template.

func (*AIMessageTemplate) Format

func (pt *AIMessageTemplate) Format(values map[string]any) (schema.ChatMessage, error)

Format formats the message using the provided values and returns an AIChatMessage.

func (*AIMessageTemplate) FormatPrompt

func (mt *AIMessageTemplate) FormatPrompt(values map[string]any) (*ChatPromptValue, error)

type ChatPromptValue

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

ChatPromptValue represents a chat prompt value containing chat messages.

func NewChatPromptValue

func NewChatPromptValue(messages schema.ChatMessages) *ChatPromptValue

NewChatPromptValue creates a new ChatPromptValue with the given chat messages.

func (ChatPromptValue) Messages

func (v ChatPromptValue) Messages() schema.ChatMessages

Messages returns the chat messages contained in the ChatPromptValue.

func (ChatPromptValue) String

func (v ChatPromptValue) String() string

String returns a string representation of the ChatPromptValue.

type ChatTemplate

type ChatTemplate interface {
	FormatPrompt(values map[string]any) (*ChatPromptValue, error)
	Format(values map[string]any) (schema.ChatMessages, error)
}

ChatTemplate represents a chat template.

func NewChatTemplate

func NewChatTemplate(messageTemplates []MessageTemplate) ChatTemplate

NewChatTemplate creates a new ChatTemplate with the given message templates.

func NewChatTemplateWrapper

func NewChatTemplateWrapper(chatTemplates ...ChatTemplate) ChatTemplate

NewChatTemplateWrapper creates a new ChatTemplate that wraps multiple ChatTemplates.

func NewMessagesPlaceholder

func NewMessagesPlaceholder(inputKey string) ChatTemplate

NewMessagesPlaceholder creates a new ChatTemplate placeholder for chat messages.

type Formatter

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

func NewFormatter

func NewFormatter(text string) *Formatter

func (*Formatter) Fields

func (pt *Formatter) Fields() []string

func (*Formatter) Render

func (pt *Formatter) Render(values map[string]any) (string, error)

type HumanMessageTemplate

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

HumanMessageTemplate represents a human message template.

func NewHumanMessageTemplate

func NewHumanMessageTemplate(template string) *HumanMessageTemplate

NewHumanMessageTemplate creates a new HumanMessageTemplate with the given template.

func (*HumanMessageTemplate) Format

func (pt *HumanMessageTemplate) Format(values map[string]any) (schema.ChatMessage, error)

Format formats the message using the provided values and returns a HumanChatMessage.

func (*HumanMessageTemplate) FormatPrompt

func (mt *HumanMessageTemplate) FormatPrompt(values map[string]any) (*ChatPromptValue, error)

type MessageTemplate

type MessageTemplate interface {
	Format(values map[string]any) (schema.ChatMessage, error)
	FormatPrompt(values map[string]any) (*ChatPromptValue, error)
}

MessageTemplate represents a chat message template.

type PartialValues

type PartialValues map[string]any

type StringPromptValue

type StringPromptValue string

func (StringPromptValue) Messages

func (v StringPromptValue) Messages() schema.ChatMessages

func (StringPromptValue) String

func (v StringPromptValue) String() string

type SystemMessageTemplate

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

SystemMessageTemplate represents a system message template.

func NewSystemMessageTemplate

func NewSystemMessageTemplate(template string) *SystemMessageTemplate

NewSystemMessageTemplate creates a new SystemMessageTemplate with the given template.

func (*SystemMessageTemplate) Format

func (pt *SystemMessageTemplate) Format(values map[string]any) (schema.ChatMessage, error)

Format formats the message using the provided values and returns a SystemChatMessage.

func (*SystemMessageTemplate) FormatPrompt

func (mt *SystemMessageTemplate) FormatPrompt(values map[string]any) (*ChatPromptValue, error)

type Template

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

func NewTemplate

func NewTemplate(template string, optFns ...func(o *TemplateOptions)) *Template

func (*Template) Format

func (p *Template) Format(values map[string]any) (string, error)

func (*Template) FormatPrompt

func (p *Template) FormatPrompt(values map[string]any) (schema.PromptValue, error)

func (*Template) InputVariables

func (p *Template) InputVariables() []string

func (*Template) OutputParser

func (p *Template) OutputParser() (schema.OutputParser[any], bool)

func (*Template) Partial

func (p *Template) Partial(values PartialValues) *Template

type TemplateOptions

type TemplateOptions struct {
	PartialValues           PartialValues
	Language                string
	OutputParser            schema.OutputParser[any]
	TransformPythonTemplate bool
}