openai 0.87.0 → 0.89.0

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

@@ -42,18 +42,23 @@ module OpenAI
         optional :order, enum: -> { OpenAI::Chat::CompletionListParams::Order }
 
         # @!method initialize(after: nil, limit: nil, metadata: nil, model: nil, order: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::CompletionListParams} for more details.
+        #   @param after [String]
+        #     Identifier for the last chat completion from the previous pagination request.
         #
-        #   @param after [String] Identifier for the last chat completion from the previous pagination request.
+        #   @param limit [Integer]
+        #     Number of Chat Completions to retrieve.
         #
-        #   @param limit [Integer] Number of Chat Completions to retrieve.
+        #   @param metadata [Hash{Symbol=>String}, nil]
+        #     A list of metadata keys to filter the Chat Completions by. Example:
         #
-        #   @param metadata [Hash{Symbol=>String}, nil] A list of metadata keys to filter the Chat Completions by. Example:
+        #     `metadata[key1]=value1&metadata[key2]=value2`
         #
-        #   @param model [String] The model used to generate the Chat Completions.
+        #   @param model [String]
+        #     The model used to generate the Chat Completions.
         #
-        #   @param order [Symbol, OpenAI::Models::Chat::CompletionListParams::Order] Sort order for Chat Completions by timestamp. Use `asc` for ascending order or `
+        #   @param order [Symbol, OpenAI::Models::Chat::CompletionListParams::Order]
+        #     Sort order for Chat Completions by timestamp. Use `asc` for ascending order or
+        #     `desc` for descending order. Defaults to `asc`.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

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

@@ -25,12 +25,15 @@ module OpenAI
         required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
         # @!method initialize(completion_id:, metadata:, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::CompletionUpdateParams} for more details.
-        #
         #   @param completion_id [String]
         #
-        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #   @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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/openai/models/chat/completions/message_list_params.rb

@@ -34,16 +34,17 @@ module OpenAI
           optional :order, enum: -> { OpenAI::Chat::Completions::MessageListParams::Order }
 
           # @!method initialize(completion_id:, after: nil, limit: nil, order: nil, request_options: {})
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::Completions::MessageListParams} for more details.
-          #
           #   @param completion_id [String]
           #
-          #   @param after [String] Identifier for the last message from the previous pagination request.
+          #   @param after [String]
+          #     Identifier for the last message from the previous pagination request.
           #
-          #   @param limit [Integer] Number of messages to retrieve.
+          #   @param limit [Integer]
+          #     Number of messages to retrieve.
           #
-          #   @param order [Symbol, OpenAI::Models::Chat::Completions::MessageListParams::Order] Sort order for messages by timestamp. Use `asc` for ascending order or `desc` fo
+          #   @param order [Symbol, OpenAI::Models::Chat::Completions::MessageListParams::Order]
+          #     Sort order for messages by timestamp. Use `asc` for ascending order or `desc`
+          #     for descending order. Defaults to `asc`.
           #
           #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/openai/models/comparison_filter.rb

@@ -33,17 +33,28 @@ module OpenAI
       required :value, union: -> { OpenAI::ComparisonFilter::Value }
 
       # @!method initialize(key:, type:, value:)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ComparisonFilter} for more details.
-      #
       #   A filter used to compare a specified attribute key to a given value using a
       #   defined comparison operation.
       #
-      #   @param key [String] The key to compare against the value.
+      #   @param key [String]
+      #     The key to compare against the value.
+      #
+      #   @param type [Symbol, OpenAI::Models::ComparisonFilter::Type]
+      #     Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`,
+      #     `nin`.
       #
-      #   @param type [Symbol, OpenAI::Models::ComparisonFilter::Type] Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `
+      #     - `eq`: equals
+      #     - `ne`: not equal
+      #     - `gt`: greater than
+      #     - `gte`: greater than or equal
+      #     - `lt`: less than
+      #     - `lte`: less than or equal
+      #     - `in`: in
+      #     - `nin`: not in
       #
