openai 0.88.0 → 0.90.0

data/lib/openai/models/beta/setup_command_param.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class SetupCommandParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute command
+        #   The shell command to execute.
+        #
+        #   @return [String]
+        required :command, String
+
+        # @!attribute cwd
+        #   The absolute working directory. Defaults to `/workspace`.
+        #
+        #   @return [String, nil]
+        optional :cwd, String, nil?: true
+
+        # @!method initialize(command:, cwd: nil)
+        #   A confidential setup command executed before the hosted agent starts.
+        #
+        #   @param command [String]
+        #     The shell command to execute.
+        #
+        #   @param cwd [String, nil]
+        #     The absolute working directory. Defaults to `/workspace`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/subagent.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class Subagent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the subagent.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute closed_at
+        #   The Unix timestamp, in seconds, when the subagent was closed. Null while active,
+        #   including after resume.
+        #
+        #   @return [Integer, nil]
+        required :closed_at, Integer, nil?: true
+
+        # @!attribute instructions
+        #   Initial task content, or null when unavailable. Text may contain placeholders
+        #   for images or audio when only a preview is available.
+        #
+        #   @return [Array<OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent>, nil]
+        required(
+          :instructions,
+          -> {
+            OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentContent]
+          },
+          nil?: true
+        )
+
+        # @!attribute name
+        #   The runner-assigned nickname, or null when unavailable.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute object
+        #   The object type. Always `agent.session.subagent`.
+        #
+        #   @return [Symbol, :"agent.session.subagent"]
+        required :object, const: :"agent.session.subagent"
+
+        # @!attribute opened_at
+        #   The Unix timestamp, in seconds, when the subagent was first opened. Resuming
+        #   does not change it.
+        #
+        #   @return [Integer]
+        required :opened_at, Integer
+
+        # @!attribute parent_agent_id
+        #   The ID of the agent that created this subagent.
+        #
+        #   @return [String]
+        required :parent_agent_id, String
+
+        # @!attribute session_id
+        #   The ID of the session that owns the subagent.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute status
+        #   The current status of the subagent.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::Subagent::Status]
+        required :status, enum: -> { OpenAI::Beta::Subagent::Status }
+
+        # @!method initialize(id:, closed_at:, instructions:, name:, opened_at:, parent_agent_id:, session_id:, status:, object: :"agent.session.subagent")
+        #   A subagent created within a session.
+        #
+        #   @param id [String]
+        #     The ID of the subagent.
+        #
+        #   @param closed_at [Integer, nil]
+        #     The Unix timestamp, in seconds, when the subagent was closed. Null while active,
+        #     including after resume.
+        #
+        #   @param instructions [Array<OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent>, nil]
+        #     Initial task content, or null when unavailable. Text may contain placeholders
+        #     for images or audio when only a preview is available.
+        #
+        #   @param name [String, nil]
+        #     The runner-assigned nickname, or null when unavailable.
+        #
+        #   @param opened_at [Integer]
+        #     The Unix timestamp, in seconds, when the subagent was first opened. Resuming
+        #     does not change it.
+        #
+        #   @param parent_agent_id [String]
+        #     The ID of the agent that created this subagent.
+        #
+        #   @param session_id [String]
+        #     The ID of the session that owns the subagent.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::Subagent::Status]
+        #     The current status of the subagent.
+        #
+        #   @param object [Symbol, :"agent.session.subagent"]
+        #     The object type. Always `agent.session.subagent`.
+
+        # The current status of the subagent.
+        #
+        # @see OpenAI::Models::Beta::Subagent#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          # The subagent remains available, including while idle between turns.
+          ACTIVE = :active
+
+          # The subagent is closed.
+          CLOSED = :closed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/summary_text.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class SummaryText < OpenAI::Internal::Type::BaseModel
+        # @!attribute text
+        #   The reasoning summary text.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The content type. Always `summary_text`.
+        #
+        #   @return [Symbol, :summary_text]
+        required :type, const: :summary_text
+
+        # @!method initialize(text:, type: :summary_text)
+        #   A reasoning summary content part.
+        #
+        #   @param text [String]
+        #     The reasoning summary text.
+        #
+        #   @param type [Symbol, :summary_text]
+        #     The content type. Always `summary_text`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/text_format.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The effective output format for generated text.
+      module TextFormat
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Generates ordinary text without a structured-output constraint.
+        variant :text, -> { OpenAI::Beta::TextFormat::Text }
+
+        # Constrains generated text to a JSON Schema.
+        variant :json_schema, -> { OpenAI::Beta::TextFormat::JSONSchema }
+
+        class Text < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `text`.
+          #
+          #   @return [Symbol, :text]
+          required :type, const: :text
+
+          # @!method initialize(type: :text)
+          #   Generates ordinary text without a structured-output constraint.
+          #
+          #   @param type [Symbol, :text]
+          #     The type of the object. Always `text`.
+        end
+
+        class JSONSchema < OpenAI::Internal::Type::BaseModel
+          # @!attribute schema
+          #   The JSON Schema that generated text must match.
+          #
+          #   @return [Hash{Symbol=>Object}]
+          required :schema, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+          # @!attribute type
+          #   The type of the object. Always `json_schema`.
+          #
+          #   @return [Symbol, :json_schema]
+          required :type, const: :json_schema
+
+          # @!method initialize(schema:, type: :json_schema)
+          #   Constrains generated text to a JSON Schema.
+          #
+          #   @param schema [Hash{Symbol=>Object}]
+          #     The JSON Schema that generated text must match.
+          #
+          #   @param type [Symbol, :json_schema]
+          #     The type of the object. Always `json_schema`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::TextFormat::Text, OpenAI::Models::Beta::TextFormat::JSONSchema)]
+      end
+    end
+  end
+end

