openai 0.18.1 → 0.20.0

data/rbi/openai/models/conversations/item_list_params.rbi

@@ -0,0 +1,178 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ItemListParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ItemListParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # An item ID to list items after, used in pagination.
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
+        # Specify additional output data to include in the model response. Currently
+        # supported values are:
+        #
+        # - `web_search_call.action.sources`: Include the sources of the web search tool
+        #   call.
+        # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #   in code interpreter tool call items.
+        # - `computer_call_output.output.image_url`: Include image urls from the computer
+        #   call output.
+        # - `file_search_call.results`: Include the search results of the file search tool
+        #   call.
+        # - `message.input_image.image_url`: Include image urls from the input message.
+        # - `message.output_text.logprobs`: Include logprobs with assistant messages.
+        # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+        #   tokens in reasoning item outputs. This enables reasoning items to be used in
+        #   multi-turn conversations when using the Responses API statelessly (like when
+        #   the `store` parameter is set to `false`, or when an organization is enrolled
+        #   in the zero data retention program).
+        sig do
+          returns(
+            T.nilable(T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol])
+          )
+        end
+        attr_reader :include
+
+        sig do
+          params(
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
+          ).void
+        end
+        attr_writer :include
+
+        # A limit on the number of objects to be returned. Limit can range between 1 and
+        # 100, and the default is 20.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # The order to return the input items in. Default is `desc`.
+        #
+        # - `asc`: Return the input items in ascending order.
+        # - `desc`: Return the input items in descending order.
+        sig do
+          returns(
+            T.nilable(OpenAI::Conversations::ItemListParams::Order::OrSymbol)
+          )
+        end
+        attr_reader :order
+
+        sig do
+          params(
+            order: OpenAI::Conversations::ItemListParams::Order::OrSymbol
+          ).void
+        end
+        attr_writer :order
+
+        sig do
+          params(
+            after: String,
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+            limit: Integer,
+            order: OpenAI::Conversations::ItemListParams::Order::OrSymbol,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An item ID to list items after, used in pagination.
+          after: nil,
+          # Specify additional output data to include in the model response. Currently
+          # supported values are:
+          #
+          # - `web_search_call.action.sources`: Include the sources of the web search tool
+          #   call.
+          # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+          #   in code interpreter tool call items.
+          # - `computer_call_output.output.image_url`: Include image urls from the computer
+          #   call output.
+          # - `file_search_call.results`: Include the search results of the file search tool
+          #   call.
+          # - `message.input_image.image_url`: Include image urls from the input message.
+          # - `message.output_text.logprobs`: Include logprobs with assistant messages.
+          # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+          #   tokens in reasoning item outputs. This enables reasoning items to be used in
+          #   multi-turn conversations when using the Responses API statelessly (like when
+          #   the `store` parameter is set to `false`, or when an organization is enrolled
+          #   in the zero data retention program).
+          include: nil,
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
+          limit: nil,
+          # The order to return the input items in. Default is `desc`.
+          #
+          # - `asc`: Return the input items in ascending order.
+          # - `desc`: Return the input items in descending order.
+          order: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              after: String,
+              include:
+                T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+              limit: Integer,
+              order: OpenAI::Conversations::ItemListParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The order to return the input items in. Default is `desc`.
+        #
+        # - `asc`: Return the input items in ascending order.
+        # - `desc`: Return the input items in descending order.
+        module Order
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Conversations::ItemListParams::Order)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ASC =
+            T.let(
+              :asc,
+              OpenAI::Conversations::ItemListParams::Order::TaggedSymbol
+            )
+          DESC =
+            T.let(
+              :desc,
+              OpenAI::Conversations::ItemListParams::Order::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Conversations::ItemListParams::Order::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/item_retrieve_params.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ItemRetrieveParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ItemRetrieveParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :conversation_id
+
+        # Additional fields to include in the response. See the `include` parameter for
+        # [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include)
+        # for more information.
+        sig do
+          returns(
+            T.nilable(T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol])
+          )
+        end
+        attr_reader :include
+
+        sig do
+          params(
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
+          ).void
+        end
+        attr_writer :include
+
+        sig do
+          params(
+            conversation_id: String,
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          conversation_id:,
+          # Additional fields to include in the response. See the `include` parameter for
+          # [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include)
+          # for more information.
+          include: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              conversation_id: String,
+              include:
+                T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/lob_prob.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class LobProb < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Conversations::LobProb, OpenAI::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :token
+
+        sig { returns(T::Array[Integer]) }
+        attr_accessor :bytes
+
+        sig { returns(Float) }
+        attr_accessor :logprob
+
+        sig { returns(T::Array[OpenAI::Conversations::TopLogProb]) }
+        attr_accessor :top_logprobs
+
+        sig do
+          params(
+            token: String,
+            bytes: T::Array[Integer],
+            logprob: Float,
+            top_logprobs: T::Array[OpenAI::Conversations::TopLogProb::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(token:, bytes:, logprob:, top_logprobs:)
+        end
+
+        sig do
+          override.returns(
+            {
+              token: String,
+              bytes: T::Array[Integer],
+              logprob: Float,
+              top_logprobs: T::Array[OpenAI::Conversations::TopLogProb]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/message.rbi

@@ -0,0 +1,196 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class Message < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Conversations::Message, OpenAI::Internal::AnyHash)
+          end
+
+        # The unique ID of the message.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The content of the message
+        sig do
+          returns(T::Array[OpenAI::Conversations::Message::Content::Variants])
+        end
+        attr_accessor :content
+
+        # The role of the message. One of `unknown`, `user`, `assistant`, `system`,
+        # `critic`, `discriminator`, `developer`, or `tool`.
+        sig { returns(OpenAI::Conversations::Message::Role::TaggedSymbol) }
+        attr_accessor :role
+
+        # The status of item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        sig { returns(OpenAI::Conversations::Message::Status::TaggedSymbol) }
+        attr_accessor :status
+
+        # The type of the message. Always set to `message`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            id: String,
+            content:
+              T::Array[
+                T.any(
+                  OpenAI::Conversations::InputTextContent::OrHash,
+                  OpenAI::Conversations::OutputTextContent::OrHash,
+                  OpenAI::Conversations::TextContent::OrHash,
+                  OpenAI::Conversations::SummaryTextContent::OrHash,
+                  OpenAI::Conversations::RefusalContent::OrHash,
+                  OpenAI::Conversations::InputImageContent::OrHash,
+                  OpenAI::Conversations::ComputerScreenshotContent::OrHash,
+                  OpenAI::Conversations::InputFileContent::OrHash
+                )
+              ],
+            role: OpenAI::Conversations::Message::Role::OrSymbol,
+            status: OpenAI::Conversations::Message::Status::OrSymbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the message.
+          id:,
+          # The content of the message
+          content:,
+          # The role of the message. One of `unknown`, `user`, `assistant`, `system`,
+          # `critic`, `discriminator`, `developer`, or `tool`.
+          role:,
+          # The status of item. One of `in_progress`, `completed`, or `incomplete`.
+          # Populated when items are returned via API.
+          status:,
+          # The type of the message. Always set to `message`.
+          type: :message
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              content:
+                T::Array[OpenAI::Conversations::Message::Content::Variants],
+              role: OpenAI::Conversations::Message::Role::TaggedSymbol,
+              status: OpenAI::Conversations::Message::Status::TaggedSymbol,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Conversations::InputTextContent,
+                OpenAI::Conversations::OutputTextContent,
+                OpenAI::Conversations::TextContent,
+                OpenAI::Conversations::SummaryTextContent,
+                OpenAI::Conversations::RefusalContent,
+                OpenAI::Conversations::InputImageContent,
+                OpenAI::Conversations::ComputerScreenshotContent,
+                OpenAI::Conversations::InputFileContent
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Conversations::Message::Content::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # The role of the message. One of `unknown`, `user`, `assistant`, `system`,
+        # `critic`, `discriminator`, `developer`, or `tool`.
+        module Role
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, OpenAI::Conversations::Message::Role) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          UNKNOWN =
+            T.let(:unknown, OpenAI::Conversations::Message::Role::TaggedSymbol)
+          USER =
+            T.let(:user, OpenAI::Conversations::Message::Role::TaggedSymbol)
+          ASSISTANT =
+            T.let(
+              :assistant,
+              OpenAI::Conversations::Message::Role::TaggedSymbol
+            )
+          SYSTEM =
+            T.let(:system, OpenAI::Conversations::Message::Role::TaggedSymbol)
+          CRITIC =
+            T.let(:critic, OpenAI::Conversations::Message::Role::TaggedSymbol)
+          DISCRIMINATOR =
+            T.let(
+              :discriminator,
+              OpenAI::Conversations::Message::Role::TaggedSymbol
+            )
+          DEVELOPER =
+            T.let(
+              :developer,
+              OpenAI::Conversations::Message::Role::TaggedSymbol
+            )
+          TOOL =
+            T.let(:tool, OpenAI::Conversations::Message::Role::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Conversations::Message::Role::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The status of 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::Conversations::Message::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Conversations::Message::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Conversations::Message::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Conversations::Message::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Conversations::Message::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/output_text_content.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class OutputTextContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::OutputTextContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The annotations of the text output.
+        sig do
+          returns(
+            T::Array[
+              OpenAI::Conversations::OutputTextContent::Annotation::Variants
+            ]
+          )
+        end
+        attr_accessor :annotations
+
+        # The text output from the model.
+        sig { returns(String) }
+        attr_accessor :text
+
+        # The type of the output text. Always `output_text`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(T::Array[OpenAI::Conversations::LobProb])) }
+        attr_reader :logprobs
+
+        sig do
+          params(
+            logprobs: T::Array[OpenAI::Conversations::LobProb::OrHash]
+          ).void
+        end
+        attr_writer :logprobs
+
+        sig do
+          params(
+            annotations:
+              T::Array[
+                T.any(
+                  OpenAI::Conversations::FileCitationBody::OrHash,
+                  OpenAI::Conversations::URLCitationBody::OrHash,
+                  OpenAI::Conversations::ContainerFileCitationBody::OrHash
+                )
+              ],
+            text: String,
+            logprobs: T::Array[OpenAI::Conversations::LobProb::OrHash],
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The annotations of the text output.
+          annotations:,
+          # The text output from the model.
+          text:,
+          logprobs: nil,
+          # The type of the output text. Always `output_text`.
+          type: :output_text
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              annotations:
+                T::Array[
+                  OpenAI::Conversations::OutputTextContent::Annotation::Variants
+                ],
+              text: String,
+              type: Symbol,
+              logprobs: T::Array[OpenAI::Conversations::LobProb]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Annotation
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Conversations::FileCitationBody,
+                OpenAI::Conversations::URLCitationBody,
+                OpenAI::Conversations::ContainerFileCitationBody
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Conversations::OutputTextContent::Annotation::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/refusal_content.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class RefusalContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::RefusalContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The refusal explanation from the model.
+        sig { returns(String) }
+        attr_accessor :refusal
+
+        # The type of the refusal. Always `refusal`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig { params(refusal: String, type: Symbol).returns(T.attached_class) }
+        def self.new(
+          # The refusal explanation from the model.
+          refusal:,
+          # The type of the refusal. Always `refusal`.
+          type: :refusal
+        )
+        end
+
+        sig { override.returns({ refusal: String, type: Symbol }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/summary_text_content.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class SummaryTextContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::SummaryTextContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :text
+
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig { params(text: String, type: Symbol).returns(T.attached_class) }
+        def self.new(text:, type: :summary_text)
+        end
+
+        sig { override.returns({ text: String, type: Symbol }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/text_content.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class TextContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Conversations::TextContent, OpenAI::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :text
+
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig { params(text: String, type: Symbol).returns(T.attached_class) }
+        def self.new(text:, type: :text)
+        end
+
+        sig { override.returns({ text: String, type: Symbol }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end