openai 0.17.1 → 0.19.0

data/lib/openai/models/chat/completion_create_params.rb

@@ -226,6 +226,8 @@ module OpenAI
         optional :safety_identifier, String
 
         # @!attribute seed
+        #   @deprecated
+        #
         #   This feature is in Beta. If specified, our system will make a best effort to
         #   sample deterministically, such that repeated requests with the same `seed` and
         #   parameters should return the same result. Determinism is not guaranteed, and you
@@ -244,9 +246,8 @@ module OpenAI
         #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
         #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
-        #     'priority', then the request will be processed with the corresponding service
-        #     tier. [Contact sales](https://openai.com/contact-sales) to learn more about
-        #     Priority processing.
+        #     '[priority](https://openai.com/api-priority-processing/)', then the request
+        #     will be processed with the corresponding service tier.
         #   - When not set, the default behavior is 'auto'.
         #
         #   When the `service_tier` parameter is set, the response body will include the
@@ -271,7 +272,7 @@ module OpenAI
         #   our [model distillation](https://platform.openai.com/docs/guides/distillation)
         #   or [evals](https://platform.openai.com/docs/guides/evals) products.
         #
-        #   Supports text and image inputs. Note: image inputs over 10MB will be dropped.
+        #   Supports text and image inputs. Note: image inputs over 8MB will be dropped.
         #
         #   @return [Boolean, nil]
         optional :store, OpenAI::Internal::Type::Boolean, nil?: true
@@ -591,9 +592,8 @@ module OpenAI
         # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
-        #   'priority', then the request will be processed with the corresponding service
-        #   tier. [Contact sales](https://openai.com/contact-sales) to learn more about
-        #   Priority processing.
+        #   '[priority](https://openai.com/api-priority-processing/)', then the request
+        #   will be processed with the corresponding service tier.
         # - When not set, the default behavior is 'auto'.
         #
         # When the `service_tier` parameter is set, the response body will include the

data/lib/openai/models/conversations/computer_screenshot_content.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Conversations
+      class ComputerScreenshotContent < OpenAI::Internal::Type::BaseModel
+        # @!attribute file_id
+        #   The identifier of an uploaded file that contains the screenshot.
+        #
+        #   @return [String, nil]
+        required :file_id, String, nil?: true
+
+        # @!attribute image_url
+        #   The URL of the screenshot image.
+        #
+        #   @return [String, nil]
+        required :image_url, String, nil?: true
+
+        # @!attribute type
+        #   Specifies the event type. For a computer screenshot, this property is always set
+        #   to `computer_screenshot`.
+        #
+        #   @return [Symbol, :computer_screenshot]
+        required :type, const: :computer_screenshot
+
+        # @!method initialize(file_id:, image_url:, type: :computer_screenshot)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Conversations::ComputerScreenshotContent} for more details.
+        #
+        #   @param file_id [String, nil] The identifier of an uploaded file that contains the screenshot.
+        #
+        #   @param image_url [String, nil] The URL of the screenshot image.
+        #
+        #   @param type [Symbol, :computer_screenshot] Specifies the event type. For a computer screenshot, this property is always set
+      end
+    end
+  end
+end