-      #   @param value [String, Float, Boolean, Array<String, Float>] The value to compare against the attribute key; supports string, number, or bool
+      #   @param value [String, Float, Boolean, Array<String, Float>]
+      #     The value to compare against the attribute key; supports string, number, or
+      #     boolean types.
 
       # Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`,
       # `nin`.

data/lib/openai/models/completion.rb

@@ -52,25 +52,32 @@ module OpenAI
       optional :usage, -> { OpenAI::CompletionUsage }
 
       # @!method initialize(id:, choices:, created:, model:, system_fingerprint: nil, usage: nil, object: :text_completion)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::Completion} for more details.
-      #
       #   Represents a completion response from the API. Note: both the streamed and
       #   non-streamed response objects share the same shape (unlike the chat endpoint).
       #
-      #   @param id [String] A unique identifier for the completion.
+      #   @param id [String]
+      #     A unique identifier for the completion.
+      #
+      #   @param choices [Array<OpenAI::Models::CompletionChoice>]
+      #     The list of completion choices the model generated for the input prompt.
       #
-      #   @param choices [Array<OpenAI::Models::CompletionChoice>] The list of completion choices the model generated for the input prompt.
+      #   @param created [Integer]
+      #     The Unix timestamp (in seconds) of when the completion was created.
       #
-      #   @param created [Integer] The Unix timestamp (in seconds) of when the completion was created.
+      #   @param model [String]
+      #     The model used for completion.
       #
-      #   @param model [String] The model used for completion.
+      #   @param system_fingerprint [String]
+      #     This fingerprint represents the backend configuration that the model runs with.
       #
-      #   @param system_fingerprint [String] This fingerprint represents the backend configuration that the model runs with.
+      #     Can be used in conjunction with the `seed` request parameter to understand when
+      #     backend changes have been made that might impact determinism.
       #
-      #   @param usage [OpenAI::Models::CompletionUsage] Usage statistics for the completion request.
+      #   @param usage [OpenAI::Models::CompletionUsage]
+      #     Usage statistics for the completion request.
       #
-      #   @param object [Symbol, :text_completion] The object type, which is always "text_completion"
+      #   @param object [Symbol, :text_completion]
+      #     The object type, which is always "text_completion"
     end
   end
 end

data/lib/openai/models/completion_choice.rb

@@ -28,10 +28,11 @@ module OpenAI
       required :text, String
 
       # @!method initialize(finish_reason:, index:, logprobs:, text:)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::CompletionChoice} for more details.
-      #
-      #   @param finish_reason [Symbol, OpenAI::Models::CompletionChoice::FinishReason] The reason the model stopped generating tokens. This will be `stop` if the model
+      #   @param finish_reason [Symbol, OpenAI::Models::CompletionChoice::FinishReason]
+      #     The reason the model stopped generating tokens. This will be `stop` if the model
+      #     hit a natural stop point or a provided stop sequence, `length` if the maximum
+      #     number of tokens specified in the request was reached, or `content_filter` if
+      #     content was omitted due to a flag from our content filters.
       #
       #   @param index [Integer]
       #

data/lib/openai/models/completion_create_params.rb

@@ -11,10 +11,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, Symbol, OpenAI::Models::CompletionCreateParams::Model]
       required :model, union: -> { OpenAI::CompletionCreateParams::Model }
@@ -55,7 +55,7 @@ module OpenAI
       #   existing frequency in the text so far, decreasing the model's likelihood to
       #   repeat the same line verbatim.
       #
-      #   [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
+      #   [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
       #
       #   @return [Float, nil]
       optional :frequency_penalty, Float, nil?: true
@@ -65,11 +65,12 @@ module OpenAI
       #
       #   Accepts a JSON object that maps tokens (specified by their token ID in the GPT
       #   tokenizer) to an associated bias value from -100 to 100. You can use this
