openai 0.68.0 → 0.69.0

data/lib/openai/models/beta/beta_response_file_search_tool_call.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseFileSearchToolCall < 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::Beta::BetaResponseFileSearchToolCall::Status]
+        required :status, enum: -> { OpenAI::Beta::BetaResponseFileSearchToolCall::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 agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseFileSearchToolCall::Agent }, nil?: true
+
+        # @!attribute results
+        #   The results of the file search tool call.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Result>, nil]
+        optional :results,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseFileSearchToolCall::Result] },
+                 nil?: true
+
+        # @!method initialize(id:, queries:, status:, agent: nil, results: nil, type: :file_search_call)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseFileSearchToolCall} 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::Beta::BetaResponseFileSearchToolCall::Status] The status of the file search tool call. One of `in_progress`,
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Agent, nil] The agent that produced this item.
+        #
+        #   @param results [Array<OpenAI::Models::Beta::BetaResponseFileSearchToolCall::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::Beta::BetaResponseFileSearchToolCall#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
+
+        # @see OpenAI::Models::Beta::BetaResponseFileSearchToolCall#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that produced this item.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        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::Beta::BetaResponseFileSearchToolCall::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::Beta::BetaResponseFileSearchToolCall::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
+
+    BetaResponseFileSearchToolCall = Beta::BetaResponseFileSearchToolCall
+  end
+end

data/lib/openai/models/beta/beta_response_format_text_config.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # 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 BetaResponseFormatTextConfig
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Default response format. Used to generate text responses.
+        variant :text, -> { OpenAI::Beta::BetaResponseFormatTextConfig::Text }
+
+        # 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::Beta::BetaResponseFormatTextJSONSchemaConfig }
+
+        # 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::Beta::BetaResponseFormatTextConfig::JSONObject }
+
+        class Text < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of response format being defined. Always `text`.
+          #
+          #   @return [Symbol, :text]
+          required :type, const: :text
+
+          # @!method initialize(type: :text)
+          #   Default response format. Used to generate text responses.
+          #
+          #   @param type [Symbol, :text] The type of response format being defined. Always `text`.
+        end
+
+        class JSONObject < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of response format being defined. Always `json_object`.
+          #
+          #   @return [Symbol, :json_object]
+          required :type, const: :json_object
+
+          # @!method initialize(type: :json_object)
+          #   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.
+          #
+          #   @param type [Symbol, :json_object] The type of response format being defined. Always `json_object`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::BetaResponseFormatTextConfig::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig, OpenAI::Models::Beta::BetaResponseFormatTextConfig::JSONObject)]
+      end
+    end
+
+    BetaResponseFormatTextConfig = Beta::BetaResponseFormatTextConfig
+  end
+end

data/lib/openai/models/beta/beta_response_format_text_json_schema_config.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseFormatTextJSONSchemaConfig < 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::Beta::BetaResponseFormatTextJSONSchemaConfig} 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
+
+    BetaResponseFormatTextJSONSchemaConfig = Beta::BetaResponseFormatTextJSONSchemaConfig
+  end
+end

data/lib/openai/models/beta/beta_response_function_call_arguments_delta_event.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseFunctionCallArgumentsDeltaEvent < 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"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent }, nil?: true
+
+        # @!method initialize(delta:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.function_call_arguments.delta")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent} 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 agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.function_call_arguments.delta"] The type of the event. Always `response.function_call_arguments.delta`.
+
+        # @see OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseFunctionCallArgumentsDeltaEvent = Beta::BetaResponseFunctionCallArgumentsDeltaEvent
+  end
+end

data/lib/openai/models/beta/beta_response_function_call_arguments_done_event.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseFunctionCallArgumentsDoneEvent < 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 name
+        #   The name of the function that was called.
+        #
+        #   @return [String]
+        required :name, 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"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseFunctionCallArgumentsDoneEvent::Agent }, nil?: true
+
+        # @!method initialize(arguments:, item_id:, name:, output_index:, sequence_number:, agent: nil, 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 name [String] The name of the function that was called.
+        #
+        #   @param output_index [Integer] The index of the output item.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.function_call_arguments.done"]
+
+        # @see OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseFunctionCallArgumentsDoneEvent = Beta::BetaResponseFunctionCallArgumentsDoneEvent
+  end
+end

