openai 0.120.0 → 0.121.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b74591c6b8e30d6e7eca63fbc88dd793ae02202cecb6d702dad6f64822ae0ab
-  data.tar.gz: 9fbcf7d70ec1521ab062a9b556154203933b1bd1aa161277b1f2d00bdbfe0efa
+  metadata.gz: ce7067efbf60066bd6974ff82a38884ef04c19d4721f00611d54dc1b1875a4b3
+  data.tar.gz: 4068623e1e610b9b5c8ba531082c2a8be68e120a8e40281ab8a712700de55b93
 SHA512:
-  metadata.gz: 1370128e59bcd5e0249a94c1236ce20da128e74ec94777dfc8b0f9f74642e08e77fcfefdaa6c3b0141923550ef109fe8b5288cb06289d9015a681ea36bb9ae13
-  data.tar.gz: 693b68d2fa4d778f6d18485bf32b501596780d2dfb7fd9fead819a255a6e4a52b5997b37ad1f1d099a91a6acd6ef25ea8bb4cc13fc54d939b980b3f33bc778f2
+  metadata.gz: ab69834a768a327fdc77f87b33d15842b5d8e1c467cf1c00b5ebdeea655dda7e46b823ad4dfc5dd9ef829445a7fbeec866cbb854c24b8f5cec4ca55473582637
+  data.tar.gz: c3da784e892417ca10617d6b590fdecce3657f6dbf0468fef0942a144dda638b7e468c98fd3fdd7b4b0a54fdf1cc9e90e09a665bdb627804eba62fe64161314a

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.121.0](https://github.com/openai/openai-ruby/compare/v0.120.0...v0.121.0) (2026-11-07)
+
+
+### Features
+
+* **api:** add agent scheduling APIs ([#1046](https://github.com/openai/openai-ruby/issues/1046)) ([4d0e09c](https://github.com/openai/openai-ruby/commit/4d0e09ce1df41e8f6442ae489c8ee9f1237cfc74))
+* **api:** add gpt-6-rosalind to beta Responses requests ([#1047](https://github.com/openai/openai-ruby/issues/1047)) ([d6461e6](https://github.com/openai/openai-ruby/commit/d6461e646fd8b747848d590a220da3fbbcc95259))
+
+
+### Documentation
+
+* consolidate AGENTS.md guidance ([#1044](https://github.com/openai/openai-ruby/issues/1044)) ([7b2dd7a](https://github.com/openai/openai-ruby/commit/7b2dd7ac84585b73d41938d9d9a547b682429c89))
+
 ## [0.120.0](https://github.com/openai/openai-ruby/compare/v0.119.0...v0.120.0) (2026-11-05)
 
 

data/README.md

@@ -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.120.0"
+gem "openai", "~> 0.121.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/openai/models/beta/agents/automation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # A saved automation and its schedule.
+        #
+        # @see OpenAI::Resources::Beta::Agents::Automations#create
+        module Automation
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # Fields shared by periodic and one-time automations.
+          variant :periodic, -> { OpenAI::Beta::Agents::PeriodicAutomation }
+
+          # Fields shared by periodic and one-time automations.
+          variant :once, -> { OpenAI::Beta::Agents::OneTimeAutomation }
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::Agents::PeriodicAutomation, OpenAI::Models::Beta::Agents::OneTimeAutomation)]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/automation_agent_config.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        class AutomationAgentConfig < OpenAI::Internal::Type::BaseModel
+          # @!attribute instructions
+          #   Custom instructions, or null when absent.
+          #
+          #   @return [String, nil]
+          required :instructions, String, nil?: true
+
+          # @!attribute model
+          #   The requested model name.
+          #
+          #   @return [String]
+          required :model, String
+
+          # @!attribute multi_agent
+          #   The configuration for creating and coordinating subagents.
+          #
+          #   @return [OpenAI::Models::Beta::MultiAgentConfig]
+          required :multi_agent, -> { OpenAI::Beta::MultiAgentConfig }
+
+          # @!attribute reasoning
+          #   The configured reasoning policy.
+          #
+          #   @return [OpenAI::Models::Beta::AgentReasoning]
+          required :reasoning, -> { OpenAI::Beta::AgentReasoning }
+
+          # @!attribute service_tier
+          #   The configured service-tier policy.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::Agents::AutomationAgentConfig::ServiceTier]
+          required :service_tier, enum: -> { OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier }
+
+          # @!attribute text
+          #   The configured output format and verbosity.
+          #
+          #   @return [OpenAI::Models::Beta::AgentText]
+          required :text, -> { OpenAI::Beta::AgentText }
+
+          # @!attribute tools
+          #   Configured tools, excluding confidential credentials.
+          #
+          #   @return [Array<OpenAI::Models::Beta::AgentTool::Function, OpenAI::Models::Beta::AgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentTool::Mcp, OpenAI::Models::Beta::AgentTool::WebSearch, OpenAI::Models::Beta::AgentTool::ComputerUse, OpenAI::Models::Beta::AgentTool::Automations>]
+          required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentTool] }
+
+          # @!attribute compaction
+          #   The effective context compaction settings.
+          #
+          #   @return [OpenAI::Models::Beta::Agents::AutomationAgentConfig::Compaction, nil]
+          optional :compaction, -> { OpenAI::Beta::Agents::AutomationAgentConfig::Compaction }
+
+          # @!attribute experimental
+          #   The effective experimental settings for the agent.
+          #
+          #   @return [OpenAI::Models::Beta::Agents::AutomationAgentConfig::Experimental, nil]
+          optional :experimental, -> { OpenAI::Beta::Agents::AutomationAgentConfig::Experimental }
+
+          # @!method initialize(instructions:, model:, multi_agent:, reasoning:, service_tier:, text:, tools:, compaction: nil, experimental: nil)
+          #   Inline agent configuration without a generated session-local identity.
+          #
+          #   @param instructions [String, nil]
+          #     Custom instructions, or null when absent.
+          #
+          #   @param model [String]
+          #     The requested model name.
+          #
+          #   @param multi_agent [OpenAI::Models::Beta::MultiAgentConfig]
+          #     The configuration for creating and coordinating subagents.
+          #
+          #   @param reasoning [OpenAI::Models::Beta::AgentReasoning]
+          #     The configured reasoning policy.
+          #
+          #   @param service_tier [Symbol, OpenAI::Models::Beta::Agents::AutomationAgentConfig::ServiceTier]
+          #     The configured service-tier policy.
+          #
+          #   @param text [OpenAI::Models::Beta::AgentText]
+          #     The configured output format and verbosity.
+          #
+          #   @param tools [Array<OpenAI::Models::Beta::AgentTool::Function, OpenAI::Models::Beta::AgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentTool::Mcp, OpenAI::Models::Beta::AgentTool::WebSearch, OpenAI::Models::Beta::AgentTool::ComputerUse, OpenAI::Models::Beta::AgentTool::Automations>]
+          #     Configured tools, excluding confidential credentials.
+          #
+          #   @param compaction [OpenAI::Models::Beta::Agents::AutomationAgentConfig::Compaction]
+          #     The effective context compaction settings.
+          #
+          #   @param experimental [OpenAI::Models::Beta::Agents::AutomationAgentConfig::Experimental]
+          #     The effective experimental settings for the agent.
+
+          # The configured service-tier policy.
+          #
+          # @see OpenAI::Models::Beta::Agents::AutomationAgentConfig#service_tier
+          module ServiceTier
+            extend OpenAI::Internal::Type::Enum
+
+            AUTO = :auto
+            DEFAULT = :default
+            FLEX = :flex
+            PRIORITY = :priority
+            FAST = :fast
+            ULTRAFAST = :ultrafast
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see OpenAI::Models::Beta::Agents::AutomationAgentConfig#compaction
+          class Compaction < OpenAI::Internal::Type::BaseModel
+            # @!attribute async
+            #   Whether context is compacted in the background. Defaults to true.
+            #
+            #   @return [Boolean]
+            required :async, OpenAI::Internal::Type::Boolean
+
+            # @!method initialize(async:)
+            #   The effective context compaction settings.
+            #
+            #   @param async [Boolean]
+            #     Whether context is compacted in the background. Defaults to true.
+          end
+
+          # @see OpenAI::Models::Beta::Agents::AutomationAgentConfig#experimental
+          class Experimental < OpenAI::Internal::Type::BaseModel
+            # @!attribute time_awareness
+            #   Whether the model receives periodic current-time reminders.
+            #
+            #   @return [Boolean]
+            required :time_awareness, OpenAI::Internal::Type::Boolean
+
+            # @!method initialize(time_awareness:)
+            #   The effective experimental settings for the agent.
+            #
+            #   @param time_awareness [Boolean]
+            #     Whether the model receives periodic current-time reminders.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/automation_create_params.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Automations#create
+        class AutomationCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute create_automation_params
+          #   Creates an automation without invoking it immediately.
+          #
+          #   @return [OpenAI::Models::Beta::Agents::AutomationScheduleParam::Periodic, OpenAI::Models::Beta::Agents::AutomationScheduleParam::Once]
+          required :create_automation_params, union: -> { OpenAI::Beta::Agents::AutomationScheduleParam }
+
+          # @!method initialize(create_automation_params:, request_options: {})
+          #   @param create_automation_params [OpenAI::Models::Beta::Agents::AutomationScheduleParam::Periodic, OpenAI::Models::Beta::Agents::AutomationScheduleParam::Once]
+          #     Creates an automation without invoking it immediately.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/automation_created_by.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # How the automation was created, independently of how an invocation started.
+        module AutomationCreatedBy
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :developer, -> { OpenAI::Beta::Agents::AutomationCreatedBy::Developer }
+
+          variant :agent, -> { OpenAI::Beta::Agents::AutomationCreatedBy::Agent }
+
+          class Developer < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #   The type of the object. Always `developer`.
+            #
+            #   @return [Symbol, :developer]
+            required :type, const: :developer
+
+            # @!method initialize(type: :developer)
+            #   @param type [Symbol, :developer]
+            #     The type of the object. Always `developer`.
+          end
+
+          class Agent < OpenAI::Internal::Type::BaseModel
+            # @!attribute session_id
+            #   The creator session, which is also the automation's target.
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute tool_call_id
+            #   The tool call that created the automation.
+            #
+            #   @return [String]
+            required :tool_call_id, String
+
+            # @!attribute type
+            #   The type of the object. Always `agent`.
+            #
+            #   @return [Symbol, :agent]
+            required :type, const: :agent
+
+            # @!method initialize(session_id:, tool_call_id:, type: :agent)
+            #   @param session_id [String]
+            #     The creator session, which is also the automation's target.
+            #
+            #   @param tool_call_id [String]
+            #     The tool call that created the automation.
+            #
+            #   @param type [Symbol, :agent]
+            #     The type of the object. Always `agent`.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::Agents::AutomationCreatedBy::Developer, OpenAI::Models::Beta::Agents::AutomationCreatedBy::Agent)]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/automation_delete_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Automations#delete
+        class AutomationDeleteParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute automation_id
+          #
+          #   @return [String]
+          required :automation_id, String
+
+          # @!method initialize(automation_id:, request_options: {})
+          #   @param automation_id [String]
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/automation_deleted.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Automations#delete
+        class AutomationDeleted < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The deleted automation ID.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute deleted
+          #   Always true.
+          #
+          #   @return [Boolean]
+          required :deleted, OpenAI::Internal::Type::Boolean
+
+          # @!attribute object
+          #   Always `agent.automation.deleted`.
+          #
+          #   @return [Symbol, :"agent.automation.deleted"]
+          required :object, const: :"agent.automation.deleted"
+
+          # @!method initialize(id:, deleted:, object: :"agent.automation.deleted")
+          #   @param id [String]
+          #     The deleted automation ID.
+          #
+          #   @param deleted [Boolean]
+          #     Always true.
+          #
+          #   @param object [Symbol, :"agent.automation.deleted"]
+          #     Always `agent.automation.deleted`.
+        end
+      end
+    end
+  end
+end