Add setModel

Author: chand1012

.gitignore

@@ -2,3 +2,4 @@ ottodocs
 bin/**
 dist/**
 *.bleve
+**.DS_Store**

ai/markdown.go

@@ -9,7 +9,7 @@ import (
 	"github.com/chand1012/ottodocs/constants"
 )
 
-func Markdown(filePath, contents, chatPrompt, APIKey string) (string, error) {
+func Markdown(filePath, contents, chatPrompt, APIKey, model string) (string, error) {
 	openai := gopenai.NewOpenAI(&gopenai.OpenAIOpts{
 		APIKey: APIKey,
 	})
@@ -41,6 +41,7 @@ func Markdown(filePath, contents, chatPrompt, APIKey string) (string, error) {
 	req := ai_types.NewDefaultChatRequest("")
 	req.Messages = messages
 	req.MaxTokens = maxTokens
+	req.Model = model
 	// lower the temperature to make the model more deterministic
 	// req.Temperature = 0.3
 

ai/question.go

@@ -9,7 +9,7 @@ import (
 	"github.com/chand1012/ottodocs/constants"
 )
 
-func Question(filePath, fileContent, chatPrompt, APIKey string) (string, error) {
+func Question(filePath, fileContent, chatPrompt, APIKey, model string) (string, error) {
 	openai := gopenai.NewOpenAI(&gopenai.OpenAIOpts{
 		APIKey: APIKey,
 	})
@@ -41,6 +41,7 @@ func Question(filePath, fileContent, chatPrompt, APIKey string) (string, error)
 	req := ai_types.NewDefaultChatRequest("")
 	req.Messages = messages
 	req.MaxTokens = maxTokens
+	req.Model = model
 	// lower the temperature to make the model more deterministic
 	// req.Temperature = 0.3
 

ai/single_file.go

@@ -34,7 +34,7 @@ func extractLineNumber(line string) (int, error) {
 }
 
 // Document a file using the OpenAI ChatGPT API. Takes a file path, a prompt, and an API key as arguments.
-func SingleFile(filePath, contents, chatPrompt, APIKey string) (string, error) {
+func SingleFile(filePath, contents, chatPrompt, APIKey, model string) (string, error) {
 
 	openai := gopenai.NewOpenAI(&gopenai.OpenAIOpts{
 		APIKey: APIKey,
@@ -74,6 +74,7 @@ func SingleFile(filePath, contents, chatPrompt, APIKey string) (string, error) {
 	req := ai_types.NewDefaultChatRequest("")
 	req.Messages = messages
 	req.MaxTokens = maxTokens
+	req.Model = model
 	// lower the temperature to make the model more deterministic
 	req.Temperature = 0.3
 

cmd/ask.go

@@ -135,7 +135,7 @@ Requires a path to a repository or file as a positional argument.`,
 			os.Exit(1)
 		}
 
-		resp, err := ai.Question(fileName, content, chatPrompt, conf.APIKey)
+		resp, err := ai.Question(fileName, content, chatPrompt, conf.APIKey, conf.Model)
 
 		if err != nil {
 			log.Errorf("Error asking question: %s", err)

cmd/doc.go

@@ -47,9 +47,9 @@ var docCmd = &cobra.Command{
 		}
 
 		if inlineMode || !markdownMode {
-			contents, err = ai.SingleFile(filePath, fileContents, chatPrompt, conf.APIKey)
+			contents, err = ai.SingleFile(filePath, fileContents, chatPrompt, conf.APIKey, conf.Model)
 		} else {
-			contents, err = ai.Markdown(filePath, fileContents, chatPrompt, conf.APIKey)
+			contents, err = ai.Markdown(filePath, fileContents, chatPrompt, conf.APIKey, conf.Model)
 		}
 
 		if err != nil {

cmd/docs.go

@@ -87,9 +87,9 @@ search for files in the directory and document them.
 			}
 
 			if inlineMode || !markdownMode {
-				contents, err = ai.SingleFile(path, fileContents, chatPrompt, conf.APIKey)
+				contents, err = ai.SingleFile(path, fileContents, chatPrompt, conf.APIKey, conf.Model)
 			} else {
-				contents, err = ai.Markdown(path, fileContents, chatPrompt, conf.APIKey)
+				contents, err = ai.Markdown(path, fileContents, chatPrompt, conf.APIKey, conf.Model)
 			}
 
 			if err != nil {

cmd/setModel.go

@@ -0,0 +1,48 @@
+/*
+Copyright © 2023 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/chand1012/ottodocs/config"
+	"github.com/chand1012/ottodocs/utils"
+)
+
+var VALID_MODELS = []string{"gpt-4", "gpt-4-0314", "gpt-4-32k", "gpt-4-32k-0314", "gpt-3.5-turbo", "gpt-3.5-turbo-0301"}
+
+// setModelCmd represents the setModel command
+var setModelCmd = &cobra.Command{
+	Use:   "setModel",
+	Short: "Set the model to use for documentation",
+	Long: `Sets the model to use for documentation. Takes a valid ChatGPT API model name as a single positional argument.
+Valid models are: gpt-4, gpt-4-0314, gpt-4-32k, gpt-4-32k-0314, gpt-3.5-turbo, gpt-3.5-turbo-0301
+See here for more information: https://platform.openai.com/docs/models/model-endpoint-compatibility
+`,
+	Run: func(cmd *cobra.Command, args []string) {
+		model := args[0]
+		c, err := config.Load()
+		if err != nil {
+			log.Errorf("Error loading config: %s", err)
+		}
+		if !utils.Contains(VALID_MODELS, model) {
+			log.Errorf("Invalid model: %s", model)
+			log.Errorf("Valid models are: %s", VALID_MODELS)
+			return
+		}
+
+		c.Model = model
+
+		err = config.Save(c)
+		if err != nil {
+			log.Errorf("Error saving config: %s", err)
+		}
+		log.Infof("Set model to %s", model)
+	},
+	Args: cobra.ExactArgs(1),
+}
+
+func init() {
+	RootCmd.AddCommand(setModelCmd)
+}

config/config.go

@@ -10,6 +10,7 @@ import (
 // Config represents the configuration file
 type Config struct {
 	APIKey string `json:"api_key"`
+	Model  string `json:"model"`
 }
 
 // also returns the path to the config file
@@ -39,7 +40,10 @@ func createIfNotExists() (string, error) {
 			return "", err
 		}
 		// add an empty config to the file
-		blankConfig := Config{}
+		blankConfig := Config{
+			APIKey: "",
+			Model:  "gpt-3.5-turbo",
+		}
 		err = json.NewEncoder(file).Encode(blankConfig)
 		if err != nil {
 			return "", err

docs/otto.md

@@ -14,10 +14,12 @@ Code documentation made easy using GPT.
 
 ### SEE ALSO
 
+* [otto ask](otto_ask.md)	 - Ask a question about a file or repo
 * [otto chat](otto_chat.md)	 - Ask ChatGPT a question from the command line.
 * [otto doc](otto_doc.md)	 - Document a file
 * [otto docs](otto_docs.md)	 - Document a repository of files
 * [otto login](otto_login.md)	 - Add an API key to your configuration
 * [otto prompt](otto_prompt.md)	 - Generates a ChatGPT prompt from a given Git repo
+* [otto setModel](otto_setModel.md)	 - Set the model to use for documentation
 
-###### Auto generated by spf13/cobra on 18-Mar-2023
+###### Auto generated by spf13/cobra on 18-Apr-2023