data/lib/openai/models/beta/text_format_param.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The output format for generated text.
+      module TextFormatParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Generates ordinary text without a structured-output constraint.
+        variant :text, -> { OpenAI::Beta::TextFormatParam::Text }
+
+        # Constrains generated text to a JSON Schema.
+        variant :json_schema, -> { OpenAI::Beta::TextFormatParam::JSONSchema }
+
+        class Text < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `text`.
+          #
+          #   @return [Symbol, :text]
+          required :type, const: :text
+
+          # @!method initialize(type: :text)
+          #   Generates ordinary text without a structured-output constraint.
+          #
+          #   @param type [Symbol, :text]
+          #     The type of the object. Always `text`.
+        end
+
+        class JSONSchema < OpenAI::Internal::Type::BaseModel
+          # @!attribute schema
+          #   The JSON Schema that generated text must match.
+          #
+          #   @return [Hash{Symbol=>Object}]
+          required :schema, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+          # @!attribute type
+          #   The type of the object. Always `json_schema`.
+          #
+          #   @return [Symbol, :json_schema]
+          required :type, const: :json_schema
+
+          # @!method initialize(schema:, type: :json_schema)
+          #   Constrains generated text to a JSON Schema.
+          #
+          #   @param schema [Hash{Symbol=>Object}]
+          #     The JSON Schema that generated text must match.
+          #
+          #   @param type [Symbol, :json_schema]
+          #     The type of the object. Always `json_schema`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::TextFormatParam::Text, OpenAI::Models::Beta::TextFormatParam::JSONSchema)]
+      end
+    end
+  end
+end

