openai 0.17.1 → 0.19.0

data/sig/openai/models/conversations/conversation_item_list.rbs

@@ -0,0 +1,44 @@
+module OpenAI
+  module Models
+    class ConversationItemList = Conversations::ConversationItemList
+
+    module Conversations
+      type conversation_item_list =
+        {
+          data: ::Array[OpenAI::Models::Conversations::conversation_item],
+          first_id: String,
+          has_more: bool,
+          last_id: String,
+          object: :list
+        }
+
+      class ConversationItemList < OpenAI::Internal::Type::BaseModel
+        attr_accessor data: ::Array[OpenAI::Models::Conversations::conversation_item]
+
+        attr_accessor first_id: String
+
+        attr_accessor has_more: bool
+
+        attr_accessor last_id: String
+
+        attr_accessor object: :list
+
+        def initialize: (
+          data: ::Array[OpenAI::Models::Conversations::conversation_item],
+          first_id: String,
+          has_more: bool,
+          last_id: String,
+          ?object: :list
+        ) -> void
+
+        def to_hash: -> {
+          data: ::Array[OpenAI::Models::Conversations::conversation_item],
+          first_id: String,
+          has_more: bool,
+          last_id: String,
+          object: :list
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/conversation_retrieve_params.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Conversations
+      type conversation_retrieve_params =
+        {  } & OpenAI::Internal::Type::request_parameters
+
+      class ConversationRetrieveParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: OpenAI::request_opts) -> void
+
+        def to_hash: -> { request_options: OpenAI::RequestOptions }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/conversation_update_params.rbs

