openai 0.1.0.pre.beta.2 → 0.1.0

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFunctionToolCallItem < OpenAI::Models::Responses::ResponseFunctionToolCall
-        # @!attribute id
-        #   The unique ID of the function tool call.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!method initialize(id:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFunctionToolCallItem} for more details.
-        #
-        #   A tool call to run a function. See the
-        #   [function calling guide](https://platform.openai.com/docs/guides/function-calling)
-        #   for more information.
-        #
-        #   @param id [String] The unique ID of the function tool call.
-      end
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFunctionToolCallOutputItem < OpenAI::Internal::Type::BaseModel
-        # @!attribute id
-        #   The unique ID of the function call tool output.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute call_id
-        #   The unique ID of the function tool call generated by the model.
-        #
-        #   @return [String]
-        required :call_id, String
-
-        # @!attribute output
-        #   A JSON string of the output of the function tool call.
-        #
-        #   @return [String]
-        required :output, String
-
-        # @!attribute type
-        #   The type of the function tool call output. Always `function_call_output`.
-        #
-        #   @return [Symbol, :function_call_output]
-        required :type, const: :function_call_output
-
-        # @!attribute status
-        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
-        #   Populated when items are returned via API.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Status, nil]
-        optional :status, enum: -> { OpenAI::Responses::ResponseFunctionToolCallOutputItem::Status }
-
-        # @!method initialize(id:, call_id:, output:, status: nil, type: :function_call_output)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem} for more
-        #   details.
-        #
-        #   @param id [String] The unique ID of the function call tool output.
-        #
-        #   @param call_id [String] The unique ID of the function tool call generated by the model.
-        #
-        #   @param output [String] A JSON string of the output of the function tool call.
-        #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Status] The status of the item. One of `in_progress`, `completed`, or
-        #
-        #   @param type [Symbol, :function_call_output] The type of the function tool call output. Always `function_call_output`.
-
-        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
-        # Populated when items are returned via API.
-        #
-        # @see OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem#status
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          IN_PROGRESS = :in_progress
-          COMPLETED = :completed
-          INCOMPLETE = :incomplete
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

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

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFunctionWebSearch < OpenAI::Internal::Type::BaseModel
-        # @!attribute id
-        #   The unique ID of the web search tool call.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute status
-        #   The status of the web search tool call.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::ResponseFunctionWebSearch::Status]
-        required :status, enum: -> { OpenAI::Responses::ResponseFunctionWebSearch::Status }
-
-        # @!attribute type
-        #   The type of the web search tool call. Always `web_search_call`.
-        #
-        #   @return [Symbol, :web_search_call]
-        required :type, const: :web_search_call
-
-        # @!method initialize(id:, status:, type: :web_search_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFunctionWebSearch} for more details.
-        #
-        #   The results of a web search tool call. See the
-        #   [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for
-        #   more information.
-        #
-        #   @param id [String] The unique ID of the web search tool call.
-        #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionWebSearch::Status] The status of the web search tool call.
-        #
-        #   @param type [Symbol, :web_search_call] The type of the web search tool call. Always `web_search_call`.
-
-        # The status of the web search tool call.
-        #
-        # @see OpenAI::Models::Responses::ResponseFunctionWebSearch#status
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          IN_PROGRESS = :in_progress
-          SEARCHING = :searching
-          COMPLETED = :completed
-          FAILED = :failed
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseImageGenCallCompletedEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute item_id
-        #   The unique identifier of the image generation item being processed.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always 'response.image_generation_call.completed'.
-        #
-        #   @return [Symbol, :"response.image_generation_call.completed"]
-        required :type, const: :"response.image_generation_call.completed"
-
-        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.image_generation_call.completed")
-        #   Emitted when an image generation tool call has completed and the final image is
-        #   available.
-        #
-        #   @param item_id [String] The unique identifier of the image generation item being processed.
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.image_generation_call.completed"] The type of the event. Always 'response.image_generation_call.completed'.
-      end
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseImageGenCallGeneratingEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute item_id
-        #   The unique identifier of the image generation item being processed.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of the image generation item being processed.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always 'response.image_generation_call.generating'.
-        #
-        #   @return [Symbol, :"response.image_generation_call.generating"]
-        required :type, const: :"response.image_generation_call.generating"
-
-        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.image_generation_call.generating")
-        #   Emitted when an image generation tool call is actively generating an image
-        #   (intermediate state).
-        #
-        #   @param item_id [String] The unique identifier of the image generation item being processed.
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param sequence_number [Integer] The sequence number of the image generation item being processed.
-        #
-        #   @param type [Symbol, :"response.image_generation_call.generating"] The type of the event. Always 'response.image_generation_call.generating'.
-      end
-    end
-  end
-end

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

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseImageGenCallInProgressEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute item_id
-        #   The unique identifier of the image generation item being processed.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of the image generation item being processed.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always 'response.image_generation_call.in_progress'.
-        #
-        #   @return [Symbol, :"response.image_generation_call.in_progress"]
-        required :type, const: :"response.image_generation_call.in_progress"
-
-        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.image_generation_call.in_progress")
-        #   Emitted when an image generation tool call is in progress.
-        #
-        #   @param item_id [String] The unique identifier of the image generation item being processed.
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param sequence_number [Integer] The sequence number of the image generation item being processed.
-        #
-        #   @param type [Symbol, :"response.image_generation_call.in_progress"] The type of the event. Always 'response.image_generation_call.in_progress'.
-      end
-    end
-  end
-end

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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseImageGenCallPartialImageEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute item_id
-        #   The unique identifier of the image generation item being processed.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute partial_image_b64
-        #   Base64-encoded partial image data, suitable for rendering as an image.
-        #
-        #   @return [String]
-        required :partial_image_b64, String
-
-        # @!attribute partial_image_index
-        #   0-based index for the partial image (backend is 1-based, but this is 0-based for
-        #   the user).
-        #
-        #   @return [Integer]
-        required :partial_image_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of the image generation item being processed.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always 'response.image_generation_call.partial_image'.
-        #
-        #   @return [Symbol, :"response.image_generation_call.partial_image"]
-        required :type, const: :"response.image_generation_call.partial_image"
-
-        # @!method initialize(item_id:, output_index:, partial_image_b64:, partial_image_index:, sequence_number:, type: :"response.image_generation_call.partial_image")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent} for more
-        #   details.
-        #
-        #   Emitted when a partial image is available during image generation streaming.
-        #
-        #   @param item_id [String] The unique identifier of the image generation item being processed.
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param partial_image_b64 [String] Base64-encoded partial image data, suitable for rendering as an image.
-        #
-        #   @param partial_image_index [Integer] 0-based index for the partial image (backend is 1-based, but this is 0-based for
-        #
-        #   @param sequence_number [Integer] The sequence number of the image generation item being processed.
-        #
-        #   @param type [Symbol, :"response.image_generation_call.partial_image"] The type of the event. Always 'response.image_generation_call.partial_image'.
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseInProgressEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute response
-        #   The response that is in progress.
-        #
-        #   @return [OpenAI::Models::Responses::Response]
-        required :response, -> { OpenAI::Responses::Response }
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always `response.in_progress`.
-        #
-        #   @return [Symbol, :"response.in_progress"]
-        required :type, const: :"response.in_progress"
-
-        # @!method initialize(response:, sequence_number:, type: :"response.in_progress")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInProgressEvent} for more details.
-        #
-        #   Emitted when the response is in progress.
-        #
-        #   @param response [OpenAI::Models::Responses::Response] The response that is in progress.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.in_progress"] The type of the event. Always `response.in_progress`.
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      # Specify additional output data to include in the model response. Currently
-      # supported values are:
-      #
-      # - `file_search_call.results`: Include the search results of the file search tool
-      #   call.
-      # - `message.input_image.image_url`: Include image urls from the input message.
-      # - `computer_call_output.output.image_url`: Include image urls from the computer
-      #   call output.
-      # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
-      #   tokens in reasoning item outputs. This enables reasoning items to be used in
-      #   multi-turn conversations when using the Responses API statelessly (like when
-      #   the `store` parameter is set to `false`, or when an organization is enrolled
-      #   in the zero data retention program).
-      module ResponseIncludable
-        extend OpenAI::Internal::Type::Enum
-
-        FILE_SEARCH_CALL_RESULTS = :"file_search_call.results"
-        MESSAGE_INPUT_IMAGE_IMAGE_URL = :"message.input_image.image_url"
-        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL = :"computer_call_output.output.image_url"
-        REASONING_ENCRYPTED_CONTENT = :"reasoning.encrypted_content"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseIncompleteEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute response
-        #   The response that was incomplete.
-        #
-        #   @return [OpenAI::Models::Responses::Response]
-        required :response, -> { OpenAI::Responses::Response }
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always `response.incomplete`.
-        #
-        #   @return [Symbol, :"response.incomplete"]
-        required :type, const: :"response.incomplete"
-
-        # @!method initialize(response:, sequence_number:, type: :"response.incomplete")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseIncompleteEvent} for more details.
-        #
-        #   An event that is emitted when a response finishes as incomplete.
-        #
-        #   @param response [OpenAI::Models::Responses::Response] The response that was incomplete.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.incomplete"] The type of the event. Always `response.incomplete`.
-      end
-    end
-  end
-end

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

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      # @type [OpenAI::Internal::Type::Converter]
-      ResponseInput = OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Responses::ResponseInputItem }]
-    end
-  end
-end

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

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseInputAudio < OpenAI::Internal::Type::BaseModel
-        # @!attribute data
-        #   Base64-encoded audio data.
-        #
-        #   @return [String]
-        required :data, String
-
-        # @!attribute format_
-        #   The format of the audio data. Currently supported formats are `mp3` and `wav`.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::ResponseInputAudio::Format]
-        required :format_, enum: -> { OpenAI::Responses::ResponseInputAudio::Format }, api_name: :format
-
-        # @!attribute type
-        #   The type of the input item. Always `input_audio`.
-        #
-        #   @return [Symbol, :input_audio]
-        required :type, const: :input_audio
-
-        # @!method initialize(data:, format_:, type: :input_audio)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInputAudio} for more details.
-        #
-        #   An audio input to the model.
-        #
-        #   @param data [String] Base64-encoded audio data.
-        #
-        #   @param format_ [Symbol, OpenAI::Models::Responses::ResponseInputAudio::Format] The format of the audio data. Currently supported formats are `mp3` and
-        #
-        #   @param type [Symbol, :input_audio] The type of the input item. Always `input_audio`.
-
-        # The format of the audio data. Currently supported formats are `mp3` and `wav`.
-        #
-        # @see OpenAI::Models::Responses::ResponseInputAudio#format_
-        module Format
-          extend OpenAI::Internal::Type::Enum
-
-          MP3 = :mp3
-          WAV = :wav
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      # A text input to the model.
-      module ResponseInputContent
-        extend OpenAI::Internal::Type::Union
-
-        discriminator :type
-
-        # A text input to the model.
-        variant :input_text, -> { OpenAI::Responses::ResponseInputText }
-
-        # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
-        variant :input_image, -> { OpenAI::Responses::ResponseInputImage }
-
-        # A file input to the model.
-        variant :input_file, -> { OpenAI::Responses::ResponseInputFile }
-
-        # @!method self.variants
-        #   @return [Array(OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile)]
-      end
-    end
-  end
-end

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseInputFile < OpenAI::Internal::Type::BaseModel
-        # @!attribute type
-        #   The type of the input item. Always `input_file`.
-        #
-        #   @return [Symbol, :input_file]
-        required :type, const: :input_file
-
-        # @!attribute file_data
-        #   The content of the file to be sent to the model.
-        #
-        #   @return [String, nil]
-        optional :file_data, String
-
-        # @!attribute file_id
-        #   The ID of the file to be sent to the model.
-        #
-        #   @return [String, nil]
-        optional :file_id, String, nil?: true
-
-        # @!attribute filename
-        #   The name of the file to be sent to the model.
-        #
-        #   @return [String, nil]
-        optional :filename, String
-
-        # @!method initialize(file_data: nil, file_id: nil, filename: nil, type: :input_file)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInputFile} for more details.
-        #
-        #   A file input to the model.
-        #
-        #   @param file_data [String] The content of the file to be sent to the model.
-        #
-        #   @param file_id [String, nil] The ID of the file to be sent to the model.
-        #
-        #   @param filename [String] The name of the file to be sent to the model.
-        #
-        #   @param type [Symbol, :input_file] The type of the input item. Always `input_file`.
-      end
-    end
-  end
-end

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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseInputImage < OpenAI::Internal::Type::BaseModel
-        # @!attribute detail
-        #   The detail level of the image to be sent to the model. One of `high`, `low`, or
-        #   `auto`. Defaults to `auto`.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::ResponseInputImage::Detail]
-        required :detail, enum: -> { OpenAI::Responses::ResponseInputImage::Detail }
-
-        # @!attribute type
-        #   The type of the input item. Always `input_image`.
-        #
-        #   @return [Symbol, :input_image]
-        required :type, const: :input_image
-
-        # @!attribute file_id
-        #   The ID of the file to be sent to the model.
-        #
-        #   @return [String, nil]
-        optional :file_id, String, nil?: true
-
-        # @!attribute image_url
-        #   The URL of the image to be sent to the model. A fully qualified URL or base64
-        #   encoded image in a data URL.
-        #
-        #   @return [String, nil]
-        optional :image_url, String, nil?: true
-
-        # @!method initialize(detail:, file_id: nil, image_url: nil, type: :input_image)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInputImage} for more details.
-        #
-        #   An image input to the model. Learn about
-        #   [image inputs](https://platform.openai.com/docs/guides/vision).
-        #
-        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputImage::Detail] The detail level of the image to be sent to the model. One of `high`, `low`, or
-        #
-        #   @param file_id [String, nil] The ID of the file to be sent to the model.
-        #
-        #   @param image_url [String, nil] The URL of the image to be sent to the model. A fully qualified URL or base64 en
-        #
-        #   @param type [Symbol, :input_image] The type of the input item. Always `input_image`.
-
-        # The detail level of the image to be sent to the model. One of `high`, `low`, or
-        # `auto`. Defaults to `auto`.
-        #
-        # @see OpenAI::Models::Responses::ResponseInputImage#detail
-        module Detail
-          extend OpenAI::Internal::Type::Enum
-
-          LOW = :low
-          HIGH = :high
-          AUTO = :auto
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end