arch: init llm plugin

1. init project
2. enable plugin arch

Author: xpzouying

README.md

@@ -1,2 +1,10 @@
-# llmplugin
-plugin for LLM
+# LLM Plugin
+
+LLM Plugin system.
+
+
+## TESTING
+
+```bash
+go test -v ./...
+```

go.mod

@@ -0,0 +1,17 @@
+module github.com/agi-cn/llmplugin
+
+go 1.20
+
+require (
+	github.com/pkg/errors v0.9.1
+	github.com/sashabaranov/go-openai v1.9.0
+	github.com/sirupsen/logrus v1.9.0
+	github.com/stretchr/testify v1.8.2
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,26 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sashabaranov/go-openai v1.9.0 h1:NoiO++IISxxJ1pRc0n7uZvMGMake0G+FJ1XPwXtprsA=
+github.com/sashabaranov/go-openai v1.9.0/go.mod h1:lj5b/K+zjTSFxVLijLSTDZuP7adOgerWeFyZLUhAKRg=
+github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
+github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

init.go

@@ -0,0 +1,8 @@
+package llmplugin
+
+import "github.com/sirupsen/logrus"
+
+func init() {
+
+	logrus.SetLevel(logrus.DebugLevel)
+}

llm/llm.go

@@ -0,0 +1,33 @@
+package llm
+
+import (
+	"context"
+
+	"github.com/sashabaranov/go-openai"
+)
+
+type Role string
+
+const (
+	RoleUser      Role = openai.ChatMessageRoleUser
+	RoleAssistant Role = openai.ChatMessageRoleAssistant
+	RoleSystem    Role = openai.ChatMessageRoleSystem
+)
+
+func (r Role) String() string {
+	return string(r)
+}
+
+type LlmMessage struct {
+	Role    Role
+	Content string
+}
+
+type LlmAnswer struct {
+	Role    string
+	Content string
+}
+
+type LLMer interface {
+	Chat(ctx context.Context, messages []LlmMessage) (*LlmAnswer, error)
+}

llm/openai/chatgpt.go

@@ -0,0 +1,88 @@
+package openai
+
+import (
+	"context"
+
+	"github.com/agi-cn/llmplugin/llm"
+
+	"github.com/pkg/errors"
+	"github.com/sashabaranov/go-openai"
+)
+
+type ChatGPT struct {
+	model  string
+	client *openai.Client
+}
+
+type Option func(c *ChatGPT)
+
+func WithModel(model string) Option {
+	return func(c *ChatGPT) {
+		c.model = model
+	}
+}
+
+func NewChatGPT(token string, opts ...Option) *ChatGPT {
+
+	client := openai.NewClient(token)
+
+	chatgpt := &ChatGPT{
+		model:  openai.GPT3Dot5Turbo,
+		client: client,
+	}
+
+	for _, opt := range opts {
+		opt(chatgpt)
+	}
+
+	return chatgpt
+}
+
+func (c ChatGPT) Chat(ctx context.Context, messages []llm.LlmMessage) (*llm.LlmAnswer, error) {
+
+	chatGPTMessages := c.makeChatGPTMessage(messages)
+
+	return c.send(ctx, chatGPTMessages)
+
+}
+
+func (c ChatGPT) makeChatGPTMessage(messages []llm.LlmMessage) []openai.ChatCompletionMessage {
+
+	chatGPTMessages := make([]openai.ChatCompletionMessage, 0, len(messages))
+	for _, m := range messages {
+		chatGPTMessages = append(chatGPTMessages, openai.ChatCompletionMessage{
+			Role:    m.Role.String(),
+			Content: m.Content,
+		})
+	}
+
+	return chatGPTMessages
+}
+
+func (c ChatGPT) send(ctx context.Context, messages []openai.ChatCompletionMessage) (*llm.LlmAnswer, error) {
+
+	resp, err := c.client.CreateChatCompletion(ctx, openai.ChatCompletionRequest{
+		Model:    c.model,
+		Messages: messages,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	if choices := resp.Choices; len(choices) == 0 {
+		return nil, errors.New("got empty ChatGPT response")
+	}
+
+	answer := c.convertLlmAnswer(resp)
+	return answer, nil
+}
+
+func (c ChatGPT) convertLlmAnswer(openaiResp openai.ChatCompletionResponse) *llm.LlmAnswer {
+
+	choices := openaiResp.Choices[0]
+
+	return &llm.LlmAnswer{
+		Role:    choices.Message.Role,
+		Content: choices.Message.Content,
+	}
+}

plugin.go

@@ -0,0 +1,31 @@
+package llmplugin
+
+import "context"
+
+type Plugin interface {
+	Do(ctx context.Context, query string) (answer string, err error)
+
+	GetName() string
+
+	GetDesc() string
+}
+
+var _ Plugin = (*SimplePlugin)(nil)
+
+type SimplePlugin struct {
+	Name   string
+	Desc   string
+	DoFunc func(ctx context.Context, query string) (answer string, err error)
+}
+
+func (p SimplePlugin) GetName() string {
+	return p.Name
+}
+
+func (p SimplePlugin) GetDesc() string {
+	return p.Desc
+}
+
+func (p SimplePlugin) Do(ctx context.Context, query string) (answer string, err error) {
+	return p.DoFunc(ctx, query)
+}

plugin_manager.go

@@ -0,0 +1,143 @@
+package llmplugin
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/agi-cn/llmplugin/llm"
+
+	"github.com/sirupsen/logrus"
+)
+
+type PluginManager struct {
+	llmer llm.LLMer
+
+	// plugins <key:name, value:Plugin>
+	plugins map[string]Plugin
+}
+
+type PluginManagerOpt func(manager *PluginManager)
+
+// WithPlugin enable one plugin.
+func WithPlugin(p Plugin) PluginManagerOpt {
+
+	return func(manager *PluginManager) {
+		name := strings.ToLower(p.GetName())
+		if _, ok := manager.plugins[name]; !ok {
+			manager.plugins[name] = p
+		}
+	}
+}
+
+// WithPlugins enable multiple plugins.
+func WithPlugins(plugins []Plugin) PluginManagerOpt {
+
+	return func(manager *PluginManager) {
+
+		for _, p := range plugins {
+			opt := WithPlugin(p)
+			opt(manager)
+		}
+	}
+}
+
+// NewPluginManager create plugin manager.
+func NewPluginManager(llmer llm.LLMer, opts ...PluginManagerOpt) *PluginManager {
+
+	manager := &PluginManager{
+		llmer:   llmer,
+		plugins: make(map[string]Plugin, 4),
+	}
+
+	for _, opt := range opts {
+		opt(manager)
+	}
+
+	return manager
+}
+
+// Select to choice some plugin to finish the task.
+func (m *PluginManager) Select(ctx context.Context, query string) ([]Plugin, error) {
+
+	prompt := m.makePrompt(query)
+
+	answer, err := m.chatWithLlm(ctx, prompt)
+	if err != nil {
+		logrus.Errorf("chat with llm error: %v", err)
+		return nil, err
+	}
+
+	plugins := m.choicePlugins(answer)
+	return plugins, nil
+}
+
+func (m *PluginManager) makePrompt(query string) string {
+
+	prompt := fmt.Sprintf(`You are an helpful and kind assistant to answer questions that can use tools to interact with real world and get access to the latest information.
+	You will performs one task based on the following object:
+	%s
+
+	You can call one of the following functions:
+
+	- Calculator, INPUT: (expr string): ACT ON A calculator, capable of performing mathematical calculations, where the input is a description of a mathematical expression and the return is the result of the calculation. For example: the input is: one plus two, the return is three.
+	- Weather, INPUT: no input: ACT ON You can check the weather forecast.
+
+	In each response, you must start with a function call like Tool name and args, split by space,like:
+	Google "query"
+	Weather
+
+	Don't explain why you use a tool. If you cannot figure out the answer, you say ’I don’t know’.
+
+	You can choose one tool or multiple tools to accomplish the corresponding goal.
+	Select only the corresponding tool and do not return any results.`,
+		query,
+	)
+
+	return prompt
+}
+
+func (m *PluginManager) chatWithLlm(ctx context.Context, query string) (string, error) {
+	messages := []llm.LlmMessage{
+		{
+			Role:    llm.RoleUser,
+			Content: query,
+		},
+	}
+
+	answer, err := m.llmer.Chat(ctx, messages)
+	if err != nil {
+		return "", err
+	}
+
+	logrus.Debugf("query: %s\n  answer: %+v", query, answer)
+
+	return answer.Content, nil
+}
+
+func (m *PluginManager) choicePlugins(answer string) []Plugin {
+
+	lines := strings.Split(answer, "\n")
+
+	plugins := make([]Plugin, 0, len(lines))
+
+	for _, line := range lines {
+
+		// Split by space
+		// IF only ONE column, it's function name without args.
+		// IF TWO column, it's function name with args.
+
+		ss := strings.Split(line, " ")
+		if len(ss) == 0 {
+			continue
+		}
+
+		n := strings.ToLower(ss[0])
+
+		if p, ok := m.plugins[n]; ok {
+			plugins = append(plugins, p)
+		}
+	}
+
+	return plugins
+}