openai 0.87.0 → 0.88.0

data/lib/openai/models/batch_create_params.rb

@@ -28,11 +28,12 @@ module OpenAI
       # @!attribute input_file_id
       #   The ID of an uploaded file that contains requests for the new batch.
       #
-      #   See [upload file](https://platform.openai.com/docs/api-reference/files/create)
+      #   See
+      #   [upload file](https://developers.openai.com/api/reference/resources/files/methods/create)
       #   for how to upload a file.
       #
       #   Your input file must be formatted as a
-      #   [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input),
+      #   [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file),
       #   and must be uploaded with the purpose `batch`. The file can contain up to 50,000
       #   requests, and can be up to 200 MB in size.
       #
@@ -58,18 +59,41 @@ module OpenAI
       optional :output_expires_after, -> { OpenAI::BatchCreateParams::OutputExpiresAfter }
 
       # @!method initialize(completion_window:, endpoint:, input_file_id:, metadata: nil, output_expires_after: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::BatchCreateParams} for more details.
+      #   @param completion_window [Symbol, OpenAI::Models::BatchCreateParams::CompletionWindow]
+      #     The time frame within which the batch should be processed. Currently only `24h`
+      #     is supported.
       #
-      #   @param completion_window [Symbol, OpenAI::Models::BatchCreateParams::CompletionWindow] The time frame within which the batch should be processed. Currently only `24h`
+      #   @param endpoint [Symbol, OpenAI::Models::BatchCreateParams::Endpoint]
+      #     The endpoint to be used for all requests in the batch. Currently
+      #     `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`,
+      #     `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and
+      #     `/v1/videos` are supported. Note that `/v1/embeddings` batches are also
+      #     restricted to a maximum of 50,000 embedding inputs across all requests in the
+      #     batch.
       #
-      #   @param endpoint [Symbol, OpenAI::Models::BatchCreateParams::Endpoint] The endpoint to be used for all requests in the batch. Currently `/v1/responses`
+      #   @param input_file_id [String]
+      #     The ID of an uploaded file that contains requests for the new batch.
       #
-      #   @param input_file_id [String] The ID of an uploaded file that contains requests for the new batch.
+      #     See
+      #     [upload file](https://developers.openai.com/api/reference/resources/files/methods/create)
+      #     for how to upload a file.
       #
-      #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+      #     Your input file must be formatted as a
+      #     [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file),
+      #     and must be uploaded with the purpose `batch`. The file can contain up to 50,000
+      #     requests, and can be up to 200 MB in size.
       #
-      #   @param output_expires_after [OpenAI::Models::BatchCreateParams::OutputExpiresAfter] The expiration policy for the output and/or error file that are generated for a
+      #   @param metadata [Hash{Symbol=>String}, nil]
+      #     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.
+      #
+      #   @param output_expires_after [OpenAI::Models::BatchCreateParams::OutputExpiresAfter]
+      #     The expiration policy for the output and/or error file that are generated for a
+      #     batch.
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -123,15 +147,17 @@ module OpenAI
         required :seconds, Integer
 
         # @!method initialize(seconds:, anchor: :created_at)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::BatchCreateParams::OutputExpiresAfter} for more details.
-        #
         #   The expiration policy for the output and/or error file that are generated for a
         #   batch.
         #
-        #   @param seconds [Integer] The number of seconds after the anchor time that the file will expire. Must be b
+        #   @param seconds [Integer]
+        #     The number of seconds after the anchor time that the file will expire. Must be
+        #     between 3600 (1 hour) and 2592000 (30 days).
         #
-        #   @param anchor [Symbol, :created_at] Anchor timestamp after which the expiration policy applies. Supported anchors: `
+        #   @param anchor [Symbol, :created_at]
+        #     Anchor timestamp after which the expiration policy applies. Supported anchors:
+        #     `created_at`. Note that the anchor is the file creation time, not the time the
+        #     batch is created.
       end
     end
   end

data/lib/openai/models/batch_error.rb

