openai · stainless-app · Aug 7, 2024 · Aug 1, 2024 · Aug 2, 2024 · Aug 2, 2024
@@ -1,3 +1,3 @@
 {
-  ".": "0.0.1-alpha.0"
+  ".": "0.1.0-alpha.1"
 }
@@ -1,2 +1,2 @@
 configured_endpoints: 68
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-77cfff37114bc9f141c7e6107eb5f1b38d8cc99bc3d4ce03a066db2b6b649c69.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-4097c2f86beb3f3bb021775cd1dfa240e960caf842aeefc2e08da4dc0851ea79.yml
@@ -0,0 +1,18 @@
+# Changelog
+
+## 0.1.0-alpha.1 (2024-08-06)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/openai/openai-go/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* add azure, examples, and message constructors ([fb2df0f](https://github.com/openai/openai-go/commit/fb2df0fe22002f1826bfaa1cb008c45db375885c))
+* **api:** updates ([#5](https://github.com/openai/openai-go/issues/5)) ([9f525e8](https://github.com/openai/openai-go/commit/9f525e85d8fe13cce2a18a1a48179bc5a6d1f094))
+* extract out `ImageModel`, `AudioModel`, `SpeechModel` ([#3](https://github.com/openai/openai-go/issues/3)) ([f085893](https://github.com/openai/openai-go/commit/f085893d109a9e841d1df13df4c71cae06018758))
+* make enums not nominal ([#4](https://github.com/openai/openai-go/issues/4)) ([9f77005](https://github.com/openai/openai-go/commit/9f77005474b8a38cbfc09f22ec3b81d1de62d3c3))
+* publish ([c329601](https://github.com/openai/openai-go/commit/c329601324226e28ff18d6ccecfdde41cedd3b5a))
+
+
+### Chores
+
+* **internal:** updates ([#2](https://github.com/openai/openai-go/issues/2)) ([5976d8d](https://github.com/openai/openai-go/commit/5976d8d8b9a94cd78e4d86f704137f4b43224a08))
@@ -22,7 +22,7 @@ Or to pin the version:
 <!-- x-release-please-start-version -->
 
 ```sh
-go get -u 'github.com/openai/openai-go@v0.0.1-alpha.0'
+go get -u 'github.com/openai/openai-go@v0.1.0-alpha.1'
 ```
 
 <!-- x-release-please-end -->
@@ -51,9 +51,10 @@ func main() {
 		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("OPENAI_API_KEY")
 	)
 	chatCompletion, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{
-		Messages: openai.F([]openai.ChatCompletionMessageParamUnion{
-			 openai.UserMessage("Say this is a test"),
-		}),
+		Messages: openai.F([]openai.ChatCompletionMessageParamUnion{openai.ChatCompletionUserMessageParam{
+			Role:    openai.F(openai.ChatCompletionUserMessageParamRoleUser),
+			Content: openai.F[openai.ChatCompletionUserMessageParamContentUnion](shared.UnionString("Say this is a test")),
+		}}),
 		Model: openai.F(openai.ChatModelGPT4o),
 	})
 	if err != nil {
@@ -236,9 +237,10 @@ defer cancel()
 client.Chat.Completions.New(
 	ctx,
 	openai.ChatCompletionNewParams{
-		Messages: openai.F([]openai.ChatCompletionMessageParamUnion{
-			 openai.UserMessage("Say this is a test"),
-		}),
+		Messages: openai.F([]openai.ChatCompletionMessageParamUnion{openai.ChatCompletionUserMessageParam{
+			Role:    openai.F(openai.ChatCompletionUserMessageParamRoleUser),
+			Content: openai.F[openai.ChatCompletionUserMessageParamContentUnion](shared.UnionString("How can I list all files in a directory using Python?")),
+		}}),
 		Model: openai.F(openai.ChatModelGPT4o),
 	},
 	// This sets the per-retry timeout
@@ -298,9 +300,10 @@ client := openai.NewClient(
 client.Chat.Completions.New(
 	context.TODO(),
 	openai.ChatCompletionNewParams{
-		Messages: openai.F([]openai.ChatCompletionMessageParamUnion{
-			 openai.UserMessage("Say this is a test"),
-		}),
+		Messages: openai.F([]openai.ChatCompletionMessageParamUnion{openai.ChatCompletionUserMessageParam{
+			Role:    openai.F(openai.ChatCompletionUserMessageParamRoleUser),
+			Content: openai.F[openai.ChatCompletionUserMessageParamContentUnion](shared.UnionString("How can I get the name of the current day in Node.js?")),
+		}}),
 		Model: openai.F(openai.ChatModelGPT4o),
 	},
 	option.WithMaxRetries(5),
@@ -393,44 +396,6 @@ You may also replace the default `http.Client` with
 accepted (this overwrites any previous client) and receives requests after any
 middleware has been applied.
 
-## Microsoft Azure OpenAI
-
-To use this library with [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/overview), use the option.RequestOption functions in the `azure` package.
-
-```go
-package main
-
-import (
-	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
-	"github.com/openai/openai-go"
-	"github.com/openai/openai-go/azure"
-	"github.com/openai/openai-go/option"
-)
-
-func main() {
-	const azureOpenAIEndpoint = "https://<azure-openai-resource>.openai.azure.com"
-
-	// The latest API versions, including previews, can be found here:
-	// https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#rest-api-versioning
-	const azureOpenAIAPIVersion = "2024-06-01"
-
-	tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)
-
-	if err != nil {
-		fmt.Printf("Failed to create the DefaultAzureCredential: %s", err)
-		os.Exit(1)
-	}
-
-	client := openai.NewClient(
-		azure.WithEndpoint(azureOpenAIEndpoint, azureOpenAIAPIVersion),
-
-		// Choose between authenticating using a TokenCredential or an API Key
-		azure.WithTokenCredential(tokenCredential),
-		// or azure.WithAPIKey(azureOpenAIAPIKey),
-	)
-}
-```
-
 ## Semantic versioning
 
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

@@ -28,3 +28,39 @@ type FunctionDefinitionParam = shared.FunctionDefinitionParam
 //
 // This is an alias to an internal type.
 type FunctionParameters = shared.FunctionParameters
+
+// This is an alias to an internal type.
+type ResponseFormatJSONObjectParam = shared.ResponseFormatJSONObjectParam
+
+// The type of response format being defined: `json_object`
+//
+// This is an alias to an internal type.
+type ResponseFormatJSONObjectType = shared.ResponseFormatJSONObjectType
+
+// This is an alias to an internal value.
+const ResponseFormatJSONObjectTypeJSONObject = shared.ResponseFormatJSONObjectTypeJSONObject
+
+// This is an alias to an internal type.
+type ResponseFormatJSONSchemaParam = shared.ResponseFormatJSONSchemaParam
+
+// This is an alias to an internal type.
+type ResponseFormatJSONSchemaJSONSchemaParam = shared.ResponseFormatJSONSchemaJSONSchemaParam
+
+// The type of response format being defined: `json_schema`
+//
+// This is an alias to an internal type.
+type ResponseFormatJSONSchemaType = shared.ResponseFormatJSONSchemaType
+
+// This is an alias to an internal value.
+const ResponseFormatJSONSchemaTypeJSONSchema = shared.ResponseFormatJSONSchemaTypeJSONSchema
+
+// This is an alias to an internal type.
+type ResponseFormatTextParam = shared.ResponseFormatTextParam
+
+// The type of response format being defined: `text`
+//
+// This is an alias to an internal type.
+type ResponseFormatTextType = shared.ResponseFormatTextType
+
+// This is an alias to an internal value.
+const ResponseFormatTextTypeText = shared.ResponseFormatTextTypeText
@@ -2,6 +2,9 @@
 
 - <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#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>
 
 # Shared Response Types
 
@@ -34,6 +37,7 @@ Params Types:
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ChatCompletionAssistantMessageParam">ChatCompletionAssistantMessageParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ChatCompletionContentPartUnionParam">ChatCompletionContentPartUnionParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ChatCompletionContentPartImageParam">ChatCompletionContentPartImageParam</a>
+- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ChatCompletionContentPartRefusalParam">ChatCompletionContentPartRefusalParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ChatCompletionContentPartTextParam">ChatCompletionContentPartTextParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ChatCompletionFunctionCallOptionParam">ChatCompletionFunctionCallOptionParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ChatCompletionFunctionMessageParam">ChatCompletionFunctionMessageParam</a>
@@ -87,6 +91,10 @@ Methods:
 
 # Images
 
+Params Types:
+
+- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ImageModel">ImageModel</a>
+
 Response Types:
 
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#Image">Image</a>
@@ -100,6 +108,10 @@ Methods:
 
 # Audio
 
+Params Types:
+
+- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AudioModel">AudioModel</a>
+
 ## Transcriptions
 
 Response Types:
@@ -122,12 +134,20 @@ Methods:
 
 ## Speech
 
+Params Types:
+
+- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#SpeechModel">SpeechModel</a>
+
 Methods:
 
 - <code title="post /audio/speech">client.Audio.Speech.<a href="https://pkg.go.dev/github.com/openai/openai-go#AudioSpeechService.New">New</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, body <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AudioSpeechNewParams">AudioSpeechNewParams</a>) (http.Response, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 
 # Moderations
 
+Params Types:
+
+- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#ModerationModel">ModerationModel</a>
+
 Response Types:
 
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#Moderation">Moderation</a>
@@ -254,16 +274,12 @@ Methods:
 
 Params Types:
 
-- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantResponseFormatParam">AssistantResponseFormatParam</a>
-- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantResponseFormatOptionUnionParam">AssistantResponseFormatOptionUnionParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantToolChoiceParam">AssistantToolChoiceParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantToolChoiceFunctionParam">AssistantToolChoiceFunctionParam</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantToolChoiceOptionUnionParam">AssistantToolChoiceOptionUnionParam</a>
 
 Response Types:
 
-- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantResponseFormat">AssistantResponseFormat</a>
-- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantResponseFormatOptionUnion">AssistantResponseFormatOptionUnion</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantToolChoice">AssistantToolChoice</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantToolChoiceFunction">AssistantToolChoiceFunction</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#AssistantToolChoiceOptionUnion">AssistantToolChoiceOptionUnion</a>
@@ -355,6 +371,8 @@ Response Types:
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#MessageDeleted">MessageDeleted</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#MessageDelta">MessageDelta</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#MessageDeltaEvent">MessageDeltaEvent</a>
+- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#RefusalContentBlock">RefusalContentBlock</a>
+- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#RefusalDeltaBlock">RefusalDeltaBlock</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#Text">Text</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#TextContentBlock">TextContentBlock</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#TextDelta">TextDelta</a>

@@ -30,3 +30,9 @@ func NewAudioService(opts ...option.RequestOption) (r *AudioService) {
 	r.Speech = NewAudioSpeechService(opts...)
 	return
 }
+
+type AudioModel = string
+
+const (
+	AudioModelWhisper1 AudioModel = "whisper-1"
+)
@@ -40,12 +40,19 @@ func (r *AudioSpeechService) New(ctx context.Context, body AudioSpeechNewParams,
 	return
 }
 
+type SpeechModel = string
+
+const (
+	SpeechModelTTS1   SpeechModel = "tts-1"
+	SpeechModelTTS1HD SpeechModel = "tts-1-hd"
+)
+
 type AudioSpeechNewParams struct {
 	// The text to generate audio for. The maximum length is 4096 characters.
 	Input param.Field[string] `json:"input,required"`
 	// One of the available [TTS models](https://platform.openai.com/docs/models/tts):
 	// `tts-1` or `tts-1-hd`
-	Model param.Field[AudioSpeechNewParamsModel] `json:"model,required"`
+	Model param.Field[SpeechModel] `json:"model,required"`
 	// The voice to use when generating the audio. Supported voices are `alloy`,
 	// `echo`, `fable`, `onyx`, `nova`, and `shimmer`. Previews of the voices are
 	// available in the
@@ -63,21 +70,6 @@ func (r AudioSpeechNewParams) MarshalJSON() (data []byte, err error) {
 	return apijson.MarshalRoot(r)
 }
 
-type AudioSpeechNewParamsModel string
-
-const (
-	AudioSpeechNewParamsModelTTS1   AudioSpeechNewParamsModel = "tts-1"
-	AudioSpeechNewParamsModelTTS1HD AudioSpeechNewParamsModel = "tts-1-hd"
-)
-
-func (r AudioSpeechNewParamsModel) IsKnown() bool {
-	switch r {
-	case AudioSpeechNewParamsModelTTS1, AudioSpeechNewParamsModelTTS1HD:
-		return true
-	}
-	return false
-}
-
 // The voice to use when generating the audio. Supported voices are `alloy`,
 // `echo`, `fable`, `onyx`, `nova`, and `shimmer`. Previews of the voices are
 // available in the

@@ -28,7 +28,7 @@ func TestAudioSpeechNewWithOptionalParams(t *testing.T) {
 	)
 	resp, err := client.Audio.Speech.New(context.TODO(), openai.AudioSpeechNewParams{
 		Input:          openai.F("input"),
-		Model:          openai.F(openai.AudioSpeechNewParamsModelTTS1),
+		Model:          openai.F(openai.SpeechModelTTS1),
 		Voice:          openai.F(openai.AudioSpeechNewParamsVoiceAlloy),
 		ResponseFormat: openai.F(openai.AudioSpeechNewParamsResponseFormatMP3),
 		Speed:          openai.F(0.250000),

@@ -72,7 +72,7 @@ type AudioTranscriptionNewParams struct {
 	File param.Field[io.Reader] `json:"file,required" format:"binary"`
 	// ID of the model to use. Only `whisper-1` (which is powered by our open source
 	// Whisper V2 model) is currently available.
-	Model param.Field[AudioTranscriptionNewParamsModel] `json:"model,required"`
+	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.
@@ -114,20 +114,6 @@ func (r AudioTranscriptionNewParams) MarshalMultipart() (data []byte, contentTyp
 	return buf.Bytes(), writer.FormDataContentType(), nil
 }
 
-type AudioTranscriptionNewParamsModel string
-
-const (
-	AudioTranscriptionNewParamsModelWhisper1 AudioTranscriptionNewParamsModel = "whisper-1"
-)
-
-func (r AudioTranscriptionNewParamsModel) IsKnown() bool {
-	switch r {
-	case AudioTranscriptionNewParamsModelWhisper1:
-		return true
-	}
-	return false
-}
-
 // The format of the transcript output, in one of these options: `json`, `text`,
 // `srt`, `verbose_json`, or `vtt`.
 type AudioTranscriptionNewParamsResponseFormat string

@@ -29,7 +29,7 @@ func TestAudioTranscriptionNewWithOptionalParams(t *testing.T) {
 	)
 	_, err := client.Audio.Transcriptions.New(context.TODO(), openai.AudioTranscriptionNewParams{
 		File:                   openai.F(io.Reader(bytes.NewBuffer([]byte("some file contents")))),
-		Model:                  openai.F(openai.AudioTranscriptionNewParamsModelWhisper1),
+		Model:                  openai.F(openai.AudioModelWhisper1),
 		Language:               openai.F("language"),
 		Prompt:                 openai.F("prompt"),
 		ResponseFormat:         openai.F(openai.AudioTranscriptionNewParamsResponseFormatJSON),

@@ -69,7 +69,7 @@ type AudioTranslationNewParams struct {
 	File param.Field[io.Reader] `json:"file,required" format:"binary"`
 	// ID of the model to use. Only `whisper-1` (which is powered by our open source
 	// Whisper V2 model) is currently available.
-	Model param.Field[AudioTranslationNewParamsModel] `json:"model,required"`
+	Model param.Field[AudioModel] `json:"model,required"`
 	// An optional text to guide the model's style or continue a previous audio
 	// segment. The
 	// [prompt](https://platform.openai.com/docs/guides/speech-to-text/prompting)
@@ -100,17 +100,3 @@ func (r AudioTranslationNewParams) MarshalMultipart() (data []byte, contentType
 	}
 	return buf.Bytes(), writer.FormDataContentType(), nil
 }
-
-type AudioTranslationNewParamsModel string
-
-const (
-	AudioTranslationNewParamsModelWhisper1 AudioTranslationNewParamsModel = "whisper-1"
-)
-
-func (r AudioTranslationNewParamsModel) IsKnown() bool {
-	switch r {
-	case AudioTranslationNewParamsModelWhisper1:
-		return true
-	}
-	return false
-}
@@ -29,7 +29,7 @@ func TestAudioTranslationNewWithOptionalParams(t *testing.T) {
 	)
 	_, err := client.Audio.Translations.New(context.TODO(), openai.AudioTranslationNewParams{
 		File:           openai.F(io.Reader(bytes.NewBuffer([]byte("some file contents")))),
-		Model:          openai.F(openai.AudioTranslationNewParamsModelWhisper1),
+		Model:          openai.F(openai.AudioModelWhisper1),
 		Prompt:         openai.F("prompt"),
 		ResponseFormat: openai.F("response_format"),
 		Temperature:    openai.F(0.000000),