data/lib/openai/models/beta/token_usage.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class TokenUsage < OpenAI::Internal::Type::BaseModel
+        # @!attribute input_tokens
+        #   The number of input tokens used by the agent.
+        #
+        #   @return [Integer]
+        required :input_tokens, Integer
+
+        # @!attribute input_tokens_details
+        #   A breakdown of the agent's input token usage.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage::InputTokensDetails]
+        required :input_tokens_details, -> { OpenAI::Beta::TokenUsage::InputTokensDetails }
+
+        # @!attribute output_tokens
+        #   The number of output tokens generated by the agent.
+        #
+        #   @return [Integer]
+        required :output_tokens, Integer
+
+        # @!attribute output_tokens_details
+        #   A breakdown of the agent's output token usage.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage::OutputTokensDetails]
+        required :output_tokens_details, -> { OpenAI::Beta::TokenUsage::OutputTokensDetails }
+
+        # @!attribute total_tokens
+        #   The total number of input and output tokens used by the agent.
+        #
+        #   @return [Integer]
+        required :total_tokens, Integer
+
+        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
+        #   Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @param input_tokens [Integer]
+        #     The number of input tokens used by the agent.
+        #
+        #   @param input_tokens_details [OpenAI::Models::Beta::TokenUsage::InputTokensDetails]
+        #     A breakdown of the agent's input token usage.
+        #
+        #   @param output_tokens [Integer]
+        #     The number of output tokens generated by the agent.
+        #
+        #   @param output_tokens_details [OpenAI::Models::Beta::TokenUsage::OutputTokensDetails]
+        #     A breakdown of the agent's output token usage.
+        #
+        #   @param total_tokens [Integer]
+        #     The total number of input and output tokens used by the agent.
+
+        # @see OpenAI::Models::Beta::TokenUsage#input_tokens_details
+        class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute cached_tokens
+          #   The number of input tokens retrieved from the prompt cache.
+          #
+          #   @return [Integer]
+          required :cached_tokens, Integer
+
+          # @!method initialize(cached_tokens:)
+          #   A breakdown of the agent's input token usage.
+          #
+          #   @param cached_tokens [Integer]
+          #     The number of input tokens retrieved from the prompt cache.
+        end
+
+        # @see OpenAI::Models::Beta::TokenUsage#output_tokens_details
+        class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute reasoning_tokens
+          #   The number of output tokens used for reasoning.
+          #
+          #   @return [Integer]
+          required :reasoning_tokens, Integer
+
+          # @!method initialize(reasoning_tokens:)
+          #   A breakdown of the agent's output token usage.
+          #
+          #   @param reasoning_tokens [Integer]
+          #     The number of output tokens used for reasoning.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/web_search_action.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # An action performed by the web search tool.
+      module WebSearchAction
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A search query or group of search queries.
+        variant :search, -> { OpenAI::Beta::WebSearchAction::Search }
+
+        # Opens a web page.
+        variant :open_page, -> { OpenAI::Beta::WebSearchAction::OpenPage }
+
+        # Finds text within a web page.
+        variant :find_in_page, -> { OpenAI::Beta::WebSearchAction::FindInPage }
+
+        # Another web search action.
+        variant :other, -> { OpenAI::Beta::WebSearchAction::Other }
+
+        class Search < OpenAI::Internal::Type::BaseModel
+          # @!attribute queries
+          #   The search queries, when multiple queries were used.
+          #
+          #   @return [Array<String>, nil]
+          required :queries, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute query
+          #   The search query, when a single query was used.
+          #
+          #   @return [String, nil]
+          required :query, String, nil?: true
+
+          # @!attribute type
+          #   The type of the object. Always `search`.
+          #
+          #   @return [Symbol, :search]
+          required :type, const: :search
+
+          # @!method initialize(queries:, query:, type: :search)
+          #   A search query or group of search queries.
+          #
+          #   @param queries [Array<String>, nil]
+          #     The search queries, when multiple queries were used.
+          #
+          #   @param query [String, nil]
+          #     The search query, when a single query was used.
+          #
+          #   @param type [Symbol, :search]
+          #     The type of the object. Always `search`.
+        end
+
+        class OpenPage < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `open_page`.
+          #
+          #   @return [Symbol, :open_page]
+          required :type, const: :open_page
+
+          # @!attribute url
+          #   The URL of the page that was opened.
+          #
+          #   @return [String, nil]
+          required :url, String, nil?: true
+
+          # @!method initialize(url:, type: :open_page)
+          #   Opens a web page.
+          #
+          #   @param url [String, nil]
+          #     The URL of the page that was opened.
+          #
+          #   @param type [Symbol, :open_page]
+          #     The type of the object. Always `open_page`.
+        end
+
+        class FindInPage < OpenAI::Internal::Type::BaseModel
+          # @!attribute pattern
+          #   The text pattern that was searched for.
+          #
+          #   @return [String, nil]
+          required :pattern, String, nil?: true
+
+          # @!attribute type
+          #   The type of the object. Always `find_in_page`.
+          #
+          #   @return [Symbol, :find_in_page]
+          required :type, const: :find_in_page
+
+          # @!attribute url
+          #   The URL of the page that was searched.
+          #
+          #   @return [String, nil]
+          required :url, String, nil?: true
+
+          # @!method initialize(pattern:, url:, type: :find_in_page)
+          #   Finds text within a web page.
+          #
+          #   @param pattern [String, nil]
+          #     The text pattern that was searched for.
+          #
+          #   @param url [String, nil]
+          #     The URL of the page that was searched.
+          #
+          #   @param type [Symbol, :find_in_page]
+          #     The type of the object. Always `find_in_page`.
+        end
+
+        class Other < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `other`.
+          #
+          #   @return [Symbol, :other]
+          required :type, const: :other
+
+          # @!method initialize(type: :other)
+          #   Another web search action.
+          #
+          #   @param type [Symbol, :other]
+          #     The type of the object. Always `other`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::WebSearchAction::Search, OpenAI::Models::Beta::WebSearchAction::OpenPage, OpenAI::Models::Beta::WebSearchAction::FindInPage, OpenAI::Models::Beta::WebSearchAction::Other)]
+      end
+    end
+  end
+end

