feat(api): add o3-mini (#195)

fix(types): correct metadata type + other fixes
openai · Jan 31, 2025 · c5689d0 · c5689d0
1 parent 3bd3c60
commit c5689d0
Show file tree

Hide file tree

Showing 24 changed files with 303 additions and 167 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 68
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-3904ef6b29a89c98f93a9b7da19879695f3c440564be6384db7af1b734611ede.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-6204952a29973265b9c0d66fc67ffaf53c6a90ae4d75cdacf9d147676f5274c9.yml
diff --git a/aliases.go b/aliases.go
@@ -29,6 +29,26 @@ type FunctionDefinitionParam = shared.FunctionDefinitionParam
 // This is an alias to an internal type.
 type FunctionParameters = shared.FunctionParameters
 
+// Set of 16 key-value pairs that can be attached to an object. This can be useful
+// for storing additional information about the object in a structured format, and
+// querying for objects via API or the dashboard.
+//
+// Keys are strings with a maximum length of 64 characters. Values are strings with
+// a maximum length of 512 characters.
+//
+// This is an alias to an internal type.
+type Metadata = shared.Metadata
+
+// Set of 16 key-value pairs that can be attached to an object. This can be useful
+// for storing additional information about the object in a structured format, and
+// querying for objects via API or the dashboard.
+//
+// Keys are strings with a maximum length of 64 characters. Values are strings with
+// a maximum length of 512 characters.
+//
+// This is an alias to an internal type.
+type MetadataParam = shared.MetadataParam
+
 // This is an alias to an internal type.
 type ResponseFormatJSONObjectParam = shared.ResponseFormatJSONObjectParam
 

diff --git a/api.md b/api.md
@@ -2,6 +2,7 @@
 
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#FunctionDefinitionParam">FunctionDefinitionParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#FunctionParameters">FunctionParameters</a>
+- <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#MetadataParam">MetadataParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#ResponseFormatJSONObjectParam">ResponseFormatJSONObjectParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#ResponseFormatJSONSchemaParam">ResponseFormatJSONSchemaParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#ResponseFormatTextParam">ResponseFormatTextParam</a>
@@ -11,6 +12,7 @@
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#ErrorObject">ErrorObject</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#FunctionDefinition">FunctionDefinition</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#FunctionParameters">FunctionParameters</a>
+- <a href="https://pkg.go.dev/github.com/openai/openai-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/shared#Metadata">Metadata</a>
 
 # Completions
 

diff --git a/audiotranscription.go b/audiotranscription.go
@@ -74,8 +74,8 @@ type AudioTranscriptionNewParams struct {
 	// Whisper V2 model) is currently available.
 	Model param.Field[AudioModel] `json:"model,required"`
 	// The language of the input audio. Supplying the input language in
-	// [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will
-	// improve accuracy and latency.
+	// [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`)
+	// format will improve accuracy and latency.
 	Language param.Field[string] `json:"language"`
 	// An optional text to guide the model's style or continue a previous audio
 	// segment. The

diff --git a/batch.go b/batch.go
@@ -15,6 +15,7 @@ import (
 	"github.com/openai/openai-go/internal/requestconfig"
 	"github.com/openai/openai-go/option"
 	"github.com/openai/openai-go/packages/pagination"
+	"github.com/openai/openai-go/shared"
 )
 
 // BatchService contains methods and other services that help with interacting with
@@ -127,10 +128,12 @@ type Batch struct {
 	// The Unix timestamp (in seconds) for when the batch started processing.
 	InProgressAt int64 `json:"in_progress_at"`
 	// Set of 16 key-value pairs that can be attached to an object. This can be useful
-	// for storing additional information about the object in a structured format. Keys
-	// can be a maximum of 64 characters long and values can be a maximum of 512
-	// characters long.
-	Metadata interface{} `json:"metadata,nullable"`
+	// for storing additional information about the object in a structured format, and
+	// querying for objects via API or the dashboard.
+	//
+	// Keys are strings with a maximum length of 64 characters. Values are strings with
+	// a maximum length of 512 characters.
+	Metadata shared.Metadata `json:"metadata,nullable"`
 	// The ID of the file containing the outputs of successfully executed requests.
 	OutputFileID string `json:"output_file_id"`
 	// The request counts for different statuses within the batch.
@@ -310,8 +313,13 @@ type BatchNewParams struct {
 	// and must be uploaded with the purpose `batch`. The file can contain up to 50,000
 	// requests, and can be up to 200 MB in size.
 	InputFileID param.Field[string] `json:"input_file_id,required"`
-	// Optional custom metadata for the batch.
-	Metadata param.Field[map[string]string] `json:"metadata"`
+	// Set of 16 key-value pairs that can be attached to an object. This can be useful
+	// for storing additional information about the object in a structured format, and
+	// querying for objects via API or the dashboard.
+	//
+	// Keys are strings with a maximum length of 64 characters. Values are strings with
+	// a maximum length of 512 characters.
+	Metadata param.Field[shared.MetadataParam] `json:"metadata"`
 }
 
 func (r BatchNewParams) MarshalJSON() (data []byte, err error) {

diff --git a/batch_test.go b/batch_test.go
@@ -11,6 +11,7 @@ import (
 	"github.com/openai/openai-go"
 	"github.com/openai/openai-go/internal/testutil"
 	"github.com/openai/openai-go/option"
+	"github.com/openai/openai-go/shared"
 )
 
 func TestBatchNewWithOptionalParams(t *testing.T) {
@@ -29,7 +30,7 @@ func TestBatchNewWithOptionalParams(t *testing.T) {
 		CompletionWindow: openai.F(openai.BatchNewParamsCompletionWindow24h),
 		Endpoint:         openai.F(openai.BatchNewParamsEndpointV1ChatCompletions),
 		InputFileID:      openai.F("input_file_id"),
-		Metadata: openai.F(map[string]string{
+		Metadata: openai.F(shared.MetadataParam{
 			"foo": "string",
 		}),
 	})

diff --git a/betaassistant.go b/betaassistant.go
@@ -122,10 +122,12 @@ type Assistant struct {
 	// characters.
 	Instructions string `json:"instructions,required,nullable"`
 	// Set of 16 key-value pairs that can be attached to an object. This can be useful
-	// for storing additional information about the object in a structured format. Keys
-	// can be a maximum of 64 characters long and values can be a maximum of 512
-	// characters long.
-	Metadata interface{} `json:"metadata,required,nullable"`
+	// for storing additional information about the object in a structured format, and
+	// querying for objects via API or the dashboard.
+	//
+	// Keys are strings with a maximum length of 64 characters. Values are strings with
+	// a maximum length of 512 characters.
+	Metadata shared.Metadata `json:"metadata,required,nullable"`
 	// ID of the model to use. You can use the
 	// [List models](https://platform.openai.com/docs/api-reference/models/list) API to
 	// see all of your available models, or see our
@@ -2072,10 +2074,12 @@ type BetaAssistantNewParams struct {
 	// characters.
 	Instructions param.Field[string] `json:"instructions"`
 	// Set of 16 key-value pairs that can be attached to an object. This can be useful
-	// for storing additional information about the object in a structured format. Keys
-	// can be a maximum of 64 characters long and values can be a maximum of 512
-	// characters long.
-	Metadata param.Field[interface{}] `json:"metadata"`
+	// for storing additional information about the object in a structured format, and
+	// querying for objects via API or the dashboard.
+	//
+	// Keys are strings with a maximum length of 64 characters. Values are strings with
+	// a maximum length of 512 characters.
+	Metadata param.Field[shared.MetadataParam] `json:"metadata"`
 	// The name of the assistant. The maximum length is 256 characters.
 	Name param.Field[string] `json:"name"`
 	// What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
@@ -2152,11 +2156,13 @@ type BetaAssistantNewParamsToolResourcesFileSearchVectorStore struct {
 	// add to the vector store. There can be a maximum of 10000 files in a vector
 	// store.
 	FileIDs param.Field[[]string] `json:"file_ids"`
-	// Set of 16 key-value pairs that can be attached to a vector store. This can be
-	// useful for storing additional information about the vector store in a structured
-	// format. Keys can be a maximum of 64 characters long and values can be a maximum
-	// of 512 characters long.
-	Metadata param.Field[interface{}] `json:"metadata"`
+	// Set of 16 key-value pairs that can be attached to an object. This can be useful
+	// for storing additional information about the object in a structured format, and
+	// querying for objects via API or the dashboard.
+	//
+	// Keys are strings with a maximum length of 64 characters. Values are strings with
+	// a maximum length of 512 characters.
+	Metadata param.Field[shared.MetadataParam] `json:"metadata"`
 }
 
 func (r BetaAssistantNewParamsToolResourcesFileSearchVectorStore) MarshalJSON() (data []byte, err error) {
@@ -2170,10 +2176,12 @@ type BetaAssistantUpdateParams struct {
 	// characters.
 	Instructions param.Field[string] `json:"instructions"`
 	// Set of 16 key-value pairs that can be attached to an object. This can be useful
-	// for storing additional information about the object in a structured format. Keys
-	// can be a maximum of 64 characters long and values can be a maximum of 512
-	// characters long.
-	Metadata param.Field[interface{}] `json:"metadata"`
+	// for storing additional information about the object in a structured format, and
+	// querying for objects via API or the dashboard.
+	//
+	// Keys are strings with a maximum length of 64 characters. Values are strings with
+	// a maximum length of 512 characters.
+	Metadata param.Field[shared.MetadataParam] `json:"metadata"`
 	// ID of the model to use. You can use the
 	// [List models](https://platform.openai.com/docs/api-reference/models/list) API to
 	// see all of your available models, or see our

diff --git a/betaassistant_test.go b/betaassistant_test.go
@@ -11,6 +11,7 @@ import (
 	"github.com/openai/openai-go"
 	"github.com/openai/openai-go/internal/testutil"
 	"github.com/openai/openai-go/option"
+	"github.com/openai/openai-go/shared"
 )
 
 func TestBetaAssistantNewWithOptionalParams(t *testing.T) {
@@ -26,12 +27,14 @@ func TestBetaAssistantNewWithOptionalParams(t *testing.T) {
 		option.WithAPIKey("My API Key"),
 	)
 	_, err := client.Beta.Assistants.New(context.TODO(), openai.BetaAssistantNewParams{
-		Model:        openai.F(openai.ChatModelO1),
+		Model:        openai.F(openai.ChatModelO3Mini),
 		Description:  openai.F("description"),
 		Instructions: openai.F("instructions"),
-		Metadata:     openai.F[any](map[string]interface{}{}),
-		Name:         openai.F("name"),
-		Temperature:  openai.F(1.000000),
+		Metadata: openai.F(shared.MetadataParam{
+			"foo": "string",
+		}),
+		Name:        openai.F("name"),
+		Temperature: openai.F(1.000000),
 		ToolResources: openai.F(openai.BetaAssistantNewParamsToolResources{
 			CodeInterpreter: openai.F(openai.BetaAssistantNewParamsToolResourcesCodeInterpreter{
 				FileIDs: openai.F([]string{"string"}),
@@ -42,8 +45,10 @@ func TestBetaAssistantNewWithOptionalParams(t *testing.T) {
 					ChunkingStrategy: openai.F[openai.FileChunkingStrategyParamUnion](openai.AutoFileChunkingStrategyParam{
 						Type: openai.F(openai.AutoFileChunkingStrategyParamTypeAuto),
 					}),
-					FileIDs:  openai.F([]string{"string"}),
-					Metadata: openai.F[any](map[string]interface{}{}),
+					FileIDs: openai.F([]string{"string"}),
+					Metadata: openai.F(shared.MetadataParam{
+						"foo": "string",
+					}),
 				}}),
 			}),
 		}),
@@ -101,10 +106,12 @@ func TestBetaAssistantUpdateWithOptionalParams(t *testing.T) {
 		openai.BetaAssistantUpdateParams{
 			Description:  openai.F("description"),
 			Instructions: openai.F("instructions"),
-			Metadata:     openai.F[any](map[string]interface{}{}),
-			Model:        openai.F("model"),
-			Name:         openai.F("name"),
-			Temperature:  openai.F(1.000000),
+			Metadata: openai.F(shared.MetadataParam{
+				"foo": "string",
+			}),
+			Model:       openai.F("model"),
+			Name:        openai.F("name"),
+			Temperature: openai.F(1.000000),
 			ToolResources: openai.F(openai.BetaAssistantUpdateParamsToolResources{
 				CodeInterpreter: openai.F(openai.BetaAssistantUpdateParamsToolResourcesCodeInterpreter{
 					FileIDs: openai.F([]string{"string"}),