enhance: ask user for OpenAI key and store it in the cred store

Signed-off-by: Grant Linville <[email protected]>

Author: g-linville

go.mod

@@ -15,7 +15,7 @@ require (
 	github.com/getkin/kin-openapi v0.123.0
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
 	github.com/google/uuid v1.6.0
-	github.com/gptscript-ai/chat-completion-client v0.0.0-20240515050533-bdef9f2226a9
+	github.com/gptscript-ai/chat-completion-client v0.0.0-20240531200700-af8e7ecf0379
 	github.com/hexops/autogold/v2 v2.2.1
 	github.com/hexops/valast v1.4.4
 	github.com/jaytaylor/html2text v0.0.0-20230321000545-74c2419ad056

go.sum

@@ -125,8 +125,8 @@ github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+
 github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk=
 github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
 github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
-github.com/gptscript-ai/chat-completion-client v0.0.0-20240515050533-bdef9f2226a9 h1:s6nL/aokB1sJTqVXEjN0zFI5CJa66ubw9g68VTMzEw0=
-github.com/gptscript-ai/chat-completion-client v0.0.0-20240515050533-bdef9f2226a9/go.mod h1:7P/o6/IWa1KqsntVf68hSnLKuu3+xuqm6lYhch1w4jo=
+github.com/gptscript-ai/chat-completion-client v0.0.0-20240531200700-af8e7ecf0379 h1:vYnXoIyCXzaCEw0sYifQ4bDpsv3/fO/dZ2suEsTwCIo=
+github.com/gptscript-ai/chat-completion-client v0.0.0-20240531200700-af8e7ecf0379/go.mod h1:7P/o6/IWa1KqsntVf68hSnLKuu3+xuqm6lYhch1w4jo=
 github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA=
 github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
 github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo=

pkg/builtin/builtin.go

@@ -17,10 +17,10 @@ import (
 	"strings"
 	"time"
 
-	"github.com/AlecAivazis/survey/v2"
 	"github.com/BurntSushi/locker"
 	"github.com/google/shlex"
 	"github.com/gptscript-ai/gptscript/pkg/engine"
+	"github.com/gptscript-ai/gptscript/pkg/prompt"
 	"github.com/gptscript-ai/gptscript/pkg/types"
 	"github.com/jaytaylor/html2text"
 )
@@ -215,7 +215,7 @@ var tools = map[string]types.Tool{
 					"sensitive", "(true or false) Whether the input should be hidden",
 				),
 			},
