From 9fe2c6ce1f5b756cd172ae9a7786beea69b2956f Mon Sep 17 00:00:00 2001
From: Sander Mack-Crane <71154168+smackcrane@users.noreply.github.com>
Date: Tue, 15 Oct 2024 14:16:57 -0600
Subject: [PATCH] Completion API: add Store and Metadata parameters (#878)

---
 chat.go       |  5 +++++
 completion.go | 26 ++++++++++++++------------
 2 files changed, 19 insertions(+), 12 deletions(-)

diff --git a/chat.go b/chat.go
index a7dee8e0..2b13f8dd 100644
--- a/chat.go
+++ b/chat.go
@@ -255,6 +255,11 @@ type ChatCompletionRequest struct {
 	StreamOptions *StreamOptions `json:"stream_options,omitempty"`
 	// Disable the default behavior of parallel tool calls by setting it: false.
 	ParallelToolCalls any `json:"parallel_tool_calls,omitempty"`
+	// Store can be set to true to store the output of this completion request for use in distillations and evals.
+	// https://platform.openai.com/docs/api-reference/chat/create#chat-create-store
+	Store bool `json:"store,omitempty"`
+	// Metadata to store with the completion.
+	Metadata map[string]string `json:"metadata,omitempty"`
 }
 
 type StreamOptions struct {
diff --git a/completion.go b/completion.go
index afcf8467..84ef2ad2 100644
--- a/completion.go
+++ b/completion.go
@@ -241,18 +241,20 @@ type CompletionRequest struct {
 	LogitBias map[string]int `json:"logit_bias,omitempty"`
 	// Store can be set to true to store the output of this completion request for use in distillations and evals.
 	// https://platform.openai.com/docs/api-reference/chat/create#chat-create-store
-	Store           bool     `json:"store,omitempty"`
-	LogProbs        int      `json:"logprobs,omitempty"`
-	MaxTokens       int      `json:"max_tokens,omitempty"`
-	N               int      `json:"n,omitempty"`
-	PresencePenalty float32  `json:"presence_penalty,omitempty"`
-	Seed            *int     `json:"seed,omitempty"`
-	Stop            []string `json:"stop,omitempty"`
-	Stream          bool     `json:"stream,omitempty"`
-	Suffix          string   `json:"suffix,omitempty"`
-	Temperature     float32  `json:"temperature,omitempty"`
-	TopP            float32  `json:"top_p,omitempty"`
-	User            string   `json:"user,omitempty"`
+	Store bool `json:"store,omitempty"`
+	// Metadata to store with the completion.
+	Metadata        map[string]string `json:"metadata,omitempty"`
+	LogProbs        int               `json:"logprobs,omitempty"`
+	MaxTokens       int               `json:"max_tokens,omitempty"`
+	N               int               `json:"n,omitempty"`
+	PresencePenalty float32           `json:"presence_penalty,omitempty"`
+	Seed            *int              `json:"seed,omitempty"`
+	Stop            []string          `json:"stop,omitempty"`
+	Stream          bool              `json:"stream,omitempty"`
+	Suffix          string            `json:"suffix,omitempty"`
+	Temperature     float32           `json:"temperature,omitempty"`
+	TopP            float32           `json:"top_p,omitempty"`
+	User            string            `json:"user,omitempty"`
 }
 
 // CompletionChoice represents one of possible completions.