openai 0.87.0 → 0.88.0

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

@@ -10,10 +10,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::ChatModel]
         required :model, union: -> { OpenAI::Beta::AssistantCreateParams::Model }
@@ -53,7 +53,7 @@ module OpenAI
         #   are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
         #   reasoning effort can result in faster responses and fewer tokens used on
         #   reasoning in a response. Not all reasoning models support every value. See the
-        #   [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+        #   [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
         #   model-specific support.
         #
         #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
@@ -61,14 +61,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.
@@ -120,44 +120,97 @@ module OpenAI
         optional :top_p, Float, nil?: true
 
         # @!method initialize(model:, description: nil, instructions: nil, metadata: nil, name: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_resources: nil, tools: nil, top_p: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::AssistantCreateParams} for more details.
+        #   @param model [String, Symbol, OpenAI::Models::ChatModel]
+        #     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::ChatModel] ID of the model to use. You can use the [List models](https://platform.openai.co
+        #   @param description [String, nil]
+        #     The description of the assistant. The maximum length is 512 characters.
         #
-        #   @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 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 useful
+        #     for storing additional information about the object in a structured format, and
+        #     querying for objects via API or the dashboard.
         #
-        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #     Keys are strings with a maximum length of 64 characters. Values are strings with
+        #     a maximum length of 512 characters.
         #
-        #   @param name [String, nil] The name of the assistant. The maximum length is 256 characters.
+        #   @param name [String, nil]
+        #     The name of the assistant. The maximum length is 256 characters.
         #
-        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
+        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil]
+        #     Constrains effort on reasoning for reasoning models. Currently supported values
+        #     are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+        #     reasoning effort can result in faster responses and fewer tokens used on
+        #     reasoning in a response. Not all reasoning models support every value. See the
+        #     [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
+        #     model-specific support.
         #
-        #   @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 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`.
         #
-        #   @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
+        #     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).
         #
-        #   @param tool_resources [OpenAI::Models::Beta::AssistantCreateParams::ToolResources, nil] A set of resources that are used by the assistant's tools. The resources are spe
+        #     Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
+        #     message the model generates is valid JSON.
         #
-        #   @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
+        #     **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 top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
+        #   @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::AssistantCreateParams::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 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 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 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
 
           variant String
 
-          # 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.
+          # 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.
           variant enum: -> { OpenAI::ChatModel }
 
           # @!method self.variants
@@ -187,26 +240,25 @@ module OpenAI
           # @see OpenAI::Models::Beta::AssistantCreateParams::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::AssistantCreateParams::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::AssistantCreateParams::ToolResources#file_search
           class FileSearch < OpenAI::Internal::Type::BaseModel
             # @!attribute vector_store_ids
             #   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.
             #
@@ -215,7 +267,7 @@ module OpenAI
 
             # @!attribute vector_stores
             #   A helper to create a
-            #   [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+            #   [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
             #   with file_ids and attach it to this assistant. There can be a maximum of 1
             #   vector store attached to the assistant.
             #
@@ -230,14 +282,17 @@ module OpenAI
             )
 
             # @!method initialize(vector_store_ids: nil, vector_stores: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch} for
-            #   more details.
-            #
-            #   @param vector_store_ids [Array<String>] The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/
+            #   @param vector_store_ids [Array<String>]
+            #     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.
             #
-            #   @param vector_stores [Array<OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore>] A helper to create a [vector store](https://platform.openai.com/docs/api-referen
-
+            #   @param vector_stores [Array<OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore>]
+            #     A helper to create a
+            #     [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+            #     with file_ids and attach it to this assistant. There can be a maximum of 1
+            #     vector store attached to the assistant.
             class VectorStore < OpenAI::Internal::Type::BaseModel
               # @!attribute chunking_strategy
               #   The chunking strategy used to chunk the file(s). If not set, will use the `auto`
@@ -252,10 +307,10 @@ module OpenAI
               )
 
               # @!attribute file_ids
-              #   A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
-              #   add to the vector store. For vector stores created before Nov 2025, there can be
-              #   a maximum of 10,000 files in a vector store. For vector stores created starting
-              #   in Nov 2025, the limit is 100,000,000 files.
+              #   A list of [file](https://developers.openai.com/api/reference/resources/files)
+              #   IDs to add to the vector store. For vector stores created before Nov 2025, there
+              #   can be a maximum of 10,000 files in a vector store. For vector stores created
+              #   starting in Nov 2025, the limit is 100,000,000 files.
               #
               #   @return [Array<String>, nil]
               optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