data/lib/openai/models/conversations/container_file_citation_body.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Conversations
+      class ContainerFileCitationBody < OpenAI::Internal::Type::BaseModel
+        # @!attribute container_id
+        #   The ID of the container file.
+        #
+        #   @return [String]
+        required :container_id, String
+
+        # @!attribute end_index
+        #   The index of the last character of the container file citation in the message.
+        #
+        #   @return [Integer]
+        required :end_index, Integer
+
+        # @!attribute file_id
+        #   The ID of the file.
+        #
+        #   @return [String]
+        required :file_id, String
+
+        # @!attribute filename
+        #   The filename of the container file cited.
+        #
+        #   @return [String]
+        required :filename, String
+
+        # @!attribute start_index
+        #   The index of the first character of the container file citation in the message.
+        #
+        #   @return [Integer]
+        required :start_index, Integer
+
+        # @!attribute type
+        #   The type of the container file citation. Always `container_file_citation`.
+        #
+        #   @return [Symbol, :container_file_citation]
+        required :type, const: :container_file_citation
+
+        # @!method initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation)
+        #   @param container_id [String] The ID of the container file.
+        #
+        #   @param end_index [Integer] The index of the last character of the container file citation in the message.
+        #
+        #   @param file_id [String] The ID of the file.
+        #
+        #   @param filename [String] The filename of the container file cited.
+        #
+        #   @param start_index [Integer] The index of the first character of the container file citation in the message.
+        #
+        #   @param type [Symbol, :container_file_citation] The type of the container file citation. Always `container_file_citation`.
+      end
+    end
+  end
+end

data/lib/openai/models/conversations/conversation.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Conversations
+      # @see OpenAI::Resources::Conversations#create
+      class Conversation < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the conversation.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The time at which the conversation was created, measured in seconds since the
+        #   Unix epoch.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute metadata
+        #   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.
+        #
+        #   @return [Object]
+        required :metadata, OpenAI::Internal::Type::Unknown
+
+        # @!attribute object
+        #   The object type, which is always `conversation`.
+        #
+        #   @return [Symbol, :conversation]
+        required :object, const: :conversation
+
+        # @!method initialize(id:, created_at:, metadata:, object: :conversation)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Conversations::Conversation} for more details.
+        #
+        #   @param id [String] The unique ID of the conversation.
+        #
+        #   @param created_at [Integer] The time at which the conversation was created, measured in seconds since the Un
+        #
+        #   @param metadata [Object] Set of 16 key-value pairs that can be attached to an object. This can be
+        #
+        #   @param object [Symbol, :conversation] The object type, which is always `conversation`.
+      end
+    end
+  end
+end

data/lib/openai/models/conversations/conversation_create_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Conversations
+      # @see OpenAI::Resources::Conversations#create
+      class ConversationCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute items
+        #   Initial items to include in the conversation context. You may add up to 20 items
+        #   at a time.
+        #
+        #   @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
+        optional :items,
+                 -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputItem] },
+                 nil?: true
+
+        # @!attribute metadata
+        #   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.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+        # @!method initialize(items: nil, metadata: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Conversations::ConversationCreateParams} for more details.
+        #
+        #   @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context.
+        #
+        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. Useful for
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openai/models/conversations/conversation_delete_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Conversations
+      # @see OpenAI::Resources::Conversations#delete
+      class ConversationDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openai/models/conversations/conversation_deleted.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Conversations
+      class ConversationDeleted < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute deleted
+        #
+        #   @return [Boolean]
+        required :deleted, OpenAI::Internal::Type::Boolean
+
+        # @!attribute object
+        #
+        #   @return [Symbol, :"conversation.deleted"]
+        required :object, const: :"conversation.deleted"
+
+        # @!method initialize(id:, deleted:, object: :"conversation.deleted")
+        #   @param id [String]
+        #   @param deleted [Boolean]
+        #   @param object [Symbol, :"conversation.deleted"]
+      end
+    end
+  end
+end

data/lib/openai/models/conversations/conversation_deleted_resource.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Conversations
+      # @see OpenAI::Resources::Conversations#delete
+      class ConversationDeletedResource < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute deleted
+        #
+        #   @return [Boolean]
+        required :deleted, OpenAI::Internal::Type::Boolean
+
+        # @!attribute object
+        #
+        #   @return [Symbol, :"conversation.deleted"]
+        required :object, const: :"conversation.deleted"
+
+        # @!method initialize(id:, deleted:, object: :"conversation.deleted")
+        #   @param id [String]
+        #   @param deleted [Boolean]
+        #   @param object [Symbol, :"conversation.deleted"]
+      end
+    end
+  end
+end