@@ -28,13 +28,17 @@ module OpenAI
       optional :param, String, nil?: true
 
       # @!method initialize(code: nil, line: nil, message: nil, param: nil)
-      #   @param code [String] An error code identifying the error type.
+      #   @param code [String]
+      #     An error code identifying the error type.
       #
-      #   @param line [Integer, nil] The line number of the input file where the error occurred, if applicable.
+      #   @param line [Integer, nil]
+      #     The line number of the input file where the error occurred, if applicable.
       #
-      #   @param message [String] A human-readable message providing more details about the error.
+      #   @param message [String]
+      #     A human-readable message providing more details about the error.
       #
-      #   @param param [String, nil] The name of the parameter that caused the error, if applicable.
+      #   @param param [String, nil]
+      #     The name of the parameter that caused the error, if applicable.
     end
   end
 end

data/lib/openai/models/batch_list_params.rb

@@ -24,12 +24,15 @@ module OpenAI
       optional :limit, Integer
 
       # @!method initialize(after: nil, limit: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::BatchListParams} for more details.
+      #   @param after [String]
+      #     A cursor for use in pagination. `after` is an object ID that defines your place
+      #     in the list. For instance, if you make a list request and receive 100 objects,
+      #     ending with obj_foo, your subsequent call can include after=obj_foo in order to
+      #     fetch the next page of the list.
       #
-      #   @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
-      #
-      #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+      #   @param limit [Integer]
+      #     A limit on the number of objects to be returned. Limit can range between 1 and
+      #     100, and the default is 20.
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/openai/models/batch_request_counts.rb

@@ -24,11 +24,14 @@ module OpenAI
       # @!method initialize(completed:, failed:, total:)
       #   The request counts for different statuses within the batch.
       #
-      #   @param completed [Integer] Number of requests that have been completed successfully.
+      #   @param completed [Integer]
+      #     Number of requests that have been completed successfully.
       #
-      #   @param failed [Integer] Number of requests that have failed.
+      #   @param failed [Integer]
+      #     Number of requests that have failed.
       #
-      #   @param total [Integer] Total number of requests in the batch.
+      #   @param total [Integer]
+      #     Total number of requests in the batch.
     end
   end
 end

data/lib/openai/models/batch_usage.rb

@@ -38,32 +38,36 @@ module OpenAI
       #   breakdown of output tokens, and the total tokens used. Only populated on batches
       #   created after September 7, 2025.
       #
-      #   @param input_tokens [Integer] The number of input tokens.
+      #   @param input_tokens [Integer]
+      #     The number of input tokens.
       #
-      #   @param input_tokens_details [OpenAI::Models::BatchUsage::InputTokensDetails] A detailed breakdown of the input tokens.
+      #   @param input_tokens_details [OpenAI::Models::BatchUsage::InputTokensDetails]
+      #     A detailed breakdown of the input tokens.
       #
-      #   @param output_tokens [Integer] The number of output tokens.
+      #   @param output_tokens [Integer]
+      #     The number of output tokens.
       #
-      #   @param output_tokens_details [OpenAI::Models::BatchUsage::OutputTokensDetails] A detailed breakdown of the output tokens.
+      #   @param output_tokens_details [OpenAI::Models::BatchUsage::OutputTokensDetails]
+      #     A detailed breakdown of the output tokens.
       #
-      #   @param total_tokens [Integer] The total number of tokens used.
+      #   @param total_tokens [Integer]
+      #     The total number of tokens used.
 
       # @see OpenAI::Models::BatchUsage#input_tokens_details
       class InputTokensDetails < OpenAI::Internal::Type::BaseModel
         # @!attribute cached_tokens
         #   The number of tokens that were retrieved from the cache.
-        #   [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+        #   [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
         #
         #   @return [Integer]
         required :cached_tokens, Integer
 
         # @!method initialize(cached_tokens:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::BatchUsage::InputTokensDetails} for more details.
-        #
         #   A detailed breakdown of the input tokens.
         #
