openai 0.1.0.pre.beta.2

data/lib/openai/models/responses/file_search_tool.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class FileSearchTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the file search tool. Always `file_search`.
+        #
+        #   @return [Symbol, :file_search]
+        required :type, const: :file_search
+
+        # @!attribute vector_store_ids
+        #   The IDs of the vector stores to search.
+        #
+        #   @return [Array<String>]
+        required :vector_store_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+        # @!attribute filters
+        #   A filter to apply.
+        #
+        #   @return [OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter, nil]
+        optional :filters, union: -> { OpenAI::Responses::FileSearchTool::Filters }, nil?: true
+
+        # @!attribute max_num_results
+        #   The maximum number of results to return. This number should be between 1 and 50
+        #   inclusive.
+        #
+        #   @return [Integer, nil]
+        optional :max_num_results, Integer
+
+        # @!attribute ranking_options
+        #   Ranking options for search.
+        #
+        #   @return [OpenAI::Models::Responses::FileSearchTool::RankingOptions, nil]
+        optional :ranking_options, -> { OpenAI::Responses::FileSearchTool::RankingOptions }
+
+        # @!method initialize(vector_store_ids:, filters: nil, max_num_results: nil, ranking_options: nil, type: :file_search)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::FileSearchTool} for more details.
+        #
+        #   A tool that searches for relevant content from uploaded files. Learn more about
+        #   the
+        #   [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
+        #
+        #   @param vector_store_ids [Array<String>] The IDs of the vector stores to search.
+        #
+        #   @param filters [OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter, nil] A filter to apply.
+        #
+        #   @param max_num_results [Integer] The maximum number of results to return. This number should be between 1 and 50
+        #
+        #   @param ranking_options [OpenAI::Models::Responses::FileSearchTool::RankingOptions] Ranking options for search.
+        #
+        #   @param type [Symbol, :file_search] The type of the file search tool. Always `file_search`.
+
+        # A filter to apply.
+        #
+        # @see OpenAI::Models::Responses::FileSearchTool#filters
+        module Filters
+          extend OpenAI::Internal::Type::Union
+
+          # A filter used to compare a specified attribute key to a given value using a defined comparison operation.
+          variant -> { OpenAI::ComparisonFilter }
+
+          # Combine multiple filters using `and` or `or`.
+          variant -> { OpenAI::CompoundFilter }
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter)]
+        end
+
+        # @see OpenAI::Models::Responses::FileSearchTool#ranking_options
+        class RankingOptions < OpenAI::Internal::Type::BaseModel
+          # @!attribute ranker
+          #   The ranker to use for the file search.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::FileSearchTool::RankingOptions::Ranker, nil]
+          optional :ranker, enum: -> { OpenAI::Responses::FileSearchTool::RankingOptions::Ranker }
+
+          # @!attribute score_threshold
+          #   The score threshold for the file search, a number between 0 and 1. Numbers
+          #   closer to 1 will attempt to return only the most relevant results, but may
+          #   return fewer results.
+          #
+          #   @return [Float, nil]
+          optional :score_threshold, Float
+
+          # @!method initialize(ranker: nil, score_threshold: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::FileSearchTool::RankingOptions} for more details.
+          #
+          #   Ranking options for search.
+          #
+          #   @param ranker [Symbol, OpenAI::Models::Responses::FileSearchTool::RankingOptions::Ranker] The ranker to use for the file search.
+          #
+          #   @param score_threshold [Float] The score threshold for the file search, a number between 0 and 1. Numbers close
+
+          # The ranker to use for the file search.
+          #
+          # @see OpenAI::Models::Responses::FileSearchTool::RankingOptions#ranker
+          module Ranker
+            extend OpenAI::Internal::Type::Enum
+
+            AUTO = :auto
+            DEFAULT_2024_11_15 = :"default-2024-11-15"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/responses/function_tool.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class FunctionTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute name
+        #   The name of the function to call.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute parameters
+        #   A JSON schema object describing the parameters of the function.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        required :parameters, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown], nil?: true
+
+        # @!attribute strict
+        #   Whether to enforce strict parameter validation. Default `true`.
+        #
+        #   @return [Boolean, nil]
+        required :strict, OpenAI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute type
+        #   The type of the function tool. Always `function`.
+        #
+        #   @return [Symbol, :function]
+        required :type, const: :function
+
+        # @!attribute description
+        #   A description of the function. Used by the model to determine whether or not to
+        #   call the function.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!method initialize(name:, parameters:, strict:, description: nil, type: :function)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::FunctionTool} for more details.
+        #
+        #   Defines a function in your own code the model can choose to call. Learn more
+        #   about
+        #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+        #
+        #   @param name [String] The name of the function to call.
+        #
+        #   @param parameters [Hash{Symbol=>Object}, nil] A JSON schema object describing the parameters of the function.
+        #
+        #   @param strict [Boolean, nil] Whether to enforce strict parameter validation. Default `true`.
+        #
+        #   @param description [String, nil] A description of the function. Used by the model to determine whether or not to
+        #
+        #   @param type [Symbol, :function] The type of the function tool. Always `function`.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/input_item_list_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      # @see OpenAI::Resources::Responses::InputItems#list
+      class InputItemListParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute after
+        #   An item ID to list items after, used in pagination.
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute before
+        #   An item ID to list items before, used in pagination.
+        #
+        #   @return [String, nil]
+        optional :before, String
+
+        # @!attribute include
+        #   Additional fields to include in the response. See the `include` parameter for
+        #   Response creation above for more information.
+        #
+        #   @return [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
+        optional :include, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::ResponseIncludable] }
+
+        # @!attribute limit
+        #   A limit on the number of objects to be returned. Limit can range between 1 and
+        #   100, and the default is 20.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute order
+        #   The order to return the input items in. Default is `desc`.
+        #
+        #   - `asc`: Return the input items in ascending order.
+        #   - `desc`: Return the input items in descending order.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::InputItemListParams::Order, nil]
+        optional :order, enum: -> { OpenAI::Responses::InputItemListParams::Order }
+
+        # @!method initialize(after: nil, before: nil, include: nil, limit: nil, order: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::InputItemListParams} for more details.
+        #
+        #   @param after [String] An item ID to list items after, used in pagination.
+        #
+        #   @param before [String] An item ID to list items before, used in pagination.
+        #
+        #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
+        #
+        #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between
+        #
+        #   @param order [Symbol, OpenAI::Models::Responses::InputItemListParams::Order] The order to return the input items in. Default is `desc`.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The order to return the input items in. Default is `desc`.
+        #
+        # - `asc`: Return the input items in ascending order.
+        # - `desc`: Return the input items in descending order.
+        module Order
+          extend OpenAI::Internal::Type::Enum
+
+          ASC = :asc
+          DESC = :desc
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response.rb

