openai 0.1.0.pre.beta.2 → 0.1.0

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

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseErrorEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute code
-        #   The error code.
-        #
-        #   @return [String, nil]
-        required :code, String, nil?: true
-
-        # @!attribute message
-        #   The error message.
-        #
-        #   @return [String]
-        required :message, String
-
-        # @!attribute param
-        #   The error parameter.
-        #
-        #   @return [String, nil]
-        required :param, String, nil?: true
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always `error`.
-        #
-        #   @return [Symbol, :error]
-        required :type, const: :error
-
-        # @!method initialize(code:, message:, param:, sequence_number:, type: :error)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseErrorEvent} for more details.
-        #
-        #   Emitted when an error occurs.
-        #
-        #   @param code [String, nil] The error code.
-        #
-        #   @param message [String] The error message.
-        #
-        #   @param param [String, nil] The error parameter.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :error] The type of the event. Always `error`.
-      end
-    end
-  end
-end

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

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

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFileSearchCallCompletedEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute item_id
-        #   The ID of the output item that the file search call is initiated.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item that the file search call is initiated.
-        #
-        #   @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.file_search_call.completed`.
-        #
-        #   @return [Symbol, :"response.file_search_call.completed"]
-        required :type, const: :"response.file_search_call.completed"
-
-        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.file_search_call.completed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent} for more
-        #   details.
-        #
-        #   Emitted when a file search call is completed (results found).
-        #
-        #   @param item_id [String] The ID of the output item that the file search call is initiated.
-        #
-        #   @param output_index [Integer] The index of the output item that the file search call is initiated.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.file_search_call.completed"] The type of the event. Always `response.file_search_call.completed`.
-      end
-    end
-  end
-end

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

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

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFileSearchCallSearchingEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute item_id
-        #   The ID of the output item that the file search call is initiated.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item that the file search call is searching.
-        #
-        #   @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.file_search_call.searching`.
-        #
-        #   @return [Symbol, :"response.file_search_call.searching"]
-        required :type, const: :"response.file_search_call.searching"
-
-        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.file_search_call.searching")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent} for more
-        #   details.
-        #
-        #   Emitted when a file search is currently searching.
-        #
-        #   @param item_id [String] The ID of the output item that the file search call is initiated.
-        #
-        #   @param output_index [Integer] The index of the output item that the file search call is searching.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.file_search_call.searching"] The type of the event. Always `response.file_search_call.searching`.
-      end
-    end
-  end
-end

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

