feat: add temperature control to OpenAI package

- Set the default sampling temperature to 0.7
- Add a flag to set the sampling temperature in the config command
- Move the initialization of the `openai` package from the `commit` command to a separate file
- Add a `WithTemperature` function to the `openai` package to set the sampling temperature
- Change the `maxTokens` variable in the `review` command from package level to local scope
- Set the `temperature` field in the `Client` struct of the `openai` package to the value set by `WithTemperature`

Signed-off-by: Bo-Yi.Wu <appleboy.tw@gmail.com>

cmd/commit.go

@@ -73,6 +73,7 @@ var commitCmd = &cobra.Command{
 			openai.WithBaseURL(viper.GetString("openai.base_url")),
 			openai.WithTimeout(viper.GetDuration("openai.timeout")),
 			openai.WithMaxTokens(viper.GetInt("openai.max_tokens")),
+			openai.WithTemperature(float32(viper.GetFloat64("openai.temperature"))),
 		)
 		if err != nil {
 			return err

cmd/config.go

@@ -24,6 +24,7 @@ var availableKeys = []string{
 	"openai.base_url",
 	"openai.timeout",
 	"openai.max_tokens",
+	"openai.temperature",
 }
 
 func init() {
@@ -39,6 +40,7 @@ func init() {
 	configCmd.PersistentFlags().StringP("template_string", "", "", "git commit message string")
 	configCmd.PersistentFlags().IntP("diff_unified", "", 3, "generate diffs with <n> lines of context, default is 3")
 	configCmd.PersistentFlags().IntP("max_tokens", "", 300, "the maximum number of tokens to generate in the chat completion.")
+	configCmd.PersistentFlags().Float32P("temperature", "", 0.7, "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.")
 	configCmd.PersistentFlags().StringSliceP("exclude_list", "", []string{}, "exclude file from `git diff` command")
 
 	_ = viper.BindPFlag("openai.base_url", configCmd.PersistentFlags().Lookup("base_url"))
@@ -49,6 +51,7 @@ func init() {
 	_ = viper.BindPFlag("openai.socks", configCmd.PersistentFlags().Lookup("socks"))
 	_ = viper.BindPFlag("openai.timeout", configCmd.PersistentFlags().Lookup("timeout"))
 	_ = viper.BindPFlag("openai.max_tokens", configCmd.PersistentFlags().Lookup("max_tokens"))
+	_ = viper.BindPFlag("openai.temperature", configCmd.PersistentFlags().Lookup("temperature"))
 	_ = viper.BindPFlag("output.lang", configCmd.PersistentFlags().Lookup("lang"))
 	_ = viper.BindPFlag("git.diff_unified", configCmd.PersistentFlags().Lookup("diff_unified"))
 	_ = viper.BindPFlag("git.exclude_list", configCmd.PersistentFlags().Lookup("exclude_list"))

cmd/review.go

@@ -14,11 +14,9 @@ import (
 	"github.com/spf13/viper"
 )
 
-var (
-	// The maximum number of tokens to generate in the chat completion.
-	// The total length of input tokens and generated tokens is limited by the model's context length.
-	maxTokens int
-)
+// The maximum number of tokens to generate in the chat completion.
+// The total length of input tokens and generated tokens is limited by the model's context length.
+var maxTokens int
 
 func init() {
 	reviewCmd.Flags().IntVar(&diffUnified, "diff_unified", 3, "generate diffs with <n> lines of context, default is 3")
@@ -57,6 +55,7 @@ var reviewCmd = &cobra.Command{
 			openai.WithBaseURL(viper.GetString("openai.base_url")),
 			openai.WithTimeout(viper.GetDuration("openai.timeout")),
 			openai.WithMaxTokens(viper.GetInt("openai.max_tokens")),
+			openai.WithTemperature(float32(viper.GetFloat64("openai.temperature"))),
 		)
 		if err != nil {
 			return err

openai/openai.go

@@ -48,9 +48,10 @@ func GetModel(model string) string {
 
 // Client is a struct that represents an OpenAI client.
 type Client struct {
-	client    *openai.Client
-	model     string
-	maxTokens int
+	client      *openai.Client
+	model       string
+	maxTokens   int
+	temperature float32
 }
 
 type Response struct {
@@ -66,7 +67,7 @@ func (c *Client) CreateChatCompletion(
 	req := openai.ChatCompletionRequest{
 		Model:       c.model,
 		MaxTokens:   c.maxTokens,
-		Temperature: 0.7,
+		Temperature: c.temperature,
 		TopP:        1,
 		Messages: []openai.ChatCompletionMessage{
 			{
@@ -92,7 +93,7 @@ func (c *Client) CreateCompletion(
 	req := openai.CompletionRequest{
 		Model:       c.model,
 		MaxTokens:   c.maxTokens,
-		Temperature: 0.7,
+		Temperature: c.temperature,
 		TopP:        1,
 		Prompt:      content,
 	}
@@ -135,8 +136,9 @@ func (c *Client) Completion(
 // returns a pointer to a Client and an error.
 func New(opts ...Option) (*Client, error) {
 	cfg := &config{
-		maxTokens: defaultMaxTokens,
-		model:     defaultModel,
+		maxTokens:   defaultMaxTokens,
+		model:       defaultModel,
+		temperature: defaultTemperature,
 	}
 
 	// Loop through each option
@@ -156,6 +158,7 @@ func New(opts ...Option) (*Client, error) {
 	}
 	instance.model = v
 	instance.maxTokens = cfg.maxTokens
+	instance.temperature = cfg.temperature
 
 	c := openai.DefaultConfig(cfg.token)
 	if cfg.orgID != "" {

openai/options.go

@@ -7,8 +7,9 @@ import (
 )
 
 const (
-	defaultMaxTokens = 300
-	defaultModel     = openai.GPT3Dot5Turbo
+	defaultMaxTokens   = 300
+	defaultModel       = openai.GPT3Dot5Turbo
+	defaultTemperature = 0.7
 )
 
 // Option is an interface that specifies instrumentation configuration options.
@@ -85,22 +86,36 @@ func WithTimeout(val time.Duration) Option {
 // The maximum number of tokens to generate in the chat completion.
 // The total length of input tokens and generated tokens is limited by the model's context length.
 func WithMaxTokens(val int) Option {
-	if val == 0 {
+	if val <= 0 {
 		val = defaultMaxTokens
 	}
 	return optionFunc(func(c *config) {
 		c.maxTokens = val
 	})
 }
 
+// WithTemperature returns a new Option that sets the temperature for the client configuration.
+// What sampling temperature to use, between 0 and 2.
+// Higher values like 0.8 will make the output more random,
+// while lower values like 0.2 will make it more focused and deterministic.
+func WithTemperature(val float32) Option {
+	if val <= 0 {
+		val = defaultTemperature
+	}
+	return optionFunc(func(c *config) {
+		c.temperature = val
+	})
+}
+
 // config is a struct that stores configuration options for the instrumentation.
 type config struct {
-	baseURL   string
-	token     string
-	orgID     string
-	model     string
-	proxyURL  string
-	socksURL  string
-	timeout   time.Duration
-	maxTokens int
+	baseURL     string
+	token       string
+	orgID       string
+	model       string
+	proxyURL    string
+	socksURL    string
+	timeout     time.Duration
+	maxTokens   int
+	temperature float32
 }