chore(api): event shapes more accurate

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 97
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-670ea0d2cc44f52a87dd3cadea45632953283e0636ba30788fdbdb22a232ccac.yml
-openapi_spec_hash: d8b7d38911fead545adf3e4297956410
-config_hash: b2a4028fdbb27a08de89831ed310e244
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-b2a451656ca64d30d174391ebfd94806b4de3ab76dc55b92843cfb7f1a54ecb6.yml
+openapi_spec_hash: 27d9691b400f28c17ef063a1374048b0
+config_hash: e822d0c9082c8b312264403949243179

api.md

@@ -710,8 +710,6 @@ Response Types:
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/responses">responses</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/responses#ResponseOutputTextAnnotationAddedEvent">ResponseOutputTextAnnotationAddedEvent</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/responses">responses</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/responses#ResponsePrompt">ResponsePrompt</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/responses">responses</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/responses#ResponseQueuedEvent">ResponseQueuedEvent</a>
-- <a href="https://pkg.go.dev/github.com/openai/openai-go/responses">responses</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/responses#ResponseReasoningDeltaEvent">ResponseReasoningDeltaEvent</a>
-- <a href="https://pkg.go.dev/github.com/openai/openai-go/responses">responses</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/responses#ResponseReasoningDoneEvent">ResponseReasoningDoneEvent</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/responses">responses</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/responses#ResponseReasoningItem">ResponseReasoningItem</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/responses">responses</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/responses#ResponseReasoningSummaryDeltaEvent">ResponseReasoningSummaryDeltaEvent</a>
 - <a href="https://pkg.go.dev/github.com/openai/openai-go/responses">responses</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go/responses#ResponseReasoningSummaryDoneEvent">ResponseReasoningSummaryDoneEvent</a>

audiospeech.go

@@ -98,9 +98,6 @@ const (
 	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"

chatcompletion.go

@@ -180,7 +180,7 @@ type ChatCompletion struct {
 	//   - If set to 'auto', then the request will be processed with the service tier
 	//     configured in the Project settings. Unless otherwise configured, the Project
 	//     will use 'default'.
-	//   - If set to 'default', then the requset will be processed with the standard
+	//   - If set to 'default', then the request will be processed with the standard
 	//     pricing and performance for the selected model.
 	//   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
 	//     'priority', then the request will be processed with the corresponding service
@@ -282,7 +282,7 @@ func (r *ChatCompletionChoiceLogprobs) UnmarshalJSON(data []byte) error {
 //   - If set to 'auto', then the request will be processed with the service tier
 //     configured in the Project settings. Unless otherwise configured, the Project
 //     will use 'default'.
-//   - If set to 'default', then the requset will be processed with the standard
+//   - If set to 'default', then the request will be processed with the standard
 //     pricing and performance for the selected model.
 //   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
 //     'priority', then the request will be processed with the corresponding service
@@ -547,9 +547,6 @@ 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"
@@ -577,7 +574,7 @@ type ChatCompletionChunk struct {
 	//   - If set to 'auto', then the request will be processed with the service tier
 	//     configured in the Project settings. Unless otherwise configured, the Project
 	//     will use 'default'.
-	//   - If set to 'default', then the requset will be processed with the standard
+	//   - If set to 'default', then the request will be processed with the standard
 	//     pricing and performance for the selected model.
 	//   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
 	//     'priority', then the request will be processed with the corresponding service
@@ -794,7 +791,7 @@ func (r *ChatCompletionChunkChoiceLogprobs) UnmarshalJSON(data []byte) error {
 //   - If set to 'auto', then the request will be processed with the service tier
 //     configured in the Project settings. Unless otherwise configured, the Project
 //     will use 'default'.
-//   - If set to 'default', then the requset will be processed with the standard
+//   - If set to 'default', then the request will be processed with the standard
 //     pricing and performance for the selected model.
 //   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
 //     'priority', then the request will be processed with the corresponding service
@@ -2227,7 +2224,7 @@ type ChatCompletionNewParams struct {
 	//   - If set to 'auto', then the request will be processed with the service tier
 	//     configured in the Project settings. Unless otherwise configured, the Project
 	//     will use 'default'.
-	//   - If set to 'default', then the requset will be processed with the standard
+	//   - If set to 'default', then the request will be processed with the standard
 	//     pricing and performance for the selected model.
 	//   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
 	//     'priority', then the request will be processed with the corresponding service
@@ -2429,7 +2426,7 @@ func (u ChatCompletionNewParamsResponseFormatUnion) GetType() *string {
 //   - If set to 'auto', then the request will be processed with the service tier
 //     configured in the Project settings. Unless otherwise configured, the Project
 //     will use 'default'.
-//   - If set to 'default', then the requset will be processed with the standard
+//   - If set to 'default', then the request will be processed with the standard
 //     pricing and performance for the selected model.
 //   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
 //     'priority', then the request will be processed with the corresponding service

image.go

@@ -812,7 +812,7 @@ type ImagesResponseUsage struct {
 	InputTokens int64 `json:"input_tokens,required"`
 	// The input tokens detailed information for the image generation.
 	InputTokensDetails ImagesResponseUsageInputTokensDetails `json:"input_tokens_details,required"`
-	// The number of image tokens in the output image.
+	// The number of output tokens generated by the model.
 	OutputTokens int64 `json:"output_tokens,required"`
 	// The total number of tokens (images and text) used for the image generation.
 	TotalTokens int64 `json:"total_tokens,required"`
@@ -940,6 +940,9 @@ type ImageEditParams struct {
 	// The number of partial images to generate. This parameter is used for streaming
 	// responses that return partial images. Value must be between 0 and 3. When set to
 	// 0, the response will be a single image sent in one streaming event.
+	//
+	// Note that the final image may be sent before the full number of partial images
+	// are generated if the full image is generated more quickly.
 	PartialImages param.Opt[int64] `json:"partial_images,omitzero"`
 	// A unique identifier representing your end-user, which can help OpenAI to monitor
 	// and detect abuse.
@@ -1130,6 +1133,9 @@ type ImageGenerateParams struct {
 	// The number of partial images to generate. This parameter is used for streaming
 	// responses that return partial images. Value must be between 0 and 3. When set to
 	// 0, the response will be a single image sent in one streaming event.
+	//
+	// Note that the final image may be sent before the full number of partial images
+	// are generated if the full image is generated more quickly.
 	PartialImages param.Opt[int64] `json:"partial_images,omitzero"`
 	// A unique identifier representing your end-user, which can help OpenAI to monitor
 	// and detect abuse.