Skip to content

Commit 2087fb5

Browse files
feat(api): make model and inputs not required to create response
1 parent 69fb0af commit 2087fb5

File tree

8 files changed

+196
-165
lines changed

8 files changed

+196
-165
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 109
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-9e41d2d5471d2c28bff0d616f4476f5b0e6c541ef4cb51bdaaef5fdf5e13c8b2.yml
3-
openapi_spec_hash: 86f765e18d00e32cf2ce9db7ab84d946
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-f411a68f272b8be0ab0c266043da33228687b9b2d76896724e3cef797de9563d.yml
3+
openapi_spec_hash: 89bf866ea95ecfb3d76c8833237047d6
44
config_hash: dc5515e257676a27cb1ace1784aa92b3

lib/openai/models/responses/response_create_params.rb

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,6 @@ class ResponseCreateParams < OpenAI::Internal::Type::BaseModel
1010
extend OpenAI::Internal::Type::RequestParameters::Converter
1111
include OpenAI::Internal::Type::RequestParameters
1212

13-
# @!attribute input
14-
# Text, image, or file inputs to the model, used to generate a response.
15-
#
16-
# Learn more:
17-
#
18-
# - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
19-
# - [Image inputs](https://platform.openai.com/docs/guides/images)
20-
# - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
21-
# - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
22-
# - [Function calling](https://platform.openai.com/docs/guides/function-calling)
23-
#
24-
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
25-
required :input, union: -> { OpenAI::Responses::ResponseCreateParams::Input }
26-
27-
# @!attribute model
28-
# Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
29-
# wide range of models with different capabilities, performance characteristics,
30-
# and price points. Refer to the
31-
# [model guide](https://platform.openai.com/docs/models) to browse and compare
32-
# available models.
33-
#
34-
# @return [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel]
35-
required :model, union: -> { OpenAI::ResponsesModel }
36-
3713
# @!attribute background
3814
# Whether to run the model response in the background.
3915
# [Learn more](https://platform.openai.com/docs/guides/background).
@@ -63,6 +39,20 @@ class ResponseCreateParams < OpenAI::Internal::Type::BaseModel
6339
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::ResponseIncludable] },
6440
nil?: true
6541

42+
# @!attribute input
43+
# Text, image, or file inputs to the model, used to generate a response.
44+
#
45+
# Learn more:
46+
#
47+
# - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
48+
# - [Image inputs](https://platform.openai.com/docs/guides/images)
49+
# - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
50+
# - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
51+
# - [Function calling](https://platform.openai.com/docs/guides/function-calling)
52+
#
53+
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
54+
optional :input, union: -> { OpenAI::Responses::ResponseCreateParams::Input }
55+
6656
# @!attribute instructions
6757
# A system (or developer) message inserted into the model's context.
6858
#
@@ -92,6 +82,16 @@ class ResponseCreateParams < OpenAI::Internal::Type::BaseModel
9282
# @return [Hash{Symbol=>String}, nil]
9383
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
9484

85+
# @!attribute model
86+
# Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
87+
# wide range of models with different capabilities, performance characteristics,
88+
# and price points. Refer to the
89+
# [model guide](https://platform.openai.com/docs/models) to browse and compare
90+
# available models.
91+
#
92+
# @return [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel, nil]
93+
optional :model, union: -> { OpenAI::ResponsesModel }
94+
9595
# @!attribute parallel_tool_calls
9696
# Whether to allow the model to run tool calls in parallel.
9797
#
@@ -232,24 +232,24 @@ class ResponseCreateParams < OpenAI::Internal::Type::BaseModel
232232
# @return [String, nil]
233233
optional :user, String
234234

235-
# @!method initialize(input:, model:, background: nil, include: nil, instructions: nil, max_output_tokens: nil, metadata: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
235+
# @!method initialize(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
236236
# Some parameter documentations has been truncated, see
237237
# {OpenAI::Models::Responses::ResponseCreateParams} for more details.
238238
#
239-
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
240-
#
241-
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
242-
#
243239
# @param background [Boolean, nil] Whether to run the model response in the background.
244240
#
245241
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
246242
#
243+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
244+
#
247245
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
248246
#
249247
# @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
250248
#
251249
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
252250
#
251+
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
252+
#
253253
# @param parallel_tool_calls [Boolean, nil] Whether to allow the model to run tool calls in parallel.
254254
#
255255
# @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to

0 commit comments

Comments
 (0)