-      #   [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs.
-      #   Mathematically, the bias is added to the logits generated by the model prior to
-      #   sampling. The exact effect will vary per model, but values between -1 and 1
-      #   should decrease or increase likelihood of selection; values like -100 or 100
-      #   should result in a ban or exclusive selection of the relevant token.
+      #   [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text
+      #   to token IDs. Mathematically, the bias is added to the logits generated by the
+      #   model prior to sampling. The exact effect will vary per model, but values
+      #   between -1 and 1 should decrease or increase likelihood of selection; values
+      #   like -100 or 100 should result in a ban or exclusive selection of the relevant
+      #   token.
       #
       #   As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
       #   from being generated.
@@ -89,8 +90,8 @@ module OpenAI
       optional :logprobs, Integer, nil?: true
 
       # @!attribute max_tokens
-      #   The maximum number of [tokens](/tokenizer) that can be generated in the
-      #   completion.
+      #   The maximum number of [tokens](https://platform.openai.com/tokenizer) that can
+      #   be generated in the completion.
       #
       #   The token count of your prompt plus `max_tokens` cannot exceed the model's
       #   context length.
@@ -115,7 +116,7 @@ module OpenAI
       #   whether they appear in the text so far, increasing the model's likelihood to
       #   talk about new topics.
       #
-      #   [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
+      #   [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
       #
       #   @return [Float, nil]
       optional :presence_penalty, Float, nil?: true
@@ -177,56 +178,142 @@ module OpenAI
       # @!attribute user
       #   A unique identifier representing your end-user, which can help OpenAI to monitor
       #   and detect abuse.
-      #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @return [String, nil]
       optional :user, String
 
       # @!method initialize(model:, prompt:, best_of: nil, echo: nil, frequency_penalty: nil, logit_bias: nil, logprobs: nil, max_tokens: nil, n: nil, presence_penalty: nil, seed: nil, stop: nil, stream_options: nil, suffix: nil, temperature: nil, top_p: nil, user: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::CompletionCreateParams} for more details.
+      #   @param model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model]
+      #     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 model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model] ID of the model to use. You can use the [List models](https://platform.openai.co
+      #   @param prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil]
+      #     The prompt(s) to generate completions for, encoded as a string, array of
+      #     strings, array of tokens, or array of token arrays.
       #
-      #   @param prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil] The prompt(s) to generate completions for, encoded as a string, array of strings
+      #     Note that <|endoftext|> is the document separator that the model sees during
+      #     training, so if a prompt is not specified the model will generate as if from the
+      #     beginning of a new document.
       #
-      #   @param best_of [Integer, nil] Generates `best_of` completions server-side and returns the "best" (the one with
+      #   @param best_of [Integer, nil]
+      #     Generates `best_of` completions server-side and returns the "best" (the one with
+      #     the highest log probability per token). Results cannot be streamed.
       #
-      #   @param echo [Boolean, nil] Echo back the prompt in addition to the completion
+      #     When used with `n`, `best_of` controls the number of candidate completions and
+      #     `n` specifies how many to return – `best_of` must be greater than `n`.
       #
-      #   @param frequency_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+      #     **Note:** Because this parameter generates many completions, it can quickly
+      #     consume your token quota. Use carefully and ensure that you have reasonable
+      #     settings for `max_tokens` and `stop`.
       #
-      #   @param logit_bias [Hash{Symbol=>Integer}, nil] Modify the likelihood of specified tokens appearing in the completion.
+      #   @param echo [Boolean, nil]
+      #     Echo back the prompt in addition to the completion
       #
-      #   @param logprobs [Integer, nil] Include the log probabilities on the `logprobs` most likely output tokens, as we
+      #   @param frequency_penalty [Float, nil]
+      #     Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+      #     existing frequency in the text so far, decreasing the model's likelihood to
+      #     repeat the same line verbatim.
       #
-      #   @param max_tokens [Integer, nil] The maximum number of [tokens](/tokenizer) that can be generated in the completi
+      #     [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
       #