@@ -0,0 +1,393 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      # @see OpenAI::Resources::Responses#create
+      #
+      # @see OpenAI::Resources::Responses#stream_raw
+      class Response < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for this Response.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   Unix timestamp (in seconds) of when this Response was created.
+        #
+        #   @return [Float]
+        required :created_at, Float
+
+        # @!attribute error
+        #   An error object returned when the model fails to generate a Response.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseError, nil]
+        required :error, -> { OpenAI::Responses::ResponseError }, nil?: true
+
+        # @!attribute incomplete_details
+        #   Details about why the response is incomplete.
+        #
+        #   @return [OpenAI::Models::Responses::Response::IncompleteDetails, nil]
+        required :incomplete_details, -> { OpenAI::Responses::Response::IncompleteDetails }, nil?: true
+
+        # @!attribute instructions
+        #   Inserts a system (or developer) message as the first item in the model's
+        #   context.
+        #
+        #   When using along with `previous_response_id`, the instructions from a previous
+        #   response will not be carried over to the next response. This makes it simple to
+        #   swap out system (or developer) messages in new responses.
+        #
+        #   @return [String, nil]
+        required :instructions, String, nil?: true
+
+        # @!attribute metadata
+        #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+        #   for storing additional information about the object in a structured format, and
+        #   querying for objects via API or the dashboard.
+        #
+        #   Keys are strings with a maximum length of 64 characters. Values are strings with
+        #   a maximum length of 512 characters.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute model
+        #   Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
+        #   wide range of models with different capabilities, performance characteristics,
+        #   and price points. Refer to the
+        #   [model guide](https://platform.openai.com/docs/models) to browse and compare
+        #   available models.
+        #
+        #   @return [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel]
+        required :model, union: -> { OpenAI::ResponsesModel }
+
+        # @!attribute object
+        #   The object type of this resource - always set to `response`.
+        #
+        #   @return [Symbol, :response]
+        required :object, const: :response
+
+        # @!attribute output
+        #   An array of content items generated by the model.
+        #
+        #   - The length and order of items in the `output` array is dependent on the
+        #     model's response.
+        #   - Rather than accessing the first item in the `output` array and assuming it's
+        #     an `assistant` message with the content generated by the model, you might
+        #     consider using the `output_text` property where supported in SDKs.
+        #
+        #   @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest>]
+        required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputItem] }
+
+        # @!attribute parallel_tool_calls
+        #   Whether to allow the model to run tool calls in parallel.
+        #
+        #   @return [Boolean]
+        required :parallel_tool_calls, OpenAI::Internal::Type::Boolean
+
+        # @!attribute temperature
+        #   What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+        #   make the output more random, while lower values like 0.2 will make it more
+        #   focused and deterministic. We generally recommend altering this or `top_p` but
+        #   not both.
+        #
+        #   @return [Float, nil]
+        required :temperature, Float, nil?: true
+
+        # @!attribute tool_choice
+        #   How the model should select which tool (or tools) to use when generating a
+        #   response. See the `tools` parameter to see how to specify which tools the model
+        #   can call.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction]
+        required :tool_choice, union: -> { OpenAI::Responses::Response::ToolChoice }
+
+        # @!attribute tools
+        #   An array of tools the model may call while generating a response. You can
+        #   specify which tool to use by setting the `tool_choice` parameter.
+        #
+        #   The two categories of tools you can provide the model are:
+        #
+        #   - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
+        #     capabilities, like
+        #     [web search](https://platform.openai.com/docs/guides/tools-web-search) or
+        #     [file search](https://platform.openai.com/docs/guides/tools-file-search).
+        #     Learn more about
+        #     [built-in tools](https://platform.openai.com/docs/guides/tools).
+        #   - **Function calls (custom tools)**: Functions that are defined by you, enabling
+        #     the model to call your own code. Learn more about
+        #     [function calling](https://platform.openai.com/docs/guides/function-calling).
+        #
+        #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>]
+        required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
+
+        # @!attribute top_p
+        #   An alternative to sampling with temperature, called nucleus sampling, where the
+        #   model considers the results of the tokens with top_p probability mass. So 0.1
+        #   means only the tokens comprising the top 10% probability mass are considered.
+        #
+        #   We generally recommend altering this or `temperature` but not both.
+        #
+        #   @return [Float, nil]
+        required :top_p, Float, nil?: true
+
+        # @!attribute background
+        #   Whether to run the model response in the background.
+        #   [Learn more](https://platform.openai.com/docs/guides/background).
+        #
+        #   @return [Boolean, nil]
+        optional :background, OpenAI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute max_output_tokens
+        #   An upper bound for the number of tokens that can be generated for a response,
+        #   including visible output tokens and
+        #   [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
+        #
+        #   @return [Integer, nil]
+        optional :max_output_tokens, Integer, nil?: true
+
+        # @!attribute previous_response_id
+        #   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).
+        #
+        #   @return [String, nil]
+        optional :previous_response_id, String, nil?: true
+
+        # @!attribute reasoning
+        #   **o-series models only**
+        #
+        #   Configuration options for
+        #   [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+        #
+        #   @return [OpenAI::Models::Reasoning, nil]
+        optional :reasoning, -> { OpenAI::Reasoning }, nil?: true
+
+        # @!attribute service_tier
+        #   Specifies the latency tier to use for processing the request. This parameter is
+        #   relevant for customers subscribed to the scale tier service:
+        #
+        #   - If set to 'auto', and the Project is Scale tier enabled, the system will
+        #     utilize scale tier credits until they are exhausted.
+        #   - If set to 'auto', and the Project is not Scale tier enabled, the request will
+        #     be processed using the default service tier with a lower uptime SLA and no
+        #     latency guarentee.
+        #   - If set to 'default', the request will be processed using the default service
+        #     tier with a lower uptime SLA and no latency guarentee.
+        #   - If set to 'flex', the request will be processed with the Flex Processing
+        #     service tier.
+        #     [Learn more](https://platform.openai.com/docs/guides/flex-processing).
+        #   - When not set, the default behavior is 'auto'.
+        #
+        #   When this parameter is set, the response body will include the `service_tier`
+        #   utilized.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::Response::ServiceTier, nil]
+        optional :service_tier, enum: -> { OpenAI::Responses::Response::ServiceTier }, nil?: true
+
+        # @!attribute status
+        #   The status of the response generation. One of `completed`, `failed`,
+        #   `in_progress`, `cancelled`, `queued`, or `incomplete`.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::ResponseStatus, nil]
+        optional :status, enum: -> { OpenAI::Responses::ResponseStatus }
+
+        # @!attribute text
+        #   Configuration options for a text response from the model. Can be plain text or
+        #   structured JSON data. Learn more:
+        #
+        #   - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+        #   - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+        #
+        #   @return [OpenAI::Models::Responses::ResponseTextConfig, nil]
+        optional :text, -> { OpenAI::Responses::ResponseTextConfig }
+
+        # @!attribute truncation
+        #   The truncation strategy to use for the model response.
+        #
+        #   - `auto`: If the context of this response and previous ones exceeds the model's
+        #     context window size, the model will truncate the response to fit the context
+        #     window by dropping input items in the middle of the conversation.
+        #   - `disabled` (default): If a model response will exceed the context window size
+        #     for a model, the request will fail with a 400 error.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::Response::Truncation, nil]
+        optional :truncation, enum: -> { OpenAI::Responses::Response::Truncation }, nil?: true
+
+        # @!attribute usage
+        #   Represents token usage details including input tokens, output tokens, a
+        #   breakdown of output tokens, and the total tokens used.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseUsage, nil]
+        optional :usage, -> { OpenAI::Responses::ResponseUsage }
+
+        # @!attribute user
+        #   A stable identifier for your end-users. Used to boost cache hit rates by better
+        #   bucketing similar requests and to help OpenAI detect and prevent abuse.
+        #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+        #
+        #   @return [String, nil]
+        optional :user, String
+
+        # @!method initialize(id:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, max_output_tokens: nil, previous_response_id: nil, reasoning: nil, service_tier: nil, status: nil, text: nil, truncation: nil, usage: nil, user: nil, object: :response)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::Response} for more details.
+        #
+        #   @param id [String] Unique identifier for this Response.
+        #
+        #   @param created_at [Float] Unix timestamp (in seconds) of when this Response was created.
+        #
+        #   @param error [OpenAI::Models::Responses::ResponseError, nil] An error object returned when the model fails to generate a Response.
+        #
+        #   @param incomplete_details [OpenAI::Models::Responses::Response::IncompleteDetails, nil] Details about why the response is incomplete.
+        #
+        #   @param instructions [String, nil] Inserts a system (or developer) message as the first item in the model's context
+        #
+        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #
+        #   @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
+        #
+        #   @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest>] An array of content items generated by the model.
+        #
+        #   @param parallel_tool_calls [Boolean] Whether to allow the model to run tool calls in parallel.
+        #
+        #   @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
+        #
+        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction] How the model should select which tool (or tools) to use when generating
+        #
+        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+        #
+        #   @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
+        #
+        #   @param background [Boolean, nil] Whether to run the model response in the background.
+        #
+        #   @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
+        #
+        #   @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to
+        #
+        #   @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
+        #
+        #   @param service_tier [Symbol, OpenAI::Models::Responses::Response::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
+        #
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseStatus] The status of the response generation. One of `completed`, `failed`,
+        #
+        #   @param text [OpenAI::Models::Responses::ResponseTextConfig] Configuration options for a text response from the model. Can be plain
+        #
+        #   @param truncation [Symbol, OpenAI::Models::Responses::Response::Truncation, nil] The truncation strategy to use for the model response.
+        #
+        #   @param usage [OpenAI::Models::Responses::ResponseUsage] Represents token usage details including input tokens, output tokens,
+        #
+        #   @param user [String] A stable identifier for your end-users.
+        #
+        #   @param object [Symbol, :response] The object type of this resource - always set to `response`.
+
+        # @see OpenAI::Models::Responses::Response#incomplete_details
+        class IncompleteDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute reason
+          #   The reason why the response is incomplete.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::Response::IncompleteDetails::Reason, nil]
+          optional :reason, enum: -> { OpenAI::Responses::Response::IncompleteDetails::Reason }
+
+          # @!method initialize(reason: nil)
+          #   Details about why the response is incomplete.
+          #
+          #   @param reason [Symbol, OpenAI::Models::Responses::Response::IncompleteDetails::Reason] The reason why the response is incomplete.
+
+          # The reason why the response is incomplete.
+          #
+          # @see OpenAI::Models::Responses::Response::IncompleteDetails#reason
+          module Reason
+            extend OpenAI::Internal::Type::Enum
+
+            MAX_OUTPUT_TOKENS = :max_output_tokens
+            CONTENT_FILTER = :content_filter
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # How the model should select which tool (or tools) to use when generating a
+        # response. See the `tools` parameter to see how to specify which tools the model
+        # can call.
+        #
+        # @see OpenAI::Models::Responses::Response#tool_choice
+        module ToolChoice
+          extend OpenAI::Internal::Type::Union
+
+          # Controls which (if any) tool is called by the model.
+          #
+          # `none` means the model will not call any tool and instead generates a message.
+          #
+          # `auto` means the model can pick between generating a message or calling one or
+          # more tools.
+          #
+          # `required` means the model must call one or more tools.
+          variant enum: -> { OpenAI::Responses::ToolChoiceOptions }
+
+          # Indicates that the model should use a built-in tool to generate a response.
+          # [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
+          variant -> { OpenAI::Responses::ToolChoiceTypes }
+
+          # Use this option to force the model to call a specific function.
+          variant -> { OpenAI::Responses::ToolChoiceFunction }
+
+          # @!method self.variants
+          #   @return [Array(Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction)]
+        end
+
+        # Specifies the latency tier to use for processing the request. This parameter is
+        # relevant for customers subscribed to the scale tier service:
+        #
+        # - If set to 'auto', and the Project is Scale tier enabled, the system will
+        #   utilize scale tier credits until they are exhausted.
+        # - If set to 'auto', and the Project is not Scale tier enabled, the request will
+        #   be processed using the default service tier with a lower uptime SLA and no
+        #   latency guarentee.
+        # - If set to 'default', the request will be processed using the default service
+        #   tier with a lower uptime SLA and no latency guarentee.
+        # - If set to 'flex', the request will be processed with the Flex Processing
+        #   service tier.
+        #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
+        # - When not set, the default behavior is 'auto'.
+        #
+        # When this parameter is set, the response body will include the `service_tier`
+        # utilized.
+        #
+        # @see OpenAI::Models::Responses::Response#service_tier
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          DEFAULT = :default
+          FLEX = :flex
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The truncation strategy to use for the model response.
+        #
+        # - `auto`: If the context of this response and previous ones exceeds the model's
+        #   context window size, the model will truncate the response to fit the context
+        #   window by dropping input items in the middle of the conversation.
+        # - `disabled` (default): If a model response will exceed the context window size
+        #   for a model, the request will fail with a 400 error.
+        #
+        # @see OpenAI::Models::Responses::Response#truncation
+        module Truncation
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          DISABLED = :disabled
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end