openai 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 778fba439d6ccb684d26309e1c8b6df0a91dfbeea730d878b27dbe5d3866c006
-  data.tar.gz: 1e01ee7a200d5fecc53101441600a2d5ff68de95c35daa39ca3a686faf687825
+  metadata.gz: e0a273910412c6b05028da1b9e7fceab0b048d4d34df4b1bee6a781dcbad33dd
+  data.tar.gz: 51a3719def2827a793c2b9974cc4104e00000cea78893ff36d327254bb8e586e
 SHA512:
-  metadata.gz: 8f8eae9d8696ab749f14921f0680faf5e4e48c80c7a22a8e956221882c2609596067036d6b8403adc6f6d6facfce355b1d708ee18030b2b44ed36db98a3399e9
-  data.tar.gz: fa5ffa61094c569e2d3c8c19f0d4fb2295bd12574f41f19b43176957fe0c7b4966054ace9f6484ec54865797bfc7a93d0a74d984d57761410e531b4c981fd2a0
+  metadata.gz: d65777601ceac3d125750949f80a0ca4d50f62593e971d067f7c164ab1dbbddf51266cee8ab752ef058f2313f09b7ad48a6312c8df7a465e0807e956ed55cedf
+  data.tar.gz: 9156aee0d88ad6be1e794acede9961d774c40ade621282aff54899879e718f6f514f61007d25f614e507796eefefbf694508042e1e126fc0412aac76b003ff44

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.9.0 (2025-06-17)
+
+Full Changelog: [v0.8.0...v0.9.0](https://github.com/openai/openai-ruby/compare/v0.8.0...v0.9.0)
+
+### Features
+
+* **api:** add reusable prompt IDs ([72e35ad](https://github.com/openai/openai-ruby/commit/72e35ad4a677a70a98db291a20aa212e53c367ea))
+* **api:** manual updates ([a4bcab7](https://github.com/openai/openai-ruby/commit/a4bcab736d59404c61b148a468d3bf0bc570fa39))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([e8dfcf9](https://github.com/openai/openai-ruby/commit/e8dfcf97f3af426d3ad83472fa6eaac718acbd4d))
+* **ci:** link to correct github repo ([7b34316](https://github.com/openai/openai-ruby/commit/7b3431612ea66d123bc114ec55bdf07f6081439e))
+
+
+### Documentation
+
+* structured outputs in README ([#723](https://github.com/openai/openai-ruby/issues/723)) ([7212e61](https://github.com/openai/openai-ruby/commit/7212e61ee2fb9ebff0576b0bff4424f43ae54af2))
+* use image edit example in readme ([#722](https://github.com/openai/openai-ruby/issues/722)) ([eaa5055](https://github.com/openai/openai-ruby/commit/eaa5055eebca620c261c749ae4945845532c012d))
+
 ## 0.8.0 (2025-06-10)
 
 Full Changelog: [v0.7.0...v0.8.0](https://github.com/openai/openai-ruby/compare/v0.7.0...v0.8.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.8.0"
+gem "openai", "~> 0.9.0"
 ```
 
 <!-- x-release-please-end -->
@@ -96,15 +96,126 @@ file_object = openai.files.create(file: Pathname("input.jsonl"), purpose: "fine-
 # Alternatively, pass file contents or a `StringIO` directly:
 file_object = openai.files.create(file: File.read("input.jsonl"), purpose: "fine-tune")
 
+puts(file_object.id)
+
 # Or, to control the filename and/or content type:
-file = OpenAI::FilePart.new(File.read("input.jsonl"), filename: "input.jsonl", content_type: "…")
-file_object = openai.files.create(file: file, purpose: "fine-tune")
+image = OpenAI::FilePart.new(Pathname('dog.jpg'), content_type: 'image/jpeg')
+edited = openai.images.edit(
+  prompt: "make this image look like a painting",
+  model: "gpt-image-1",
+  size: '1024x1024',
+  image: image
+)
 
-puts(file_object.id)
+puts(edited.data.first)
 ```
 
 Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
 
+### [Structured outputs](https://platform.openai.com/docs/guides/structured-outputs) and function calling
+
+This SDK ships with helpers in `OpenAI::BaseModel`, `OpenAI::ArrayOf`, `OpenAI::EnumOf`, and `OpenAI::UnionOf` to help you define the supported JSON schemas used in making structured outputs and function calling requests.
+
+<details>
+<summary>Snippet</summary>
+
+```ruby
+# Participant model with an optional last_name and an enum for status
+class Participant < OpenAI::BaseModel
+  required :first_name, String
+  required :last_name, String, nil?: true
+  required :status, OpenAI::EnumOf[:confirmed, :unconfirmed, :tentative]
+end
+
+# CalendarEvent model with a list of participants.
+class CalendarEvent < OpenAI::BaseModel
+  required :name, String
+  required :date, String
+  required :participants, OpenAI::ArrayOf[Participant]
+end
+
+
+client = OpenAI::Client.new
+
+response = client.responses.create(
+  model: "gpt-4o-2024-08-06",
+  input: [
+    {role: :system, content: "Extract the event information."},
+    {
+      role: :user,
+      content: <<~CONTENT
+        Alice Shah and Lena are going to a science fair on Friday at 123 Main St. in San Diego.
+        They have also invited Jasper Vellani and Talia Groves - Jasper has not responded and Talia said she is thinking about it.
+      CONTENT
+    }
+  ],
+  text: CalendarEvent
+)
+
+response
+  .output
+  .flat_map { _1.content }
+  # filter out refusal responses
+  .grep_v(OpenAI::Models::Responses::ResponseOutputRefusal)
+  .each do |content|
+    # parsed is an instance of `CalendarEvent`
+    pp(content.parsed)
+  end
+```
+
+</details>
+
+See the [examples](https://github.com/openai/openai-ruby/tree/main/examples) directory for more usage examples for helper usage.
+
+To make the equivalent request using raw JSON schema format, you would do the following:
+
+<details>
+<summary>Snippet</summary>
+
+```ruby
+response = client.responses.create(
+  model: "gpt-4o-2024-08-06",
+  input: [
+    {role: :system, content: "Extract the event information."},
+    {
+      role: :user,
+      content: "..."
+    }
+  ],
+  text: {
+    format: {
+      type: :json_schema,
+      name: "CalendarEvent",
+      strict: true,
+      schema: {
+        type: "object",
+        properties: {
+          name: {type: "string"},
+          date: {type: "string"},
+          participants: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                first_name: {type: "string"},
+                last_name: {type: %w[string null]},
+                status: {type: "string", enum: %w[confirmed unconfirmed tentative]}
+              },
+              required: %w[first_name last_name status],
+              additionalProperties: false
+            }
+          }
+        },
+        required: %w[name date participants],
+        additionalProperties: false
+      }
+    }
+  }
+)
+```
+
+</details>
+
 ### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `OpenAI::Errors::APIError` will be thrown:

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

@@ -213,6 +213,7 @@ module OpenAI
           AUTO = :auto
           DEFAULT = :default
           FLEX = :flex
+          SCALE = :scale
 
           # @!method self.values
           #   @return [Array<Symbol>]

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

@@ -396,6 +396,7 @@ module OpenAI
           AUTO = :auto
           DEFAULT = :default
           FLEX = :flex
+          SCALE = :scale
 
           # @!method self.values
           #   @return [Array<Symbol>]

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

@@ -569,6 +569,7 @@ module OpenAI
           AUTO = :auto
           DEFAULT = :default
           FLEX = :flex
+          SCALE = :scale
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rb

@@ -6,76 +6,41 @@ module OpenAI
       module Checkpoints
         # @see OpenAI::Resources::FineTuning::Checkpoints::Permissions#retrieve
         class PermissionRetrieveResponse < OpenAI::Internal::Type::BaseModel
-          # @!attribute data
+          # @!attribute id
+          #   The permission identifier, which can be referenced in the API endpoints.
           #
-          #   @return [Array<OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse::Data>]
-          required :data,
-                   -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse::Data] }
+          #   @return [String]
+          required :id, String
 
-          # @!attribute has_more
+          # @!attribute created_at
+          #   The Unix timestamp (in seconds) for when the permission was created.
           #
-          #   @return [Boolean]
-          required :has_more, OpenAI::Internal::Type::Boolean
+          #   @return [Integer]
+          required :created_at, Integer
 
           # @!attribute object
+          #   The object type, which is always "checkpoint.permission".
           #
-          #   @return [Symbol, :list]
-          required :object, const: :list
+          #   @return [Symbol, :"checkpoint.permission"]
+          required :object, const: :"checkpoint.permission"
 
-          # @!attribute first_id
+          # @!attribute project_id
+          #   The project identifier that the permission is for.
           #
-          #   @return [String, nil]
-          optional :first_id, String, nil?: true
+          #   @return [String]
+          required :project_id, String
 
-          # @!attribute last_id
+          # @!method initialize(id:, created_at:, project_id:, object: :"checkpoint.permission")
+          #   The `checkpoint.permission` object represents a permission for a fine-tuned
+          #   model checkpoint.
           #
-          #   @return [String, nil]
-          optional :last_id, String, nil?: true
-
-          # @!method initialize(data:, has_more:, first_id: nil, last_id: nil, object: :list)
-          #   @param data [Array<OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse::Data>]
-          #   @param has_more [Boolean]
-          #   @param first_id [String, nil]
-          #   @param last_id [String, nil]
-          #   @param object [Symbol, :list]
-
-          class Data < OpenAI::Internal::Type::BaseModel
-            # @!attribute id
-            #   The permission identifier, which can be referenced in the API endpoints.
-            #
-            #   @return [String]
-            required :id, String
-
-            # @!attribute created_at
-            #   The Unix timestamp (in seconds) for when the permission was created.
-            #
-            #   @return [Integer]
-            required :created_at, Integer
-
-            # @!attribute object
-            #   The object type, which is always "checkpoint.permission".
-            #
-            #   @return [Symbol, :"checkpoint.permission"]
-            required :object, const: :"checkpoint.permission"
-
-            # @!attribute project_id
-            #   The project identifier that the permission is for.
-            #
-            #   @return [String]
-            required :project_id, String
-
-            # @!method initialize(id:, created_at:, project_id:, object: :"checkpoint.permission")
-            #   The `checkpoint.permission` object represents a permission for a fine-tuned
-            #   model checkpoint.
-            #
-            #   @param id [String] The permission identifier, which can be referenced in the API endpoints.
-            #
-            #   @param created_at [Integer] The Unix timestamp (in seconds) for when the permission was created.
-            #
-            #   @param project_id [String] The project identifier that the permission is for.
-            #
-            #   @param object [Symbol, :"checkpoint.permission"] The object type, which is always "checkpoint.permission".
-          end
+          #   @param id [String] The permission identifier, which can be referenced in the API endpoints.
+          #
+          #   @param created_at [Integer] The Unix timestamp (in seconds) for when the permission was created.
+          #
+          #   @param project_id [String] The project identifier that the permission is for.
+          #
+          #   @param object [Symbol, :"checkpoint.permission"] The object type, which is always "checkpoint.permission".
         end
       end
     end

data/lib/openai/models/fine_tuning/job_create_params.rb

@@ -31,7 +31,8 @@ module OpenAI
         #   [preference](https://platform.openai.com/docs/api-reference/fine-tuning/preference-input)
         #   format.
         #
-        #   See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+        #   See the
+        #   [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization)
         #   for more details.
         #
         #   @return [String]
@@ -100,7 +101,8 @@ module OpenAI
         #   Your dataset must be formatted as a JSONL file. You must upload your file with
         #   the purpose `fine-tune`.
         #
-        #   See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+        #   See the
+        #   [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization)
         #   for more details.
         #
         #   @return [String, nil]

data/lib/openai/models/image_edit_params.rb

@@ -61,6 +61,22 @@ module OpenAI
       #   @return [Integer, nil]
       optional :n, Integer, nil?: true
 
+      # @!attribute output_compression
+      #   The compression level (0-100%) for the generated images. This parameter is only
+      #   supported for `gpt-image-1` with the `webp` or `jpeg` output formats, and
+      #   defaults to 100.
+      #
+      #   @return [Integer, nil]
+      optional :output_compression, Integer, nil?: true
+
+      # @!attribute output_format
+      #   The format in which the generated images are returned. This parameter is only
+      #   supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`. The
+      #   default value is `png`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil]
+      optional :output_format, enum: -> { OpenAI::ImageEditParams::OutputFormat }, nil?: true
+
       # @!attribute quality
       #   The quality of the image that will be generated. `high`, `medium` and `low` are
       #   only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality.
@@ -94,7 +110,7 @@ module OpenAI
       #   @return [String, nil]
       optional :user, String
 
-      # @!method initialize(image:, prompt:, background: nil, mask: nil, model: nil, n: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
+      # @!method initialize(image:, prompt:, background: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {OpenAI::Models::ImageEditParams} for more details.
       #
@@ -110,6 +126,10 @@ module OpenAI
       #
       #   @param n [Integer, nil] The number of images to generate. Must be between 1 and 10.
       #
+      #   @param output_compression [Integer, nil] The compression level (0-100%) for the generated images. This parameter
+      #
+      #   @param output_format [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil] The format in which the generated images are returned. This parameter is
+      #
       #   @param quality [Symbol, OpenAI::Models::ImageEditParams::Quality, nil] The quality of the image that will be generated. `high`, `medium` and `low` are
       #
       #   @param response_format [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil] The format in which the generated images are returned. Must be one of `url` or `
@@ -174,6 +194,20 @@ module OpenAI
         #   @return [Array(String, Symbol, OpenAI::Models::ImageModel)]
       end
 
+      # The format in which the generated images are returned. This parameter is only
+      # supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`. The
+      # default value is `png`.
+      module OutputFormat
+        extend OpenAI::Internal::Type::Enum
+
+        PNG = :png
+        JPEG = :jpeg
+        WEBP = :webp
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The quality of the image that will be generated. `high`, `medium` and `low` are
       # only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality.
       # Defaults to `auto`.

data/lib/openai/models/responses/response.rb

@@ -32,15 +32,14 @@ module OpenAI
         required :incomplete_details, -> { OpenAI::Responses::Response::IncompleteDetails }, nil?: true
 
         # @!attribute instructions
-        #   Inserts a system (or developer) message as the first item in the model's
-        #   context.
+        #   A system (or developer) message inserted into the model's context.
         #
         #   When using along with `previous_response_id`, the instructions from a previous
         #   response will not be carried over to the next response. This makes it simple to
         #   swap out system (or developer) messages in new responses.
         #
-        #   @return [String, nil]
-        required :instructions, String, nil?: true
+        #   @return [String, 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::ResponseInputItem::ItemReference>, nil]
+        required :instructions, union: -> { OpenAI::Responses::Response::Instructions }, nil?: true
 
         # @!attribute metadata
         #   Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -156,6 +155,13 @@ module OpenAI
         #   @return [String, nil]
         optional :previous_response_id, String, nil?: true
 
+        # @!attribute prompt
+        #   Reference to a prompt template and its variables.
+        #   [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        #
+        #   @return [OpenAI::Models::Responses::ResponsePrompt, nil]
+        optional :prompt, -> { OpenAI::Responses::ResponsePrompt }, nil?: true
+
         # @!attribute reasoning
         #   **o-series models only**
         #
@@ -231,7 +237,7 @@ module OpenAI
         #   @return [String, nil]
         optional :user, String
 
-        # @!method initialize(id:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, max_output_tokens: nil, previous_response_id: nil, reasoning: nil, service_tier: nil, status: nil, text: nil, truncation: nil, usage: nil, user: nil, object: :response)
+        # @!method initialize(id:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, max_output_tokens: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, status: nil, text: nil, truncation: nil, usage: nil, user: nil, object: :response)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::Response} for more details.
         #
@@ -243,7 +249,7 @@ module OpenAI
         #
         #   @param incomplete_details [OpenAI::Models::Responses::Response::IncompleteDetails, nil] Details about why the response is incomplete.
         #
-        #   @param instructions [String, nil] Inserts a system (or developer) message as the first item in the model's context
+        #   @param instructions [String, 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::ResponseInputItem::ItemReference>, nil] A system (or developer) message inserted into the model's context.
         #
         #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
         #
@@ -267,6 +273,8 @@ module OpenAI
         #
         #   @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to
         #
+        #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
+        #
         #   @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
         #
         #   @param service_tier [Symbol, OpenAI::Models::Responses::Response::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
@@ -310,6 +318,32 @@ module OpenAI
           end
         end
 
+        # A system (or developer) message inserted into the model's context.
+        #
+        # When using along with `previous_response_id`, the instructions from a previous
+        # response will not be carried over to the next response. This makes it simple to
+        # swap out system (or developer) messages in new responses.
+        #
+        # @see OpenAI::Models::Responses::Response#instructions
+        module Instructions
+          extend OpenAI::Internal::Type::Union
+
+          # A text input to the model, equivalent to a text input with the
+          # `developer` role.
+          variant String
+
+          # A list of one or many input items to the model, containing
+          # different content types.
+          variant -> { OpenAI::Models::Responses::Response::Instructions::ResponseInputItemArray }
+
+          # @!method self.variants
+          #   @return [Array(String, 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::ResponseInputItem::ItemReference>)]
+
+          # @type [OpenAI::Internal::Type::Converter]
+          ResponseInputItemArray =
+            OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Responses::ResponseInputItem }]
+        end
+
         # How the model should select which tool (or tools) to use when generating a
         # response. See the `tools` parameter to see how to specify which tools the model
         # can call.
@@ -364,6 +398,7 @@ module OpenAI
           AUTO = :auto
           DEFAULT = :default
           FLEX = :flex
+          SCALE = :scale
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/openai/models/responses/response_create_params.rb

@@ -64,8 +64,7 @@ module OpenAI
                  nil?: true
 
         # @!attribute instructions
-        #   Inserts a system (or developer) message as the first item in the model's
-        #   context.
+        #   A system (or developer) message inserted into the model's context.
         #
         #   When using along with `previous_response_id`, the instructions from a previous
         #   response will not be carried over to the next response. This makes it simple to
@@ -107,6 +106,13 @@ module OpenAI
         #   @return [String, nil]
         optional :previous_response_id, String, nil?: true
 
+        # @!attribute prompt
+        #   Reference to a prompt template and its variables.
+        #   [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        #
+        #   @return [OpenAI::Models::Responses::ResponsePrompt, nil]
+        optional :prompt, -> { OpenAI::Responses::ResponsePrompt }, nil?: true
+
         # @!attribute reasoning
         #   **o-series models only**
         #
@@ -226,7 +232,7 @@ module OpenAI
         #   @return [String, nil]
         optional :user, String
 
-        # @!method initialize(input:, model:, background: nil, include: nil, instructions: nil, max_output_tokens: nil, metadata: nil, parallel_tool_calls: nil, previous_response_id: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
+        # @!method initialize(input:, model:, background: nil, include: nil, instructions: nil, max_output_tokens: nil, metadata: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseCreateParams} for more details.
         #
@@ -238,7 +244,7 @@ module OpenAI
         #
         #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
         #
-        #   @param instructions [String, nil] Inserts a system (or developer) message as the first item in the model's context
+        #   @param instructions [String, nil] A system (or developer) message inserted into the model's context.
         #
         #   @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
         #
@@ -248,6 +254,8 @@ module OpenAI
         #
         #   @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to
         #
+        #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
+        #
         #   @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
         #
         #   @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
@@ -317,6 +325,7 @@ module OpenAI
           AUTO = :auto
           DEFAULT = :default
           FLEX = :flex
+          SCALE = :scale
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/openai/models/responses/response_prompt.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponsePrompt < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier of the prompt template to use.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute variables
+        #   Optional map of values to substitute in for variables in your prompt. The
+        #   substitution values can either be strings, or other Response input types like
+        #   images or files.
+        #
+        #   @return [Hash{Symbol=>String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile}, nil]
+        optional :variables,
+                 -> { OpenAI::Internal::Type::HashOf[union: OpenAI::Responses::ResponsePrompt::Variable] },
+                 nil?: true
+
+        # @!attribute version
+        #   Optional version of the prompt template.
+        #
+        #   @return [String, nil]
+        optional :version, String, nil?: true
+
+        # @!method initialize(id:, variables: nil, version: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ResponsePrompt} for more details.
+        #
+        #   Reference to a prompt template and its variables.
+        #   [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        #
+        #   @param id [String] The unique identifier of the prompt template to use.
+        #
+        #   @param variables [Hash{Symbol=>String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile}, nil] Optional map of values to substitute in for variables in your
+        #
+        #   @param version [String, nil] Optional version of the prompt template.
+
+        # A text input to the model.
+        module Variable
+          extend OpenAI::Internal::Type::Union
+
+          variant String
+
+          # A text input to the model.
+          variant -> { OpenAI::Responses::ResponseInputText }
+
+          # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
+          variant -> { OpenAI::Responses::ResponseInputImage }
+
+          # A file input to the model.
+          variant -> { OpenAI::Responses::ResponseInputFile }
+
+          # @!method self.variants
+          #   @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile)]
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb

@@ -60,7 +60,7 @@ module OpenAI
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse]
+          # @return [OpenAI::Internal::CursorPage<OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse>]
           #
           # @see OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveParams
           def retrieve(fine_tuned_model_checkpoint, params = {})
@@ -69,6 +69,7 @@ module OpenAI
               method: :get,
               path: ["fine_tuning/checkpoints/%1$s/permissions", fine_tuned_model_checkpoint],
               query: parsed,
+              page: OpenAI::Internal::CursorPage,
               model: OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse,
               options: options
             )

data/lib/openai/resources/fine_tuning/jobs.rb

@@ -16,7 +16,7 @@ module OpenAI
         # Response includes details of the enqueued job including job status and the name
         # of the fine-tuned models once complete.
         #
-        # [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
+        # [Learn more about fine-tuning](https://platform.openai.com/docs/guides/model-optimization)
         #
         # @overload create(model:, training_file:, hyperparameters: nil, integrations: nil, metadata: nil, method_: nil, seed: nil, suffix: nil, validation_file: nil, request_options: {})
         #
@@ -59,7 +59,7 @@ module OpenAI
         #
         # Get info about a fine-tuning job.
         #
-        # [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
+        # [Learn more about fine-tuning](https://platform.openai.com/docs/guides/model-optimization)
         #
         # @overload retrieve(fine_tuning_job_id, request_options: {})
         #