ai

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 21, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	PromptSummarizeThread         = "summarize_thread"
	PromptDirectMessageQuestion   = "direct_message_question"
	PromptEmojiSelect             = "emoji_select"
	PromptMeetingSummary          = "meeting_summary"
	PromptMeetingSummaryOnly      = "summary_only"
	PromptMeetingKeyPoints        = "meeting_key_points"
	PromptSpellcheck              = "spellcheck"
	PromptChangeTone              = "change_tone"
	PromptSimplifyText            = "simplify_text"
	PromptAIChangeText            = "ai_change_text"
	PromptSummarizeChannelSince   = "summarize_channel_since"
	PromptSummarizeChunk          = "summarize_chunk"
	PromptExplainCode             = "explain_code"
	PromptSuggestCodeImprovements = "suggest_code_improvements"
	PromptFindActionItemsSince    = "find_action_items_since"
	PromptFindOpenQuestionsSince  = "find_open_questions_since"
)

Convenience vars for the filenames in ai/prompts/

View Source 
const PromptExtension = "tmpl"
View Source 
const SystemSubTemplateName = ".system"
View Source 
const UserSubTemplateName = ".user"

Variables

This section is empty.

Functions

func FormatPostBody added in v0.7.0 

func FormatPostBody(post *model.Post) string

Types

type BotConfig added in v0.8.0 

type BotConfig struct {
	ID                 string        `json:"id"`
	Name               string        `json:"name"`
	DisplayName        string        `json:"displayName"`
	CustomInstructions string        `json:"customInstructions"`
	Service            ServiceConfig `json:"service"`
	EnableVision       bool          `json:"enableVision"`
	DisableTools       bool          `json:"disableTools"`
}

func (*BotConfig) IsValid added in v0.8.0 

func (c *BotConfig) IsValid() bool

type BotConversation 

type BotConversation struct {
	Posts   []Post
	Tools   ToolStore
	Context ConversationContext
}

func (*BotConversation) AddPost added in v0.9.0 

func (b *BotConversation) AddPost(post Post)

func (*BotConversation) AppendConversation 

func (b *BotConversation) AppendConversation(conversation BotConversation)

func (*BotConversation) ExtractSystemMessage added in v0.2.0 

func (b *BotConversation) ExtractSystemMessage() string

func (BotConversation) String added in v0.3.0 

func (b BotConversation) String() string

func (*BotConversation) Truncate added in v0.5.0 

func (b *BotConversation) Truncate(maxTokens int, countTokens func(string) int) bool

type ConversationContext added in v0.3.0 

type ConversationContext struct {
	BotID              string
	Time               string
	ServerName         string
	CompanyName        string
	RequestingUser     *model.User
	Channel            *model.Channel
	Team               *model.Team
	Post               *model.Post
	PromptParameters   map[string]string
	CustomInstructions string
}

func NewConversationContext added in v0.3.0 

func NewConversationContext(botID string, requestingUser *model.User, channel *model.Channel, post *model.Post) ConversationContext

func NewConversationContextParametersOnly added in v0.3.0 

func NewConversationContextParametersOnly(promptParameters map[string]string) ConversationContext

func (*ConversationContext) IsDMWithBot added in v0.6.0 

func (c *ConversationContext) IsDMWithBot() bool

func (ConversationContext) String added in v0.4.0 

func (c ConversationContext) String() string

type File added in v0.9.0 

type File struct {
	MimeType string
	Size     int64
	Reader   io.Reader
}

type ImageGenerator 

type ImageGenerator interface {
	GenerateImage(prompt string) (image.Image, error)
}

type LLMConfig 

type LLMConfig struct {
	Model              string
	MaxGeneratedTokens int
	EnableVision       bool
}

type LanguageModel 

type LanguageModel interface {
	ChatCompletion(conversation BotConversation, opts ...LanguageModelOption) (*TextStreamResult, error)
	ChatCompletionNoStream(conversation BotConversation, opts ...LanguageModelOption) (string, error)

	CountTokens(text string) int
	TokenLimit() int
}

type LanguageModelOption 

type LanguageModelOption func(*LLMConfig)

func WithMaxGeneratedTokens added in v0.6.1 

func WithMaxGeneratedTokens(maxGeneratedTokens int) LanguageModelOption

func WithModel 

func WithModel(model string) LanguageModelOption

type Post 

type Post struct {
	Role    PostRole
	Message string
	Files   []File
}

type PostRole 

type PostRole int
const (
	PostRoleUser PostRole = iota
	PostRoleBot
	PostRoleSystem
)

type Prompts 

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

func NewPrompts 

func NewPrompts(input fs.FS) (*Prompts, error)

func (*Prompts) ChatCompletion 

func (p *Prompts) ChatCompletion(templateName string, context ConversationContext, tools ToolStore) (BotConversation, error)

type ServiceConfig added in v0.5.0 

type ServiceConfig struct {
	Name                    string `json:"name"`
	Type                    string `json:"type"`
	APIKey                  string `json:"apiKey"`
	OrgID                   string `json:"orgId"`
	DefaultModel            string `json:"defaultModel"`
	APIURL                  string `json:"apiURL"`
	Username                string `json:"username"`
	Password                string `json:"password"`
	TokenLimit              int    `json:"tokenLimit"`
	StreamingTimeoutSeconds int    `json:"streamingTimeoutSeconds"`
}

type TextStreamResult 

type TextStreamResult struct {
	Stream <-chan string
	Err    <-chan error
}

func NewStreamFromString 

func NewStreamFromString(text string) *TextStreamResult

func (*TextStreamResult) ReadAll 

func (t *TextStreamResult) ReadAll() string

type Tool added in v0.3.0 

type Tool struct {
	Name        string
	Description string
	Schema      any
	Resolver    func(context ConversationContext, argsGetter ToolArgumentGetter) (string, error)
}

type ToolArgumentGetter added in v0.3.0 

type ToolArgumentGetter func(args any) error

type ToolStore added in v0.3.0 

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

func NewNoTools added in v0.9.0 

func NewNoTools() ToolStore

func NewToolStore added in v0.3.0 

func NewToolStore(log TraceLog, doTrace bool) ToolStore

func (*ToolStore) AddTools added in v0.3.0 

func (s *ToolStore) AddTools(tools []Tool)

func (*ToolStore) GetTools added in v0.3.0 

func (s *ToolStore) GetTools() []Tool

func (*ToolStore) ResolveTool added in v0.3.0 

func (s *ToolStore) ResolveTool(name string, argsGetter ToolArgumentGetter, context ConversationContext) (string, error)

func (*ToolStore) TraceResolved added in v0.9.0 

func (s *ToolStore) TraceResolved(name string, argsGetter ToolArgumentGetter, result string)

func (*ToolStore) TraceUnknown added in v0.9.0 

func (s *ToolStore) TraceUnknown(name string, argsGetter ToolArgumentGetter)

type TraceLog added in v0.9.0 

type TraceLog interface {
	Info(message string, keyValuePairs ...any)
}

type Transcriber 

type Transcriber interface {
	Transcribe(file io.Reader) (*subtitles.Subtitles, error)
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.