-        #   @param cached_tokens [Integer] The number of tokens that were retrieved from the cache. [More on
+        #   @param cached_tokens [Integer]
+        #     The number of tokens that were retrieved from the cache.
+        #     [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
       end
 
       # @see OpenAI::Models::BatchUsage#output_tokens_details
@@ -77,7 +81,8 @@ module OpenAI
         # @!method initialize(reasoning_tokens:)
         #   A detailed breakdown of the output tokens.
         #
-        #   @param reasoning_tokens [Integer] The number of reasoning tokens.
+        #   @param reasoning_tokens [Integer]
+        #     The number of reasoning tokens.
       end
     end
   end

data/lib/openai/models/beta/assistant.rb

@@ -45,10 +45,10 @@ module OpenAI
 
         # @!attribute model
         #   ID of the model to use. You can use the
-        #   [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-        #   see all of your available models, or see our
-        #   [Model overview](https://platform.openai.com/docs/models) for descriptions of
-        #   them.
+        #   [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+        #   API to see all of your available models, or see our
+        #   [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+        #   of them.
         #
         #   @return [String]
         required :model, String
@@ -75,14 +75,14 @@ module OpenAI
 
         # @!attribute response_format
         #   Specifies the format that the model must output. Compatible with
-        #   [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
-        #   [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
-        #   and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+        #   [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+        #   [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+        #   all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
         #
         #   Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
         #   Outputs which ensures the model will match your supplied JSON schema. Learn more
         #   in the
-        #   [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
         #   Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
         #   message the model generates is valid JSON.
@@ -126,36 +126,86 @@ module OpenAI
         optional :top_p, Float, nil?: true
 
         # @!method initialize(id:, created_at:, description:, instructions:, metadata:, model:, name:, tools:, response_format: nil, temperature: nil, tool_resources: nil, top_p: nil, object: :assistant)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::Assistant} for more details.
-        #
         #   Represents an `assistant` that can call the model and use tools.
         #
-        #   @param id [String] The identifier, which can be referenced in API endpoints.
-        #
-        #   @param created_at [Integer] The Unix timestamp (in seconds) for when the assistant was created.
-        #
-        #   @param description [String, nil] The description of the assistant. The maximum length is 512 characters.
-        #
-        #   @param instructions [String, nil] The system instructions that the assistant uses. The maximum length is 256,000 c
-        #
-        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
-        #
-        #   @param model [String] ID of the model to use. You can use the [List models](https://platform.openai.co
-        #
-        #   @param name [String, nil] The name of the assistant. The maximum length is 256 characters.
-        #
-        #   @param tools [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool>] A list of tool enabled on the assistant. There can be a maximum of 128 tools per
-        #
-        #   @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil] Specifies the format that the model must output. Compatible with [GPT-4o](https:
-        #
-        #   @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
-        #
-        #   @param tool_resources [OpenAI::Models::Beta::Assistant::ToolResources, nil] A set of resources that are used by the assistant's tools. The resources are spe
-        #
-        #   @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
-        #
-        #   @param object [Symbol, :assistant] The object type, which is always `assistant`.
+        #   @param id [String]
+        #     The identifier, which can be referenced in API endpoints.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp (in seconds) for when the assistant was created.
+        #
+        #   @param description [String, nil]
+        #     The description of the assistant. The maximum length is 512 characters.
+        #
+        #   @param instructions [String, nil]
+        #     The system instructions that the assistant uses. The maximum length is 256,000
+        #     characters.
+        #
+        #   @param metadata [Hash{Symbol=>String}, nil]
+        #     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.
+        #
+        #   @param model [String]
+        #     ID of the model to use. You can use the
+        #     [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+        #     API to see all of your available models, or see our
+        #     [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+        #     of them.
+        #
+        #   @param name [String, nil]
+        #     The name of the assistant. The maximum length is 256 characters.
+        #
+        #   @param tools [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool>]
+        #     A list of tool enabled on the assistant. There can be a maximum of 128 tools per
+        #     assistant. Tools can be of types `code_interpreter`, `file_search`, or
+        #     `function`.
+        #
+        #   @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil]
+        #     Specifies the format that the model must output. Compatible with
+        #     [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+        #     [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+        #     all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+        #
+        #     Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
+        #     Outputs which ensures the model will match your supplied JSON schema. Learn more
+        #     in the
+        #     [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+        #
+        #     Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
+        #     message the model generates is valid JSON.
+        #
+        #     **Important:** when using JSON mode, you **must** also instruct the model to
+        #     produce JSON yourself via a system or user message. Without this, the model may
+        #     generate an unending stream of whitespace until the generation reaches the token
+        #     limit, resulting in a long-running and seemingly "stuck" request. Also note that
+        #     the message content may be partially cut off if `finish_reason="length"`, which
+        #     indicates the generation exceeded `max_tokens` or the conversation exceeded the
+        #     max context length.
+        #
+        #   @param temperature [Float, nil]
+        #     What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+        #     make the output more random, while lower values like 0.2 will make it more
+        #     focused and deterministic.
+        #
+        #   @param tool_resources [OpenAI::Models::Beta::Assistant::ToolResources, nil]
+        #     A set of resources that are used by the assistant's tools. The resources are
+        #     specific to the type of tool. For example, the `code_interpreter` tool requires
+        #     a list of file IDs, while the `file_search` tool requires a list of vector store
+        #     IDs.
+        #
+        #   @param top_p [Float, nil]
+        #     An alternative to sampling with temperature, called nucleus sampling, where the
+        #     model considers the results of the tokens with top_p probability mass. So 0.1
+        #     means only the tokens comprising the top 10% probability mass are considered.
+        #
+        #     We generally recommend altering this or temperature but not both.
+        #
+        #   @param object [Symbol, :assistant]
+        #     The object type, which is always `assistant`.
 
         # @see OpenAI::Models::Beta::Assistant#tool_resources
         class ToolResources < OpenAI::Internal::Type::BaseModel
