openai 0.18.1 → 0.19.0

data/rbi/openai/models/responses/tool.rbi

@@ -32,10 +32,6 @@ module OpenAI
           sig { returns(String) }
           attr_accessor :server_label
 
-          # The URL for the MCP server.
-          sig { returns(String) }
-          attr_accessor :server_url
-
           # The type of the MCP tool. Always `mcp`.
           sig { returns(Symbol) }
           attr_accessor :type
@@ -46,13 +42,51 @@ module OpenAI
               T.nilable(
                 T.any(
                   T::Array[String],
-                  OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter
+                  OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter
                 )
               )
             )
           end
           attr_accessor :allowed_tools
 
+          # An OAuth access token that can be used with a remote MCP server, either with a
+          # custom MCP server URL or a service connector. Your application must handle the
+          # OAuth authorization flow and provide the token here.
+          sig { returns(T.nilable(String)) }
+          attr_reader :authorization
+
+          sig { params(authorization: String).void }
+          attr_writer :authorization
+
+          # Identifier for service connectors, like those available in ChatGPT. One of
+          # `server_url` or `connector_id` must be provided. Learn more about service
+          # connectors
+          # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+          #
+          # Currently supported `connector_id` values are:
+          #
+          # - Dropbox: `connector_dropbox`
+          # - Gmail: `connector_gmail`
+          # - Google Calendar: `connector_googlecalendar`
+          # - Google Drive: `connector_googledrive`
+          # - Microsoft Teams: `connector_microsoftteams`
+          # - Outlook Calendar: `connector_outlookcalendar`
+          # - Outlook Email: `connector_outlookemail`
+          # - SharePoint: `connector_sharepoint`
+          sig do
+            returns(
+              T.nilable(OpenAI::Responses::Tool::Mcp::ConnectorID::OrSymbol)
+            )
+          end
+          attr_reader :connector_id
+
+          sig do
+            params(
+              connector_id: OpenAI::Responses::Tool::Mcp::ConnectorID::OrSymbol
+            ).void
+          end
+          attr_writer :connector_id
+
           # Optional HTTP headers to send to the MCP server. Use for authentication or other
           # purposes.
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -78,20 +112,29 @@ module OpenAI
           sig { params(server_description: String).void }
           attr_writer :server_description
 
+          # The URL for the MCP server. One of `server_url` or `connector_id` must be
+          # provided.
+          sig { returns(T.nilable(String)) }
+          attr_reader :server_url
+
+          sig { params(server_url: String).void }
+          attr_writer :server_url
+
           # Give the model access to additional tools via remote Model Context Protocol
           # (MCP) servers.
           # [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
           sig do
             params(
               server_label: String,
-              server_url: String,
               allowed_tools:
                 T.nilable(
                   T.any(
                     T::Array[String],
-                    OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter::OrHash
+                    OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter::OrHash
                   )
                 ),
+              authorization: String,
+              connector_id: OpenAI::Responses::Tool::Mcp::ConnectorID::OrSymbol,
               headers: T.nilable(T::Hash[Symbol, String]),
               require_approval:
                 T.nilable(
@@ -101,16 +144,35 @@ module OpenAI
                   )
                 ),
               server_description: String,
+              server_url: String,
               type: Symbol
             ).returns(T.attached_class)
           end
           def self.new(
             # A label for this MCP server, used to identify it in tool calls.
             server_label:,
-            # The URL for the MCP server.
-            server_url:,
             # List of allowed tool names or a filter object.
             allowed_tools: nil,
+            # An OAuth access token that can be used with a remote MCP server, either with a
+            # custom MCP server URL or a service connector. Your application must handle the
+            # OAuth authorization flow and provide the token here.
+            authorization: nil,
+            # Identifier for service connectors, like those available in ChatGPT. One of
+            # `server_url` or `connector_id` must be provided. Learn more about service
+            # connectors
+            # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+            #
+            # Currently supported `connector_id` values are:
+            #
+            # - Dropbox: `connector_dropbox`
+            # - Gmail: `connector_gmail`
+            # - Google Calendar: `connector_googlecalendar`
+            # - Google Drive: `connector_googledrive`
+            # - Microsoft Teams: `connector_microsoftteams`
+            # - Outlook Calendar: `connector_outlookcalendar`
+            # - Outlook Email: `connector_outlookemail`
+            # - SharePoint: `connector_sharepoint`
+            connector_id: nil,
             # Optional HTTP headers to send to the MCP server. Use for authentication or other
             # purposes.
             headers: nil,
@@ -118,6 +180,9 @@ module OpenAI
             require_approval: nil,
             # Optional description of the MCP server, used to provide more context.
             server_description: nil,
+            # The URL for the MCP server. One of `server_url` or `connector_id` must be
+            # provided.
+            server_url: nil,
             # The type of the MCP tool. Always `mcp`.
             type: :mcp
           )