data/lib/openai/models/chat/completion_create_params.rb

@@ -1080,7 +1080,7 @@ module OpenAI
           # An {OpenAI::BaseModel} can be provided and implicitly converted into {OpenAI::Models::ResponseFormatJSONSchema}.
           # See examples for more details.
           #
-          # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+          # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
           variant -> { OpenAI::StructuredOutput::JsonSchemaConverter }
 
           # JSON object response format. An older method of generating JSON responses.

data/lib/openai/models/conversations/conversation_item.rb

@@ -126,6 +126,36 @@ module OpenAI
           #   @return [Symbol, :image_generation_call]
           required :type, const: :image_generation_call
 
+          # @!attribute action
+          #   The action used for image generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Action, nil]
+          optional(
+            :action,
+            enum: -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall::Action },
+            nil?: true
+          )
+
+          # @!attribute background
+          #   The background setting used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Background, nil]
+          optional(
+            :background,
+            enum: -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall::Background },
+            nil?: true
+          )
+
+          # @!attribute output_format
+          #   The output format used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::OutputFormat, nil]
+          optional(
+            :output_format,
+            enum: -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall::OutputFormat },
+            nil?: true
+          )
+
           # @!attribute quality
           #   The quality of the image generated by the image generation tool call. One of
           #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
@@ -137,6 +167,12 @@ module OpenAI
             nil?: true
           )
 
+          # @!attribute revised_prompt
+          #   The prompt that was used after any model prompt rewriting.
+          #
+          #   @return [String, nil]
+          optional :revised_prompt, String, nil?: true
+
           # @!attribute size
           #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
@@ -147,7 +183,7 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(id:, result:, status:, quality: nil, size: nil, type: :image_generation_call)
+          # @!method initialize(id:, result:, status:, action: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
           #   An image generation request made by the model.
           #
           #   @param id [String]
@@ -159,10 +195,22 @@ module OpenAI
           #   @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Status]
           #     The status of the image generation call.
           #
+          #   @param action [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Action, nil]
+          #     The action used for image generation.
+          #
+          #   @param background [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Background, nil]
+          #     The background setting used for generation.
+          #
+          #   @param output_format [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::OutputFormat, nil]
+          #     The output format used for generation.
+          #
           #   @param quality [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Quality, nil]
           #     The quality of the image generated by the image generation tool call. One of
           #     `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #
+          #   @param revised_prompt [String, nil]
+          #     The prompt that was used after any model prompt rewriting.
+          #
           #   @param size [String, Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
@@ -184,6 +232,48 @@ module OpenAI
             #   @return [Array<Symbol>]
           end
 
+          # The action used for image generation.
+          #
+          # @see OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall#action
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            GENERATE = :generate
+            EDIT = :edit
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The background setting used for generation.
+          #
+          # @see OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall#background
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TRANSPARENT = :transparent
+            OPAQUE = :opaque
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The output format used for generation.
+          #
+          # @see OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall#output_format
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            PNG = :png
+            WEBP = :webp
+            JPEG = :jpeg
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #