openai 0.65.0 → 0.66.0

data/rbi/openai/models/responses/responses_client_event.rbi

@@ -154,6 +154,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::ResponsesClientEvent::Moderation)
+          )
+        end
+        attr_reader :moderation
+
+        sig do
+          params(
+            moderation:
+              T.nilable(
+                OpenAI::Responses::ResponsesClientEvent::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
@@ -485,6 +503,10 @@ module OpenAI
                 OpenAI::ChatModel::OrSymbol,
                 OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
               ),
+            moderation:
+              T.nilable(
+                OpenAI::Responses::ResponsesClientEvent::Moderation::OrHash
+              ),
             parallel_tool_calls: T.nilable(T::Boolean),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
@@ -616,6 +638,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
@@ -777,6 +801,8 @@ module OpenAI
                   OpenAI::ChatModel::OrSymbol,
                   OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
                 ),
+              moderation:
+                T.nilable(OpenAI::Responses::ResponsesClientEvent::Moderation),
               parallel_tool_calls: T.nilable(T::Boolean),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
@@ -934,6 +960,34 @@ module OpenAI
           end
         end
 
+        class Moderation < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponsesClientEvent::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.

data/rbi/openai/resources/chat/completions.rbi

@@ -67,6 +67,10 @@ module OpenAI
                   OpenAI::Chat::CompletionCreateParams::Modality::OrSymbol
                 ]
               ),
+            moderation:
+              T.nilable(
+                OpenAI::Chat::CompletionCreateParams::Moderation::OrHash
+              ),
             n: T.nilable(Integer),
             parallel_tool_calls: T::Boolean,
             prediction:
@@ -209,6 +213,8 @@ module OpenAI
           #
           # `["text", "audio"]`
           modalities: nil,
+          # Configuration for running moderation on the request input and generated output.
+          moderation: nil,
           # How many chat completion choices to generate for each input message. Note that
           # you will be charged based on the number of generated tokens across all of the
           # choices. Keep `n` as `1` to minimize costs.
@@ -416,6 +422,10 @@ module OpenAI
                   OpenAI::Chat::CompletionCreateParams::Modality::OrSymbol
                 ]
               ),
+            moderation:
+              T.nilable(
+                OpenAI::Chat::CompletionCreateParams::Moderation::OrHash
+              ),
             n: T.nilable(Integer),
             parallel_tool_calls: T::Boolean,
             prediction:
@@ -556,6 +566,8 @@ module OpenAI
           #
           # `["text", "audio"]`
           modalities: nil,
+          # Configuration for running moderation on the request input and generated output.
+          moderation: nil,
           # How many chat completion choices to generate for each input message. Note that
           # you will be charged based on the number of generated tokens across all of the
           # choices. Keep `n` as `1` to minimize costs.

data/rbi/openai/resources/responses.rbi

@@ -53,6 +53,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),
@@ -188,6 +192,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
@@ -358,6 +364,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),
@@ -499,6 +509,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

data/sig/openai/models/chat/chat_completion.rbs

@@ -10,6 +10,7 @@ module OpenAI
           created: Integer,
           model: String,
           object: :"chat.completion",
+          moderation: OpenAI::Chat::ChatCompletion::Moderation?,
           service_tier: OpenAI::Models::Chat::ChatCompletion::service_tier?,
           system_fingerprint: String,
           usage: OpenAI::CompletionUsage
@@ -26,6 +27,8 @@ module OpenAI
 
         attr_accessor object: :"chat.completion"
 
+        attr_accessor moderation: OpenAI::Chat::ChatCompletion::Moderation?
+
         attr_accessor service_tier: OpenAI::Models::Chat::ChatCompletion::service_tier?
 
         attr_reader system_fingerprint: String?
@@ -41,6 +44,7 @@ module OpenAI
           choices: ::Array[OpenAI::Chat::ChatCompletion::Choice],
           created: Integer,
           model: String,
+          ?moderation: OpenAI::Chat::ChatCompletion::Moderation?,
           ?service_tier: OpenAI::Models::Chat::ChatCompletion::service_tier?,
           ?system_fingerprint: String,
           ?usage: OpenAI::CompletionUsage,
@@ -53,6 +57,7 @@ module OpenAI
           created: Integer,
           model: String,
           object: :"chat.completion",
+          moderation: OpenAI::Chat::ChatCompletion::Moderation?,
           service_tier: OpenAI::Models::Chat::ChatCompletion::service_tier?,
           system_fingerprint: String,
           usage: OpenAI::CompletionUsage
@@ -127,6 +132,244 @@ module OpenAI
           end
         end
 
