openai 0.67.0 → 0.69.0

data/lib/openai/models/webhooks/safety_identifier_blocked_webhook_event.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class SafetyIdentifierBlockedWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) of when the request was blocked.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #   Event data payload.
+        #
+        #   @return [OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::SafetyIdentifierBlockedWebhookEvent::Data }
+
+        # @!attribute type
+        #   The type of the event. Always `safety_identifier.blocked`.
+        #
+        #   @return [Symbol, :"safety_identifier.blocked"]
+        required :type, const: :"safety_identifier.blocked"
+
+        # @!attribute object
+        #   The object of the event. Always `event`.
+        #
+        #   @return [Symbol, OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent::Object, nil]
+        optional :object, enum: -> { OpenAI::Webhooks::SafetyIdentifierBlockedWebhookEvent::Object }
+
+        # @!method initialize(id:, created_at:, data:, object: nil, type: :"safety_identifier.blocked")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent} for more
+        #   details.
+        #
+        #   Sent when a request associated with a safety identifier has been blocked.
+        #
+        #   @param id [String] The unique ID of the event.
+        #
+        #   @param created_at [Integer] The Unix timestamp (in seconds) of when the request was blocked.
+        #
+        #   @param data [OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent::Data] Event data payload.
+        #
+        #   @param object [Symbol, OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent::Object] The object of the event. Always `event`.
+        #
+        #   @param type [Symbol, :"safety_identifier.blocked"] The type of the event. Always `safety_identifier.blocked`.
+
+        # @see OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute safety_category
+          #   The safety category that triggered the block, such as `bio` or `cyber`.
+          #
+          #   @return [String]
+          required :safety_category, String
+
+          # @!attribute safety_identifier
+          #   The stable safety identifier associated with the blocked request.
+          #
+          #   @return [String]
+          required :safety_identifier, String
+
+          # @!attribute model
+          #   The model used for the blocked request, if available.
+          #
+          #   @return [String, nil]
+          optional :model, String
+
+          # @!attribute project_id
+          #   The project associated with the blocked request, if available.
+          #
+          #   @return [String, nil]
+          optional :project_id, String
+
+          # @!attribute request_id
+          #   The OpenAI request ID for the blocked request, if available.
+          #
+          #   @return [String, nil]
+          optional :request_id, String
+
+          # @!method initialize(safety_category:, safety_identifier:, model: nil, project_id: nil, request_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent::Data} for more
+          #   details.
+          #
+          #   Event data payload.
+          #
+          #   @param safety_category [String] The safety category that triggered the block, such as `bio` or `cyber`.
+          #
+          #   @param safety_identifier [String] The stable safety identifier associated with the blocked request.
+          #
+          #   @param model [String] The model used for the blocked request, if available.
+          #
+          #   @param project_id [String] The project associated with the blocked request, if available.
+          #
+          #   @param request_id [String] The OpenAI request ID for the blocked request, if available.
+        end
+
+        # The object of the event. Always `event`.
+        #
+        # @see OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/unwrap_webhook_event.rb

@@ -54,8 +54,11 @@ module OpenAI
         # Sent when a background response has been interrupted.
         variant :"response.incomplete", -> { OpenAI::Webhooks::ResponseIncompleteWebhookEvent }
 
+        # Sent when a request associated with a safety identifier has been blocked.
+        variant :"safety_identifier.blocked", -> { OpenAI::Webhooks::SafetyIdentifierBlockedWebhookEvent }
+
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent)]
+        #   @return [Array(OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyIdentifierBlockedWebhookEvent)]
       end
     end
   end

data/lib/openai/resources/beta/assistants.rb

@@ -24,7 +24,7 @@ module OpenAI
         #
         # @param name [String, nil] The name of the assistant. The maximum length is 256 characters.
         #
-        # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
+        # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
         #
         # @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil] Specifies the format that the model must output. Compatible with [GPT-4o](https:
         #
@@ -97,7 +97,7 @@ module OpenAI
         #
         # @param name [String, nil] The name of the assistant. The maximum length is 256 characters.
         #
-        # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
+        # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
         #
         # @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil] Specifies the format that the model must output. Compatible with [GPT-4o](https:
         #

