From 181fc2ade904c7d6a0910cfebdd6c90e7a4d80ef Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=B8=A1=E9=82=89=E7=A5=90=E4=B8=80=20/=20Yuichi=20Watana?=
 =?UTF-8?q?be?= <yuichi.watanabe.ja@gmail.com>
Date: Sun, 9 Jul 2023 18:11:39 +0900
Subject: [PATCH] docs: explanation about LogitBias. (129) (#426)

---
 chat.go       | 11 +++++++----
 completion.go | 35 +++++++++++++++++++----------------
 2 files changed, 26 insertions(+), 20 deletions(-)

diff --git a/chat.go b/chat.go
index e4f23df..17d7cd5 100644
--- a/chat.go
+++ b/chat.go
@@ -52,10 +52,13 @@ type ChatCompletionRequest struct {
 	Stop             []string                `json:"stop,omitempty"`
 	PresencePenalty  float32                 `json:"presence_penalty,omitempty"`
 	FrequencyPenalty float32                 `json:"frequency_penalty,omitempty"`
-	LogitBias        map[string]int          `json:"logit_bias,omitempty"`
-	User             string                  `json:"user,omitempty"`
-	Functions        []FunctionDefinition    `json:"functions,omitempty"`
-	FunctionCall     any                     `json:"function_call,omitempty"`
+	// LogitBias is must be a token id string (specified by their token ID in the tokenizer), not a word string.
+	// incorrect: `"logit_bias":{"You": 6}`, correct: `"logit_bias":{"1639": 6}`
+	// refs: https://platform.openai.com/docs/api-reference/chat/create#chat/create-logit_bias
+	LogitBias    map[string]int       `json:"logit_bias,omitempty"`
+	User         string               `json:"user,omitempty"`
+	Functions    []FunctionDefinition `json:"functions,omitempty"`
+	FunctionCall any                  `json:"function_call,omitempty"`
 }
 
 type FunctionDefinition struct {
diff --git a/completion.go b/completion.go
index 61bfed6..7b9ae89 100644
--- a/completion.go
+++ b/completion.go
@@ -109,22 +109,25 @@ func checkPromptType(prompt any) bool {
 
 // CompletionRequest represents a request structure for completion API.
 type CompletionRequest struct {
-	Model            string         `json:"model"`
-	Prompt           any            `json:"prompt,omitempty"`
-	Suffix           string         `json:"suffix,omitempty"`
-	MaxTokens        int            `json:"max_tokens,omitempty"`
-	Temperature      float32        `json:"temperature,omitempty"`
-	TopP             float32        `json:"top_p,omitempty"`
-	N                int            `json:"n,omitempty"`
-	Stream           bool           `json:"stream,omitempty"`
-	LogProbs         int            `json:"logprobs,omitempty"`
-	Echo             bool           `json:"echo,omitempty"`
-	Stop             []string       `json:"stop,omitempty"`
-	PresencePenalty  float32        `json:"presence_penalty,omitempty"`
-	FrequencyPenalty float32        `json:"frequency_penalty,omitempty"`
-	BestOf           int            `json:"best_of,omitempty"`
-	LogitBias        map[string]int `json:"logit_bias,omitempty"`
-	User             string         `json:"user,omitempty"`
+	Model            string   `json:"model"`
+	Prompt           any      `json:"prompt,omitempty"`
+	Suffix           string   `json:"suffix,omitempty"`
+	MaxTokens        int      `json:"max_tokens,omitempty"`
+	Temperature      float32  `json:"temperature,omitempty"`
+	TopP             float32  `json:"top_p,omitempty"`
+	N                int      `json:"n,omitempty"`
+	Stream           bool     `json:"stream,omitempty"`
+	LogProbs         int      `json:"logprobs,omitempty"`
+	Echo             bool     `json:"echo,omitempty"`
+	Stop             []string `json:"stop,omitempty"`
+	PresencePenalty  float32  `json:"presence_penalty,omitempty"`
+	FrequencyPenalty float32  `json:"frequency_penalty,omitempty"`
+	BestOf           int      `json:"best_of,omitempty"`
+	// LogitBias is must be a token id string (specified by their token ID in the tokenizer), not a word string.
+	// incorrect: `"logit_bias":{"You": 6}`, correct: `"logit_bias":{"1639": 6}`
+	// refs: https://platform.openai.com/docs/api-reference/completions/create#completions/create-logit_bias
+	LogitBias map[string]int `json:"logit_bias,omitempty"`
+	User      string         `json:"user,omitempty"`
 }
 
 // CompletionChoice represents one of possible completions.