-      #   @param n [Integer, nil] How many completions to generate for each prompt.
+      #   @param logit_bias [Hash{Symbol=>Integer}, nil]
+      #     Modify the likelihood of specified tokens appearing in the completion.
       #
-      #   @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on whethe
+      #     Accepts a JSON object that maps tokens (specified by their token ID in the GPT
+      #     tokenizer) to an associated bias value from -100 to 100. You can use this
+      #     [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text
+      #     to token IDs. Mathematically, the bias is added to the logits generated by the
+      #     model prior to sampling. The exact effect will vary per model, but values
+      #     between -1 and 1 should decrease or increase likelihood of selection; values
+      #     like -100 or 100 should result in a ban or exclusive selection of the relevant
+      #     token.
       #
-      #   @param seed [Integer, nil] If specified, our system will make a best effort to sample deterministically, su
+      #     As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
+      #     from being generated.
       #
-      #   @param stop [String, Array<String>, nil] Not supported with latest reasoning models `o3` and `o4-mini`.
+      #   @param logprobs [Integer, nil]
+      #     Include the log probabilities on the `logprobs` most likely output tokens, as
+      #     well the chosen tokens. For example, if `logprobs` is 5, the API will return a
+      #     list of the 5 most likely tokens. The API will always return the `logprob` of
+      #     the sampled token, so there may be up to `logprobs+1` elements in the response.
       #
-      #   @param stream_options [OpenAI::Models::Chat::ChatCompletionStreamOptions, nil] Options for streaming response. Only set this when you set `stream: true`.
+      #     The maximum value for `logprobs` is 5.
       #
-      #   @param suffix [String, nil] The suffix that comes after a completion of inserted text.
+      #   @param max_tokens [Integer, nil]
+      #     The maximum number of [tokens](https://platform.openai.com/tokenizer) that can
+      #     be generated in the completion.
       #
-      #   @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
+      #     The token count of your prompt plus `max_tokens` cannot exceed the model's
+      #     context length.
+      #     [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
+      #     for counting tokens.
       #
-      #   @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
+      #   @param n [Integer, nil]
+      #     How many completions to generate for each prompt.
       #
-      #   @param user [String] A unique identifier representing your end-user, which can help OpenAI to monitor
+      #     **Note:** Because this parameter generates many completions, it can quickly
+      #     consume your token quota. Use carefully and ensure that you have reasonable
+      #     settings for `max_tokens` and `stop`.
+      #
+      #   @param presence_penalty [Float, nil]
+      #     Number between -2.0 and 2.0. Positive values penalize new tokens based on
+      #     whether they appear in the text so far, increasing the model's likelihood to
+      #     talk about new topics.
+      #
+      #     [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
+      #
+      #   @param seed [Integer, nil]
+      #     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 should refer to the `system_fingerprint`
+      #     response parameter to monitor changes in the backend.
+      #
+      #   @param stop [String, Array<String>, nil]
+      #     Not supported with latest reasoning models `o3` and `o4-mini`.
+      #
+      #     Up to 4 sequences where the API will stop generating further tokens. The
+      #     returned text will not contain the stop sequence.
+      #
+      #   @param stream_options [OpenAI::Models::Chat::ChatCompletionStreamOptions, nil]
+      #     Options for streaming response. Only set this when you set `stream: true`.
+      #
+      #   @param suffix [String, nil]
+      #     The suffix that comes after a completion of inserted text.
+      #
+      #     This parameter is only supported for `gpt-3.5-turbo-instruct`.
+      #
+      #   @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.
+      #
+      #     We generally recommend altering this or `top_p` but not both.
+      #
+      #   @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 user [String]
+      #     A unique identifier representing your end-user, which can help OpenAI to monitor
+      #     and detect abuse.
+      #     [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
       # 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.
       module Model
         extend OpenAI::Internal::Type::Union
 

data/lib/openai/models/completion_usage.rb

