openai 0.1.0.pre.beta.2 → 0.1.0

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseAudioDeltaEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute delta
-        #   A chunk of Base64 encoded response audio bytes.
-        #
-        #   @return [String]
-        required :delta, String
-
-        # @!attribute sequence_number
-        #   A sequence number for this chunk of the stream response.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always `response.audio.delta`.
-        #
-        #   @return [Symbol, :"response.audio.delta"]
-        required :type, const: :"response.audio.delta"
-
-        # @!method initialize(delta:, sequence_number:, type: :"response.audio.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseAudioDeltaEvent} for more details.
-        #
-        #   Emitted when there is a partial audio response.
-        #
-        #   @param delta [String] A chunk of Base64 encoded response audio bytes.
-        #
-        #   @param sequence_number [Integer] A sequence number for this chunk of the stream response.
-        #
-        #   @param type [Symbol, :"response.audio.delta"] The type of the event. Always `response.audio.delta`.
-      end
-    end
-  end
-end

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

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

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

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

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

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

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      # @see OpenAI::Resources::Responses#cancel
-      class ResponseCancelParams < OpenAI::Internal::Type::BaseModel
-        extend OpenAI::Internal::Type::RequestParameters::Converter
-        include OpenAI::Internal::Type::RequestParameters
-
-        # @!method initialize(request_options: {})
-        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseCodeInterpreterCallCodeDeltaEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute delta
-        #   The partial code snippet added by the code interpreter.
-        #
-        #   @return [String]
-        required :delta, String
-
-        # @!attribute output_index
-        #   The index of the output item that the code interpreter call is in progress.
-        #
-        #   @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.code_interpreter_call.code.delta`.
-        #
-        #   @return [Symbol, :"response.code_interpreter_call.code.delta"]
-        required :type, const: :"response.code_interpreter_call.code.delta"
-
-        # @!method initialize(delta:, output_index:, sequence_number:, type: :"response.code_interpreter_call.code.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent} for more
-        #   details.
-        #
-        #   Emitted when a partial code snippet is added by the code interpreter.
-        #
-        #   @param delta [String] The partial code snippet added by the code interpreter.
-        #
-        #   @param output_index [Integer] The index of the output item that the code interpreter call is in progress.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.code_interpreter_call.code.delta"] The type of the event. Always `response.code_interpreter_call.code.delta`.
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseCodeInterpreterCallCodeDoneEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute code
-        #   The final code snippet output by the code interpreter.
-        #
-        #   @return [String]
-        required :code, String
-
-        # @!attribute output_index
-        #   The index of the output item that the code interpreter call is in progress.
-        #
-        #   @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.code_interpreter_call.code.done`.
-        #
-        #   @return [Symbol, :"response.code_interpreter_call.code.done"]
-        required :type, const: :"response.code_interpreter_call.code.done"
-
-        # @!method initialize(code:, output_index:, sequence_number:, type: :"response.code_interpreter_call.code.done")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent} for more
-        #   details.
-        #
-        #   Emitted when code snippet output is finalized by the code interpreter.
-        #
-        #   @param code [String] The final code snippet output by the code interpreter.
-        #
-        #   @param output_index [Integer] The index of the output item that the code interpreter call is in progress.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.code_interpreter_call.code.done"] The type of the event. Always `response.code_interpreter_call.code.done`.
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseCodeInterpreterCallCompletedEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute code_interpreter_call
-        #   A tool call to run code.
-        #
-        #   @return [OpenAI::Models::Responses::ResponseCodeInterpreterToolCall]
-        required :code_interpreter_call, -> { OpenAI::Responses::ResponseCodeInterpreterToolCall }
-
-        # @!attribute output_index
-        #   The index of the output item that the code interpreter call is in progress.
-        #
-        #   @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.code_interpreter_call.completed`.
-        #
-        #   @return [Symbol, :"response.code_interpreter_call.completed"]
-        required :type, const: :"response.code_interpreter_call.completed"
-
-        # @!method initialize(code_interpreter_call:, output_index:, sequence_number:, type: :"response.code_interpreter_call.completed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent} for more
-        #   details.
-        #
-        #   Emitted when the code interpreter call is completed.
-        #
-        #   @param code_interpreter_call [OpenAI::Models::Responses::ResponseCodeInterpreterToolCall] A tool call to run code.
-        #
-        #   @param output_index [Integer] The index of the output item that the code interpreter call is in progress.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.code_interpreter_call.completed"] The type of the event. Always `response.code_interpreter_call.completed`.
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseCodeInterpreterCallInProgressEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute code_interpreter_call
-        #   A tool call to run code.
-        #
-        #   @return [OpenAI::Models::Responses::ResponseCodeInterpreterToolCall]
-        required :code_interpreter_call, -> { OpenAI::Responses::ResponseCodeInterpreterToolCall }
-
-        # @!attribute output_index
-        #   The index of the output item that the code interpreter call is in progress.
-        #
-        #   @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.code_interpreter_call.in_progress`.
-        #
-        #   @return [Symbol, :"response.code_interpreter_call.in_progress"]
-        required :type, const: :"response.code_interpreter_call.in_progress"
-
-        # @!method initialize(code_interpreter_call:, output_index:, sequence_number:, type: :"response.code_interpreter_call.in_progress")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent} for more
-        #   details.
-        #
-        #   Emitted when a code interpreter call is in progress.
-        #
-        #   @param code_interpreter_call [OpenAI::Models::Responses::ResponseCodeInterpreterToolCall] A tool call to run code.
-        #
-        #   @param output_index [Integer] The index of the output item that the code interpreter call is in progress.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.code_interpreter_call.in_progress"] The type of the event. Always `response.code_interpreter_call.in_progress`.
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseCodeInterpreterCallInterpretingEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute code_interpreter_call
-        #   A tool call to run code.
-        #
-        #   @return [OpenAI::Models::Responses::ResponseCodeInterpreterToolCall]
-        required :code_interpreter_call, -> { OpenAI::Responses::ResponseCodeInterpreterToolCall }
-
-        # @!attribute output_index
-        #   The index of the output item that the code interpreter call is in progress.
-        #
-        #   @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.code_interpreter_call.interpreting`.
-        #
-        #   @return [Symbol, :"response.code_interpreter_call.interpreting"]
-        required :type, const: :"response.code_interpreter_call.interpreting"
-
-        # @!method initialize(code_interpreter_call:, output_index:, sequence_number:, type: :"response.code_interpreter_call.interpreting")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent} for
-        #   more details.
-        #
-        #   Emitted when the code interpreter is actively interpreting the code snippet.
-        #
-        #   @param code_interpreter_call [OpenAI::Models::Responses::ResponseCodeInterpreterToolCall] A tool call to run code.
-        #
-        #   @param output_index [Integer] The index of the output item that the code interpreter call is in progress.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.code_interpreter_call.interpreting"] The type of the event. Always `response.code_interpreter_call.interpreting`.
-      end
-    end
-  end
-end

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