@@ -272,15 +327,23 @@ module OpenAI
               optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
               # @!method initialize(chunking_strategy: nil, file_ids: nil, metadata: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore}
-              #   for more details.
+              #   @param chunking_strategy [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static]
+              #     The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+              #     strategy.
               #
-              #   @param chunking_strategy [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static] The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+              #   @param file_ids [Array<String>]
+              #     A list of [file](https://developers.openai.com/api/reference/resources/files)
+              #     IDs to add to the vector store. For vector stores created before Nov 2025, there
+              #     can be a maximum of 10,000 files in a vector store. For vector stores created
+              #     starting in Nov 2025, the limit is 100,000,000 files.
               #
-              #   @param file_ids [Array<String>] A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to ad
+              #   @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.
               #
-              #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+              #     Keys are strings with a maximum length of 64 characters. Values are strings with
+              #     a maximum length of 512 characters.
 
               # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
               # strategy.
@@ -317,7 +380,8 @@ module OpenAI
                   #   The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
                   #   `800` and `chunk_overlap_tokens` of `400`.
                   #
-                  #   @param type [Symbol, :auto] Always `auto`.
+                  #   @param type [Symbol, :auto]
+                  #     Always `auto`.
                 end
 
                 class Static < OpenAI::Internal::Type::BaseModel
@@ -340,7 +404,8 @@ module OpenAI
                   # @!method initialize(static:, type: :static)
                   #   @param static [OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static]
                   #
-                  #   @param type [Symbol, :static] Always `static`.
+                  #   @param type [Symbol, :static]
+                  #     Always `static`.
 
                   # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static#static
                   class Static < OpenAI::Internal::Type::BaseModel
@@ -360,13 +425,14 @@ module OpenAI
                     required :max_chunk_size_tokens, Integer
 
                     # @!method initialize(chunk_overlap_tokens:, max_chunk_size_tokens:)
-                    #   Some parameter documentations has been truncated, see
-                    #   {OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static}
-                    #   for more details.
+                    #   @param chunk_overlap_tokens [Integer]
+                    #     The number of tokens that overlap between chunks. The default value is `400`.
                     #
-                    #   @param chunk_overlap_tokens [Integer] The number of tokens that overlap between chunks. The default value is `400`.
+                    #     Note that the overlap must not exceed half of `max_chunk_size_tokens`.
                     #
-                    #   @param max_chunk_size_tokens [Integer] The maximum number of tokens in each chunk. The default value is `800`. The mini
+                    #   @param max_chunk_size_tokens [Integer]
+                    #     The maximum number of tokens in each chunk. The default value is `800`. The
+                    #     minimum value is `100` and the maximum value is `4096`.
                   end
                 end
 

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

@@ -41,16 +41,25 @@ module OpenAI
         optional :order, enum: -> { OpenAI::Beta::AssistantListParams::Order }
 
         # @!method initialize(after: nil, before: nil, limit: nil, order: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::AssistantListParams} 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 before [String]
+        #     A cursor for use in pagination. `before` is an object ID that defines your place
+        #     in the list. For instance, if you make a list request and receive 100 objects,
+        #     starting with obj_foo, your subsequent call can include before=obj_foo in order
+        #     to fetch the previous page of the list.
         #
-        #   @param before [String] A cursor for use in pagination. `before` 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
+        #     100, and the default is 20.
         #
-        #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
-        #
-        #   @param order [Symbol, OpenAI::Models::Beta::AssistantListParams::Order] Sort order by the `created_at` timestamp of the objects. `asc` for ascending ord
+        #   @param order [Symbol, OpenAI::Models::Beta::AssistantListParams::Order]
+        #     Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+        #     order and `desc` for descending order.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

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

@@ -4,14 +4,14 @@ module OpenAI
   module Models
     module Beta
       # 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.
@@ -39,7 +39,7 @@ module OpenAI
         variant -> { OpenAI::ResponseFormatJSONObject }
 
         # JSON Schema response format. Used to generate structured JSON responses.
-        # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+        # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
         variant -> { OpenAI::ResponseFormatJSONSchema }
 
         # @!method self.variants