@@ -181,26 +231,25 @@ module OpenAI
           # @see OpenAI::Models::Beta::Assistant::ToolResources#code_interpreter
           class CodeInterpreter < OpenAI::Internal::Type::BaseModel
             # @!attribute file_ids
-            #   A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
-            #   available to the `code_interpreter`` tool. There can be a maximum of 20 files
-            #   associated with the tool.
+            #   A list of [file](https://developers.openai.com/api/reference/resources/files)
+            #   IDs made available to the `code_interpreter`` tool. There can be a maximum of 20
+            #   files associated with the tool.
             #
             #   @return [Array<String>, nil]
             optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
 
             # @!method initialize(file_ids: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::Assistant::ToolResources::CodeInterpreter} for more
-            #   details.
-            #
-            #   @param file_ids [Array<String>] A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+            #   @param file_ids [Array<String>]
+            #     A list of [file](https://developers.openai.com/api/reference/resources/files)
+            #     IDs made available to the `code_interpreter`` tool. There can be a maximum of 20
+            #     files associated with the tool.
           end
 
           # @see OpenAI::Models::Beta::Assistant::ToolResources#file_search
           class FileSearch < OpenAI::Internal::Type::BaseModel
             # @!attribute vector_store_ids
             #   The ID of the
-            #   [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+            #   [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
             #   attached to this assistant. There can be a maximum of 1 vector store attached to
             #   the assistant.
             #
@@ -208,10 +257,11 @@ module OpenAI
             optional :vector_store_ids, OpenAI::Internal::Type::ArrayOf[String]
 
             # @!method initialize(vector_store_ids: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::Assistant::ToolResources::FileSearch} for more details.
-            #
-            #   @param vector_store_ids [Array<String>] The ID of the [vector store](https://platform.openai.com/docs/api-reference/vect
+            #   @param vector_store_ids [Array<String>]
+            #     The ID of the
+            #     [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+            #     attached to this assistant. There can be a maximum of 1 vector store attached to
+            #     the assistant.
           end
         end
       end