fix(api): internal openapi updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 122
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-f59befea071ed7729cbb7bce219e7f837eccfdb57e01698514e6a0bd6052ff60.yml
-openapi_spec_hash: 49da48619d37932b2e257c532078b2bb
-config_hash: 1af83449a09a3b4f276444dbcdd3eb67
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-b062c33330de7e3bbf992fd4f0799afd868c30a66c39418dd2c62f4add3b45b6.yml
+openapi_spec_hash: fe067f5b1c0e93799b5ea7fde3c4b1b3
+config_hash: 4b6f471b24d659514b86b736c90a0c0a

aliases.go

@@ -294,13 +294,9 @@ type CompoundFilterParam = shared.CompoundFilterParam
 // This is an alias to an internal type.
 type CustomToolInputFormatUnion = shared.CustomToolInputFormatUnion
 
-// Unconstrained free-form text.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatText = shared.CustomToolInputFormatText
 
-// A grammar defined by the user.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatGrammar = shared.CustomToolInputFormatGrammar
 
@@ -309,13 +305,9 @@ type CustomToolInputFormatGrammar = shared.CustomToolInputFormatGrammar
 // This is an alias to an internal type.
 type CustomToolInputFormatUnionParam = shared.CustomToolInputFormatUnionParam
 
-// Unconstrained free-form text.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatTextParam = shared.CustomToolInputFormatTextParam
 
-// A grammar defined by the user.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatGrammarParam = shared.CustomToolInputFormatGrammarParam
 

conversations/aliases.go

@@ -294,13 +294,9 @@ type CompoundFilterParam = shared.CompoundFilterParam
 // This is an alias to an internal type.
 type CustomToolInputFormatUnion = shared.CustomToolInputFormatUnion
 
-// Unconstrained free-form text.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatText = shared.CustomToolInputFormatText
 
-// A grammar defined by the user.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatGrammar = shared.CustomToolInputFormatGrammar
 
@@ -309,13 +305,9 @@ type CustomToolInputFormatGrammar = shared.CustomToolInputFormatGrammar
 // This is an alias to an internal type.
 type CustomToolInputFormatUnionParam = shared.CustomToolInputFormatUnionParam
 
-// Unconstrained free-form text.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatTextParam = shared.CustomToolInputFormatTextParam
 
-// A grammar defined by the user.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatGrammarParam = shared.CustomToolInputFormatGrammarParam
 

conversations/item_test.go

@@ -40,7 +40,7 @@ func TestItemNewWithOptionalParams(t *testing.T) {
 					Type: responses.EasyInputMessageTypeMessage,
 				},
 			}},
