openai 0.64.0 → 0.66.0

data/rbi/openai/models/responses/response.rbi

@@ -170,6 +170,19 @@ module OpenAI
         sig { returns(T.nilable(Integer)) }
         attr_accessor :max_tool_calls
 
+        # Moderation results for the response input and output, if moderated completions
+        # were requested.
+        sig { returns(T.nilable(OpenAI::Responses::Response::Moderation)) }
+        attr_reader :moderation
+
+        sig do
+          params(
+            moderation:
+              T.nilable(OpenAI::Responses::Response::Moderation::OrHash)
+          ).void
+        end
+        attr_writer :moderation
+
         # The unique ID of the previous response to the model. Use this to create
         # multi-turn conversations. Learn more about
         # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
@@ -202,6 +215,14 @@ module OpenAI
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
+        #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
         sig do
           returns(
             T.nilable(
@@ -345,6 +366,7 @@ module OpenAI
                   OpenAI::Responses::ResponseReasoningItem::OrHash,
                   OpenAI::Responses::ResponseToolSearchCall::OrHash,
                   OpenAI::Responses::ResponseToolSearchOutputItem::OrHash,
+                  OpenAI::Responses::ResponseOutputItem::AdditionalTools::OrHash,
                   OpenAI::Responses::ResponseCompactionItem::OrHash,
                   OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OrHash,
                   OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
@@ -402,6 +424,8 @@ module OpenAI
               T.nilable(OpenAI::Responses::Response::Conversation::OrHash),
             max_output_tokens: T.nilable(Integer),
             max_tool_calls: T.nilable(Integer),
+            moderation:
+              T.nilable(OpenAI::Responses::Response::Moderation::OrHash),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
             prompt_cache_key: String,
@@ -514,6 +538,9 @@ module OpenAI
           # individual tool. Any further attempts to call a tool by the model will be
           # ignored.
           max_tool_calls: nil,
+          # Moderation results for the response input and output, if moderated completions
+          # were requested.
+          moderation: nil,
           # The unique ID of the previous response to the model. Use this to create
           # multi-turn conversations. Learn more about
           # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
@@ -530,6 +557,14 @@ module OpenAI
           # prompt caching, which keeps cached prefixes active for longer, up to a maximum
           # of 24 hours.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+          # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+          #
+          # For older models that support both `in_memory` and `24h`, the default depends on
+          # your organization's data retention policy:
+          #
+          # - Organizations without ZDR enabled default to `24h`.
+          # - Organizations with ZDR enabled default to `in_memory` when
+          #   `prompt_cache_retention` is not specified.
           prompt_cache_retention: nil,
           # **gpt-5 and o-series models only**
           #
@@ -620,6 +655,7 @@ module OpenAI
                 T.nilable(OpenAI::Responses::Response::Conversation),
               max_output_tokens: T.nilable(Integer),
               max_tool_calls: T.nilable(Integer),
+              moderation: T.nilable(OpenAI::Responses::Response::Moderation),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
               prompt_cache_key: String,
@@ -824,10 +860,484 @@ module OpenAI
           end
         end
 
+        class Moderation < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::Response::Moderation,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Moderation for the response input.
+          sig do
+            returns(OpenAI::Responses::Response::Moderation::Input::Variants)
+          end
+          attr_accessor :input
+
+          # Moderation for the response output.
+          sig do
+            returns(OpenAI::Responses::Response::Moderation::Output::Variants)
+          end
+          attr_accessor :output
+
+          # Moderation results for the response input and output, if moderated completions
+          # were requested.
+          sig do
+            params(
+              input:
+                T.any(
+                  OpenAI::Responses::Response::Moderation::Input::ModerationResult::OrHash,
+                  OpenAI::Responses::Response::Moderation::Input::Error::OrHash
+                ),
+              output:
+                T.any(
+                  OpenAI::Responses::Response::Moderation::Output::ModerationResult::OrHash,
+                  OpenAI::Responses::Response::Moderation::Output::Error::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Moderation for the response input.
+            input:,
+            # Moderation for the response output.
+            output:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                input: OpenAI::Responses::Response::Moderation::Input::Variants,
+                output:
+                  OpenAI::Responses::Response::Moderation::Output::Variants
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Moderation for the response input.
+          module Input
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::Response::Moderation::Input::ModerationResult,
+                  OpenAI::Responses::Response::Moderation::Input::Error
+                )
+              end
+
+            class ModerationResult < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Responses::Response::Moderation::Input::ModerationResult,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # A dictionary of moderation categories to booleans, True if the input is flagged
+              # under this category.
+              sig { returns(T::Hash[Symbol, T::Boolean]) }
+              attr_accessor :categories
+
+              # Which modalities of input are reflected by the score for each category.
+              sig do
+                returns(
+                  T::Hash[
+                    Symbol,
+                    T::Array[
+                      OpenAI::Responses::Response::Moderation::Input::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                    ]
+                  ]
+                )
+              end
+              attr_accessor :category_applied_input_types
+
+              # A dictionary of moderation categories to scores.
+              sig { returns(T::Hash[Symbol, Float]) }
+              attr_accessor :category_scores
+
+              # A boolean indicating whether the content was flagged by any category.
+              sig { returns(T::Boolean) }
+              attr_accessor :flagged
+
+              # The moderation model that produced this result.
+              sig { returns(String) }
+              attr_accessor :model
+
+              # The object type, which was always `moderation_result` for successful moderation
+              # results.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # A moderation result produced for the response input or output.
+              sig do
+                params(
+                  categories: T::Hash[Symbol, T::Boolean],
+                  category_applied_input_types:
+                    T::Hash[
+                      Symbol,
+                      T::Array[
+                        OpenAI::Responses::Response::Moderation::Input::ModerationResult::CategoryAppliedInputType::OrSymbol
+                      ]
+                    ],
+                  category_scores: T::Hash[Symbol, Float],
+                  flagged: T::Boolean,
+                  model: String,
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # A dictionary of moderation categories to booleans, True if the input is flagged
+                # under this category.
+                categories:,
+                # Which modalities of input are reflected by the score for each category.
+                category_applied_input_types:,
+                # A dictionary of moderation categories to scores.
+                category_scores:,
+                # A boolean indicating whether the content was flagged by any category.
+                flagged:,
+                # The moderation model that produced this result.
+                model:,
+                # The object type, which was always `moderation_result` for successful moderation
+                # results.
+                type: :moderation_result
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    categories: T::Hash[Symbol, T::Boolean],
+                    category_applied_input_types:
+                      T::Hash[
+                        Symbol,
+                        T::Array[
+                          OpenAI::Responses::Response::Moderation::Input::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                        ]
+                      ],
+                    category_scores: T::Hash[Symbol, Float],
+                    flagged: T::Boolean,
+                    model: String,
+                    type: Symbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              module CategoryAppliedInputType
+                extend OpenAI::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      OpenAI::Responses::Response::Moderation::Input::ModerationResult::CategoryAppliedInputType
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                TEXT =
+                  T.let(
+                    :text,
+                    OpenAI::Responses::Response::Moderation::Input::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                  )
+                IMAGE =
+                  T.let(
+                    :image,
+                    OpenAI::Responses::Response::Moderation::Input::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      OpenAI::Responses::Response::Moderation::Input::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+
+            class Error < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Responses::Response::Moderation::Input::Error,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # The error code.
+              sig { returns(String) }
+              attr_accessor :code
+
+              # The error message.
+              sig { returns(String) }
+              attr_accessor :message
+
+              # The object type, which was always `error` for moderation failures.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # An error produced while attempting moderation for the response input or output.
+              sig do
+                params(code: String, message: String, type: Symbol).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The error code.
+                code:,
+                # The error message.
+                message:,
+                # The object type, which was always `error` for moderation failures.
+                type: :error
+              )
+              end
+
+              sig do
+                override.returns(
+                  { code: String, message: String, type: Symbol }
+                )
+              end
+              def to_hash
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::Response::Moderation::Input::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          # Moderation for the response output.
+          module Output
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::Response::Moderation::Output::ModerationResult,
+                  OpenAI::Responses::Response::Moderation::Output::Error
+                )
+              end
+
+            class ModerationResult < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Responses::Response::Moderation::Output::ModerationResult,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # A dictionary of moderation categories to booleans, True if the input is flagged
+              # under this category.
+              sig { returns(T::Hash[Symbol, T::Boolean]) }
+              attr_accessor :categories
+
+              # Which modalities of input are reflected by the score for each category.
+              sig do
+                returns(
+                  T::Hash[
+                    Symbol,
+                    T::Array[
+                      OpenAI::Responses::Response::Moderation::Output::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                    ]
+                  ]
+                )
+              end
+              attr_accessor :category_applied_input_types
+
+              # A dictionary of moderation categories to scores.
+              sig { returns(T::Hash[Symbol, Float]) }
+              attr_accessor :category_scores
+
+              # A boolean indicating whether the content was flagged by any category.
+              sig { returns(T::Boolean) }
+              attr_accessor :flagged
+
+              # The moderation model that produced this result.
+              sig { returns(String) }
+              attr_accessor :model
+
+              # The object type, which was always `moderation_result` for successful moderation
+              # results.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # A moderation result produced for the response input or output.
+              sig do
+                params(
+                  categories: T::Hash[Symbol, T::Boolean],
+                  category_applied_input_types:
+                    T::Hash[
+                      Symbol,
+                      T::Array[
+                        OpenAI::Responses::Response::Moderation::Output::ModerationResult::CategoryAppliedInputType::OrSymbol
+                      ]
+                    ],
+                  category_scores: T::Hash[Symbol, Float],
+                  flagged: T::Boolean,
+                  model: String,
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # A dictionary of moderation categories to booleans, True if the input is flagged
+                # under this category.
+                categories:,
+                # Which modalities of input are reflected by the score for each category.
+                category_applied_input_types:,
+                # A dictionary of moderation categories to scores.
+                category_scores:,
+                # A boolean indicating whether the content was flagged by any category.
+                flagged:,
+                # The moderation model that produced this result.
+                model:,
+                # The object type, which was always `moderation_result` for successful moderation
+                # results.
+                type: :moderation_result
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    categories: T::Hash[Symbol, T::Boolean],
+                    category_applied_input_types:
+                      T::Hash[
+                        Symbol,
+                        T::Array[
+                          OpenAI::Responses::Response::Moderation::Output::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                        ]
+                      ],
+                    category_scores: T::Hash[Symbol, Float],
+                    flagged: T::Boolean,
+                    model: String,
+                    type: Symbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              module CategoryAppliedInputType
+                extend OpenAI::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      OpenAI::Responses::Response::Moderation::Output::ModerationResult::CategoryAppliedInputType
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                TEXT =
+                  T.let(
+                    :text,
+                    OpenAI::Responses::Response::Moderation::Output::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                  )
+                IMAGE =
+                  T.let(
+                    :image,
+                    OpenAI::Responses::Response::Moderation::Output::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      OpenAI::Responses::Response::Moderation::Output::ModerationResult::CategoryAppliedInputType::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+
+            class Error < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Responses::Response::Moderation::Output::Error,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # The error code.
+              sig { returns(String) }
+              attr_accessor :code
+
+              # The error message.
+              sig { returns(String) }
+              attr_accessor :message
+
+              # The object type, which was always `error` for moderation failures.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # An error produced while attempting moderation for the response input or output.
+              sig do
+                params(code: String, message: String, type: Symbol).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The error code.
+                code:,
+                # The error message.
+                message:,
+                # The object type, which was always `error` for moderation failures.
+                type: :error
+              )
+              end
+
+              sig do
+                override.returns(
+                  { code: String, message: String, type: Symbol }
+                )
+              end
+              def to_hash
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::Response::Moderation::Output::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+
         # The retention policy for the prompt cache. Set to `24h` to enable extended
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
+        #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/responses/response_create_params.rbi

@@ -153,6 +153,24 @@ module OpenAI
         end
         attr_writer :model
 
+        # Configuration for running moderation on the input and output of this response.
+        sig do
+          returns(
+            T.nilable(OpenAI::Responses::ResponseCreateParams::Moderation)
+          )
+        end
+        attr_reader :moderation
+
+        sig do
+          params(
+            moderation:
+              T.nilable(
+                OpenAI::Responses::ResponseCreateParams::Moderation::OrHash
+              )
+          ).void
+        end
+        attr_writer :moderation
+
         # Whether to allow the model to run tool calls in parallel.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :parallel_tool_calls
@@ -189,6 +207,14 @@ module OpenAI
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
+        #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
         sig do
           returns(
             T.nilable(
@@ -475,6 +501,10 @@ module OpenAI
                 OpenAI::ChatModel::OrSymbol,
                 OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
               ),
+            moderation:
+              T.nilable(
+                OpenAI::Responses::ResponseCreateParams::Moderation::OrHash
+              ),
             parallel_tool_calls: T.nilable(T::Boolean),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
@@ -605,6 +635,8 @@ module OpenAI
           # [model guide](https://platform.openai.com/docs/models) to browse and compare
           # available models.
           model: nil,
+          # Configuration for running moderation on the input and output of this response.
+          moderation: nil,
           # Whether to allow the model to run tool calls in parallel.
           parallel_tool_calls: nil,
           # The unique ID of the previous response to the model. Use this to create
@@ -623,6 +655,14 @@ module OpenAI
           # prompt caching, which keeps cached prefixes active for longer, up to a maximum
           # of 24 hours.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+          # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+          #
+          # For older models that support both `in_memory` and `24h`, the default depends on
+          # your organization's data retention policy:
+          #
+          # - Organizations without ZDR enabled default to `24h`.
+          # - Organizations with ZDR enabled default to `in_memory` when
+          #   `prompt_cache_retention` is not specified.
           prompt_cache_retention: nil,
           # **gpt-5 and o-series models only**
           #
@@ -749,6 +789,8 @@ module OpenAI
                   OpenAI::ChatModel::OrSymbol,
                   OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
                 ),
+              moderation:
+                T.nilable(OpenAI::Responses::ResponseCreateParams::Moderation),
               parallel_tool_calls: T.nilable(T::Boolean),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
@@ -906,10 +948,46 @@ module OpenAI
           end
         end
 
+        class Moderation < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseCreateParams::Moderation,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The moderation model to use for moderated completions, e.g.
+          # 'omni-moderation-latest'.
+          sig { returns(String) }
+          attr_accessor :model
+
+          # Configuration for running moderation on the input and output of this response.
+          sig { params(model: String).returns(T.attached_class) }
+          def self.new(
+            # The moderation model to use for moderated completions, e.g.
+            # 'omni-moderation-latest'.
+            model:
+          )
+          end
+
+          sig { override.returns({ model: String }) }
+          def to_hash
+          end
+        end
+
         # The retention policy for the prompt cache. Set to `24h` to enable extended
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
+        #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum