Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.33.0"
".": "0.33.1"
}
6 changes: 3 additions & 3 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 134
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
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## 0.33.1 (2025-10-18)

Full Changelog: [v0.33.0...v0.33.1](https://github.com/openai/openai-ruby/compare/v0.33.0...v0.33.1)

### Bug Fixes

* **api:** internal openapi updates ([1fbce8c](https://github.com/openai/openai-ruby/commit/1fbce8c1158482b361ea48ff996b1998031679bf))

## 0.33.0 (2025-10-17)

Full Changelog: [v0.32.0...v0.33.0](https://github.com/openai/openai-ruby/compare/v0.32.0...v0.33.0)
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GIT
PATH
remote: .
specs:
openai (0.33.0)
openai (0.33.1)
connection_pool

GEM
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
<!-- x-release-please-start-version -->

```ruby
gem "openai", "~> 0.33.0"
gem "openai", "~> 0.33.1"
```

<!-- x-release-please-end -->
Expand Down
4 changes: 0 additions & 4 deletions lib/openai/models/conversations/conversation_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,6 @@ class Action < OpenAI::Internal::Type::BaseModel
optional :working_directory, String, nil?: true

# @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Conversations::ConversationItem::LocalShellCall::Action} for
# more details.
#
# Execute a shell command on the server.
#
# @param command [Array<String>] The command to run.
Expand Down
2 changes: 1 addition & 1 deletion lib/openai/models/conversations/item_list_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class ItemListParams < OpenAI::Internal::Type::BaseModel
#
# @param after [String] An item ID to list items after, used in pagination.
#
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Specify additional output data to include in the model response. Currently
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Specify additional output data to include in the model response. Currently suppo
#
# @param limit [Integer] A limit on the number of objects to be returned. Limit can range between
#
Expand Down
6 changes: 0 additions & 6 deletions lib/openai/models/custom_tool_input_format.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@ module CustomToolInputFormat

discriminator :type

# Unconstrained free-form text.
variant :text, -> { OpenAI::CustomToolInputFormat::Text }

# A grammar defined by the user.
variant :grammar, -> { OpenAI::CustomToolInputFormat::Grammar }

class Text < OpenAI::Internal::Type::BaseModel
Expand All @@ -22,8 +20,6 @@ class Text < OpenAI::Internal::Type::BaseModel
required :type, const: :text

# @!method initialize(type: :text)
# Unconstrained free-form text.
#
# @param type [Symbol, :text] Unconstrained text format. Always `text`.
end

Expand All @@ -47,8 +43,6 @@ class Grammar < OpenAI::Internal::Type::BaseModel
required :type, const: :grammar

# @!method initialize(definition:, syntax:, type: :grammar)
# A grammar defined by the user.
#
# @param definition [String] The grammar definition.
#
# @param syntax [Symbol, OpenAI::Models::CustomToolInputFormat::Grammar::Syntax] The syntax of the grammar definition. One of `lark` or `regex`.
Expand Down
2 changes: 1 addition & 1 deletion lib/openai/models/image_edit_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ class ImageEditParams < OpenAI::Internal::Type::BaseModel
#
# @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil] Allows to set transparency for the background of the generated image(s).
#
# @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil] Control how much effort the model will exert to match the style and features,
# @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
#
# @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart] An additional image whose fully transparent areas (e.g. where alpha is zero) ind
#
Expand Down
6 changes: 0 additions & 6 deletions lib/openai/models/responses/custom_tool.rb
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,6 @@ class CustomTool < OpenAI::Internal::Type::BaseModel
optional :format_, union: -> { OpenAI::CustomToolInputFormat }, api_name: :format

# @!method initialize(name:, description: nil, format_: nil, type: :custom)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::CustomTool} for more details.
#
# 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).
#
# @param name [String] The name of the custom tool, used to identify it in tool calls.
#
# @param description [String] Optional description of the custom tool, used to provide more context.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ class Logs < OpenAI::Internal::Type::BaseModel
required :logs, String

# @!attribute type
# The type of the output. Always 'logs'.
# The type of the output. Always `logs`.
#
# @return [Symbol, :logs]
required :type, const: :logs
Expand All @@ -94,12 +94,12 @@ class Logs < OpenAI::Internal::Type::BaseModel
#
# @param logs [String] The logs output from the code interpreter.
#
# @param type [Symbol, :logs] The type of the output. Always 'logs'.
# @param type [Symbol, :logs] The type of the output. Always `logs`.
end

class Image < OpenAI::Internal::Type::BaseModel
# @!attribute type
# The type of the output. Always 'image'.
# The type of the output. Always `image`.
#
# @return [Symbol, :image]
required :type, const: :image
Expand All @@ -115,7 +115,7 @@ class Image < OpenAI::Internal::Type::BaseModel
#
# @param url [String] The URL of the image output from the code interpreter.
#
# @param type [Symbol, :image] The type of the output. Always 'image'.
# @param type [Symbol, :image] The type of the output. Always `image`.
end

# @!method self.variants
Expand Down
31 changes: 13 additions & 18 deletions lib/openai/models/responses/response_computer_tool_call.rb
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,7 @@ class Click < OpenAI::Internal::Type::BaseModel
required :button, enum: -> { OpenAI::Responses::ResponseComputerToolCall::Action::Click::Button }

# @!attribute type
# 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`.
#
# @return [Symbol, :click]
required :type, const: :click
Expand Down Expand Up @@ -137,7 +136,7 @@ class Click < OpenAI::Internal::Type::BaseModel
#
# @param y_ [Integer] The y-coordinate where the click occurred.
#
# @param type [Symbol, :click] Specifies the event type. For a click action, this property is
# @param type [Symbol, :click] Specifies the event type. For a click action, this property is always `click`.

# Indicates which mouse button was pressed during the click. One of `left`,
# `right`, `wheel`, `back`, or `forward`.
Expand Down Expand Up @@ -188,7 +187,7 @@ class DoubleClick < OpenAI::Internal::Type::BaseModel
#
# @param y_ [Integer] The y-coordinate where the double click occurred.
#
# @param type [Symbol, :double_click] Specifies the event type. For a double click action, this property is
# @param type [Symbol, :double_click] Specifies the event type. For a double click action, this property is always set
end

class Drag < OpenAI::Internal::Type::BaseModel
Expand Down Expand Up @@ -239,11 +238,7 @@ class Path < OpenAI::Internal::Type::BaseModel
required :y_, Integer, api_name: :y

# @!method initialize(x:, y_:)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::ResponseComputerToolCall::Action::Drag::Path} for
# more details.
#
# A series of x/y coordinate pairs in the drag path.
# An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`.
#
# @param x [Integer] The x-coordinate.
#
Expand Down Expand Up @@ -273,9 +268,9 @@ class Keypress < OpenAI::Internal::Type::BaseModel
#
# A collection of keypresses the model would like to perform.
#
# @param keys [Array<String>] The combination of keys the model is requesting to be pressed. This is an
# @param keys [Array<String>] The combination of keys the model is requesting to be pressed. This is an array
#
# @param type [Symbol, :keypress] Specifies the event type. For a keypress action, this property is
# @param type [Symbol, :keypress] Specifies the event type. For a keypress action, this property is always set to
end

class Move < OpenAI::Internal::Type::BaseModel
Expand Down Expand Up @@ -438,23 +433,23 @@ class PendingSafetyCheck < OpenAI::Internal::Type::BaseModel
# @!attribute code
# The type of the pending safety check.
#
# @return [String]
required :code, String
# @return [String, nil]
optional :code, String, nil?: true

# @!attribute message
# Details about the pending safety check.
#
# @return [String]
required :message, String
# @return [String, nil]
optional :message, String, nil?: true

# @!method initialize(id:, code:, message:)
# @!method initialize(id:, code: nil, message: nil)
# A pending safety check for the computer call.
#
# @param id [String] The ID of the pending safety check.
#
# @param code [String] The type of the pending safety check.
# @param code [String, nil] The type of the pending safety check.
#
# @param message [String] Details about the pending safety check.
# @param message [String, nil] Details about the pending safety check.
end

# The status of the item. One of `in_progress`, `completed`, or `incomplete`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,23 +70,23 @@ class AcknowledgedSafetyCheck < OpenAI::Internal::Type::BaseModel
# @!attribute code
# The type of the pending safety check.
#
# @return [String]
required :code, String
# @return [String, nil]
optional :code, String, nil?: true

# @!attribute message
# Details about the pending safety check.
#
# @return [String]
required :message, String
# @return [String, nil]
optional :message, String, nil?: true

# @!method initialize(id:, code:, message:)
# @!method initialize(id:, code: nil, message: nil)
# A pending safety check for the computer call.
#
# @param id [String] The ID of the pending safety check.
#
# @param code [String] The type of the pending safety check.
# @param code [String, nil] The type of the pending safety check.
#
# @param message [String] Details about the pending safety check.
# @param message [String, nil] Details about the pending safety check.
end

# The status of the message input. One of `in_progress`, `completed`, or
Expand Down
2 changes: 1 addition & 1 deletion lib/openai/models/responses/response_create_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ class ResponseCreateParams < OpenAI::Internal::Type::BaseModel
#
# @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
#
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
#
# @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::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
#
Expand Down
8 changes: 5 additions & 3 deletions lib/openai/models/responses/response_includable.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,14 @@ module Responses
module ResponseIncludable
extend OpenAI::Internal::Type::Enum

CODE_INTERPRETER_CALL_OUTPUTS = :"code_interpreter_call.outputs"
COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL = :"computer_call_output.output.image_url"
FILE_SEARCH_CALL_RESULTS = :"file_search_call.results"
WEB_SEARCH_CALL_RESULTS = :"web_search_call.results"
WEB_SEARCH_CALL_ACTION_SOURCES = :"web_search_call.action.sources"
MESSAGE_INPUT_IMAGE_IMAGE_URL = :"message.input_image.image_url"
MESSAGE_OUTPUT_TEXT_LOGPROBS = :"message.output_text.logprobs"
COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL = :"computer_call_output.output.image_url"
CODE_INTERPRETER_CALL_OUTPUTS = :"code_interpreter_call.outputs"
REASONING_ENCRYPTED_CONTENT = :"reasoning.encrypted_content"
MESSAGE_OUTPUT_TEXT_LOGPROBS = :"message.output_text.logprobs"

# @!method self.values
# @return [Array<Symbol>]
Expand Down
4 changes: 0 additions & 4 deletions lib/openai/models/responses/response_input_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -508,10 +508,6 @@ class Action < OpenAI::Internal::Type::BaseModel
optional :working_directory, String, nil?: true

# @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::ResponseInputItem::LocalShellCall::Action} for more
# details.
#
# Execute a shell command on the server.
#
# @param command [Array<String>] The command to run.
Expand Down
4 changes: 0 additions & 4 deletions lib/openai/models/responses/response_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,6 @@ class Action < OpenAI::Internal::Type::BaseModel
optional :working_directory, String, nil?: true

# @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::ResponseItem::LocalShellCall::Action} for more
# details.
#
# Execute a shell command on the server.
#
# @param command [Array<String>] The command to run.
Expand Down
4 changes: 0 additions & 4 deletions lib/openai/models/responses/response_output_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,6 @@ class Action < OpenAI::Internal::Type::BaseModel
optional :working_directory, String, nil?: true

# @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall::Action} for more
# details.
#
# Execute a shell command on the server.
#
# @param command [Array<String>] The command to run.
Expand Down
14 changes: 2 additions & 12 deletions lib/openai/models/responses/tool.rb
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,8 @@ module Tool
# A tool that generates images using a model like `gpt-image-1`.
variant :image_generation, -> { OpenAI::Responses::Tool::ImageGeneration }

# A tool that allows the model to execute shell commands in a local environment.
variant :local_shell, -> { OpenAI::Responses::Tool::LocalShell }

# 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).
variant :custom, -> { OpenAI::Responses::CustomTool }

# Search the Internet for sources related to the prompt. Learn more about the
Expand Down Expand Up @@ -375,8 +372,7 @@ module Container
# The container ID.
variant String

# Configuration for a code interpreter container. Optionally specify the IDs
# of the files to run the code on.
# Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
variant -> { OpenAI::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto }

class CodeInterpreterToolAuto < OpenAI::Internal::Type::BaseModel
Expand All @@ -393,10 +389,6 @@ class CodeInterpreterToolAuto < OpenAI::Internal::Type::BaseModel
optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]

# @!method initialize(file_ids: nil, type: :auto)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto}
# for more details.
#
# Configuration for a code interpreter container. Optionally specify the IDs of
# the files to run the code on.
#
Expand Down Expand Up @@ -498,7 +490,7 @@ class ImageGeneration < OpenAI::Internal::Type::BaseModel
#
# @param background [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Background] Background type for the generated image. One of `transparent`,
#
# @param input_fidelity [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::InputFidelity, nil] Control how much effort the model will exert to match the style and features,
# @param input_fidelity [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::InputFidelity, nil]
#
# @param input_image_mask [OpenAI::Models::Responses::Tool::ImageGeneration::InputImageMask] Optional mask for inpainting. Contains `image_url`
#
Expand Down Expand Up @@ -658,8 +650,6 @@ class LocalShell < OpenAI::Internal::Type::BaseModel
required :type, const: :local_shell

# @!method initialize(type: :local_shell)
# A tool that allows the model to execute shell commands in a local environment.
#
# @param type [Symbol, :local_shell] The type of the local shell tool. Always `local_shell`.
end

Expand Down
Loading