@@ -0,0 +1,26 @@
+module OpenAI
+  module Models
+    module Conversations
+      type conversation_update_params =
+        { metadata: ::Hash[Symbol, String] }
+        & OpenAI::Internal::Type::request_parameters
+
+      class ConversationUpdateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor metadata: ::Hash[Symbol, String]
+
+        def initialize: (
+          metadata: ::Hash[Symbol, String],
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          metadata: ::Hash[Symbol, String],
+          request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/file_citation_body.rbs

@@ -0,0 +1,37 @@
+module OpenAI
+  module Models
+    module Conversations
+      type file_citation_body =
+        {
+          file_id: String,
+          filename: String,
+          index: Integer,
+          type: :file_citation
+        }
+
+      class FileCitationBody < OpenAI::Internal::Type::BaseModel
+        attr_accessor file_id: String
+
+        attr_accessor filename: String
+
+        attr_accessor index: Integer
+
+        attr_accessor type: :file_citation
+
+        def initialize: (
+          file_id: String,
+          filename: String,
+          index: Integer,
+          ?type: :file_citation
+        ) -> void
+
+        def to_hash: -> {
+          file_id: String,
+          filename: String,
+          index: Integer,
+          type: :file_citation
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/input_file_content.rbs

@@ -0,0 +1,41 @@
+module OpenAI
+  module Models
+    module Conversations
+      type input_file_content =
+        {
+          file_id: String?,
+          type: :input_file,
+          file_url: String,
+          filename: String
+        }
+
+      class InputFileContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor file_id: String?
+
+        attr_accessor type: :input_file
+
+        attr_reader file_url: String?
+
+        def file_url=: (String) -> String
+
+        attr_reader filename: String?
+
+        def filename=: (String) -> String
+
+        def initialize: (
+          file_id: String?,
+          ?file_url: String,
+          ?filename: String,
+          ?type: :input_file
+        ) -> void
+
+        def to_hash: -> {
+          file_id: String?,
+          type: :input_file,
+          file_url: String,
+          filename: String
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/input_image_content.rbs

@@ -0,0 +1,49 @@
+module OpenAI
+  module Models
+    module Conversations
+      type input_image_content =
+        {
+          detail: OpenAI::Models::Conversations::InputImageContent::detail,
+          file_id: String?,
+          image_url: String?,
+          type: :input_image
+        }
+
+      class InputImageContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor detail: OpenAI::Models::Conversations::InputImageContent::detail
+
+        attr_accessor file_id: String?
+
+        attr_accessor image_url: String?
+
+        attr_accessor type: :input_image
+
+        def initialize: (
+          detail: OpenAI::Models::Conversations::InputImageContent::detail,
+          file_id: String?,
+          image_url: String?,
+          ?type: :input_image
+        ) -> void
+
+        def to_hash: -> {
+          detail: OpenAI::Models::Conversations::InputImageContent::detail,
+          file_id: String?,
+          image_url: String?,
+          type: :input_image
+        }
+
+        type detail = :low | :high | :auto
+
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          LOW: :low
+          HIGH: :high
+          AUTO: :auto
+
+          def self?.values: -> ::Array[OpenAI::Models::Conversations::InputImageContent::detail]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/input_text_content.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Conversations
+      type input_text_content = { text: String, type: :input_text }
+
+      class InputTextContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor text: String
+
+        attr_accessor type: :input_text
+
+        def initialize: (text: String, ?type: :input_text) -> void
+
+        def to_hash: -> { text: String, type: :input_text }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/item_create_params.rbs

@@ -0,0 +1,37 @@
+module OpenAI
+  module Models
+    module Conversations
+      type item_create_params =
+        {
+          items: ::Array[OpenAI::Models::Responses::response_input_item],
+          include: ::Array[OpenAI::Models::Responses::response_includable]
+        }
+        & OpenAI::Internal::Type::request_parameters
+
+      class ItemCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor items: ::Array[OpenAI::Models::Responses::response_input_item]
+
+        attr_reader include: ::Array[OpenAI::Models::Responses::response_includable]?
+
+        def include=: (
+          ::Array[OpenAI::Models::Responses::response_includable]
+        ) -> ::Array[OpenAI::Models::Responses::response_includable]
+
+        def initialize: (
+          items: ::Array[OpenAI::Models::Responses::response_input_item],
+          ?include: ::Array[OpenAI::Models::Responses::response_includable],
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          items: ::Array[OpenAI::Models::Responses::response_input_item],
+          include: ::Array[OpenAI::Models::Responses::response_includable],
+          request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/item_delete_params.rbs

@@ -0,0 +1,25 @@
+module OpenAI
+  module Models
+    module Conversations
+      type item_delete_params =
+        { conversation_id: String } & OpenAI::Internal::Type::request_parameters
+
+      class ItemDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor conversation_id: String
+
+        def initialize: (
+          conversation_id: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          conversation_id: String,
+          request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/item_list_params.rbs

@@ -0,0 +1,66 @@
+module OpenAI
+  module Models
+    module Conversations
+      type item_list_params =
+        {
+          after: String,
+          include: ::Array[OpenAI::Models::Responses::response_includable],
+          limit: Integer,
+          order: OpenAI::Models::Conversations::ItemListParams::order
+        }
+        & OpenAI::Internal::Type::request_parameters
+
+      class ItemListParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_reader after: String?
+
+        def after=: (String) -> String
+
+        attr_reader include: ::Array[OpenAI::Models::Responses::response_includable]?
+
+        def include=: (
+          ::Array[OpenAI::Models::Responses::response_includable]
+        ) -> ::Array[OpenAI::Models::Responses::response_includable]
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        attr_reader order: OpenAI::Models::Conversations::ItemListParams::order?
+
+        def order=: (
+          OpenAI::Models::Conversations::ItemListParams::order
+        ) -> OpenAI::Models::Conversations::ItemListParams::order
+
+        def initialize: (
+          ?after: String,
+          ?include: ::Array[OpenAI::Models::Responses::response_includable],
+          ?limit: Integer,
+          ?order: OpenAI::Models::Conversations::ItemListParams::order,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          after: String,
+          include: ::Array[OpenAI::Models::Responses::response_includable],
+          limit: Integer,
+          order: OpenAI::Models::Conversations::ItemListParams::order,
+          request_options: OpenAI::RequestOptions
+        }
+
+        type order = :asc | :desc
+
+        module Order
+          extend OpenAI::Internal::Type::Enum
+
+          ASC: :asc
+          DESC: :desc
+
+          def self?.values: -> ::Array[OpenAI::Models::Conversations::ItemListParams::order]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/item_retrieve_params.rbs

@@ -0,0 +1,37 @@
+module OpenAI
+  module Models
+    module Conversations
+      type item_retrieve_params =
+        {
+          conversation_id: String,
+          include: ::Array[OpenAI::Models::Responses::response_includable]
+        }
+        & OpenAI::Internal::Type::request_parameters
+
+      class ItemRetrieveParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor conversation_id: String
+
+        attr_reader include: ::Array[OpenAI::Models::Responses::response_includable]?
+
+        def include=: (
+          ::Array[OpenAI::Models::Responses::response_includable]
+        ) -> ::Array[OpenAI::Models::Responses::response_includable]
+
+        def initialize: (
+          conversation_id: String,
+          ?include: ::Array[OpenAI::Models::Responses::response_includable],
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          conversation_id: String,
+          include: ::Array[OpenAI::Models::Responses::response_includable],
+          request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/lob_prob.rbs

@@ -0,0 +1,37 @@
+module OpenAI
+  module Models
+    module Conversations
+      type lob_prob =
+        {
+          token: String,
+          bytes: ::Array[Integer],
+          logprob: Float,
+          top_logprobs: ::Array[OpenAI::Conversations::TopLogProb]
+        }
+
+      class LobProb < OpenAI::Internal::Type::BaseModel
+        attr_accessor token: String
+
+        attr_accessor bytes: ::Array[Integer]
+
+        attr_accessor logprob: Float
+
+        attr_accessor top_logprobs: ::Array[OpenAI::Conversations::TopLogProb]
+
+        def initialize: (
+          token: String,
+          bytes: ::Array[Integer],
+          logprob: Float,
+          top_logprobs: ::Array[OpenAI::Conversations::TopLogProb]
+        ) -> void
+
+        def to_hash: -> {
+          token: String,
+          bytes: ::Array[Integer],
+          logprob: Float,
+          top_logprobs: ::Array[OpenAI::Conversations::TopLogProb]
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/message.rbs

@@ -0,0 +1,95 @@
+module OpenAI
+  module Models
+    module Conversations
+      type message =
+        {
+          id: String,
+          content: ::Array[OpenAI::Models::Conversations::Message::content],
+          role: OpenAI::Models::Conversations::Message::role,
+          status: OpenAI::Models::Conversations::Message::status,
+          type: :message
+        }
+
+      class Message < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor content: ::Array[OpenAI::Models::Conversations::Message::content]
+
+        attr_accessor role: OpenAI::Models::Conversations::Message::role
+
+        attr_accessor status: OpenAI::Models::Conversations::Message::status
+
+        attr_accessor type: :message
+
+        def initialize: (
+          id: String,
+          content: ::Array[OpenAI::Models::Conversations::Message::content],
+          role: OpenAI::Models::Conversations::Message::role,
+          status: OpenAI::Models::Conversations::Message::status,
+          ?type: :message
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          content: ::Array[OpenAI::Models::Conversations::Message::content],
+          role: OpenAI::Models::Conversations::Message::role,
+          status: OpenAI::Models::Conversations::Message::status,
+          type: :message
+        }
+
+        type content =
+          OpenAI::Conversations::InputTextContent
+          | OpenAI::Conversations::OutputTextContent
+          | OpenAI::Conversations::TextContent
+          | OpenAI::Conversations::SummaryTextContent
+          | OpenAI::Conversations::RefusalContent
+          | OpenAI::Conversations::InputImageContent
+          | OpenAI::Conversations::ComputerScreenshotContent
+          | OpenAI::Conversations::InputFileContent
+
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::Conversations::Message::content]
+        end
+
+        type role =
+          :unknown
+          | :user
+          | :assistant
+          | :system
+          | :critic
+          | :discriminator
+          | :developer
+          | :tool
+
+        module Role
+          extend OpenAI::Internal::Type::Enum
+
+          UNKNOWN: :unknown
+          USER: :user
+          ASSISTANT: :assistant
+          SYSTEM: :system
+          CRITIC: :critic
+          DISCRIMINATOR: :discriminator
+          DEVELOPER: :developer
+          TOOL: :tool
+
+          def self?.values: -> ::Array[OpenAI::Models::Conversations::Message::role]
+        end
+
+        type status = :in_progress | :completed | :incomplete
+
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS: :in_progress
+          COMPLETED: :completed
+          INCOMPLETE: :incomplete
+
+          def self?.values: -> ::Array[OpenAI::Models::Conversations::Message::status]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/output_text_content.rbs

@@ -0,0 +1,52 @@
+module OpenAI
+  module Models
+    module Conversations
+      type output_text_content =
+        {
+          annotations: ::Array[OpenAI::Models::Conversations::OutputTextContent::annotation],
+          text: String,
+          type: :output_text,
+          logprobs: ::Array[OpenAI::Conversations::LobProb]
+        }
+
+      class OutputTextContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor annotations: ::Array[OpenAI::Models::Conversations::OutputTextContent::annotation]
+
+        attr_accessor text: String
+
+        attr_accessor type: :output_text
+
+        attr_reader logprobs: ::Array[OpenAI::Conversations::LobProb]?
+
+        def logprobs=: (
+          ::Array[OpenAI::Conversations::LobProb]
+        ) -> ::Array[OpenAI::Conversations::LobProb]
+
+        def initialize: (
+          annotations: ::Array[OpenAI::Models::Conversations::OutputTextContent::annotation],
+          text: String,
+          ?logprobs: ::Array[OpenAI::Conversations::LobProb],
+          ?type: :output_text
+        ) -> void
+
+        def to_hash: -> {
+          annotations: ::Array[OpenAI::Models::Conversations::OutputTextContent::annotation],
+          text: String,
+          type: :output_text,
+          logprobs: ::Array[OpenAI::Conversations::LobProb]
+        }
+
+        type annotation =
+          OpenAI::Conversations::FileCitationBody
+          | OpenAI::Conversations::URLCitationBody
+          | OpenAI::Conversations::ContainerFileCitationBody
+
+        module Annotation
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::Conversations::OutputTextContent::annotation]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/refusal_content.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Conversations
+      type refusal_content = { refusal: String, type: :refusal }
+
+      class RefusalContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor refusal: String
+
+        attr_accessor type: :refusal
+
+        def initialize: (refusal: String, ?type: :refusal) -> void
+
+        def to_hash: -> { refusal: String, type: :refusal }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/summary_text_content.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Conversations
+      type summary_text_content = { text: String, type: :summary_text }
+
+      class SummaryTextContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor text: String
+
+        attr_accessor type: :summary_text
+
+        def initialize: (text: String, ?type: :summary_text) -> void
+
+        def to_hash: -> { text: String, type: :summary_text }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/text_content.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Conversations
+      type text_content = { text: String, type: :text }
+
+      class TextContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor text: String
+
+        attr_accessor type: :text
+
+        def initialize: (text: String, ?type: :text) -> void
+
+        def to_hash: -> { text: String, type: :text }
+      end
+    end
+  end
+end

data/sig/openai/models/conversations/top_log_prob.rbs

@@ -0,0 +1,28 @@
+module OpenAI
+  module Models
+    module Conversations
+      type top_log_prob =
+        { token: String, bytes: ::Array[Integer], logprob: Float }
+
+      class TopLogProb < OpenAI::Internal::Type::BaseModel
+        attr_accessor token: String
+
+        attr_accessor bytes: ::Array[Integer]
+
+        attr_accessor logprob: Float
+
+        def initialize: (
+          token: String,
+          bytes: ::Array[Integer],
+          logprob: Float
+        ) -> void
+
+        def to_hash: -> {
+          token: String,
+          bytes: ::Array[Integer],
+          logprob: Float
+        }
+      end
+    end
+  end
+end