+        type moderation =
+          {
+            input: OpenAI::Models::Chat::ChatCompletion::Moderation::input,
+            output: OpenAI::Models::Chat::ChatCompletion::Moderation::output
+          }
+
+        class Moderation < OpenAI::Internal::Type::BaseModel
+          attr_accessor input: OpenAI::Models::Chat::ChatCompletion::Moderation::input
+
+          attr_accessor output: OpenAI::Models::Chat::ChatCompletion::Moderation::output
+
+          def initialize: (
+            input: OpenAI::Models::Chat::ChatCompletion::Moderation::input,
+            output: OpenAI::Models::Chat::ChatCompletion::Moderation::output
+          ) -> void
+
+          def to_hash: -> {
+            input: OpenAI::Models::Chat::ChatCompletion::Moderation::input,
+            output: OpenAI::Models::Chat::ChatCompletion::Moderation::output
+          }
+
+          type input =
+            OpenAI::Chat::ChatCompletion::Moderation::Input::ModerationResults
+            | OpenAI::Chat::ChatCompletion::Moderation::Input::Error
+
+          module Input
+            extend OpenAI::Internal::Type::Union
+
+            type moderation_results =
+              {
+                model: String,
+                results: ::Array[OpenAI::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result],
+                type: :moderation_results
+              }
+
+            class ModerationResults < OpenAI::Internal::Type::BaseModel
+              attr_accessor model: String
+
+              attr_accessor results: ::Array[OpenAI::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result]
+
+              attr_accessor type: :moderation_results
+
+              def initialize: (
+                model: String,
+                results: ::Array[OpenAI::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result],
+                ?type: :moderation_results
+              ) -> void
+
+              def to_hash: -> {
+                model: String,
+                results: ::Array[OpenAI::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result],
+                type: :moderation_results
+              }
+
+              type result =
+                {
+                  categories: ::Hash[Symbol, bool],
+                  category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::category_applied_input_type]],
+                  category_scores: ::Hash[Symbol, Float],
+                  flagged: bool,
+                  model: String,
+                  type: :moderation_result
+                }
+
+              class Result < OpenAI::Internal::Type::BaseModel
+                attr_accessor categories: ::Hash[Symbol, bool]
+
+                attr_accessor category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::category_applied_input_type]]
+
+                attr_accessor category_scores: ::Hash[Symbol, Float]
+
+                attr_accessor flagged: bool
+
+                attr_accessor model: String
+
+                attr_accessor type: :moderation_result
+
+                def initialize: (
+                  categories: ::Hash[Symbol, bool],
+                  category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::category_applied_input_type]],
+                  category_scores: ::Hash[Symbol, Float],
+                  flagged: bool,
+                  model: String,
+                  ?type: :moderation_result
+                ) -> void
+
+                def to_hash: -> {
+                  categories: ::Hash[Symbol, bool],
+                  category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::category_applied_input_type]],
+                  category_scores: ::Hash[Symbol, Float],
+                  flagged: bool,
+                  model: String,
+                  type: :moderation_result
+                }
+
+                type category_applied_input_type = :text | :image
+
+                module CategoryAppliedInputType
+                  extend OpenAI::Internal::Type::Enum
+
+                  TEXT: :text
+                  IMAGE: :image
+
+                  def self?.values: -> ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::category_applied_input_type]
+                end
+              end
+            end
+
+            type error = { code: String, message: String, type: :error }
+
+            class Error < OpenAI::Internal::Type::BaseModel
+              attr_accessor code: String
+
+              attr_accessor message: String
+
+              attr_accessor type: :error
+
+              def initialize: (
+                code: String,
+                message: String,
+                ?type: :error
+              ) -> void
+
+              def to_hash: -> { code: String, message: String, type: :error }
+            end
+
+            def self?.variants: -> ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::input]
+          end
+
+          type output =
+            OpenAI::Chat::ChatCompletion::Moderation::Output::ModerationResults
+            | OpenAI::Chat::ChatCompletion::Moderation::Output::Error
+
+          module Output
+            extend OpenAI::Internal::Type::Union
+
+            type moderation_results =
+              {
+                model: String,
+                results: ::Array[OpenAI::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result],
+                type: :moderation_results
+              }
+
+            class ModerationResults < OpenAI::Internal::Type::BaseModel
+              attr_accessor model: String
+
+              attr_accessor results: ::Array[OpenAI::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result]
+
+              attr_accessor type: :moderation_results
+
+              def initialize: (
+                model: String,
+                results: ::Array[OpenAI::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result],
+                ?type: :moderation_results
+              ) -> void
+
+              def to_hash: -> {
+                model: String,
+                results: ::Array[OpenAI::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result],
+                type: :moderation_results
+              }
+
+              type result =
+                {
+                  categories: ::Hash[Symbol, bool],
+                  category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::category_applied_input_type]],
+                  category_scores: ::Hash[Symbol, Float],
+                  flagged: bool,
+                  model: String,
+                  type: :moderation_result
+                }
+
+              class Result < OpenAI::Internal::Type::BaseModel
+                attr_accessor categories: ::Hash[Symbol, bool]
+
+                attr_accessor category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::category_applied_input_type]]
+
+                attr_accessor category_scores: ::Hash[Symbol, Float]
+
+                attr_accessor flagged: bool
+
+                attr_accessor model: String
+
+                attr_accessor type: :moderation_result
+
+                def initialize: (
+                  categories: ::Hash[Symbol, bool],
+                  category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::category_applied_input_type]],
+                  category_scores: ::Hash[Symbol, Float],
+                  flagged: bool,
+                  model: String,
+                  ?type: :moderation_result
+                ) -> void
+
+                def to_hash: -> {
+                  categories: ::Hash[Symbol, bool],
+                  category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::category_applied_input_type]],
+                  category_scores: ::Hash[Symbol, Float],
+                  flagged: bool,
+                  model: String,
+                  type: :moderation_result
+                }
+
+                type category_applied_input_type = :text | :image
+
+                module CategoryAppliedInputType
+                  extend OpenAI::Internal::Type::Enum
+
+                  TEXT: :text
+                  IMAGE: :image
+
+                  def self?.values: -> ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::category_applied_input_type]
+                end
+              end
+            end
+
+            type error = { code: String, message: String, type: :error }
+
+            class Error < OpenAI::Internal::Type::BaseModel
+              attr_accessor code: String
+
+              attr_accessor message: String
+
+              attr_accessor type: :error
+
+              def initialize: (
+                code: String,
+                message: String,
+                ?type: :error
+              ) -> void
+
+              def to_hash: -> { code: String, message: String, type: :error }
+            end
+
+            def self?.variants: -> ::Array[OpenAI::Models::Chat::ChatCompletion::Moderation::output]
+          end
+        end
+
         type service_tier = :auto | :default | :flex | :scale | :priority
 
         module ServiceTier