release: 0.1.0-beta.3

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-beta.2"
+  ".": "0.1.0-beta.3"
 }

.stats.yml

@@ -1,2 +1,4 @@
 configured_endpoints: 80
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-5ad6884898c07591750dde560118baf7074a59aecd1f367f930c5e42b04e848a.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-6663c59193eb95b201e492de17dcbd5e126ba03d18ce66287a3e2c632ca56fe7.yml
+openapi_spec_hash: 7996d2c34cc44fe2ce9ffe93c0ab774e
+config_hash: e25e31d8446b6bc0e3ef7103b6993cce

CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 0.1.0-beta.3 (2025-03-28)
+
+Full Changelog: [v0.1.0-beta.2...v0.1.0-beta.3](https://github.com/openai/openai-go/compare/v0.1.0-beta.2...v0.1.0-beta.3)
+
+### ⚠ BREAKING CHANGES
+
+* **client:** add enums ([#327](https://github.com/openai/openai-go/issues/327))
+
+### Features
+
+* **api:** add `get /chat/completions` endpoint ([e8ed116](https://github.com/openai/openai-go/commit/e8ed1168576c885cb26fbf819b9c8d24975749bd))
+* **api:** add `get /responses/{response_id}/input_items` endpoint ([8870c26](https://github.com/openai/openai-go/commit/8870c26f010a596adcf37ac10dba096bdd4394e3))
+
+
+### Bug Fixes
+
+* **client:** add enums ([#327](https://github.com/openai/openai-go/issues/327)) ([b0e3afb](https://github.com/openai/openai-go/commit/b0e3afbd6f18fd9fc2a5ea9174bd7ec0ac0614db))
+
+
+### Chores
+
+* add hash of OpenAPI spec/config inputs to .stats.yml ([104b786](https://github.com/openai/openai-go/commit/104b7861bb025514999b143f7d1de45d2dab659f))
+* add request options to client tests ([#321](https://github.com/openai/openai-go/issues/321)) ([f5239ce](https://github.com/openai/openai-go/commit/f5239ceecf36835341eac5121ed1770020c4806a))
+* **api:** updates to supported Voice IDs ([#325](https://github.com/openai/openai-go/issues/325)) ([477727a](https://github.com/openai/openai-go/commit/477727a44b0fb72493c4749cc60171e0d30f98ec))
+* **docs:** improve security documentation ([#319](https://github.com/openai/openai-go/issues/319)) ([0271053](https://github.com/openai/openai-go/commit/027105363ab30ac3e189234908169faf94e0ca49))
+* fix typos ([#324](https://github.com/openai/openai-go/issues/324)) ([dba15f7](https://github.com/openai/openai-go/commit/dba15f74d63814ce16f778e1017a209a42f46179))
+
 ## 0.1.0-beta.2 (2025-03-22)
 
 Full Changelog: [v0.1.0-beta.1...v0.1.0-beta.2](https://github.com/openai/openai-go/compare/v0.1.0-beta.1...v0.1.0-beta.2)

README.md

@@ -26,7 +26,7 @@ Or to pin the version:
 <!-- x-release-please-start-version -->
 
 ```sh
-go get -u 'github.com/openai/[email protected].2'
+go get -u 'github.com/openai/[email protected].3'
 ```
 
 <!-- x-release-please-end -->
@@ -310,8 +310,8 @@ To send `null` instead of a struct, use `param.NullObj[T]()`, where `T` is a str
 To send a custom value instead of a struct, use `param.OverrideObj[T](value)`.
 
 To override request structs contain a `.WithExtraFields(map[string]any)` method which can be used to
-send non-conforming fields in the request body. Extra fields take higher precedence than normal
-fields.
+send non-conforming fields in the request body. Extra fields overwrite any struct fields with a matching
+key, so only use with trusted data.
 
 ```go
 params := FooParams{
@@ -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

@@ -54,12 +54,9 @@ type AudioSpeechNewParams struct {
 	// `tts-1`, `tts-1-hd` or `gpt-4o-mini-tts`.
 	Model SpeechModel `json:"model,omitzero,required"`
 	// The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
-	// `coral`, `echo`, `fable`, `onyx`, `nova`, `sage` and `shimmer`. Previews of the
-	// voices are available in the
+	// `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).
-	//
-	// Any of "alloy", "ash", "coral", "echo", "fable", "onyx", "nova", "sage",
-	// "shimmer".
 	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`.
@@ -85,21 +82,23 @@ func (r AudioSpeechNewParams) MarshalJSON() (data []byte, err error) {
 }
 
 // The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
-// `coral`, `echo`, `fable`, `onyx`, `nova`, `sage` and `shimmer`. Previews of the
-// voices are available in the
+// `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`,

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,8 +500,6 @@ 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`.
-	//
-	// Any of "alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse".
 	Voice ChatCompletionAudioParamVoice `json:"voice,omitzero,required"`
 	paramObj
 }
@@ -536,6 +534,9 @@ const (
 	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"
@@ -2071,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.
@@ -2407,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.

client_test.go

@@ -28,6 +28,7 @@ func (t *closureTransport) RoundTrip(req *http.Request) (*http.Response, error)
 func TestUserAgentHeader(t *testing.T) {
 	var userAgent string
 	client := openai.NewClient(
+		option.WithAPIKey("My API Key"),
 		option.WithHTTPClient(&http.Client{
 			Transport: &closureTransport{
 				fn: func(req *http.Request) (*http.Response, error) {
@@ -57,6 +58,7 @@ func TestUserAgentHeader(t *testing.T) {
 func TestRetryAfter(t *testing.T) {
 	retryCountHeaders := make([]string, 0)
 	client := openai.NewClient(
+		option.WithAPIKey("My API Key"),
 		option.WithHTTPClient(&http.Client{
 			Transport: &closureTransport{
 				fn: func(req *http.Request) (*http.Response, error) {
@@ -99,6 +101,7 @@ func TestRetryAfter(t *testing.T) {
 func TestDeleteRetryCountHeader(t *testing.T) {
 	retryCountHeaders := make([]string, 0)
 	client := openai.NewClient(
+		option.WithAPIKey("My API Key"),
 		option.WithHTTPClient(&http.Client{
 			Transport: &closureTransport{
 				fn: func(req *http.Request) (*http.Response, error) {
@@ -137,6 +140,7 @@ func TestDeleteRetryCountHeader(t *testing.T) {
 func TestOverwriteRetryCountHeader(t *testing.T) {
 	retryCountHeaders := make([]string, 0)
 	client := openai.NewClient(
+		option.WithAPIKey("My API Key"),
 		option.WithHTTPClient(&http.Client{
 			Transport: &closureTransport{
 				fn: func(req *http.Request) (*http.Response, error) {
@@ -175,6 +179,7 @@ func TestOverwriteRetryCountHeader(t *testing.T) {
 func TestRetryAfterMs(t *testing.T) {
 	attempts := 0
 	client := openai.NewClient(
+		option.WithAPIKey("My API Key"),
 		option.WithHTTPClient(&http.Client{
 			Transport: &closureTransport{
 				fn: func(req *http.Request) (*http.Response, error) {
@@ -209,6 +214,7 @@ func TestRetryAfterMs(t *testing.T) {
 
 func TestContextCancel(t *testing.T) {
 	client := openai.NewClient(
+		option.WithAPIKey("My API Key"),
 		option.WithHTTPClient(&http.Client{
 			Transport: &closureTransport{
 				fn: func(req *http.Request) (*http.Response, error) {
@@ -237,6 +243,7 @@ func TestContextCancel(t *testing.T) {
 
 func TestContextCancelDelay(t *testing.T) {
 	client := openai.NewClient(
+		option.WithAPIKey("My API Key"),
 		option.WithHTTPClient(&http.Client{
 			Transport: &closureTransport{
 				fn: func(req *http.Request) (*http.Response, error) {
@@ -273,6 +280,7 @@ func TestContextDeadline(t *testing.T) {
 
 	go func() {
 		client := openai.NewClient(
+			option.WithAPIKey("My API Key"),
 			option.WithHTTPClient(&http.Client{
 				Transport: &closureTransport{
 					fn: func(req *http.Request) (*http.Response, error) {
@@ -318,6 +326,7 @@ func TestContextDeadlineStreaming(t *testing.T) {
 
 	go func() {
 		client := openai.NewClient(
+			option.WithAPIKey("My API Key"),
 			option.WithHTTPClient(&http.Client{
 				Transport: &closureTransport{
 					fn: func(req *http.Request) (*http.Response, error) {
@@ -371,6 +380,7 @@ func TestContextDeadlineStreamingWithRequestTimeout(t *testing.T) {
 
 	go func() {
 		client := openai.NewClient(
+			option.WithAPIKey("My API Key"),
 			option.WithHTTPClient(&http.Client{
 				Transport: &closureTransport{
 					fn: func(req *http.Request) (*http.Response, error) {

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."),
 		},