@@ -36,15 +36,20 @@ module OpenAI
       # @!method initialize(completion_tokens:, prompt_tokens:, total_tokens:, completion_tokens_details: nil, prompt_tokens_details: nil)
       #   Usage statistics for the completion request.
       #
-      #   @param completion_tokens [Integer] Number of tokens in the generated completion.
+      #   @param completion_tokens [Integer]
+      #     Number of tokens in the generated completion.
       #
-      #   @param prompt_tokens [Integer] Number of tokens in the prompt.
+      #   @param prompt_tokens [Integer]
+      #     Number of tokens in the prompt.
       #
-      #   @param total_tokens [Integer] Total number of tokens used in the request (prompt + completion).
+      #   @param total_tokens [Integer]
+      #     Total number of tokens used in the request (prompt + completion).
       #
-      #   @param completion_tokens_details [OpenAI::Models::CompletionUsage::CompletionTokensDetails] Breakdown of tokens used in a completion.
+      #   @param completion_tokens_details [OpenAI::Models::CompletionUsage::CompletionTokensDetails]
+      #     Breakdown of tokens used in a completion.
       #
-      #   @param prompt_tokens_details [OpenAI::Models::CompletionUsage::PromptTokensDetails] Breakdown of tokens used in the prompt.
+      #   @param prompt_tokens_details [OpenAI::Models::CompletionUsage::PromptTokensDetails]
+      #     Breakdown of tokens used in the prompt.
 
       # @see OpenAI::Models::CompletionUsage#completion_tokens_details
       class CompletionTokensDetails < OpenAI::Internal::Type::BaseModel
@@ -83,20 +88,26 @@ module OpenAI
         optional :text_tokens, Integer
 
         # @!method initialize(accepted_prediction_tokens: nil, audio_tokens: nil, reasoning_tokens: nil, rejected_prediction_tokens: nil, text_tokens: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::CompletionUsage::CompletionTokensDetails} for more details.
-        #
         #   Breakdown of tokens used in a completion.
         #
-        #   @param accepted_prediction_tokens [Integer] When using Predicted Outputs, the number of tokens in the
+        #   @param accepted_prediction_tokens [Integer]
+        #     When using Predicted Outputs, the number of tokens in the prediction that
+        #     appeared in the completion.
         #
-        #   @param audio_tokens [Integer] Audio input tokens generated by the model.
+        #   @param audio_tokens [Integer]
+        #     Audio input tokens generated by the model.
         #
-        #   @param reasoning_tokens [Integer] Tokens generated by the model for reasoning.
+        #   @param reasoning_tokens [Integer]
+        #     Tokens generated by the model for reasoning.
         #
-        #   @param rejected_prediction_tokens [Integer] When using Predicted Outputs, the number of tokens in the
+        #   @param rejected_prediction_tokens [Integer]
+        #     When using Predicted Outputs, the number of tokens in the prediction that did
+        #     not appear in the completion. However, like reasoning tokens, these tokens are
+        #     still counted in the total completion tokens for purposes of billing, output,
+        #     and context window limits.
         #
-        #   @param text_tokens [Integer] Text output tokens generated by the model.
+        #   @param text_tokens [Integer]
+        #     Text output tokens generated by the model.
       end
 
       # @see OpenAI::Models::CompletionUsage#prompt_tokens_details
@@ -134,15 +145,20 @@ module OpenAI
         # @!method initialize(audio_tokens: nil, cache_write_tokens: nil, cached_tokens: nil, image_tokens: nil, text_tokens: nil)
         #   Breakdown of tokens used in the prompt.
         #
-        #   @param audio_tokens [Integer] Audio input tokens present in the prompt.
+        #   @param audio_tokens [Integer]
+        #     Audio input tokens present in the prompt.
         #
-        #   @param cache_write_tokens [Integer] The unadjusted number of prompt tokens written to cache.
+        #   @param cache_write_tokens [Integer]
+        #     The unadjusted number of prompt tokens written to cache.
         #