@@ -127,15 +192,17 @@ module OpenAI
             override.returns(
               {
                 server_label: String,
-                server_url: String,
                 type: Symbol,
                 allowed_tools:
                   T.nilable(
                     T.any(
                       T::Array[String],
-                      OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter
+                      OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter
                     )
                   ),
+                authorization: String,
+                connector_id:
+                  OpenAI::Responses::Tool::Mcp::ConnectorID::OrSymbol,
                 headers: T.nilable(T::Hash[Symbol, String]),
                 require_approval:
                   T.nilable(
@@ -144,7 +211,8 @@ module OpenAI
                       OpenAI::Responses::Tool::Mcp::RequireApproval::McpToolApprovalSetting::OrSymbol
                     )
                   ),
-                server_description: String
+                server_description: String,
+                server_url: String
               }
             )
           end
@@ -159,19 +227,29 @@ module OpenAI
               T.type_alias do
                 T.any(
                   T::Array[String],
-                  OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter
+                  OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter
                 )
               end
 
-            class McpAllowedToolsFilter < OpenAI::Internal::Type::BaseModel
+            class McpToolFilter < OpenAI::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do
                   T.any(
-                    OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter,
+                    OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter,
                     OpenAI::Internal::AnyHash
                   )
                 end
 
+              # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              # is
+              # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              # it will match this filter.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :read_only
+
+              sig { params(read_only: T::Boolean).void }
+              attr_writer :read_only
+
               # List of allowed tool names.
               sig { returns(T.nilable(T::Array[String])) }
               attr_reader :tool_names
@@ -181,15 +259,27 @@ module OpenAI
 
               # A filter object to specify which tools are allowed.
               sig do
-                params(tool_names: T::Array[String]).returns(T.attached_class)
+                params(
+                  read_only: T::Boolean,
+                  tool_names: T::Array[String]
+                ).returns(T.attached_class)
               end
               def self.new(
+                # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                # is
+                # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                # it will match this filter.
+                read_only: nil,
                 # List of allowed tool names.
                 tool_names: nil
               )
               end
 
-              sig { override.returns({ tool_names: T::Array[String] }) }
+              sig do
+                override.returns(
+                  { read_only: T::Boolean, tool_names: T::Array[String] }
+                )
+              end
               def to_hash
               end
             end
@@ -209,6 +299,82 @@ module OpenAI
               )
           end
 