data/lib/openai/resources/beta/responses/input_items.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Beta
+      class Responses
+        class InputItems
+          # Some parameter documentations has been truncated, see
+          # {OpenAI::Models::Beta::Responses::InputItemListParams} for more details.
+          #
+          # Returns a list of input items for a given response.
+          #
+          # @overload list(response_id, after: nil, include: nil, limit: nil, order: nil, betas: nil, request_options: {})
+          #
+          # @param response_id [String] Path param: The ID of the response to retrieve input items for.
+          #
+          # @param after [String] Query param: An item ID to list items after, used in pagination.
+          #
+          # @param include [Array<Symbol, OpenAI::Models::Beta::BetaResponseIncludable>] Query param: Additional fields to include in the response. See the `include`
+          #
+          # @param limit [Integer] Query param: A limit on the number of objects to be returned. Limit can range be
+          #
+          # @param order [Symbol, OpenAI::Models::Beta::Responses::InputItemListParams::Order] Query param: The order to return the input items in. Default is `desc`.
+          #
+          # @param betas [Array<Symbol, OpenAI::Models::Beta::Responses::InputItemListParams::Beta>] Header param: Optional beta features to enable for this request.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::BetaResponseInputMessageItem, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCallItem, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseItem::AgentMessage, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseItem::Program, OpenAI::Models::Beta::BetaResponseItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseItem::McpListTools, OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallItem, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>]
+          #
+          # @see OpenAI::Models::Beta::Responses::InputItemListParams
+          def list(response_id, params = {})
+            query_params = [:after, :include, :limit, :order]
+            parsed, options = OpenAI::Beta::Responses::InputItemListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed.slice(*query_params))
+            @client.request(
+              method: :get,
+              path: ["responses/%1$s/input_items?beta=true", response_id],
+              query: query,
+              headers: parsed.except(*query_params).transform_keys(betas: "openai-beta"),
+              page: OpenAI::Internal::CursorPage,
+              model: OpenAI::Beta::BetaResponseItem,
+              security: {bearer_auth: true},
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [OpenAI::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/beta/responses/input_tokens.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Beta
+      class Responses
+        class InputTokens
+          # Some parameter documentations has been truncated, see
+          # {OpenAI::Models::Beta::Responses::InputTokenCountParams} for more details.
+          #
+          # Returns input token counts of the request.
+          #
+          # Returns an object with `object` set to `response.input_tokens` and an
+          # `input_tokens` count.
+          #
+          # @overload count(conversation: nil, input: nil, instructions: nil, model: nil, parallel_tool_calls: nil, personality: nil, previous_response_id: nil, reasoning: nil, text: nil, tool_choice: nil, tools: nil, truncation: nil, betas: nil, request_options: {})
+          #
+          # @param conversation [String, OpenAI::Models::Beta::BetaResponseConversationParam, nil] Body param: The conversation that this response belongs to. Items from this conv
+          #
+          # @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] Body param: Text, image, or file inputs to the model, used to generate a respons
+          #
+          # @param instructions [String, nil] Body param: A system (or developer) message inserted into the model's context.
+          #
+          # @param model [String, nil] Body param: Model ID used to generate the response, like `gpt-4o` or `o3`. OpenA
+          #
+          # @param parallel_tool_calls [Boolean, nil] Body param: Whether to allow the model to run tool calls in parallel.
+          #
+          # @param personality [String, Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Personality] Body param: A model-owned style preset to apply to this request. Omit this param
+          #
+          # @param previous_response_id [String, nil] Body param: The unique ID of the previous response to the model. Use this to cre
+          #
+          # @param reasoning [OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning, nil] Body param: **gpt-5 and o-series models only** Configuration options for [reason
+          #
+          # @param text [OpenAI::Models::Beta::Responses::InputTokenCountParams::Text, nil] Body param: Configuration options for a text response from the model. Can be pla
+          #
+          # @param tool_choice [Symbol, OpenAI::Models::Beta::BetaToolChoiceOptions, OpenAI::Models::Beta::BetaToolChoiceAllowed, OpenAI::Models::Beta::BetaToolChoiceTypes, OpenAI::Models::Beta::BetaToolChoiceFunction, OpenAI::Models::Beta::BetaToolChoiceMcp, OpenAI::Models::Beta::BetaToolChoiceCustom, OpenAI::Models::Beta::Responses::InputTokenCountParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam, OpenAI::Models::Beta::BetaToolChoiceApplyPatch, OpenAI::Models::Beta::BetaToolChoiceShell, nil] Body param: Controls which tool the model should use, if any.
+          #
+          # @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>, nil] Body param: An array of tools the model may call while generating a response. Yo
+          #
+          # @param truncation [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Truncation] Body param: The truncation strategy to use for the model response. - `auto`: If
+          #
+          # @param betas [Array<Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Beta>] Header param: Optional beta features to enable for this request.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Beta::Responses::InputTokenCountResponse]
+          #
+          # @see OpenAI::Models::Beta::Responses::InputTokenCountParams
+          def count(params = {})
+            parsed, options = OpenAI::Beta::Responses::InputTokenCountParams.dump_request(params)
+            header_params = {betas: "openai-beta"}
+            @client.request(
+              method: :post,
+              path: "responses/input_tokens?beta=true",
+              headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+              body: parsed.except(*header_params.keys),
+              model: OpenAI::Models::Beta::Responses::InputTokenCountResponse,
+              security: {bearer_auth: true},
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [OpenAI::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end