-        #   @param cached_tokens [Integer] Cached tokens present in the prompt.
+        #   @param cached_tokens [Integer]
+        #     Cached tokens present in the prompt.
         #
-        #   @param image_tokens [Integer] Image input tokens present in the prompt.
+        #   @param image_tokens [Integer]
+        #     Image input tokens present in the prompt.
         #
-        #   @param text_tokens [Integer] Text input tokens present in the prompt.
+        #   @param text_tokens [Integer]
+        #     Text input tokens present in the prompt.
       end
     end
   end

data/lib/openai/models/compound_filter.rb

@@ -17,14 +17,14 @@ module OpenAI
       required :type, enum: -> { OpenAI::CompoundFilter::Type }
 
       # @!method initialize(filters:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::CompoundFilter} for more details.
-      #
       #   Combine multiple filters using `and` or `or`.
       #
-      #   @param filters [Array<OpenAI::Models::ComparisonFilter, Object>] Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`
+      #   @param filters [Array<OpenAI::Models::ComparisonFilter, Object>]
+      #     Array of filters to combine. Items can be `ComparisonFilter` or
+      #     `CompoundFilter`.
       #
-      #   @param type [Symbol, OpenAI::Models::CompoundFilter::Type] Type of operation: `and` or `or`.
+      #   @param type [Symbol, OpenAI::Models::CompoundFilter::Type]
+      #     Type of operation: `and` or `or`.
 
       # A filter used to compare a specified attribute key to a given value using a
       # defined comparison operation.

data/lib/openai/models/container_create_params.rb

@@ -44,17 +44,23 @@ module OpenAI
       optional :skills, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::ContainerCreateParams::Skill] }
 
       # @!method initialize(name:, expires_after: nil, file_ids: nil, memory_limit: nil, network_policy: nil, skills: nil, request_options: {})
-      #   @param name [String] Name of the container to create.
+      #   @param name [String]
+      #     Name of the container to create.
       #
-      #   @param expires_after [OpenAI::Models::ContainerCreateParams::ExpiresAfter] Container expiration time in seconds relative to the 'anchor' time.
+      #   @param expires_after [OpenAI::Models::ContainerCreateParams::ExpiresAfter]
+      #     Container expiration time in seconds relative to the 'anchor' time.
       #
-      #   @param file_ids [Array<String>] IDs of files to copy to the container.
+      #   @param file_ids [Array<String>]
+      #     IDs of files to copy to the container.
       #
-      #   @param memory_limit [Symbol, OpenAI::Models::ContainerCreateParams::MemoryLimit] Optional memory limit for the container. Defaults to "1g".
+      #   @param memory_limit [Symbol, OpenAI::Models::ContainerCreateParams::MemoryLimit]
+      #     Optional memory limit for the container. Defaults to "1g".
       #
-      #   @param network_policy [OpenAI::Models::Responses::ContainerNetworkPolicyDisabled, OpenAI::Models::Responses::ContainerNetworkPolicyAllowlist] Network access policy for the container.
+      #   @param network_policy [OpenAI::Models::Responses::ContainerNetworkPolicyDisabled, OpenAI::Models::Responses::ContainerNetworkPolicyAllowlist]
+      #     Network access policy for the container.
       #
-      #   @param skills [Array<OpenAI::Models::Responses::SkillReference, OpenAI::Models::Responses::InlineSkill>] An optional list of skills referenced by id or inline data.
+      #   @param skills [Array<OpenAI::Models::Responses::SkillReference, OpenAI::Models::Responses::InlineSkill>]
+      #     An optional list of skills referenced by id or inline data.
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -72,12 +78,11 @@ module OpenAI
         required :minutes, Integer
 
         # @!method initialize(anchor:, minutes:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::ContainerCreateParams::ExpiresAfter} for more details.
-        #
         #   Container expiration time in seconds relative to the 'anchor' time.
         #