+          # Identifier for service connectors, like those available in ChatGPT. One of
+          # `server_url` or `connector_id` must be provided. Learn more about service
+          # connectors
+          # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+          #
+          # Currently supported `connector_id` values are:
+          #
+          # - Dropbox: `connector_dropbox`
+          # - Gmail: `connector_gmail`
+          # - Google Calendar: `connector_googlecalendar`
+          # - Google Drive: `connector_googledrive`
+          # - Microsoft Teams: `connector_microsoftteams`
+          # - Outlook Calendar: `connector_outlookcalendar`
+          # - Outlook Email: `connector_outlookemail`
+          # - SharePoint: `connector_sharepoint`
+          module ConnectorID
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Responses::Tool::Mcp::ConnectorID)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CONNECTOR_DROPBOX =
+              T.let(
+                :connector_dropbox,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_GMAIL =
+              T.let(
+                :connector_gmail,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_GOOGLECALENDAR =
+              T.let(
+                :connector_googlecalendar,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_GOOGLEDRIVE =
+              T.let(
+                :connector_googledrive,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_MICROSOFTTEAMS =
+              T.let(
+                :connector_microsoftteams,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_OUTLOOKCALENDAR =
+              T.let(
+                :connector_outlookcalendar,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_OUTLOOKEMAIL =
+              T.let(
+                :connector_outlookemail,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_SHAREPOINT =
+              T.let(
+                :connector_sharepoint,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           # Specify which of the MCP server's tools require approval.
           module RequireApproval
             extend OpenAI::Internal::Type::Union
@@ -230,7 +396,7 @@ module OpenAI
                   )
                 end
 
-              # A list of tools that always require approval.
+              # A filter object to specify which tools are allowed.
               sig do
                 returns(
                   T.nilable(
@@ -248,7 +414,7 @@ module OpenAI
               end
               attr_writer :always
 
-              # A list of tools that never require approval.
+              # A filter object to specify which tools are allowed.
               sig do
                 returns(
                   T.nilable(
@@ -266,6 +432,8 @@ module OpenAI
               end
               attr_writer :never
 
+              # Specify which of the MCP server's tools require approval. Can be `always`,
+              # `never`, or a filter object associated with tools that require approval.
               sig do
                 params(
                   always:
@@ -275,9 +443,9 @@ module OpenAI
                 ).returns(T.attached_class)
               end
               def self.new(
-                # A list of tools that always require approval.
+                # A filter object to specify which tools are allowed.
                 always: nil,
-                # A list of tools that never require approval.
+                # A filter object to specify which tools are allowed.
                 never: nil
               )
               end
@@ -304,24 +472,46 @@ module OpenAI
                     )
                   end
 
-                # List of tools that require approval.
+                # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                # is
+                # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                # it will match this filter.
+                sig { returns(T.nilable(T::Boolean)) }
+                attr_reader :read_only
+
+                sig { params(read_only: T::Boolean).void }
+                attr_writer :read_only
+
+                # List of allowed tool names.
                 sig { returns(T.nilable(T::Array[String])) }
                 attr_reader :tool_names
 
                 sig { params(tool_names: T::Array[String]).void }
                 attr_writer :tool_names
 
-                # A list of tools that always require approval.
+                # A filter object to specify which tools are allowed.
                 sig do
-                  params(tool_names: T::Array[String]).returns(T.attached_class)
+                  params(
+                    read_only: T::Boolean,
+                    tool_names: T::Array[String]
+                  ).returns(T.attached_class)
                 end
                 def self.new(
-                  # List of tools that require approval.
+                  # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                  # is
+                  # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                  # it will match this filter.
+                  read_only: nil,
+                  # List of allowed tool names.
                   tool_names: nil
                 )
                 end
 
-                sig { override.returns({ tool_names: T::Array[String] }) }
+                sig do
+                  override.returns(
+                    { read_only: T::Boolean, tool_names: T::Array[String] }
+                  )
+                end
                 def to_hash
                 end
               end
@@ -335,24 +525,46 @@ module OpenAI
                     )
                   end
 
-                # List of tools that do not require approval.
+                # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                # is
+                # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                # it will match this filter.
+                sig { returns(T.nilable(T::Boolean)) }
+                attr_reader :read_only
+
+                sig { params(read_only: T::Boolean).void }
+                attr_writer :read_only
+
+                # List of allowed tool names.
                 sig { returns(T.nilable(T::Array[String])) }
                 attr_reader :tool_names
 
                 sig { params(tool_names: T::Array[String]).void }
                 attr_writer :tool_names
 
-                # A list of tools that never require approval.
+                # A filter object to specify which tools are allowed.
                 sig do
-                  params(tool_names: T::Array[String]).returns(T.attached_class)
+                  params(
+                    read_only: T::Boolean,
+                    tool_names: T::Array[String]
+                  ).returns(T.attached_class)
                 end
                 def self.new(
-                  # List of tools that do not require approval.
+                  # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                  # is
+                  # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                  # it will match this filter.
+                  read_only: nil,
+                  # List of allowed tool names.
                   tool_names: nil
                 )
                 end
 
-                sig { override.returns({ tool_names: T::Array[String] }) }
+                sig do
+                  override.returns(
+                    { read_only: T::Boolean, tool_names: T::Array[String] }
+                  )
+                end
                 def to_hash
                 end
               end

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,152 @@
+# 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:
+          #
+          # - `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