openai 0.68.0 → 0.69.0

data/rbi/openai/models/beta/beta_response_custom_tool_call_item.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseCustomToolCallItem = Beta::BetaResponseCustomToolCallItem
+
+    module Beta
+      class BetaResponseCustomToolCallItem < OpenAI::Models::Beta::BetaResponseCustomToolCall
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseCustomToolCallItem,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the custom tool call item.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        sig do
+          returns(
+            OpenAI::Beta::BetaResponseCustomToolCallItem::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The identifier of the actor that created the item.
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_by
+
+        sig { params(created_by: String).void }
+        attr_writer :created_by
+
+        # A call to a custom tool created by the model.
+        sig do
+          params(
+            id: String,
+            status:
+              OpenAI::Beta::BetaResponseCustomToolCallItem::Status::OrSymbol,
+            created_by: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the custom tool call item.
+          id:,
+          # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+          # Populated when items are returned via API.
+          status:,
+          # The identifier of the actor that created the item.
+          created_by: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              status:
+                OpenAI::Beta::BetaResponseCustomToolCallItem::Status::TaggedSymbol,
+              created_by: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Beta::BetaResponseCustomToolCallItem::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Beta::BetaResponseCustomToolCallItem::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Beta::BetaResponseCustomToolCallItem::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Beta::BetaResponseCustomToolCallItem::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseCustomToolCallItem::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_custom_tool_call_output.rbi

@@ -0,0 +1,303 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseCustomToolCallOutput = Beta::BetaResponseCustomToolCallOutput
+
+    module Beta
+      class BetaResponseCustomToolCallOutput < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseCustomToolCallOutput,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The call ID, used to map this custom tool call output to a custom tool call.
+        sig { returns(String) }
+        attr_accessor :call_id
+
+        # The output from the custom tool call generated by your code. Can be a string or
+        # an list of output content.
+        sig do
+          returns(
+            OpenAI::Beta::BetaResponseCustomToolCallOutput::Output::Variants
+          )
+        end
+        attr_accessor :output
+
+        # The type of the custom tool call output. Always `custom_tool_call_output`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The unique ID of the custom tool call output in the OpenAI platform.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The agent that produced this item.
+        sig do
+          returns(
+            T.nilable(OpenAI::Beta::BetaResponseCustomToolCallOutput::Agent)
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # The execution context that produced this tool call.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Direct,
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Program
+              )
+            )
+          )
+        end
+        attr_accessor :caller_
+
+        # The output of a custom tool call from your code, being sent back to the model.
+        sig do
+          params(
+            call_id: String,
+            output:
+              OpenAI::Beta::BetaResponseCustomToolCallOutput::Output::Variants,
+            id: String,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Agent::OrHash
+              ),
+            caller_:
+              T.nilable(
+                T.any(
+                  OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Direct::OrHash,
+                  OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Program::OrHash
+                )
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The call ID, used to map this custom tool call output to a custom tool call.
+          call_id:,
+          # The output from the custom tool call generated by your code. Can be a string or
+          # an list of output content.
+          output:,
+          # The unique ID of the custom tool call output in the OpenAI platform.
+          id: nil,
+          # The agent that produced this item.
+          agent: nil,
+          # The execution context that produced this tool call.
+          caller_: nil,
+          # The type of the custom tool call output. Always `custom_tool_call_output`.
+          type: :custom_tool_call_output
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              call_id: String,
+              output:
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Output::Variants,
+              type: Symbol,
+              id: String,
+              agent:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseCustomToolCallOutput::Agent
+                ),
+              caller_:
+                T.nilable(
+                  T.any(
+                    OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Direct,
+                    OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Program
+                  )
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The output from the custom tool call generated by your code. Can be a string or
+        # an list of output content.
+        module Output
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                T::Array[
+                  OpenAI::Beta::BetaResponseCustomToolCallOutput::Output::OutputContentList::Variants
+                ]
+              )
+            end
+
+          # A text input to the model.
+          module OutputContentList
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::BetaResponseInputText,
+                  OpenAI::Beta::BetaResponseInputImage,
+                  OpenAI::Beta::BetaResponseInputFile
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::BetaResponseCustomToolCallOutput::Output::OutputContentList::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Output::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          OutputContentListArray =
+            T.let(
+              OpenAI::Internal::Type::ArrayOf[
+                union:
+                  OpenAI::Beta::BetaResponseCustomToolCallOutput::Output::OutputContentList
+              ],
+              OpenAI::Internal::Type::Converter
+            )
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Agent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The canonical name of the agent that produced this item.
+          sig { returns(String) }
+          attr_accessor :agent_name
+
+          # The agent that produced this item.
+          sig { params(agent_name: String).returns(T.attached_class) }
+          def self.new(
+            # The canonical name of the agent that produced this item.
+            agent_name:
+          )
+          end
+
+          sig { override.returns({ agent_name: String }) }
+          def to_hash
+          end
+        end
+
+        # The execution context that produced this tool call.
+        module Caller
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Direct,
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Program
+              )
+            end
+
+          class Direct < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Direct,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The caller type. Always `direct`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig { params(type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # The caller type. Always `direct`.
+              type: :direct
+            )
+            end
+
+            sig { override.returns({ type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          class Program < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Program,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The call ID of the program item that produced this tool call.
+            sig { returns(String) }
+            attr_accessor :caller_id
+
+            # The caller type. Always `program`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(caller_id: String, type: Symbol).returns(T.attached_class)
+            end
+            def self.new(
+              # The call ID of the program item that produced this tool call.
+              caller_id:,
+              # The caller type. Always `program`.
+              type: :program
+            )
+            end
+
+            sig { override.returns({ caller_id: String, type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_custom_tool_call_output_item.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseCustomToolCallOutputItem =
+      Beta::BetaResponseCustomToolCallOutputItem
+
+    module Beta
+      class BetaResponseCustomToolCallOutputItem < OpenAI::Models::Beta::BetaResponseCustomToolCallOutput
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseCustomToolCallOutputItem,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the custom tool call output item.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        sig do
+          returns(
+            OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The identifier of the actor that created the item.
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_by
+
+        sig { params(created_by: String).void }
+        attr_writer :created_by
+
+        # The output of a custom tool call from your code, being sent back to the model.
+        sig do
+          params(
+            id: String,
+            status:
+              OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status::OrSymbol,
+            created_by: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the custom tool call output item.
+          id:,
+          # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+          # Populated when items are returned via API.
+          status:,
+          # The identifier of the actor that created the item.
+          created_by: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              status:
+                OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status::TaggedSymbol,
+              created_by: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_error.rbi

@@ -0,0 +1,165 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseError = Beta::BetaResponseError
+
+    module Beta
+      class BetaResponseError < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::BetaResponseError, OpenAI::Internal::AnyHash)
+          end
+
+        # The error code for the response.
+        sig { returns(OpenAI::Beta::BetaResponseError::Code::TaggedSymbol) }
+        attr_accessor :code
+
+        # A human-readable description of the error.
+        sig { returns(String) }
+        attr_accessor :message
+
+        # An error object returned when the model fails to generate a Response.
+        sig do
+          params(
+            code: OpenAI::Beta::BetaResponseError::Code::OrSymbol,
+            message: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The error code for the response.
+          code:,
+          # A human-readable description of the error.
+          message:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: OpenAI::Beta::BetaResponseError::Code::TaggedSymbol,
+              message: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The error code for the response.
+        module Code
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaResponseError::Code)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SERVER_ERROR =
+            T.let(
+              :server_error,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          RATE_LIMIT_EXCEEDED =
+            T.let(
+              :rate_limit_exceeded,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          INVALID_PROMPT =
+            T.let(
+              :invalid_prompt,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          BIO_POLICY =
+            T.let(
+              :bio_policy,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          VECTOR_STORE_TIMEOUT =
+            T.let(
+              :vector_store_timeout,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          INVALID_IMAGE =
+            T.let(
+              :invalid_image,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          INVALID_IMAGE_FORMAT =
+            T.let(
+              :invalid_image_format,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          INVALID_BASE64_IMAGE =
+            T.let(
+              :invalid_base64_image,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          INVALID_IMAGE_URL =
+            T.let(
+              :invalid_image_url,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          IMAGE_TOO_LARGE =
+            T.let(
+              :image_too_large,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          IMAGE_TOO_SMALL =
+            T.let(
+              :image_too_small,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          IMAGE_PARSE_ERROR =
+            T.let(
+              :image_parse_error,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          IMAGE_CONTENT_POLICY_VIOLATION =
+            T.let(
+              :image_content_policy_violation,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          INVALID_IMAGE_MODE =
+            T.let(
+              :invalid_image_mode,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          IMAGE_FILE_TOO_LARGE =
+            T.let(
+              :image_file_too_large,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          UNSUPPORTED_IMAGE_MEDIA_TYPE =
+            T.let(
+              :unsupported_image_media_type,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          EMPTY_IMAGE_FILE =
+            T.let(
+              :empty_image_file,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          FAILED_TO_DOWNLOAD_IMAGE =
+            T.let(
+              :failed_to_download_image,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+          IMAGE_FILE_NOT_FOUND =
+            T.let(
+              :image_file_not_found,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Beta::BetaResponseError::Code::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end