-			BuiltinFunc: SysPrompt,
+			BuiltinFunc: prompt.SysPrompt,
 		},
 	},
 	"sys.chat.history": {
@@ -774,42 +774,6 @@ func SysDownload(ctx context.Context, env []string, input string) (_ string, err
 	return params.Location, nil
 }
 
-func SysPrompt(_ context.Context, _ []string, input string) (_ string, err error) {
-	var params struct {
-		Message   string `json:"message,omitempty"`
-		Fields    string `json:"fields,omitempty"`
-		Sensitive string `json:"sensitive,omitempty"`
-	}
-	if err := json.Unmarshal([]byte(input), &params); err != nil {
-		return "", err
-	}
-
-	if params.Message != "" {
-		_, _ = fmt.Fprintln(os.Stderr, params.Message)
-	}
-
-	results := map[string]string{}
-	for _, f := range strings.Split(params.Fields, ",") {
-		var value string
-		if params.Sensitive == "true" {
-			err = survey.AskOne(&survey.Password{Message: f}, &value, survey.WithStdio(os.Stdin, os.Stderr, os.Stderr))
-		} else {
-			err = survey.AskOne(&survey.Input{Message: f}, &value, survey.WithStdio(os.Stdin, os.Stderr, os.Stderr))
-		}
-		if err != nil {
-			return "", err
-		}
-		results[f] = value
-	}
-
-	resultsStr, err := json.Marshal(results)
-	if err != nil {
-		return "", err
-	}
-
-	return string(resultsStr), nil
-}
-
 func SysTimeNow(ctx context.Context, env []string, input string) (string, error) {
 	return time.Now().Format(time.RFC3339), nil
 }

pkg/gptscript/gptscript.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/gptscript-ai/gptscript/pkg/builtin"
 	"github.com/gptscript-ai/gptscript/pkg/cache"
+	"github.com/gptscript-ai/gptscript/pkg/config"
 	"github.com/gptscript-ai/gptscript/pkg/engine"
 	"github.com/gptscript-ai/gptscript/pkg/hash"
 	"github.com/gptscript-ai/gptscript/pkg/llm"
@@ -65,15 +66,20 @@ func New(opts *Options) (*GPTScript, error) {
 		return nil, err
 	}
 
-	oAIClient, err := openai.NewClient(opts.OpenAI, openai.Options{
+	cliCfg, err := config.ReadCLIConfig(opts.OpenAI.ConfigFile)
+	if err != nil {
+		return nil, err
+	}
+
+	oaiClient, err := openai.NewClient(cliCfg, opts.CredentialContext, opts.OpenAI, openai.Options{
 		Cache:   cacheClient,
 		SetSeed: true,
 	})
 	if err != nil {
 		return nil, err
 	}
 
-	if err := registry.AddClient(oAIClient); err != nil {
+	if err := registry.AddClient(oaiClient); err != nil {
 		return nil, err
 	}
 
@@ -90,7 +96,7 @@ func New(opts *Options) (*GPTScript, error) {
 		return nil, err
 	}
 
-	remoteClient := remote.New(runner, opts.Env, cacheClient)
+	remoteClient := remote.New(runner, opts.Env, cacheClient, cliCfg, opts.CredentialContext)
 
 	if err := registry.AddClient(remoteClient); err != nil {
 		return nil, err

pkg/llm/registry.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"sort"
 
+	"github.com/gptscript-ai/gptscript/pkg/openai"
 	"github.com/gptscript-ai/gptscript/pkg/types"
 )
 
@@ -32,7 +33,21 @@ func (r *Registry) ListModels(ctx context.Context, providers ...string) (result
 	for _, v := range r.clients {
 		models, err := v.ListModels(ctx, providers...)
 		if err != nil {
-			return nil, err
+			// If we got back an InvalidAuthError, then we know it came from the OpenAI client, and we can
+			// try to get the credential from the cred store.
+			if errors.Is(err, openai.InvalidAuthError{}) {
+				if err := v.(*openai.Client).RetrieveAPIKey(); err != nil {
+					return nil, err
+				}
+
+				// Now that the API key has been retrieved, try to list models again.
+				models, err = v.ListModels(ctx, providers...)
+				if err != nil {
+					return nil, err
+				}
+			} else {
+				return nil, err
+			}
 		}
 		result = append(result, models...)
 	}

pkg/openai/client.go

@@ -12,14 +12,19 @@ import (
 
 	openai "github.com/gptscript-ai/chat-completion-client"
 	"github.com/gptscript-ai/gptscript/pkg/cache"
+	"github.com/gptscript-ai/gptscript/pkg/config"
 	"github.com/gptscript-ai/gptscript/pkg/counter"
+	"github.com/gptscript-ai/gptscript/pkg/credentials"
 	"github.com/gptscript-ai/gptscript/pkg/hash"
+	"github.com/gptscript-ai/gptscript/pkg/prompt"
 	"github.com/gptscript-ai/gptscript/pkg/system"
 	"github.com/gptscript-ai/gptscript/pkg/types"
+	"github.com/tidwall/gjson"
 )
 
 const (
-	DefaultModel = openai.GPT4o
+	DefaultModel    = openai.GPT4o
+	BuiltinCredName = "sys.openai"
 )
 
 var (
@@ -28,13 +33,21 @@ var (
 	azureModel = os.Getenv("OPENAI_AZURE_DEPLOYMENT")
 )
 
+type InvalidAuthError struct{}
+
+func (InvalidAuthError) Error() string {
+	return "OPENAI_API_KEY is not set. Please set the OPENAI_API_KEY environment variable"
+}
+
 type Client struct {
 	defaultModel string
 	c            *openai.Client
 	cache        *cache.Client
 	invalidAuth  bool
 	cacheKeyBase string
 	setSeed      bool
+	cliCfg       *config.CLIConfig
+	credCtx      string
 }
 
 type Options struct {
@@ -93,12 +106,28 @@ func GetAzureMapperFunction(defaultModel, azureModel string) func(string) string
 	}
 }
 
-func NewClient(opts ...Options) (*Client, error) {
+func NewClient(cliCfg *config.CLIConfig, credCtx string, opts ...Options) (*Client, error) {
 	opt, err := complete(opts...)
 	if err != nil {
 		return nil, err
 	}
 
+	// If the API key is not set, try to get it from the cred store
+	if opt.APIKey == "" && opt.BaseURL == "" {
+		store, err := credentials.NewStore(cliCfg, credCtx)
+		if err != nil {
+			return nil, err
+		}
+
+		cred, exists, err := store.Get(BuiltinCredName)
+		if err != nil {
+			return nil, err
+		}
+		if exists {
+			opt.APIKey = cred.Env["OPENAI_API_KEY"]
+		}
+	}
+
 	cfg := openai.DefaultConfig(opt.APIKey)
 	if strings.Contains(string(opt.APIType), "AZURE") {
 		cfg = openai.DefaultAzureConfig(key, url)
@@ -122,12 +151,14 @@ func NewClient(opts ...Options) (*Client, error) {
 		cacheKeyBase: cacheKeyBase,
 		invalidAuth:  opt.APIKey == "" && opt.BaseURL == "",
 		setSeed:      opt.SetSeed,
+		cliCfg:       cliCfg,
+		credCtx:      credCtx,
 	}, nil
 }
 
 func (c *Client) ValidAuth() error {
 	if c.invalidAuth {
-		return fmt.Errorf("OPENAI_API_KEY is not set. Please set the OPENAI_API_KEY environment variable")
+		return InvalidAuthError{}
 	}
 	return nil
 }
@@ -276,7 +307,9 @@ func toMessages(request types.CompletionRequest, compat bool) (result []openai.C
 
 func (c *Client) Call(ctx context.Context, messageRequest types.CompletionRequest, status chan<- types.CompletionStatus) (*types.CompletionMessage, error) {
 	if err := c.ValidAuth(); err != nil {
-		return nil, err
+		if err := c.RetrieveAPIKey(); err != nil {
+			return nil, err
+		}
 	}
 
 	if messageRequest.Model == "" {
@@ -525,6 +558,44 @@ func (c *Client) call(ctx context.Context, request openai.ChatCompletionRequest,
 	}
 }
 
+func (c *Client) RetrieveAPIKey() error {
+	store, err := credentials.NewStore(c.cliCfg, c.credCtx)
+	if err != nil {
+		return err
+	}
+
+	cred, exists, err := store.Get(BuiltinCredName)
+	if err != nil {
+		return err
+	}
+
+	var k string
+	if exists {
+		k = cred.Env[key]
+	} else {
+		// SysPrompt doesn't use its first two arguments, so we can safely pass nil to them
+		result, err := prompt.SysPrompt(nil, nil, `{"message":"Please provide your OpenAI API key:","fields":"key","sensitive":"true"}`)
+		if err != nil {
+			return err
+		}
+
+		k = gjson.Get(result, "key").String()
+		if err := store.Add(credentials.Credential{
+			ToolName: BuiltinCredName,
+			Env: map[string]string{
+				"OPENAI_API_KEY": k,
+			},
+		}); err != nil {
+			return err
+		}
+		log.Infof("Saved API key as credential %s", BuiltinCredName)
+	}
+
+	c.c.SetAPIKey(k)
+	c.invalidAuth = false
+	return nil
+}
+
 func ptr[T any](v T) *T {
 	return &v
 }

pkg/openai/log.go

@@ -0,0 +1,5 @@
+package openai
+
+import "github.com/gptscript-ai/gptscript/pkg/mvl"
+
+var log = mvl.Package()

pkg/prompt/prompt.go

@@ -0,0 +1,47 @@
+package prompt
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/AlecAivazis/survey/v2"
+)
+
+func SysPrompt(_ context.Context, _ []string, input string) (_ string, err error) {
+	var params struct {
+		Message   string `json:"message,omitempty"`
+		Fields    string `json:"fields,omitempty"`
+		Sensitive string `json:"sensitive,omitempty"`
+	}
+	if err := json.Unmarshal([]byte(input), &params); err != nil {
+		return "", err
+	}
+
+	if params.Message != "" {
+		_, _ = fmt.Fprintln(os.Stderr, params.Message)
+	}
+
+	results := map[string]string{}
+	for _, f := range strings.Split(params.Fields, ",") {
+		var value string
+		if params.Sensitive == "true" {
+			err = survey.AskOne(&survey.Password{Message: f}, &value, survey.WithStdio(os.Stdin, os.Stderr, os.Stderr))
+		} else {
+			err = survey.AskOne(&survey.Input{Message: f}, &value, survey.WithStdio(os.Stdin, os.Stderr, os.Stderr))
+		}
+		if err != nil {
+			return "", err
+		}
+		results[f] = value
+	}
+
+	resultsStr, err := json.Marshal(results)
+	if err != nil {
+		return "", err
+	}
+
+	return string(resultsStr), nil
+}