Improve AI suggestions by specifying shell name and OS in OpenAI query

backend/server/internal/server/api_handlers.go

@@ -319,7 +319,7 @@ func (s *Server) aiSuggestionHandler(w http.ResponseWriter, r *http.Request) {
 	if numDevices == 0 {
 		panic(fmt.Errorf("rejecting OpenAI request for user_id=%#v since it does not exist", req.UserId))
 	}
-	suggestions, usage, err := ai.GetAiSuggestionsViaOpenAiApi(req.Query, req.NumberCompletions)
+	suggestions, usage, err := ai.GetAiSuggestionsViaOpenAiApi(req.Query, req.ShellName, req.OsName, req.NumberCompletions)
 	if err != nil {
 		panic(fmt.Errorf("failed to query OpenAI API: %w", err))
 	}

client/ai/ai.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"runtime"
 	"time"
 
 	"github.com/ddworken/hishtory/client/data"
@@ -28,11 +29,26 @@ func GetAiSuggestions(ctx context.Context, query string, numberCompletions int)
 	if os.Getenv("OPENAI_API_KEY") == "" {
 		return GetAiSuggestionsViaHishtoryApi(ctx, query, numberCompletions)
 	} else {
-		suggestions, _, err := ai.GetAiSuggestionsViaOpenAiApi(query, numberCompletions)
+		suggestions, _, err := ai.GetAiSuggestionsViaOpenAiApi(query, getShellName(), getOsName(), numberCompletions)
 		return suggestions, err
 	}
 }
 
+func getOsName() string {
+	switch runtime.GOOS {
+	case "linux":
+		return "Linux"
+	case "darwin":
+		return "MacOS"
+	default:
+		return runtime.GOOS
+	}
+}
+
+func getShellName() string {
+	return "bash"
+}
+
 func GetAiSuggestionsViaHishtoryApi(ctx context.Context, query string, numberCompletions int) ([]string, error) {
 	hctx.GetLogger().Infof("Running OpenAI query for %#v", query)
 	req := ai.AiSuggestionRequest{
@@ -40,6 +56,8 @@ func GetAiSuggestionsViaHishtoryApi(ctx context.Context, query string, numberCom
 		UserId:            data.UserId(hctx.GetConf(ctx).UserSecret),
 		Query:             query,
 		NumberCompletions: numberCompletions,
+		OsName:            getOsName(),
+		ShellName:         getShellName(),
 	}
 	reqData, err := json.Marshal(req)
 	if err != nil {

scripts/aimain.go

@@ -9,7 +9,7 @@ import (
 )
 
 func main() {
-	resp, _, err := ai.GetAiSuggestionsViaOpenAiApi("Find all CSV files in the current directory or subdirectories and select the first column, then prepend `foo` to each line", 3)
+	resp, _, err := ai.GetAiSuggestionsViaOpenAiApi("Find all CSV files in the current directory or subdirectories and select the first column, then prepend `foo` to each line", "bash", "MacOS", 3)
 	if err != nil {
 		log.Fatal(err)
 	}

shared/ai/ai.go

@@ -51,11 +51,17 @@ type TestOnlyOverrideAiSuggestionRequest struct {
 
 var TestOnlyOverrideAiSuggestions map[string][]string = make(map[string][]string)
 
-func GetAiSuggestionsViaOpenAiApi(query string, numberCompletions int) ([]string, OpenAiUsage, error) {
+func GetAiSuggestionsViaOpenAiApi(query, shellName, osName string, numberCompletions int) ([]string, OpenAiUsage, error) {
 	if results := TestOnlyOverrideAiSuggestions[query]; len(results) > 0 {
 		return results, OpenAiUsage{}, nil
 	}
 	hctx.GetLogger().Infof("Running OpenAI query for %#v", query)
+	if osName == "" {
+		osName = "Linux"
+	}
+	if shellName == "" {
+		shellName = "bash"
+	}
 	apiKey := os.Getenv("OPENAI_API_KEY")
 	if apiKey == "" {
 		return nil, OpenAiUsage{}, fmt.Errorf("OPENAI_API_KEY environment variable is not set")
@@ -65,7 +71,10 @@ func GetAiSuggestionsViaOpenAiApi(query string, numberCompletions int) ([]string
 		Model:             "gpt-3.5-turbo",
 		NumberCompletions: numberCompletions,
 		Messages: []openAiMessage{
-			{Role: "system", Content: "You are an expert programmer that loves to help people with writing shell commands. You always reply with just a shell command and no additional context, information, or formatting. Your replies will be directly executed in bash, so ensure that they are correct and do not contain anything other than a bash command."},
+			{Role: "system", Content: "You are an expert programmer that loves to help people with writing shell commands. " +
+				"You always reply with just a shell command and no additional context, information, or formatting. " +
+				"Your replies will be directly executed in " + shellName + " on " + osName +
+				", so ensure that they are correct and do not contain anything other than a shell command."},
 			{Role: "user", Content: query},
 		},
 	}
@@ -111,6 +120,8 @@ type AiSuggestionRequest struct {
 	UserId            string `json:"user_id"`
 	Query             string `json:"query"`
 	NumberCompletions int    `json:"number_completions"`
+	ShellName         string `json:"shell_name"`
+	OsName            string `json:"os_name"`
 }
 
 type AiSuggestionResponse struct {

shared/ai/ai_test.go

@@ -13,7 +13,7 @@ func TestLiveOpenAiApi(t *testing.T) {
 	if os.Getenv("OPENAI_API_KEY") == "" {
 		t.Skip("Skipping test since OPENAI_API_KEY is not set")
 	}
-	results, _, err := GetAiSuggestionsViaOpenAiApi("list files in the current directory", 3)
+	results, _, err := GetAiSuggestionsViaOpenAiApi("list files in the current directory", "MacOS", "Linux", 3)
 	require.NoError(t, err)
 	resultsContainsLs := false
 	for _, result := range results {