-        #   @param anchor [Symbol, OpenAI::Models::ContainerCreateParams::ExpiresAfter::Anchor] Time anchor for the expiration time. Currently only 'last_active_at' is supporte
+        #   @param anchor [Symbol, OpenAI::Models::ContainerCreateParams::ExpiresAfter::Anchor]
+        #     Time anchor for the expiration time. Currently only 'last_active_at' is
+        #     supported.
         #
         #   @param minutes [Integer]
 

data/lib/openai/models/container_create_response.rb

@@ -61,26 +61,34 @@ module OpenAI
       optional :network_policy, -> { OpenAI::Models::ContainerCreateResponse::NetworkPolicy }
 
       # @!method initialize(id:, created_at:, name:, object:, status:, expires_after: nil, last_active_at: nil, memory_limit: nil, network_policy: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ContainerCreateResponse} for more details.
+      #   @param id [String]
+      #     Unique identifier for the container.
       #
-      #   @param id [String] Unique identifier for the container.
+      #   @param created_at [Integer]
+      #     Unix timestamp (in seconds) when the container was created.
       #
-      #   @param created_at [Integer] Unix timestamp (in seconds) when the container was created.
+      #   @param name [String]
+      #     Name of the container.
       #
-      #   @param name [String] Name of the container.
+      #   @param object [String]
+      #     The type of this object.
       #
-      #   @param object [String] The type of this object.
+      #   @param status [String]
+      #     Status of the container (e.g., active, deleted).
       #
-      #   @param status [String] Status of the container (e.g., active, deleted).
+      #   @param expires_after [OpenAI::Models::ContainerCreateResponse::ExpiresAfter]
+      #     The container will expire after this time period. The anchor is the reference
+      #     point for the expiration. The minutes is the number of minutes after the anchor
+      #     before the container expires.
       #
-      #   @param expires_after [OpenAI::Models::ContainerCreateResponse::ExpiresAfter] The container will expire after this time period.
+      #   @param last_active_at [Integer]
+      #     Unix timestamp (in seconds) when the container was last active.
       #
-      #   @param last_active_at [Integer] Unix timestamp (in seconds) when the container was last active.
+      #   @param memory_limit [Symbol, OpenAI::Models::ContainerCreateResponse::MemoryLimit]
+      #     The memory limit configured for the container.
       #
-      #   @param memory_limit [Symbol, OpenAI::Models::ContainerCreateResponse::MemoryLimit] The memory limit configured for the container.
-      #
-      #   @param network_policy [OpenAI::Models::ContainerCreateResponse::NetworkPolicy] Network access policy for the container.
+      #   @param network_policy [OpenAI::Models::ContainerCreateResponse::NetworkPolicy]
+      #     Network access policy for the container.
 
       # @see OpenAI::Models::ContainerCreateResponse#expires_after
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
@@ -101,9 +109,11 @@ module OpenAI
         #   point for the expiration. The minutes is the number of minutes after the anchor
         #   before the container expires.
         #
-        #   @param anchor [Symbol, OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor] The reference point for the expiration.
+        #   @param anchor [Symbol, OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor]
+        #     The reference point for the expiration.
         #
-        #   @param minutes [Integer] The number of minutes after the anchor before the container expires.
+        #   @param minutes [Integer]
+        #     The number of minutes after the anchor before the container expires.
 
         # The reference point for the expiration.
         #
@@ -150,9 +160,11 @@ module OpenAI
         # @!method initialize(type:, allowed_domains: nil)
         #   Network access policy for the container.
         #
-        #   @param type [Symbol, OpenAI::Models::ContainerCreateResponse::NetworkPolicy::Type] The network policy mode.
+        #   @param type [Symbol, OpenAI::Models::ContainerCreateResponse::NetworkPolicy::Type]
+        #     The network policy mode.
         #
-        #   @param allowed_domains [Array<String>] Allowed outbound domains when `type` is `allowlist`.
+        #   @param allowed_domains [Array<String>]
+        #     Allowed outbound domains when `type` is `allowlist`.
 
         # The network policy mode.
         #