openai 0.18.1 → 0.20.0

data/rbi/openai/models.rbi

@@ -53,6 +53,8 @@ module OpenAI
 
   Containers = OpenAI::Models::Containers
 
+  Conversations = OpenAI::Models::Conversations
+
   CreateEmbeddingResponse = OpenAI::Models::CreateEmbeddingResponse
 
   CustomToolInputFormat = OpenAI::Models::CustomToolInputFormat

data/rbi/openai/resources/conversations/items.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Conversations
+      class Items
+        # Create items in a conversation with the given ID.
+        sig do
+          params(
+            conversation_id: String,
+            items:
+              T::Array[
+                T.any(
+                  OpenAI::Responses::EasyInputMessage::OrHash,
+                  OpenAI::Responses::ResponseInputItem::Message::OrHash,
+                  OpenAI::Responses::ResponseOutputMessage::OrHash,
+                  OpenAI::Responses::ResponseFileSearchToolCall::OrHash,
+                  OpenAI::Responses::ResponseComputerToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ComputerCallOutput::OrHash,
+                  OpenAI::Responses::ResponseFunctionWebSearch::OrHash,
+                  OpenAI::Responses::ResponseFunctionToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::FunctionCallOutput::OrHash,
+                  OpenAI::Responses::ResponseReasoningItem::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OrHash,
+                  OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::LocalShellCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::LocalShellCallOutput::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpListTools::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpApprovalRequest::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpApprovalResponse::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpCall::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCallOutput::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ItemReference::OrHash
+                )
+              ],
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Conversations::ConversationItemList)
+        end
+        def create(
+          # Path param: The ID of the conversation to add the item to.
+          conversation_id,
+          # Body param: The items to add to the conversation. You may add up to 20 items at
+          # a time.
+          items:,
+          # Query param: 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
+
+        # Get a single item from a conversation with the given IDs.
+        sig do
+          params(
+            item_id: String,
+            conversation_id: String,
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Conversations::ConversationItem::Variants)
+        end
+        def retrieve(
+          # Path param: The ID of the item to retrieve.
+          item_id,
+          # Path param: The ID of the conversation that contains the item.
+          conversation_id:,
+          # Query param: 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
+
+        # List all items for a conversation with the given ID.
+        sig do
+          params(
+            conversation_id: String,
+            after: String,
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+            limit: Integer,
+            order: OpenAI::Conversations::ItemListParams::Order::OrSymbol,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(
+            OpenAI::Internal::ConversationCursorPage[
+              OpenAI::Conversations::ConversationItem::Variants
+            ]
+          )
+        end
+        def list(
+          # The ID of the conversation to list items for.
+          conversation_id,
+          # 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
+
+        # Delete an item from a conversation with the given IDs.
+        sig do
+          params(
+            item_id: String,
+            conversation_id: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Conversations::Conversation)
+        end
+        def delete(
+          # The ID of the item to delete.
+          item_id,
+          # The ID of the conversation that contains the item.
+          conversation_id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/conversations.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Conversations
+      sig { returns(OpenAI::Resources::Conversations::Items) }
+      attr_reader :items
+
+      # Create a conversation.
+      sig do
+        params(
+          items:
+            T.nilable(
+              T::Array[
+                T.any(
+                  OpenAI::Responses::EasyInputMessage::OrHash,
+                  OpenAI::Responses::ResponseInputItem::Message::OrHash,
+                  OpenAI::Responses::ResponseOutputMessage::OrHash,
+                  OpenAI::Responses::ResponseFileSearchToolCall::OrHash,
+                  OpenAI::Responses::ResponseComputerToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ComputerCallOutput::OrHash,
+                  OpenAI::Responses::ResponseFunctionWebSearch::OrHash,
+                  OpenAI::Responses::ResponseFunctionToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::FunctionCallOutput::OrHash,
+                  OpenAI::Responses::ResponseReasoningItem::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OrHash,
+                  OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::LocalShellCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::LocalShellCallOutput::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpListTools::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpApprovalRequest::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpApprovalResponse::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpCall::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCallOutput::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ItemReference::OrHash
+                )
+              ]
+            ),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Conversations::Conversation)
+      end
+      def create(
+        # Initial items to include in the conversation context. You may add up to 20 items
+        # at a time.
+        items: nil,
+        # Set of 16 key-value pairs that can be attached to an object. Useful for storing
+        # additional information about the object in a structured format.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a conversation with the given ID.
+      sig do
+        params(
+          conversation_id: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Conversations::Conversation)
+      end
+      def retrieve(
+        # The ID of the conversation to retrieve.
+        conversation_id,
+        request_options: {}
+      )
+      end
+
+      # Update a conversation's metadata with the given ID.
+      sig do
+        params(
+          conversation_id: String,
+          metadata: T::Hash[Symbol, String],
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Conversations::Conversation)
+      end
+      def update(
+        # The ID of the conversation to update.
+        conversation_id,
+        # 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.
+        metadata:,
+        request_options: {}
+      )
+      end
+
+      # Delete a conversation with the given ID.
+      sig do
+        params(
+          conversation_id: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Conversations::ConversationDeletedResource)
+      end
+      def delete(
+        # The ID of the conversation to delete.
+        conversation_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OpenAI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/openai/resources/responses/input_items.rbi

@@ -9,7 +9,6 @@ module OpenAI
           params(
             response_id: String,
             after: String,
-            before: String,
             include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
             limit: Integer,
             order: OpenAI::Responses::InputItemListParams::Order::OrSymbol,
@@ -25,8 +24,6 @@ module OpenAI
           response_id,
           # An item ID to list items after, used in pagination.
           after: nil,
-          # An item ID to list items before, used in pagination.
-          before: nil,
           # Additional fields to include in the response. See the `include` parameter for
           # Response creation above for more information.
           include: nil,

data/rbi/openai/resources/responses.rbi

@@ -22,6 +22,13 @@ module OpenAI
       sig do
         params(
           background: T.nilable(T::Boolean),
+          conversation:
+            T.nilable(
+              T.any(
+                String,
+                OpenAI::Responses::ResponseConversationParam::OrHash
+              )
+            ),
           include:
             T.nilable(
               T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
@@ -78,6 +85,7 @@ module OpenAI
                 OpenAI::Responses::Tool::ImageGeneration::OrHash,
                 OpenAI::Responses::Tool::LocalShell::OrHash,
                 OpenAI::Responses::CustomTool::OrHash,
+                OpenAI::Responses::Tool::WebSearchTool::OrHash,
                 OpenAI::Responses::WebSearchTool::OrHash
               )
             ],
@@ -96,9 +104,16 @@ module OpenAI
         # Whether to run the model response in the background.
         # [Learn more](https://platform.openai.com/docs/guides/background).
         background: nil,
+        # The conversation that this response belongs to. Items from this conversation are
+        # prepended to `input_items` for this response request. Input items and output
+        # items from this response are automatically added to this conversation after this
+        # response completes.
+        conversation: 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
@@ -156,6 +171,7 @@ module OpenAI
         # The unique ID of the previous response to the model. Use this to create
         # multi-turn conversations. Learn more about
         # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
+        # Cannot be used in conjunction with `conversation`.
         previous_response_id: nil,
         # Reference to a prompt template and its variables.
         # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
@@ -274,6 +290,13 @@ module OpenAI
       sig do
         params(
           background: T.nilable(T::Boolean),
+          conversation:
+            T.nilable(
+              T.any(
+                String,
+                OpenAI::Responses::ResponseConversationParam::OrHash
+              )
+            ),
           include:
             T.nilable(
               T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
@@ -332,6 +355,7 @@ module OpenAI
                 OpenAI::Responses::Tool::ImageGeneration::OrHash,
                 OpenAI::Responses::Tool::LocalShell::OrHash,
                 OpenAI::Responses::CustomTool::OrHash,
+                OpenAI::Responses::Tool::WebSearchTool::OrHash,
                 OpenAI::Responses::WebSearchTool::OrHash
               )
             ],
@@ -354,9 +378,16 @@ module OpenAI
         # Whether to run the model response in the background.
         # [Learn more](https://platform.openai.com/docs/guides/background).
         background: nil,
+        # The conversation that this response belongs to. Items from this conversation are
+        # prepended to `input_items` for this response request. Input items and output
+        # items from this response are automatically added to this conversation after this
+        # response completes.
+        conversation: 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
@@ -414,6 +445,7 @@ module OpenAI
         # The unique ID of the previous response to the model. Use this to create
         # multi-turn conversations. Learn more about
         # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
+        # Cannot be used in conjunction with `conversation`.
         previous_response_id: nil,
         # Reference to a prompt template and its variables.
         # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).

data/sig/openai/client.rbs

@@ -46,6 +46,8 @@ module OpenAI
 
     attr_reader responses: OpenAI::Resources::Responses
 
+    attr_reader conversations: OpenAI::Resources::Conversations
+
     attr_reader evals: OpenAI::Resources::Evals
 
     attr_reader containers: OpenAI::Resources::Containers

data/sig/openai/internal/conversation_cursor_page.rbs

@@ -0,0 +1,15 @@
+module OpenAI
+  module Internal
+    class ConversationCursorPage[Elem]
+      include OpenAI::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor has_more: bool
+
+      attr_accessor last_id: String
+
+      def inspect: -> String
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module OpenAI
+  module Models
+    module Conversations
+      type computer_screenshot_content =
+        { file_id: String?, image_url: String?, type: :computer_screenshot }
+
+      class ComputerScreenshotContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor file_id: String?
+
+        attr_accessor image_url: String?
+
+        attr_accessor type: :computer_screenshot
+
+        def initialize: (
+          file_id: String?,
+          image_url: String?,
+          ?type: :computer_screenshot
+        ) -> void
+
+        def to_hash: -> {
+          file_id: String?,
+          image_url: String?,
+          type: :computer_screenshot
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module OpenAI
+  module Models
+    module Conversations
+      type container_file_citation_body =
+        {
+          container_id: String,
+          end_index: Integer,
+          file_id: String,
+          filename: String,
+          start_index: Integer,
+          type: :container_file_citation
+        }
+
+      class ContainerFileCitationBody < OpenAI::Internal::Type::BaseModel
+        attr_accessor container_id: String
+
+        attr_accessor end_index: Integer
+
+        attr_accessor file_id: String
+
+        attr_accessor filename: String
+
+        attr_accessor start_index: Integer
+
+        attr_accessor type: :container_file_citation
+
+        def initialize: (
+          container_id: String,
+          end_index: Integer,
+          file_id: String,
+          filename: String,
+          start_index: Integer,
+          ?type: :container_file_citation
+        ) -> void
+
+        def to_hash: -> {
+          container_id: String,
+          end_index: Integer,
+          file_id: String,
+          filename: String,
+          start_index: Integer,
+          type: :container_file_citation
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module OpenAI
+  module Models
+    module Conversations
+      type conversation =
+        {
+          id: String,
+          created_at: Integer,
+          metadata: top,
+          object: :conversation
+        }
+
+      class Conversation < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Integer
+
+        attr_accessor metadata: top
+
+        attr_accessor object: :conversation
+
+        def initialize: (
+          id: String,
+          created_at: Integer,
+          metadata: top,
+          ?object: :conversation
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Integer,
+          metadata: top,
+          object: :conversation
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module OpenAI
+  module Models
+    module Conversations
+      type conversation_create_params =
+        {
+          items: ::Array[OpenAI::Models::Responses::response_input_item]?,
+          metadata: OpenAI::Models::metadata?
+        }
+        & OpenAI::Internal::Type::request_parameters
+
+      class ConversationCreateParams < 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_accessor metadata: OpenAI::Models::metadata?
+
+        def initialize: (
+          ?items: ::Array[OpenAI::Models::Responses::response_input_item]?,
+          ?metadata: OpenAI::Models::metadata?,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          items: ::Array[OpenAI::Models::Responses::response_input_item]?,
+          metadata: OpenAI::Models::metadata?,
+          request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Conversations
+      type conversation_delete_params =
+        {  } & OpenAI::Internal::Type::request_parameters
+
+      class ConversationDeleteParams < 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_deleted.rbs

@@ -0,0 +1,28 @@
+module OpenAI
+  module Models
+    module Conversations
+      type conversation_deleted =
+        { id: String, deleted: bool, object: :"conversation.deleted" }
+
+      class ConversationDeleted < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor deleted: bool
+
+        attr_accessor object: :"conversation.deleted"
+
+        def initialize: (
+          id: String,
+          deleted: bool,
+          ?object: :"conversation.deleted"
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          deleted: bool,
+          object: :"conversation.deleted"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module OpenAI
+  module Models
+    module Conversations
+      type conversation_deleted_resource =
+        { id: String, deleted: bool, object: :"conversation.deleted" }
+
+      class ConversationDeletedResource < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor deleted: bool
+
+        attr_accessor object: :"conversation.deleted"
+
+        def initialize: (
+          id: String,
+          deleted: bool,
+          ?object: :"conversation.deleted"
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          deleted: bool,
+          object: :"conversation.deleted"
+        }
+      end
+    end
+  end
+end