data/lib/openai/models/beta/beta_response_function_call_output_item.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A piece of message content, such as text, an image, or a file.
+      module BetaResponseFunctionCallOutputItem
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A text input to the model.
+        variant :input_text, -> { OpenAI::Beta::BetaResponseInputTextContent }
+
+        # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision)
+        variant :input_image, -> { OpenAI::Beta::BetaResponseInputImageContent }
+
+        # A file input to the model.
+        variant :input_file, -> { OpenAI::Beta::BetaResponseInputFileContent }
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent)]
+      end
+    end
+
+    BetaResponseFunctionCallOutputItem = Beta::BetaResponseFunctionCallOutputItem
+  end
+end

data/lib/openai/models/beta/beta_response_function_call_output_item_list.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @type [OpenAI::Internal::Type::Converter]
+      BetaResponseFunctionCallOutputItemList =
+        OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Beta::BetaResponseFunctionCallOutputItem }]
+    end
+
+    # @type [OpenAI::Internal::Type::Converter]
+    BetaResponseFunctionCallOutputItemList = Beta::BetaResponseFunctionCallOutputItemList
+  end
+end

data/lib/openai/models/beta/beta_response_function_shell_call_output_content.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseFunctionShellCallOutputContent < OpenAI::Internal::Type::BaseModel
+        # @!attribute outcome
+        #   The exit or timeout outcome associated with this shell call.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Exit]
+        required :outcome, union: -> { OpenAI::Beta::BetaResponseFunctionShellCallOutputContent::Outcome }
+
+        # @!attribute stderr
+        #   Captured stderr output for the shell call.
+        #
+        #   @return [String]
+        required :stderr, String
+
+        # @!attribute stdout
+        #   Captured stdout output for the shell call.
+        #
+        #   @return [String]
+        required :stdout, String
+
+        # @!method initialize(outcome:, stderr:, stdout:)
+        #   Captured stdout and stderr for a portion of a shell tool call output.
+        #
+        #   @param outcome [OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Exit] The exit or timeout outcome associated with this shell call.
+        #
+        #   @param stderr [String] Captured stderr output for the shell call.
+        #
+        #   @param stdout [String] Captured stdout output for the shell call.
+
+        # The exit or timeout outcome associated with this shell call.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent#outcome
+        module Outcome
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # Indicates that the shell call exceeded its configured time limit.
+          variant :timeout, -> { OpenAI::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Timeout }
+
+          # Indicates that the shell commands finished and returned an exit code.
+          variant :exit, -> { OpenAI::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Exit }
+
+          class Timeout < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #   The outcome type. Always `timeout`.
+            #
+            #   @return [Symbol, :timeout]
+            required :type, const: :timeout
+
+            # @!method initialize(type: :timeout)
+            #   Indicates that the shell call exceeded its configured time limit.
+            #
+            #   @param type [Symbol, :timeout] The outcome type. Always `timeout`.
+          end
+
+          class Exit < OpenAI::Internal::Type::BaseModel
+            # @!attribute exit_code
+            #   The exit code returned by the shell process.
+            #
+            #   @return [Integer]
+            required :exit_code, Integer
+
+            # @!attribute type
+            #   The outcome type. Always `exit`.
+            #
+            #   @return [Symbol, :exit]
+            required :type, const: :exit
+
+            # @!method initialize(exit_code:, type: :exit)
+            #   Indicates that the shell commands finished and returned an exit code.
+            #
+            #   @param exit_code [Integer] The exit code returned by the shell process.
+            #
+            #   @param type [Symbol, :exit] The outcome type. Always `exit`.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Exit)]
+        end
+      end
+    end
+
+    BetaResponseFunctionShellCallOutputContent = Beta::BetaResponseFunctionShellCallOutputContent
+  end
+end