fix(client)!: add enums (#327)

Author: stainless-app[bot]

README.md

@@ -527,7 +527,7 @@ To handle errors, we recommend that you use the `errors.As` pattern:
 
 ```go
 _, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{
-	Model:        "babbage-002",
+	Model:        openai.FineTuningJobNewParamsModelBabbage002,
 	TrainingFile: "file-abc123",
 })
 if err != nil {

audiospeech.go

@@ -57,7 +57,7 @@ type AudioSpeechNewParams struct {
 	// `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, and
 	// `verse`. Previews of the voices are available in the
 	// [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
-	Voice string `json:"voice,omitzero,required"`
+	Voice AudioSpeechNewParamsVoice `json:"voice,omitzero,required"`
 	// Control the voice of your generated audio with additional instructions. Does not
 	// work with `tts-1` or `tts-1-hd`.
 	Instructions param.Opt[string] `json:"instructions,omitzero"`
@@ -81,6 +81,26 @@ func (r AudioSpeechNewParams) MarshalJSON() (data []byte, err error) {
 	return param.MarshalObject(r, (*shadow)(&r))
 }
 
+// The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
+// `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, and
+// `verse`. Previews of the voices are available in the
+// [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
+type AudioSpeechNewParamsVoice string
+
+const (
+	AudioSpeechNewParamsVoiceAlloy   AudioSpeechNewParamsVoice = "alloy"
+	AudioSpeechNewParamsVoiceAsh     AudioSpeechNewParamsVoice = "ash"
+	AudioSpeechNewParamsVoiceBallad  AudioSpeechNewParamsVoice = "ballad"
+	AudioSpeechNewParamsVoiceCoral   AudioSpeechNewParamsVoice = "coral"
+	AudioSpeechNewParamsVoiceEcho    AudioSpeechNewParamsVoice = "echo"
+	AudioSpeechNewParamsVoiceFable   AudioSpeechNewParamsVoice = "fable"
+	AudioSpeechNewParamsVoiceOnyx    AudioSpeechNewParamsVoice = "onyx"
+	AudioSpeechNewParamsVoiceNova    AudioSpeechNewParamsVoice = "nova"
+	AudioSpeechNewParamsVoiceSage    AudioSpeechNewParamsVoice = "sage"
+	AudioSpeechNewParamsVoiceShimmer AudioSpeechNewParamsVoice = "shimmer"
+	AudioSpeechNewParamsVoiceVerse   AudioSpeechNewParamsVoice = "verse"
+)
+
 // The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`,
 // `wav`, and `pcm`.
 type AudioSpeechNewParamsResponseFormat string

audiospeech_test.go

@@ -29,7 +29,7 @@ func TestAudioSpeechNewWithOptionalParams(t *testing.T) {
 	resp, err := client.Audio.Speech.New(context.TODO(), openai.AudioSpeechNewParams{
 		Input:          "input",
 		Model:          openai.SpeechModelTTS1,
-		Voice:          "alloy",
+		Voice:          openai.AudioSpeechNewParamsVoiceAlloy,
 		Instructions:   openai.String("instructions"),
 		ResponseFormat: openai.AudioSpeechNewParamsResponseFormatMP3,
 		Speed:          openai.Float(0.25),

betaassistant.go

@@ -2093,7 +2093,7 @@ type BetaAssistantUpdateParams struct {
 	// see all of your available models, or see our
 	// [Model overview](https://platform.openai.com/docs/models) for descriptions of
 	// them.
-	Model string `json:"model,omitzero"`
+	Model BetaAssistantUpdateParamsModel `json:"model,omitzero"`
 	// Specifies the format that the model must output. Compatible with
 	// [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
 	// [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
@@ -2131,6 +2131,46 @@ func (r BetaAssistantUpdateParams) MarshalJSON() (data []byte, err error) {
 	return param.MarshalObject(r, (*shadow)(&r))
 }
 
+// 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
+// [Model overview](https://platform.openai.com/docs/models) for descriptions of
+// them.
+type BetaAssistantUpdateParamsModel string
+
+const (
+	BetaAssistantUpdateParamsModelO3Mini                  BetaAssistantUpdateParamsModel = "o3-mini"
+	BetaAssistantUpdateParamsModelO3Mini2025_01_31        BetaAssistantUpdateParamsModel = "o3-mini-2025-01-31"
+	BetaAssistantUpdateParamsModelO1                      BetaAssistantUpdateParamsModel = "o1"
+	BetaAssistantUpdateParamsModelO1_2024_12_17           BetaAssistantUpdateParamsModel = "o1-2024-12-17"
+	BetaAssistantUpdateParamsModelGPT4o                   BetaAssistantUpdateParamsModel = "gpt-4o"
+	BetaAssistantUpdateParamsModelGPT4o2024_11_20         BetaAssistantUpdateParamsModel = "gpt-4o-2024-11-20"
+	BetaAssistantUpdateParamsModelGPT4o2024_08_06         BetaAssistantUpdateParamsModel = "gpt-4o-2024-08-06"
+	BetaAssistantUpdateParamsModelGPT4o2024_05_13         BetaAssistantUpdateParamsModel = "gpt-4o-2024-05-13"
+	BetaAssistantUpdateParamsModelGPT4oMini               BetaAssistantUpdateParamsModel = "gpt-4o-mini"
+	BetaAssistantUpdateParamsModelGPT4oMini2024_07_18     BetaAssistantUpdateParamsModel = "gpt-4o-mini-2024-07-18"
+	BetaAssistantUpdateParamsModelGPT4_5Preview           BetaAssistantUpdateParamsModel = "gpt-4.5-preview"
+	BetaAssistantUpdateParamsModelGPT4_5Preview2025_02_27 BetaAssistantUpdateParamsModel = "gpt-4.5-preview-2025-02-27"
+	BetaAssistantUpdateParamsModelGPT4Turbo               BetaAssistantUpdateParamsModel = "gpt-4-turbo"
+	BetaAssistantUpdateParamsModelGPT4Turbo2024_04_09     BetaAssistantUpdateParamsModel = "gpt-4-turbo-2024-04-09"
+	BetaAssistantUpdateParamsModelGPT4_0125Preview        BetaAssistantUpdateParamsModel = "gpt-4-0125-preview"
+	BetaAssistantUpdateParamsModelGPT4TurboPreview        BetaAssistantUpdateParamsModel = "gpt-4-turbo-preview"
+	BetaAssistantUpdateParamsModelGPT4_1106Preview        BetaAssistantUpdateParamsModel = "gpt-4-1106-preview"
+	BetaAssistantUpdateParamsModelGPT4VisionPreview       BetaAssistantUpdateParamsModel = "gpt-4-vision-preview"
+	BetaAssistantUpdateParamsModelGPT4                    BetaAssistantUpdateParamsModel = "gpt-4"
+	BetaAssistantUpdateParamsModelGPT4_0314               BetaAssistantUpdateParamsModel = "gpt-4-0314"
+	BetaAssistantUpdateParamsModelGPT4_0613               BetaAssistantUpdateParamsModel = "gpt-4-0613"
+	BetaAssistantUpdateParamsModelGPT4_32k                BetaAssistantUpdateParamsModel = "gpt-4-32k"
+	BetaAssistantUpdateParamsModelGPT4_32k0314            BetaAssistantUpdateParamsModel = "gpt-4-32k-0314"
+	BetaAssistantUpdateParamsModelGPT4_32k0613            BetaAssistantUpdateParamsModel = "gpt-4-32k-0613"
+	BetaAssistantUpdateParamsModelGPT3_5Turbo             BetaAssistantUpdateParamsModel = "gpt-3.5-turbo"
+	BetaAssistantUpdateParamsModelGPT3_5Turbo16k          BetaAssistantUpdateParamsModel = "gpt-3.5-turbo-16k"
+	BetaAssistantUpdateParamsModelGPT3_5Turbo0613         BetaAssistantUpdateParamsModel = "gpt-3.5-turbo-0613"
+	BetaAssistantUpdateParamsModelGPT3_5Turbo1106         BetaAssistantUpdateParamsModel = "gpt-3.5-turbo-1106"
+	BetaAssistantUpdateParamsModelGPT3_5Turbo0125         BetaAssistantUpdateParamsModel = "gpt-3.5-turbo-0125"
+	BetaAssistantUpdateParamsModelGPT3_5Turbo16k0613      BetaAssistantUpdateParamsModel = "gpt-3.5-turbo-16k-0613"
+)
+
 // A set of resources that are used by the assistant's tools. The resources are
 // specific to the type of tool. For example, the `code_interpreter` tool requires
 // a list of file IDs, while the `file_search` tool requires a list of vector store

betaassistant_test.go

@@ -114,7 +114,7 @@ func TestBetaAssistantUpdateWithOptionalParams(t *testing.T) {
 			Metadata: shared.MetadataParam{
 				"foo": "string",
 			},
-			Model:           "o3-mini",
+			Model:           openai.BetaAssistantUpdateParamsModelO3Mini,
 			Name:            openai.String("name"),
 			ReasoningEffort: shared.ReasoningEffortLow,
 			ResponseFormat: openai.AssistantResponseFormatOptionUnionParam{

betathread.go

@@ -403,6 +403,18 @@ func (r AssistantToolChoiceOptionUnion) ToParam() AssistantToolChoiceOptionUnion
 	return param.OverrideObj[AssistantToolChoiceOptionUnionParam](r.RawJSON())
 }
 
+// `none` means the model will not call any tools and instead generates a message.
+// `auto` means the model can pick between generating a message or calling one or
+// more tools. `required` means the model must call one or more tools before
+// responding to the user.
+type AssistantToolChoiceOptionAuto string
+
+const (
+	AssistantToolChoiceOptionAutoNone     AssistantToolChoiceOptionAuto = "none"
+	AssistantToolChoiceOptionAutoAuto     AssistantToolChoiceOptionAuto = "auto"
+	AssistantToolChoiceOptionAutoRequired AssistantToolChoiceOptionAuto = "required"
+)
+
 func AssistantToolChoiceOptionParamOfAssistantToolChoice(type_ AssistantToolChoiceType) AssistantToolChoiceOptionUnionParam {
 	var variant AssistantToolChoiceParam
 	variant.Type = type_

chatcompletion.go

@@ -500,7 +500,7 @@ type ChatCompletionAudioParam struct {
 	Format ChatCompletionAudioParamFormat `json:"format,omitzero,required"`
 	// The voice the model uses to respond. Supported voices are `alloy`, `ash`,
 	// `ballad`, `coral`, `echo`, `sage`, and `shimmer`.
-	Voice string `json:"voice,omitzero,required"`
+	Voice ChatCompletionAudioParamVoice `json:"voice,omitzero,required"`
 	paramObj
 }
 
@@ -524,6 +524,24 @@ const (
 	ChatCompletionAudioParamFormatPcm16 ChatCompletionAudioParamFormat = "pcm16"
 )
 
+// The voice the model uses to respond. Supported voices are `alloy`, `ash`,
+// `ballad`, `coral`, `echo`, `sage`, and `shimmer`.
+type ChatCompletionAudioParamVoice string
+
+const (
+	ChatCompletionAudioParamVoiceAlloy   ChatCompletionAudioParamVoice = "alloy"
+	ChatCompletionAudioParamVoiceAsh     ChatCompletionAudioParamVoice = "ash"
+	ChatCompletionAudioParamVoiceBallad  ChatCompletionAudioParamVoice = "ballad"
+	ChatCompletionAudioParamVoiceCoral   ChatCompletionAudioParamVoice = "coral"
+	ChatCompletionAudioParamVoiceEcho    ChatCompletionAudioParamVoice = "echo"
+	ChatCompletionAudioParamVoiceFable   ChatCompletionAudioParamVoice = "fable"
+	ChatCompletionAudioParamVoiceOnyx    ChatCompletionAudioParamVoice = "onyx"
+	ChatCompletionAudioParamVoiceNova    ChatCompletionAudioParamVoice = "nova"
+	ChatCompletionAudioParamVoiceSage    ChatCompletionAudioParamVoice = "sage"
+	ChatCompletionAudioParamVoiceShimmer ChatCompletionAudioParamVoice = "shimmer"
+	ChatCompletionAudioParamVoiceVerse   ChatCompletionAudioParamVoice = "verse"
+)
+
 // Represents a streamed chunk of a chat completion response returned by the model,
 // based on the provided input.
 // [Learn more](https://platform.openai.com/docs/guides/streaming-responses).
@@ -2054,6 +2072,17 @@ func (u ChatCompletionToolChoiceOptionUnionParam) GetType() *string {
 	return nil
 }
 
+// `none` means the model will not call any tool and instead generates a message.
+// `auto` means the model can pick between generating a message or calling one or
+// more tools. `required` means the model must call one or more tools.
+type ChatCompletionToolChoiceOptionAuto string
+
+const (
+	ChatCompletionToolChoiceOptionAutoNone     ChatCompletionToolChoiceOptionAuto = "none"
+	ChatCompletionToolChoiceOptionAutoAuto     ChatCompletionToolChoiceOptionAuto = "auto"
+	ChatCompletionToolChoiceOptionAutoRequired ChatCompletionToolChoiceOptionAuto = "required"
+)
+
 // The properties Content, Role, ToolCallID are required.
 type ChatCompletionToolMessageParam struct {
 	// The contents of the tool message.
@@ -2390,6 +2419,16 @@ func (u ChatCompletionNewParamsFunctionCallUnion) GetName() *string {
 	return nil
 }
 
+// `none` means the model will not call a function and instead generates a message.
+// `auto` means the model can pick between generating a message or calling a
+// function.
+type ChatCompletionNewParamsFunctionCallFunctionCallMode string
+
+const (
+	ChatCompletionNewParamsFunctionCallFunctionCallModeNone ChatCompletionNewParamsFunctionCallFunctionCallMode = "none"
+	ChatCompletionNewParamsFunctionCallFunctionCallModeAuto ChatCompletionNewParamsFunctionCallFunctionCallMode = "auto"
+)
+
 // Deprecated: deprecated
 //
 // The property Name is required.

chatcompletion_test.go

@@ -38,7 +38,7 @@ func TestChatCompletionNewWithOptionalParams(t *testing.T) {
 		Model: shared.ChatModelO3Mini,
 		Audio: openai.ChatCompletionAudioParam{
 			Format: openai.ChatCompletionAudioParamFormatWAV,
-			Voice:  "alloy",
+			Voice:  openai.ChatCompletionAudioParamVoiceAlloy,
 		},
 		FrequencyPenalty: openai.Float(-2),
 		FunctionCall: openai.ChatCompletionNewParamsFunctionCallUnion{

completion.go

@@ -258,7 +258,7 @@ type CompletionNewParams struct {
 	// see all of your available models, or see our
 	// [Model overview](https://platform.openai.com/docs/models) for descriptions of
 	// them.
-	Model string `json:"model,omitzero,required"`
+	Model CompletionNewParamsModel `json:"model,omitzero,required"`
 	// Generates `best_of` completions server-side and returns the "best" (the one with
 	// the highest log probability per token). Results cannot be streamed.
 	//
@@ -361,6 +361,19 @@ func (r CompletionNewParams) MarshalJSON() (data []byte, err error) {
 	return param.MarshalObject(r, (*shadow)(&r))
 }
 
+// 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
+// [Model overview](https://platform.openai.com/docs/models) for descriptions of
+// them.
+type CompletionNewParamsModel string
+
+const (
+	CompletionNewParamsModelGPT3_5TurboInstruct CompletionNewParamsModel = "gpt-3.5-turbo-instruct"
+	CompletionNewParamsModelDavinci002          CompletionNewParamsModel = "davinci-002"
+	CompletionNewParamsModelBabbage002          CompletionNewParamsModel = "babbage-002"
+)
+
 // Only one field can be non-zero.
 //
 // Use [param.IsOmitted] to confirm if a field is set.

completion_test.go

@@ -26,7 +26,7 @@ func TestCompletionNewWithOptionalParams(t *testing.T) {
 		option.WithAPIKey("My API Key"),
 	)
 	_, err := client.Completions.New(context.TODO(), openai.CompletionNewParams{
-		Model: "gpt-3.5-turbo-instruct",
+		Model: openai.CompletionNewParamsModelGPT3_5TurboInstruct,
 		Prompt: openai.CompletionNewParamsPromptUnion{
 			OfString: openai.String("This is a test."),
 		},

finetuningjob.go

@@ -917,7 +917,7 @@ func (r *FineTuningJobWandbIntegrationObject) UnmarshalJSON(data []byte) error {
 type FineTuningJobNewParams struct {
 	// The name of the model to fine-tune. You can select one of the
 	// [supported models](https://platform.openai.com/docs/guides/fine-tuning#which-models-can-be-fine-tuned).
-	Model string `json:"model,omitzero,required"`
+	Model FineTuningJobNewParamsModel `json:"model,omitzero,required"`
 	// The ID of an uploaded file that contains training data.
 	//
 	// See [upload file](https://platform.openai.com/docs/api-reference/files/create)
@@ -985,6 +985,17 @@ func (r FineTuningJobNewParams) MarshalJSON() (data []byte, err error) {
 	return param.MarshalObject(r, (*shadow)(&r))
 }
 
+// The name of the model to fine-tune. You can select one of the
+// [supported models](https://platform.openai.com/docs/guides/fine-tuning#which-models-can-be-fine-tuned).
+type FineTuningJobNewParamsModel string
+
+const (
+	FineTuningJobNewParamsModelBabbage002  FineTuningJobNewParamsModel = "babbage-002"
+	FineTuningJobNewParamsModelDavinci002  FineTuningJobNewParamsModel = "davinci-002"
+	FineTuningJobNewParamsModelGPT3_5Turbo FineTuningJobNewParamsModel = "gpt-3.5-turbo"
+	FineTuningJobNewParamsModelGPT4oMini   FineTuningJobNewParamsModel = "gpt-4o-mini"
+)
+
 // The hyperparameters used for the fine-tuning job. This value is now deprecated
 // in favor of `method`, and should be passed in under the `method` parameter.
 //

finetuningjob_test.go

@@ -28,7 +28,7 @@ func TestFineTuningJobNewWithOptionalParams(t *testing.T) {
 		option.WithAPIKey("My API Key"),
 	)
 	_, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{
-		Model:        "babbage-002",
+		Model:        openai.FineTuningJobNewParamsModelBabbage002,
 		TrainingFile: "file-abc123",
 		Hyperparameters: openai.FineTuningJobNewParamsHyperparameters{
 			BatchSize: openai.FineTuningJobNewParamsHyperparametersBatchSizeUnion{