@@ -1,171 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseCodeInterpreterToolCall < OpenAI::Internal::Type::BaseModel
-        # @!attribute id
-        #   The unique ID of the code interpreter tool call.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute code
-        #   The code to run.
-        #
-        #   @return [String]
-        required :code, String
-
-        # @!attribute results
-        #   The results of the code interpreter tool call.
-        #
-        #   @return [Array<OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Logs, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Files>]
-        required :results,
-                 -> {
-                   OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseCodeInterpreterToolCall::Result]
-                 }
-
-        # @!attribute status
-        #   The status of the code interpreter tool call.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Status]
-        required :status, enum: -> { OpenAI::Responses::ResponseCodeInterpreterToolCall::Status }
-
-        # @!attribute type
-        #   The type of the code interpreter tool call. Always `code_interpreter_call`.
-        #
-        #   @return [Symbol, :code_interpreter_call]
-        required :type, const: :code_interpreter_call
-
-        # @!attribute container_id
-        #   The ID of the container used to run the code.
-        #
-        #   @return [String, nil]
-        optional :container_id, String
-
-        # @!method initialize(id:, code:, results:, status:, container_id: nil, type: :code_interpreter_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterToolCall} for more details.
-        #
-        #   A tool call to run code.
-        #
-        #   @param id [String] The unique ID of the code interpreter tool call.
-        #
-        #   @param code [String] The code to run.
-        #
-        #   @param results [Array<OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Logs, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Files>] The results of the code interpreter tool call.
-        #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Status] The status of the code interpreter tool call.
-        #
-        #   @param container_id [String] The ID of the container used to run the code.
-        #
-        #   @param type [Symbol, :code_interpreter_call] The type of the code interpreter tool call. Always `code_interpreter_call`.
-
-        # The output of a code interpreter tool.
-        module Result
-          extend OpenAI::Internal::Type::Union
-
-          discriminator :type
-
-          # The output of a code interpreter tool call that is text.
-          variant :logs, -> { OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Logs }
-
-          # The output of a code interpreter tool call that is a file.
-          variant :files, -> { OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files }
-
-          class Logs < OpenAI::Internal::Type::BaseModel
-            # @!attribute logs
-            #   The logs of the code interpreter tool call.
-            #
-            #   @return [String]
-            required :logs, String
-
-            # @!attribute type
-            #   The type of the code interpreter text output. Always `logs`.
-            #
-            #   @return [Symbol, :logs]
-            required :type, const: :logs
-
-            # @!method initialize(logs:, type: :logs)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Logs} for
-            #   more details.
-            #
-            #   The output of a code interpreter tool call that is text.
-            #
-            #   @param logs [String] The logs of the code interpreter tool call.
-            #
-            #   @param type [Symbol, :logs] The type of the code interpreter text output. Always `logs`.
-          end
-
-          class Files < OpenAI::Internal::Type::BaseModel
-            # @!attribute files
-            #
-            #   @return [Array<OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Files::File>]
-            required :files,
-                     -> {
-                       OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files::File]
-                     }
-
-            # @!attribute type
-            #   The type of the code interpreter file output. Always `files`.
-            #
-            #   @return [Symbol, :files]
-            required :type, const: :files
-
-            # @!method initialize(files:, type: :files)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Files} for
-            #   more details.
-            #
-            #   The output of a code interpreter tool call that is a file.
-            #
-            #   @param files [Array<OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Files::File>]
-            #
-            #   @param type [Symbol, :files] The type of the code interpreter file output. Always `files`.
-
-            class File < OpenAI::Internal::Type::BaseModel
-              # @!attribute file_id
-              #   The ID of the file.
-              #
-              #   @return [String]
-              required :file_id, String
-
-              # @!attribute mime_type
-              #   The MIME type of the file.
-              #
-              #   @return [String]
-              required :mime_type, String
-
-              # @!method initialize(file_id:, mime_type:)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Files::File}
-              #   for more details.
-              #
-              #   @param file_id [String] The ID of the file.
-              #
-              #   @param mime_type [String] The MIME type of the file.
-            end
-          end
-
-          # @!method self.variants
-          #   @return [Array(OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Logs, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result::Files)]
-        end
-
-        # The status of the code interpreter tool call.
-        #
-        # @see OpenAI::Models::Responses::ResponseCodeInterpreterToolCall#status
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          IN_PROGRESS = :in_progress
-          INTERPRETING = :interpreting
-          COMPLETED = :completed
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

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

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