chat

Documentation

Overview

Package chat provides a chat prompt template. Sometimes you need to define a chat prompt, this package provides a way to do that.

Index

• Variables
• type Chat
  • func New(promptMessages ...PromptMessage) *Chat
  • func (c *Chat) PromptMessages() PromptMessages
  • func (p *Chat) ToMessages() (Messages, error)
• type Message
• type MessageType
• type Messages
• type Prompt
• type PromptMessage
• type PromptMessages

Variables

var (
	ErrChatMessages = errors.New("unable to convert chat messages")
)

Types

type Chat

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

func New

func New(promptMessages ...PromptMessage) *Chat

func (*Chat) PromptMessages

func (c *Chat) PromptMessages() PromptMessages

func (*Chat) ToMessages

func (p *Chat) ToMessages() (Messages, error)

ToMessages converts the chat prompt template to a list of messages.

type Message

type Message struct {
	Type    MessageType
	Content string
}

type MessageType

type MessageType string

const (
	MessageTypeSystem    MessageType = "system"
	MessageTypeUser      MessageType = "user"
	MessageTypeAssistant MessageType = "assistant"
)

type Messages

type Messages []Message

type Prompt

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

type PromptMessage

type PromptMessage struct {
	Type   MessageType
	Prompt Prompt
}

type PromptMessages

type PromptMessages []PromptMessage