-			Include: []responses.ResponseIncludable{responses.ResponseIncludableCodeInterpreterCallOutputs},
+			Include: []responses.ResponseIncludable{responses.ResponseIncludableFileSearchCallResults},
 		},
 	)
 	if err != nil {
@@ -69,7 +69,7 @@ func TestItemGetWithOptionalParams(t *testing.T) {
 		"conv_123",
 		"msg_abc",
 		conversations.ItemGetParams{
-			Include: []responses.ResponseIncludable{responses.ResponseIncludableCodeInterpreterCallOutputs},
+			Include: []responses.ResponseIncludable{responses.ResponseIncludableFileSearchCallResults},
 		},
 	)
 	if err != nil {
@@ -98,7 +98,7 @@ func TestItemListWithOptionalParams(t *testing.T) {
 		"conv_123",
 		conversations.ItemListParams{
 			After:   openai.String("after"),
-			Include: []responses.ResponseIncludable{responses.ResponseIncludableCodeInterpreterCallOutputs},
+			Include: []responses.ResponseIncludable{responses.ResponseIncludableFileSearchCallResults},
 			Limit:   openai.Int(0),
 			Order:   conversations.ItemListParamsOrderAsc,
 		},

image.go

@@ -960,10 +960,7 @@ type ImageEditParams struct {
 	//
 	// Any of "transparent", "opaque", "auto".
 	Background ImageEditParamsBackground `json:"background,omitzero"`
-	// Control how much effort the model will exert to match the style and features,
-	// especially facial features, of input images. This parameter is only supported
-	// for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
-	// `low`. Defaults to `low`.
+	// Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
 	//
 	// Any of "high", "low".
 	InputFidelity ImageEditParamsInputFidelity `json:"input_fidelity,omitzero"`
@@ -1062,10 +1059,7 @@ const (
 	ImageEditParamsBackgroundAuto        ImageEditParamsBackground = "auto"
 )
 
-// Control how much effort the model will exert to match the style and features,
-// especially facial features, of input images. This parameter is only supported
-// for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
-// `low`. Defaults to `low`.
+// Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
 type ImageEditParamsInputFidelity string
 
 const (

realtime/aliases.go

@@ -294,13 +294,9 @@ type CompoundFilterParam = shared.CompoundFilterParam
 // This is an alias to an internal type.
 type CustomToolInputFormatUnion = shared.CustomToolInputFormatUnion
 
-// Unconstrained free-form text.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatText = shared.CustomToolInputFormatText
 
-// A grammar defined by the user.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatGrammar = shared.CustomToolInputFormatGrammar
 
@@ -309,13 +305,9 @@ type CustomToolInputFormatGrammar = shared.CustomToolInputFormatGrammar
 // This is an alias to an internal type.
 type CustomToolInputFormatUnionParam = shared.CustomToolInputFormatUnionParam
 
-// Unconstrained free-form text.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatTextParam = shared.CustomToolInputFormatTextParam
 
-// A grammar defined by the user.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatGrammarParam = shared.CustomToolInputFormatGrammarParam
 

responses/aliases.go

@@ -294,13 +294,9 @@ type CompoundFilterParam = shared.CompoundFilterParam
 // This is an alias to an internal type.
 type CustomToolInputFormatUnion = shared.CustomToolInputFormatUnion
 
-// Unconstrained free-form text.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatText = shared.CustomToolInputFormatText
 
-// A grammar defined by the user.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatGrammar = shared.CustomToolInputFormatGrammar
 
@@ -309,13 +305,9 @@ type CustomToolInputFormatGrammar = shared.CustomToolInputFormatGrammar
 // This is an alias to an internal type.
 type CustomToolInputFormatUnionParam = shared.CustomToolInputFormatUnionParam
 
-// Unconstrained free-form text.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatTextParam = shared.CustomToolInputFormatTextParam
 
-// A grammar defined by the user.
-//
 // This is an alias to an internal type.
 type CustomToolInputFormatGrammarParam = shared.CustomToolInputFormatGrammarParam
 

responses/inputitem_test.go

@@ -31,7 +31,7 @@ func TestInputItemListWithOptionalParams(t *testing.T) {
 		"response_id",
 		responses.InputItemListParams{
 			After:   openai.String("after"),
-			Include: []responses.ResponseIncludable{responses.ResponseIncludableCodeInterpreterCallOutputs},
+			Include: []responses.ResponseIncludable{responses.ResponseIncludableFileSearchCallResults},
 			Limit:   openai.Int(0),
 			Order:   responses.InputItemListParamsOrderAsc,
 		},

responses/response.go

@@ -221,8 +221,6 @@ func (r *ComputerToolParam) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, r)
 }
 
-// A custom tool that processes input using a specified format. Learn more about
-// [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools).
 type CustomTool struct {
 	// The name of the custom tool, used to identify it in tool calls.
 	Name string `json:"name,required"`
@@ -258,9 +256,6 @@ func (r CustomTool) ToParam() CustomToolParam {
 	return param.Override[CustomToolParam](json.RawMessage(r.RawJSON()))
 }
 
-// A custom tool that processes input using a specified format. Learn more about
-// [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools).
-//
 // The properties Name, Type are required.
 type CustomToolParam struct {
 	// The name of the custom tool, used to identify it in tool calls.
@@ -1704,7 +1699,7 @@ func (r *ResponseCodeInterpreterToolCallOutputUnion) UnmarshalJSON(data []byte)
 type ResponseCodeInterpreterToolCallOutputLogs struct {
 	// The logs output from the code interpreter.
 	Logs string `json:"logs,required"`
-	// The type of the output. Always 'logs'.
+	// The type of the output. Always `logs`.
 	Type constant.Logs `json:"type,required"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
@@ -1723,7 +1718,7 @@ func (r *ResponseCodeInterpreterToolCallOutputLogs) UnmarshalJSON(data []byte) e
 
 // The image output from the code interpreter.
 type ResponseCodeInterpreterToolCallOutputImage struct {
-	// The type of the output. Always 'image'.
+	// The type of the output. Always `image`.
 	Type constant.Image `json:"type,required"`
 	// The URL of the image output from the code interpreter.
 	URL string `json:"url,required"`
@@ -1845,7 +1840,7 @@ func (u ResponseCodeInterpreterToolCallOutputUnionParam) GetType() *string {
 type ResponseCodeInterpreterToolCallOutputLogsParam struct {
 	// The logs output from the code interpreter.
 	Logs string `json:"logs,required"`
-	// The type of the output. Always 'logs'.
+	// The type of the output. Always `logs`.
 	//
 	// This field can be elided, and will marshal its zero value as "logs".
 	Type constant.Logs `json:"type,required"`
@@ -1866,7 +1861,7 @@ func (r *ResponseCodeInterpreterToolCallOutputLogsParam) UnmarshalJSON(data []by
 type ResponseCodeInterpreterToolCallOutputImageParam struct {
 	// The URL of the image output from the code interpreter.
 	URL string `json:"url,required"`
-	// The type of the output. Always 'image'.
+	// The type of the output. Always `image`.
 	//
 	// This field can be elided, and will marshal its zero value as "image".
 	Type constant.Image `json:"type,required"`
@@ -2117,8 +2112,7 @@ type ResponseComputerToolCallActionClick struct {
 	//
 	// Any of "left", "right", "wheel", "back", "forward".
 	Button string `json:"button,required"`
-	// Specifies the event type. For a click action, this property is always set to
-	// `click`.
+	// Specifies the event type. For a click action, this property is always `click`.
 	Type constant.Click `json:"type,required"`
 	// The x-coordinate where the click occurred.
 	X int64 `json:"x,required"`
@@ -2198,7 +2192,7 @@ func (r *ResponseComputerToolCallActionDrag) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, r)
 }
 
-// A series of x/y coordinate pairs in the drag path.
+// An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`.
 type ResponseComputerToolCallActionDragPath struct {
 	// The x-coordinate.
 	X int64 `json:"x,required"`
@@ -2363,9 +2357,9 @@ type ResponseComputerToolCallPendingSafetyCheck struct {
 	// The ID of the pending safety check.
 	ID string `json:"id,required"`
 	// The type of the pending safety check.
-	Code string `json:"code,required"`
+	Code string `json:"code,nullable"`
 	// Details about the pending safety check.
-	Message string `json:"message,required"`
+	Message string `json:"message,nullable"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
 		ID          respjson.Field
@@ -2601,8 +2595,7 @@ type ResponseComputerToolCallActionClickParam struct {
 	X int64 `json:"x,required"`
 	// The y-coordinate where the click occurred.
 	Y int64 `json:"y,required"`
-	// Specifies the event type. For a click action, this property is always set to
-	// `click`.
+	// Specifies the event type. For a click action, this property is always `click`.
 	//
 	// This field can be elided, and will marshal its zero value as "click".
 	Type constant.Click `json:"type,required"`
@@ -2673,7 +2666,7 @@ func (r *ResponseComputerToolCallActionDragParam) UnmarshalJSON(data []byte) err
 	return apijson.UnmarshalRoot(data, r)
 }
 
-// A series of x/y coordinate pairs in the drag path.
+// An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`.
 //
 // The properties X, Y are required.
 type ResponseComputerToolCallActionDragPathParam struct {
@@ -2841,14 +2834,14 @@ func (r *ResponseComputerToolCallActionWaitParam) UnmarshalJSON(data []byte) err
 
 // A pending safety check for the computer call.
 //
-// The properties ID, Code, Message are required.
+// The property ID is required.
 type ResponseComputerToolCallPendingSafetyCheckParam struct {
 	// The ID of the pending safety check.
 	ID string `json:"id,required"`
 	// The type of the pending safety check.
-	Code string `json:"code,required"`
+	Code param.Opt[string] `json:"code,omitzero"`
 	// Details about the pending safety check.
-	Message string `json:"message,required"`
+	Message param.Opt[string] `json:"message,omitzero"`
 	paramObj
 }
 
@@ -2903,9 +2896,9 @@ type ResponseComputerToolCallOutputItemAcknowledgedSafetyCheck struct {
 	// The ID of the pending safety check.
 	ID string `json:"id,required"`
 	// The type of the pending safety check.
-	Code string `json:"code,required"`
+	Code string `json:"code,nullable"`
 	// Details about the pending safety check.
-	Message string `json:"message,required"`
+	Message string `json:"message,nullable"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
 		ID          respjson.Field
@@ -5586,12 +5579,14 @@ func (r *ResponseInProgressEvent) UnmarshalJSON(data []byte) error {
 type ResponseIncludable string
 
 const (
-	ResponseIncludableCodeInterpreterCallOutputs       ResponseIncludable = "code_interpreter_call.outputs"
-	ResponseIncludableComputerCallOutputOutputImageURL ResponseIncludable = "computer_call_output.output.image_url"
 	ResponseIncludableFileSearchCallResults            ResponseIncludable = "file_search_call.results"
+	ResponseIncludableWebSearchCallResults             ResponseIncludable = "web_search_call.results"
+	ResponseIncludableWebSearchCallActionSources       ResponseIncludable = "web_search_call.action.sources"
 	ResponseIncludableMessageInputImageImageURL        ResponseIncludable = "message.input_image.image_url"
-	ResponseIncludableMessageOutputTextLogprobs        ResponseIncludable = "message.output_text.logprobs"
+	ResponseIncludableComputerCallOutputOutputImageURL ResponseIncludable = "computer_call_output.output.image_url"
+	ResponseIncludableCodeInterpreterCallOutputs       ResponseIncludable = "code_interpreter_call.outputs"
 	ResponseIncludableReasoningEncryptedContent        ResponseIncludable = "reasoning.encrypted_content"
+	ResponseIncludableMessageOutputTextLogprobs        ResponseIncludable = "message.output_text.logprobs"
 )
 
 // An event that is emitted when a response finishes as incomplete.
@@ -13503,10 +13498,7 @@ type ToolImageGeneration struct {
 	//
 	// Any of "transparent", "opaque", "auto".
 	Background string `json:"background"`
-	// Control how much effort the model will exert to match the style and features,
-	// especially facial features, of input images. This parameter is only supported
-	// for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
-	// `low`. Defaults to `low`.
+	// Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
 	//
 	// Any of "high", "low".
 	InputFidelity string `json:"input_fidelity,nullable"`
@@ -13587,7 +13579,6 @@ func (r *ToolImageGenerationInputImageMask) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, r)
 }
 
-// A tool that allows the model to execute shell commands in a local environment.
 type ToolLocalShell struct {
 	// The type of the local shell tool. Always `local_shell`.
 	Type constant.LocalShell `json:"type,required"`
@@ -14422,10 +14413,7 @@ type ToolImageGenerationParam struct {
 	// Number of partial images to generate in streaming mode, from 0 (default value)
 	// to 3.
 	PartialImages param.Opt[int64] `json:"partial_images,omitzero"`
-	// Control how much effort the model will exert to match the style and features,
-	// especially facial features, of input images. This parameter is only supported
-	// for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
-	// `low`. Defaults to `low`.
+	// Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
 	//
 	// Any of "high", "low".
 	InputFidelity string `json:"input_fidelity,omitzero"`
@@ -14523,8 +14511,6 @@ func NewToolLocalShellParam() ToolLocalShellParam {
 	}
 }
 
-// A tool that allows the model to execute shell commands in a local environment.
-//
 // This struct has a constant value, construct it with [NewToolLocalShellParam].
 type ToolLocalShellParam struct {
 	// The type of the local shell tool. Always `local_shell`.

responses/response_test.go

@@ -32,7 +32,7 @@ func TestResponseNewWithOptionalParams(t *testing.T) {
 		Conversation: responses.ResponseNewParamsConversationUnion{
 			OfString: openai.String("string"),
 		},
-		Include: []responses.ResponseIncludable{responses.ResponseIncludableCodeInterpreterCallOutputs},
+		Include: []responses.ResponseIncludable{responses.ResponseIncludableFileSearchCallResults},
 		Input: responses.ResponseNewParamsInputUnion{
 			OfString: openai.String("string"),
 		},
@@ -116,7 +116,7 @@ func TestResponseGetWithOptionalParams(t *testing.T) {
 		context.TODO(),
 		"resp_677efb5139a88190b512bc3fef8e535d",
 		responses.ResponseGetParams{
-			Include:            []responses.ResponseIncludable{responses.ResponseIncludableCodeInterpreterCallOutputs},
+			Include:            []responses.ResponseIncludable{responses.ResponseIncludableFileSearchCallResults},
 			IncludeObfuscation: openai.Bool(true),
 			StartingAfter:      openai.Int(0),
 		},