feat: allow setting global gptscript variables

Signed-off-by: Donnie Adams <[email protected]>

Author: thedadams

README.md

@@ -18,12 +18,21 @@ Additionally, you need the `gptscript` binary. You can install it on your system
 
 ## GPTScript
 
-The GPTScript instance allows the caller to run gptscript files, tools, and other operations (see below). There are currently no options for this instance, so calling `NewGPTScript()` is all you need. Although, the intention is that a single GPTScript instance is all you need for the life of your application, you should call `Close()` on the instance when you are done.
+The GPTScript instance allows the caller to run gptscript files, tools, and other operations (see below). Note that the intention is that a single GPTScript instance is all you need for the life of your application, you should call `Close()` on the instance when you are done.
 
-## Options
+## Global Options
+
+When creating a `GTPScript` instance, you can pass the following global options. These options are also available as run `Options`. Anything specified as a run option will take precedence over the global option.
+
+- `APIKey`: Specify an OpenAI API key for authenticating requests
+- `BaseURL`: A base URL for an OpenAI compatible API (the default is `https://api.openai.com/v1`)
+- `DefaultModel`: The default model to use for OpenAI requests
+
+## Run Options
 
 These are optional options that can be passed to the various `exec` functions.
 None of the options is required, and the defaults will reduce the number of calls made to the Model API.
+As noted above, the Global Options are also available to specify here. These options would take precedence.
 
 - `cache`: Enable or disable caching. Default (true).
 - `cacheDir`: Specify the cache directory.

gptscript.go

@@ -44,13 +44,16 @@ type gptscript struct {
 	url string
 }
 
-func NewGPTScript() (GPTScript, error) {
+func NewGPTScript(opts GlobalOptions) (GPTScript, error) {
 	lock.Lock()
 	defer lock.Unlock()
 	gptscriptCount++
 
-	if serverProcessCancel == nil && os.Getenv("GPTSCRIPT_DISABLE_SERVER") != "true" {
+	if serverURL == "" {
 		serverURL = os.Getenv("GPTSCRIPT_URL")
+	}
+
+	if serverProcessCancel == nil && os.Getenv("GPTSCRIPT_DISABLE_SERVER") != "true" {
 		if serverURL == "" {
 			l, err := net.Listen("tcp", "127.0.0.1:0")
 			if err != nil {
@@ -68,7 +71,7 @@ func NewGPTScript() (GPTScript, error) {
 		ctx, cancel := context.WithCancel(context.Background())
 
 		in, _ := io.Pipe()
-		serverProcess = exec.CommandContext(ctx, getCommand(), "--listen-address", serverURL, "sdkserver")
+		serverProcess = exec.CommandContext(ctx, getCommand(), append(opts.toArgs(), "--listen-address", serverURL, "sdkserver")...)
 		serverProcess.Stdin = in
 
 		serverProcessCancel = func() {

gptscript_test.go

@@ -20,7 +20,7 @@ func TestMain(m *testing.M) {
 	}
 
 	var err error
-	g, err = NewGPTScript()
+	g, err = NewGPTScript(GlobalOptions{})
 	if err != nil {
 		panic(fmt.Sprintf("error creating gptscript: %s", err))
 	}
@@ -31,7 +31,7 @@ func TestMain(m *testing.M) {
 }
 
 func TestCreateAnotherGPTScript(t *testing.T) {
-	g, err := NewGPTScript()
+	g, err := NewGPTScript(GlobalOptions{})
 	if err != nil {
 		t.Errorf("error creating gptscript: %s", err)
 	}
@@ -107,7 +107,9 @@ func TestAbortRun(t *testing.T) {
 func TestSimpleEvaluate(t *testing.T) {
 	tool := ToolDef{Instructions: "What is the capital of the united states?"}
 
-	run, err := g.Evaluate(context.Background(), Options{}, tool)
+	run, err := g.Evaluate(context.Background(), Options{
+		GlobalOptions: GlobalOptions{},
+	}, tool)
 	if err != nil {
 		t.Errorf("Error executing tool: %v", err)
 	}

opts.go

@@ -1,7 +1,32 @@
 package gptscript
 
+// GlobalOptions allows specification of settings that are used for every call made.
+// These options can be overridden by the corresponding Options.
+type GlobalOptions struct {
+	OpenAIAPIKey  string `json:"APIKey"`
+	OpenAIBaseURL string `json:"BaseURL"`
+	DefaultModel  string `json:"DefaultModel"`
+}
+
+func (g GlobalOptions) toArgs() []string {
+	var args []string
+	if g.OpenAIAPIKey != "" {
+		args = append(args, "--openai-api-key", g.OpenAIAPIKey)
+	}
+	if g.OpenAIBaseURL != "" {
+		args = append(args, "--openai-base-url", g.OpenAIBaseURL)
+	}
+	if g.DefaultModel != "" {
+		args = append(args, "--default-model", g.DefaultModel)
+	}
+
+	return args
+}
+
 // Options represents options for the gptscript tool or file.
 type Options struct {
+	GlobalOptions `json:",inline"`
+
 	Confirm       bool     `json:"confirm"`
 	Input         string   `json:"input"`
 	DisableCache  bool     `json:"disableCache"`