openai 0.65.0 → 0.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a5fa30c047f790a8b47104b540af59fa63faead196ff665b549fca8fdcbc389
-  data.tar.gz: 0f1c46ebe4c7124a099ccdc6e62cddf49450503fb2eb7457ee112cb5cd4d7a4a
+  metadata.gz: def61cc329e11cd35421f9669cecf9c9f58e909b6e1b6874261c1488c8002eb4
+  data.tar.gz: 1d32ed8ed65907e7345826dc5a8709c0d93d3525e1f18f807972b01ff8ce2547
 SHA512:
-  metadata.gz: 79597c5c13502bb29dec186d69641c8d5df202c0d08af665b14b3169327c294a97a0c011a061d36ce7b30a9a44a6ca76ce47ab6aef8b25ed706aadaf9aa08d01
-  data.tar.gz: 1eafbf4d2a836289e33500620ac9a1d258a252462437ae468bec5370867ed51423bf1de2e6e50dac3909f2b4d3b6dbca83c51e05d155948e2e43083971aae4b4
+  metadata.gz: b2ace6e03dce77274deacb50ebc17952721f235b7c3f9ef5b477b800baa9c08479eae1e9e8866b3426889a106230f10c8c1410119a6b9d1b1d4089c9515a5354
+  data.tar.gz: c23affbd799ec9c17f08004dedb608a56f8074ab117573bcc35b23871b4337c51ddbf2729b25639f6e319d01827822f4ca08881204791f02b2ab61fd2e5f4550

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.66.0 (2026-06-03)
+
+Full Changelog: [v0.65.0...v0.66.0](https://github.com/openai/openai-ruby/compare/v0.65.0...v0.66.0)
+
+### Features
+
+* **api:** responses.moderation and chat_completions.moderation ([39eeb8b](https://github.com/openai/openai-ruby/commit/39eeb8b3152476aff78c54f196f2e360f58d3408))
+
 ## 0.65.0 (2026-06-01)
 
 Full Changelog: [v0.64.0...v0.65.0](https://github.com/openai/openai-ruby/compare/v0.64.0...v0.65.0)

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

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

@@ -38,6 +38,13 @@ module OpenAI
         #   @return [Symbol, :"chat.completion"]
         required :object, const: :"chat.completion"
 
+        # @!attribute moderation
+        #   Moderation results for the request input and generated output, if moderated
+        #   completions were requested.
+        #
+        #   @return [OpenAI::Models::Chat::ChatCompletion::Moderation, nil]
+        optional :moderation, -> { OpenAI::Chat::ChatCompletion::Moderation }, nil?: true
+
         # @!attribute service_tier
         #   Specifies the processing type used for serving the request.
         #
@@ -76,7 +83,7 @@ module OpenAI
         #   @return [OpenAI::Models::CompletionUsage, nil]
         optional :usage, -> { OpenAI::CompletionUsage }
 
-        # @!method initialize(id:, choices:, created:, model:, service_tier: nil, system_fingerprint: nil, usage: nil, object: :"chat.completion")
+        # @!method initialize(id:, choices:, created:, model:, moderation: nil, service_tier: nil, system_fingerprint: nil, usage: nil, object: :"chat.completion")
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Chat::ChatCompletion} for more details.
         #
@@ -91,6 +98,8 @@ module OpenAI
         #
         #   @param model [String] The model used for the chat completion.
         #
+        #   @param moderation [OpenAI::Models::Chat::ChatCompletion::Moderation, nil] Moderation results for the request input and generated output, if moderated
+        #
         #   @param service_tier [Symbol, OpenAI::Models::Chat::ChatCompletion::ServiceTier, nil] Specifies the processing type used for serving the request.
         #
         #   @param system_fingerprint [String] This fingerprint represents the backend configuration that the model runs with.
@@ -106,7 +115,8 @@ module OpenAI
           #   number of tokens specified in the request was reached, `content_filter` if
           #   content was omitted due to a flag from our content filters, `tool_calls` if the
           #   model called a tool, or `function_call` (deprecated) if the model called a
-          #   function.
+          #   function. Read the [Model Spec](https://model-spec.openai.com/2025-12-18.html)
+          #   for more.
           #
           #   @return [Symbol, OpenAI::Models::Chat::ChatCompletion::Choice::FinishReason]
           required :finish_reason, enum: -> { OpenAI::Chat::ChatCompletion::Choice::FinishReason }
@@ -146,7 +156,8 @@ module OpenAI
           # number of tokens specified in the request was reached, `content_filter` if
           # content was omitted due to a flag from our content filters, `tool_calls` if the
           # model called a tool, or `function_call` (deprecated) if the model called a
-          # function.
+          # function. Read the [Model Spec](https://model-spec.openai.com/2025-12-18.html)
+          # for more.
           #
           # @see OpenAI::Models::Chat::ChatCompletion::Choice#finish_reason
           module FinishReason
@@ -189,6 +200,333 @@ module OpenAI
           end
         end
 
+        # @see OpenAI::Models::Chat::ChatCompletion#moderation
+        class Moderation < OpenAI::Internal::Type::BaseModel
+          # @!attribute input
+          #   Moderation for the request input.
+          #
+          #   @return [OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::Error]
+          required :input, union: -> { OpenAI::Chat::ChatCompletion::Moderation::Input }
+
+          # @!attribute output
+          #   Moderation for the generated output.
+          #
+          #   @return [OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::Error]
+          required :output, union: -> { OpenAI::Chat::ChatCompletion::Moderation::Output }
+
+          # @!method initialize(input:, output:)
+          #   Moderation results for the request input and generated output, if moderated
+          #   completions were requested.
+          #
+          #   @param input [OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::Error] Moderation for the request input.
+          #
+          #   @param output [OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::Error] Moderation for the generated output.
+
+          # Moderation for the request input.
+          #
+          # @see OpenAI::Models::Chat::ChatCompletion::Moderation#input
+          module Input
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Successful moderation results for the request input or generated output.
+            variant :moderation_results, -> { OpenAI::Chat::ChatCompletion::Moderation::Input::ModerationResults }
+
+            # An error produced while attempting moderation.
+            variant :error, -> { OpenAI::Chat::ChatCompletion::Moderation::Input::Error }
+
+            class ModerationResults < OpenAI::Internal::Type::BaseModel
+              # @!attribute model
+              #   The moderation model used to generate the results.
+              #
+              #   @return [String]
+              required :model, String
+
+              # @!attribute results
+              #   A list of moderation results.
+              #
+              #   @return [Array<OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result>]
+              required :results,
+                       -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result] }
+
+              # @!attribute type
+              #   The object type, which is always `moderation_results`.
+              #
+              #   @return [Symbol, :moderation_results]
+              required :type, const: :moderation_results
+
+              # @!method initialize(model:, results:, type: :moderation_results)
+              #   Successful moderation results for the request input or generated output.
+              #
+              #   @param model [String] The moderation model used to generate the results.
+              #
+              #   @param results [Array<OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result>] A list of moderation results.
+              #
+              #   @param type [Symbol, :moderation_results] The object type, which is always `moderation_results`.
+
+              class Result < OpenAI::Internal::Type::BaseModel
+                # @!attribute categories
+                #   A dictionary of moderation categories to booleans, True if the input is flagged
+                #   under this category.
+                #
+                #   @return [Hash{Symbol=>Boolean}]
+                required :categories, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Boolean]
+
+                # @!attribute category_applied_input_types
+                #   Which modalities of input are reflected by the score for each category.
+                #
+                #   @return [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::CategoryAppliedInputType>}]
+                required :category_applied_input_types,
+                         -> do
+                           OpenAI::Internal::Type::HashOf[
+                             OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::CategoryAppliedInputType]
+                           ]
+                         end
+
+                # @!attribute category_scores
+                #   A dictionary of moderation categories to scores.
+                #
+                #   @return [Hash{Symbol=>Float}]
+                required :category_scores, OpenAI::Internal::Type::HashOf[Float]
+
+                # @!attribute flagged
+                #   A boolean indicating whether the content was flagged by any category.
+                #
+                #   @return [Boolean]
+                required :flagged, OpenAI::Internal::Type::Boolean
+
+                # @!attribute model
+                #   The moderation model that produced this result.
+                #
+                #   @return [String]
+                required :model, String
+
+                # @!attribute type
+                #   The object type, which was always `moderation_result` for successful moderation
+                #   results.
+                #
+                #   @return [Symbol, :moderation_result]
+                required :type, const: :moderation_result
+
+                # @!method initialize(categories:, category_applied_input_types:, category_scores:, flagged:, model:, type: :moderation_result)
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result}
+                #   for more details.
+                #
+                #   A moderation result produced for the response input or output.
+                #
+                #   @param categories [Hash{Symbol=>Boolean}] A dictionary of moderation categories to booleans, True if the input is flagged
+                #
+                #   @param category_applied_input_types [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::CategoryAppliedInputType>}] Which modalities of input are reflected by the score for each category.
+                #
+                #   @param category_scores [Hash{Symbol=>Float}] A dictionary of moderation categories to scores.
+                #
+                #   @param flagged [Boolean] A boolean indicating whether the content was flagged by any category.
+                #
+                #   @param model [String] The moderation model that produced this result.
+                #
+                #   @param type [Symbol, :moderation_result] The object type, which was always `moderation_result` for successful moderation
+
+                module CategoryAppliedInputType
+                  extend OpenAI::Internal::Type::Enum
+
+                  TEXT = :text
+                  IMAGE = :image
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+            end
+
+            class Error < OpenAI::Internal::Type::BaseModel
+              # @!attribute code
+              #   The error code.
+              #
+              #   @return [String]
+              required :code, String
+
+              # @!attribute message
+              #   The error message.
+              #
+              #   @return [String]
+              required :message, String
+
+              # @!attribute type
+              #   The object type, which is always `error`.
+              #
+              #   @return [Symbol, :error]
+              required :type, const: :error
+
+              # @!method initialize(code:, message:, type: :error)
+              #   An error produced while attempting moderation.
+              #
+              #   @param code [String] The error code.
+              #
+              #   @param message [String] The error message.
+              #
+              #   @param type [Symbol, :error] The object type, which is always `error`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::Error)]
+          end
+
+          # Moderation for the generated output.
+          #
+          # @see OpenAI::Models::Chat::ChatCompletion::Moderation#output
+          module Output
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Successful moderation results for the request input or generated output.
+            variant :moderation_results, -> { OpenAI::Chat::ChatCompletion::Moderation::Output::ModerationResults }
+
+            # An error produced while attempting moderation.
+            variant :error, -> { OpenAI::Chat::ChatCompletion::Moderation::Output::Error }
+
+            class ModerationResults < OpenAI::Internal::Type::BaseModel
+              # @!attribute model
+              #   The moderation model used to generate the results.
+              #
+              #   @return [String]
+              required :model, String
+
+              # @!attribute results
+              #   A list of moderation results.
+              #
+              #   @return [Array<OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result>]
+              required :results,
+                       -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result] }
+
+              # @!attribute type
+              #   The object type, which is always `moderation_results`.
+              #
+              #   @return [Symbol, :moderation_results]
+              required :type, const: :moderation_results
+
+              # @!method initialize(model:, results:, type: :moderation_results)
+              #   Successful moderation results for the request input or generated output.
+              #
+              #   @param model [String] The moderation model used to generate the results.
+              #
+              #   @param results [Array<OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result>] A list of moderation results.
+              #
+              #   @param type [Symbol, :moderation_results] The object type, which is always `moderation_results`.
+
+              class Result < OpenAI::Internal::Type::BaseModel
+                # @!attribute categories
+                #   A dictionary of moderation categories to booleans, True if the input is flagged
+                #   under this category.
+                #
+                #   @return [Hash{Symbol=>Boolean}]
+                required :categories, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Boolean]
+
+                # @!attribute category_applied_input_types
+                #   Which modalities of input are reflected by the score for each category.
+                #
+                #   @return [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::CategoryAppliedInputType>}]
+                required :category_applied_input_types,
+                         -> do
+                           OpenAI::Internal::Type::HashOf[
+                             OpenAI::Internal::Type::ArrayOf[
+                               enum: OpenAI::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::CategoryAppliedInputType
+                             ]
+                           ]
+                         end
+
+                # @!attribute category_scores
+                #   A dictionary of moderation categories to scores.
+                #
+                #   @return [Hash{Symbol=>Float}]
+                required :category_scores, OpenAI::Internal::Type::HashOf[Float]
+
+                # @!attribute flagged
+                #   A boolean indicating whether the content was flagged by any category.
+                #
+                #   @return [Boolean]
+                required :flagged, OpenAI::Internal::Type::Boolean
+
+                # @!attribute model
+                #   The moderation model that produced this result.
+                #
+                #   @return [String]
+                required :model, String
+
+                # @!attribute type
+                #   The object type, which was always `moderation_result` for successful moderation
+                #   results.
+                #
+                #   @return [Symbol, :moderation_result]
+                required :type, const: :moderation_result
+
+                # @!method initialize(categories:, category_applied_input_types:, category_scores:, flagged:, model:, type: :moderation_result)
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result}
+                #   for more details.
+                #
+                #   A moderation result produced for the response input or output.
+                #
+                #   @param categories [Hash{Symbol=>Boolean}] A dictionary of moderation categories to booleans, True if the input is flagged
+                #
+                #   @param category_applied_input_types [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::CategoryAppliedInputType>}] Which modalities of input are reflected by the score for each category.
+                #
+                #   @param category_scores [Hash{Symbol=>Float}] A dictionary of moderation categories to scores.
+                #
+                #   @param flagged [Boolean] A boolean indicating whether the content was flagged by any category.
+                #
+                #   @param model [String] The moderation model that produced this result.
+                #
+                #   @param type [Symbol, :moderation_result] The object type, which was always `moderation_result` for successful moderation
+
+                module CategoryAppliedInputType
+                  extend OpenAI::Internal::Type::Enum
+
+                  TEXT = :text
+                  IMAGE = :image
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+            end
+
+            class Error < OpenAI::Internal::Type::BaseModel
+              # @!attribute code
+              #   The error code.
+              #
+              #   @return [String]
+              required :code, String
+
+              # @!attribute message
+              #   The error message.
+              #
+              #   @return [String]
+              required :message, String
+
+              # @!attribute type
+              #   The object type, which is always `error`.
+              #
+              #   @return [Symbol, :error]
+              required :type, const: :error
+
+              # @!method initialize(code:, message:, type: :error)
+              #   An error produced while attempting moderation.
+              #
+              #   @param code [String] The error code.
+              #
+              #   @param message [String] The error message.
+              #
+              #   @param type [Symbol, :error] The object type, which is always `error`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::Error)]
+          end
+        end
+
         # Specifies the processing type used for serving the request.
         #
         # - If set to 'auto', then the request will be processed with the service tier