@@ -1,147 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFileSearchToolCall < OpenAI::Internal::Type::BaseModel
-        # @!attribute id
-        #   The unique ID of the file search tool call.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute queries
-        #   The queries used to search for files.
-        #
-        #   @return [Array<String>]
-        required :queries, OpenAI::Internal::Type::ArrayOf[String]
-
-        # @!attribute status
-        #   The status of the file search tool call. One of `in_progress`, `searching`,
-        #   `incomplete` or `failed`,
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::ResponseFileSearchToolCall::Status]
-        required :status, enum: -> { OpenAI::Responses::ResponseFileSearchToolCall::Status }
-
-        # @!attribute type
-        #   The type of the file search tool call. Always `file_search_call`.
-        #
-        #   @return [Symbol, :file_search_call]
-        required :type, const: :file_search_call
-
-        # @!attribute results
-        #   The results of the file search tool call.
-        #
-        #   @return [Array<OpenAI::Models::Responses::ResponseFileSearchToolCall::Result>, nil]
-        optional :results,
-                 -> {
-                   OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseFileSearchToolCall::Result]
-                 },
-                 nil?: true
-
-        # @!method initialize(id:, queries:, status:, results: nil, type: :file_search_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFileSearchToolCall} for more details.
-        #
-        #   The results of a file search tool call. See the
-        #   [file search guide](https://platform.openai.com/docs/guides/tools-file-search)
-        #   for more information.
-        #
-        #   @param id [String] The unique ID of the file search tool call.
-        #
-        #   @param queries [Array<String>] The queries used to search for files.
-        #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseFileSearchToolCall::Status] The status of the file search tool call. One of `in_progress`,
-        #
-        #   @param results [Array<OpenAI::Models::Responses::ResponseFileSearchToolCall::Result>, nil] The results of the file search tool call.
-        #
-        #   @param type [Symbol, :file_search_call] The type of the file search tool call. Always `file_search_call`.
-
-        # The status of the file search tool call. One of `in_progress`, `searching`,
-        # `incomplete` or `failed`,
-        #
-        # @see OpenAI::Models::Responses::ResponseFileSearchToolCall#status
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          IN_PROGRESS = :in_progress
-          SEARCHING = :searching
-          COMPLETED = :completed
-          INCOMPLETE = :incomplete
-          FAILED = :failed
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        class Result < OpenAI::Internal::Type::BaseModel
-          # @!attribute attributes
-          #   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, booleans, or numbers.
-          #
-          #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
-          optional :attributes,
-                   -> {
-                     OpenAI::Internal::Type::HashOf[union: OpenAI::Responses::ResponseFileSearchToolCall::Result::Attribute]
-                   },
-                   nil?: true
-
-          # @!attribute file_id
-          #   The unique ID of the file.
-          #
-          #   @return [String, nil]
-          optional :file_id, String
-
-          # @!attribute filename
-          #   The name of the file.
-          #
-          #   @return [String, nil]
-          optional :filename, String
-
-          # @!attribute score
-          #   The relevance score of the file - a value between 0 and 1.
-          #
-          #   @return [Float, nil]
-          optional :score, Float
-
-          # @!attribute text
-          #   The text that was retrieved from the file.
-          #
-          #   @return [String, nil]
-          optional :text, String
-
-          # @!method initialize(attributes: nil, file_id: nil, filename: nil, score: nil, text: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseFileSearchToolCall::Result} for more
-          #   details.
-          #
-          #   @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
-          #
-          #   @param file_id [String] The unique ID of the file.
-          #
-          #   @param filename [String] The name of the file.
-          #
-          #   @param score [Float] The relevance score of the file - a value between 0 and 1.
-          #
-          #   @param text [String] The text that was retrieved from the file.
-
-          module Attribute
-            extend OpenAI::Internal::Type::Union
-
-            variant String
-
-            variant Float
-
-            variant OpenAI::Internal::Type::Boolean
-
-            # @!method self.variants
-            #   @return [Array(String, Float, Boolean)]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      # An object specifying the format that the model must output.
-      #
-      # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
-      # ensures the model will match your supplied JSON schema. Learn more in the
-      # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
-      #
-      # The default format is `{ "type": "text" }` with no additional options.
-      #
-      # **Not recommended for gpt-4o and newer models:**
-      #
-      # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
-      # ensures the message the model generates is valid JSON. Using `json_schema` is
-      # preferred for models that support it.
-      module ResponseFormatTextConfig
-        extend OpenAI::Internal::Type::Union
-
-        discriminator :type
-
-        # Default response format. Used to generate text responses.
-        variant :text, -> { OpenAI::ResponseFormatText }
-
-        # JSON Schema response format. Used to generate structured JSON responses.
-        # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
-        variant :json_schema, -> { OpenAI::Responses::ResponseFormatTextJSONSchemaConfig }
-
-        # JSON object response format. An older method of generating JSON responses.
-        # Using `json_schema` is recommended for models that support it. Note that the
-        # model will not generate JSON without a system or user message instructing it
-        # to do so.
-        variant :json_object, -> { OpenAI::ResponseFormatJSONObject }
-
-        # @!method self.variants
-        #   @return [Array(OpenAI::Models::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig, OpenAI::Models::ResponseFormatJSONObject)]
-      end
-    end
-  end
-end

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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFormatTextJSONSchemaConfig < OpenAI::Internal::Type::BaseModel
-        # @!attribute name
-        #   The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
-        #   and dashes, with a maximum length of 64.
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute schema
-        #   The schema for the response format, described as a JSON Schema object. Learn how
-        #   to build JSON schemas [here](https://json-schema.org/).
-        #
-        #   @return [Hash{Symbol=>Object}]
-        required :schema, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
-
-        # @!attribute type
-        #   The type of response format being defined. Always `json_schema`.
-        #
-        #   @return [Symbol, :json_schema]
-        required :type, const: :json_schema
-
-        # @!attribute description
-        #   A description of what the response format is for, used by the model to determine
-        #   how to respond in the format.
-        #
-        #   @return [String, nil]
-        optional :description, String
-
-        # @!attribute strict
-        #   Whether to enable strict schema adherence when generating the output. If set to
-        #   true, the model will always follow the exact schema defined in the `schema`
-        #   field. Only a subset of JSON Schema is supported when `strict` is `true`. To
-        #   learn more, read the
-        #   [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
-        #
-        #   @return [Boolean, nil]
-        optional :strict, OpenAI::Internal::Type::Boolean, nil?: true
-
-        # @!method initialize(name:, schema:, description: nil, strict: nil, type: :json_schema)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig} for more
-        #   details.
-        #
-        #   JSON Schema response format. Used to generate structured JSON responses. Learn
-        #   more about
-        #   [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
-        #
-        #   @param name [String] The name of the response format. Must be a-z, A-Z, 0-9, or contain
-        #
-        #   @param schema [Hash{Symbol=>Object}] The schema for the response format, described as a JSON Schema object.
-        #
-        #   @param description [String] A description of what the response format is for, used by the model to
-        #
-        #   @param strict [Boolean, nil] Whether to enable strict schema adherence when generating the output.
-        #
-        #   @param type [Symbol, :json_schema] The type of response format being defined. Always `json_schema`.
-      end
-    end
-  end
-end

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

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

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFunctionCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute arguments
-        #   The function-call arguments.
-        #
-        #   @return [String]
-        required :arguments, String
-
-        # @!attribute item_id
-        #   The ID of the item.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #
-        #   @return [Symbol, :"response.function_call_arguments.done"]
-        required :type, const: :"response.function_call_arguments.done"
-
-        # @!method initialize(arguments:, item_id:, output_index:, sequence_number:, type: :"response.function_call_arguments.done")
-        #   Emitted when function-call arguments are finalized.
-        #
-        #   @param arguments [String] The function-call arguments.
-        #
-        #   @param item_id [String] The ID of the item.
-        #
-        #   @param output_index [Integer] The index of the output item.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.function_call_arguments.done"]
-      end
-    end
-  end
-end

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseFunctionToolCall < OpenAI::Internal::Type::BaseModel
-        # @!attribute arguments
-        #   A JSON string of the arguments to pass to the function.
-        #
-        #   @return [String]
-        required :arguments, String
-
-        # @!attribute call_id
-        #   The unique ID of the function tool call generated by the model.
-        #
-        #   @return [String]
-        required :call_id, String
-
-        # @!attribute name
-        #   The name of the function to run.
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute type
-        #   The type of the function tool call. Always `function_call`.
-        #
-        #   @return [Symbol, :function_call]
-        required :type, const: :function_call
-
-        # @!attribute id
-        #   The unique ID of the function tool call.
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!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::ResponseFunctionToolCall::Status, nil]
-        optional :status, enum: -> { OpenAI::Responses::ResponseFunctionToolCall::Status }
-
-        # @!method initialize(arguments:, call_id:, name:, id: nil, status: nil, type: :function_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFunctionToolCall} 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 arguments [String] A JSON string of the arguments to pass to the function.
-        #
-        #   @param call_id [String] The unique ID of the function tool call generated by the model.
-        #
-        #   @param name [String] The name of the function to run.
-        #
-        #   @param id [String] The unique ID of the function tool call.
-        #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionToolCall::Status] The status of the item. One of `in_progress`, `completed`, or
-        #
-        #   @param type [Symbol, :function_call] The type of the function tool call. Always `function_call`.
-
-        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
-        # Populated when items are returned via API.
-        #
-        # @see OpenAI::Models::Responses::ResponseFunctionToolCall#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