openai 0.87.0 → 0.89.0

data/lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb

@@ -41,15 +41,20 @@ module OpenAI
           # @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
           #   A paginated list of thread items rendered for the ChatKit API.
           #
-          #   @param data [Array<OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem, OpenAI::Models::Beta::ChatKit::ChatKitThreadAssistantMessageItem, OpenAI::Models::Beta::ChatKit::ChatKitWidgetItem, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup>] A list of items
+          #   @param data [Array<OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem, OpenAI::Models::Beta::ChatKit::ChatKitThreadAssistantMessageItem, OpenAI::Models::Beta::ChatKit::ChatKitWidgetItem, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup>]
+          #     A list of items
           #
-          #   @param first_id [String, nil] The ID of the first item in the list.
+          #   @param first_id [String, nil]
+          #     The ID of the first item in the list.
           #
-          #   @param has_more [Boolean] Whether there are more items available.
+          #   @param has_more [Boolean]
+          #     Whether there are more items available.
           #
-          #   @param last_id [String, nil] The ID of the last item in the list.
+          #   @param last_id [String, nil]
+          #     The ID of the last item in the list.
           #
-          #   @param object [Symbol, :list] The type of object returned, must be `list`.
+          #   @param object [Symbol, :list]
+          #     The type of object returned, must be `list`.
 
           # User-authored messages within a thread.
           module Data
@@ -144,31 +149,38 @@ module OpenAI
               required :type, const: :"chatkit.client_tool_call"
 
               # @!method initialize(id:, arguments:, call_id:, created_at:, name:, output:, status:, thread_id:, object: :"chatkit.thread_item", type: :"chatkit.client_tool_call")
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall}
-              #   for more details.
-              #
               #   Record of a client side tool invocation initiated by the assistant.
               #
-              #   @param id [String] Identifier of the thread item.
+              #   @param id [String]
+              #     Identifier of the thread item.
               #
-              #   @param arguments [String] JSON-encoded arguments that were sent to the tool.
+              #   @param arguments [String]
+              #     JSON-encoded arguments that were sent to the tool.
               #
-              #   @param call_id [String] Identifier for the client tool call.
+              #   @param call_id [String]
+              #     Identifier for the client tool call.
               #
-              #   @param created_at [Integer] Unix timestamp (in seconds) for when the item was created.
+              #   @param created_at [Integer]
+              #     Unix timestamp (in seconds) for when the item was created.
               #
-              #   @param name [String] Tool name that was invoked.
+              #   @param name [String]
+              #     Tool name that was invoked.
               #
-              #   @param output [String, nil] JSON-encoded output captured from the tool. Defaults to null while execution is
+              #   @param output [String, nil]
+              #     JSON-encoded output captured from the tool. Defaults to null while execution is
+              #     in progress.
               #
-              #   @param status [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall::Status] Execution status for the tool call.
+              #   @param status [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall::Status]
+              #     Execution status for the tool call.
               #
-              #   @param thread_id [String] Identifier of the parent thread.
+              #   @param thread_id [String]
+              #     Identifier of the parent thread.
               #
-              #   @param object [Symbol, :"chatkit.thread_item"] Type discriminator that is always `chatkit.thread_item`.
+              #   @param object [Symbol, :"chatkit.thread_item"]
+              #     Type discriminator that is always `chatkit.thread_item`.
               #
-              #   @param type [Symbol, :"chatkit.client_tool_call"] Type discriminator that is always `chatkit.client_tool_call`.
+              #   @param type [Symbol, :"chatkit.client_tool_call"]
+              #     Type discriminator that is always `chatkit.client_tool_call`.
 
               # Execution status for the tool call.
               #
@@ -239,21 +251,29 @@ module OpenAI
               # @!method initialize(id:, created_at:, heading:, summary:, task_type:, thread_id:, object: :"chatkit.thread_item", type: :"chatkit.task")
               #   Task emitted by the workflow to show progress and status updates.
               #
-              #   @param id [String] Identifier of the thread item.
+              #   @param id [String]
+              #     Identifier of the thread item.
               #
-              #   @param created_at [Integer] Unix timestamp (in seconds) for when the item was created.
+              #   @param created_at [Integer]
+              #     Unix timestamp (in seconds) for when the item was created.
               #
-              #   @param heading [String, nil] Optional heading for the task. Defaults to null when not provided.
+              #   @param heading [String, nil]
+              #     Optional heading for the task. Defaults to null when not provided.
               #
-              #   @param summary [String, nil] Optional summary that describes the task. Defaults to null when omitted.
+              #   @param summary [String, nil]
+              #     Optional summary that describes the task. Defaults to null when omitted.
               #
-              #   @param task_type [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask::TaskType] Subtype for the task.
+              #   @param task_type [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask::TaskType]
+              #     Subtype for the task.
               #
-              #   @param thread_id [String] Identifier of the parent thread.
+              #   @param thread_id [String]
+              #     Identifier of the parent thread.
               #
-              #   @param object [Symbol, :"chatkit.thread_item"] Type discriminator that is always `chatkit.thread_item`.
+              #   @param object [Symbol, :"chatkit.thread_item"]
+              #     Type discriminator that is always `chatkit.thread_item`.
               #
-              #   @param type [Symbol, :"chatkit.task"] Type discriminator that is always `chatkit.task`.
+              #   @param type [Symbol, :"chatkit.task"]
+              #     Type discriminator that is always `chatkit.task`.
 
               # Subtype for the task.
               #
@@ -316,18 +336,23 @@ module OpenAI
               # @!method initialize(id:, created_at:, tasks:, thread_id:, object: :"chatkit.thread_item", type: :"chatkit.task_group")
               #   Collection of workflow tasks grouped together in the thread.
               #
-              #   @param id [String] Identifier of the thread item.
+              #   @param id [String]
+              #     Identifier of the thread item.
               #
-              #   @param created_at [Integer] Unix timestamp (in seconds) for when the item was created.
+              #   @param created_at [Integer]
+              #     Unix timestamp (in seconds) for when the item was created.
               #
-              #   @param tasks [Array<OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task>] Tasks included in the group.
+              #   @param tasks [Array<OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task>]
+              #     Tasks included in the group.
               #
-              #   @param thread_id [String] Identifier of the parent thread.
+              #   @param thread_id [String]
+              #     Identifier of the parent thread.
               #
-              #   @param object [Symbol, :"chatkit.thread_item"] Type discriminator that is always `chatkit.thread_item`.
+              #   @param object [Symbol, :"chatkit.thread_item"]
+              #     Type discriminator that is always `chatkit.thread_item`.
               #
-              #   @param type [Symbol, :"chatkit.task_group"] Type discriminator that is always `chatkit.task_group`.
-
+              #   @param type [Symbol, :"chatkit.task_group"]
+              #     Type discriminator that is always `chatkit.task_group`.
               class Task < OpenAI::Internal::Type::BaseModel
                 # @!attribute heading
                 #   Optional heading for the grouped task. Defaults to null when not provided.
@@ -351,17 +376,16 @@ module OpenAI
                 )
 
                 # @!method initialize(heading:, summary:, type:)
-                #   Some parameter documentations has been truncated, see
-                #   {OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task}
-                #   for more details.
-                #
                 #   Task entry that appears within a TaskGroup.
                 #
-                #   @param heading [String, nil] Optional heading for the grouped task. Defaults to null when not provided.
+                #   @param heading [String, nil]
+                #     Optional heading for the grouped task. Defaults to null when not provided.
                 #
-                #   @param summary [String, nil] Optional summary that describes the grouped task. Defaults to null when omitted.
+                #   @param summary [String, nil]
+                #     Optional summary that describes the grouped task. Defaults to null when omitted.
                 #
-                #   @param type [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::Type] Subtype for the grouped task.
+                #   @param type [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::Type]
+                #     Subtype for the grouped task.
 
                 # Subtype for the grouped task.
                 #

data/lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb

@@ -62,19 +62,26 @@ module OpenAI
           # @!method initialize(id:, attachments:, content:, created_at:, inference_options:, thread_id:, object: :"chatkit.thread_item", type: :"chatkit.user_message")
           #   User-authored messages within a thread.
           #
-          #   @param id [String] Identifier of the thread item.
+          #   @param id [String]
+          #     Identifier of the thread item.
           #
-          #   @param attachments [Array<OpenAI::Models::Beta::ChatKit::ChatKitAttachment>] Attachments associated with the user message. Defaults to an empty list.
+          #   @param attachments [Array<OpenAI::Models::Beta::ChatKit::ChatKitAttachment>]
+          #     Attachments associated with the user message. Defaults to an empty list.
           #
-          #   @param content [Array<OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::Content::InputText, OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::Content::QuotedText>] Ordered content elements supplied by the user.
+          #   @param content [Array<OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::Content::InputText, OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::Content::QuotedText>]
+          #     Ordered content elements supplied by the user.
           #
-          #   @param created_at [Integer] Unix timestamp (in seconds) for when the item was created.
+          #   @param created_at [Integer]
+          #     Unix timestamp (in seconds) for when the item was created.
           #
-          #   @param inference_options [OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions, nil] Inference overrides applied to the message. Defaults to null when unset.
+          #   @param inference_options [OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions, nil]
+          #     Inference overrides applied to the message. Defaults to null when unset.
           #
-          #   @param thread_id [String] Identifier of the parent thread.
+          #   @param thread_id [String]
+          #     Identifier of the parent thread.
           #
-          #   @param object [Symbol, :"chatkit.thread_item"] Type discriminator that is always `chatkit.thread_item`.
+          #   @param object [Symbol, :"chatkit.thread_item"]
+          #     Type discriminator that is always `chatkit.thread_item`.
           #
           #   @param type [Symbol, :"chatkit.user_message"]
 
@@ -106,9 +113,11 @@ module OpenAI
               # @!method initialize(text:, type: :input_text)
               #   Text block that a user contributed to the thread.
               #
-              #   @param text [String] Plain-text content supplied by the user.
+              #   @param text [String]
+              #     Plain-text content supplied by the user.
               #
-              #   @param type [Symbol, :input_text] Type discriminator that is always `input_text`.
+              #   @param type [Symbol, :input_text]
+              #     Type discriminator that is always `input_text`.
             end
 
             class QuotedText < OpenAI::Internal::Type::BaseModel
@@ -127,9 +136,11 @@ module OpenAI
               # @!method initialize(text:, type: :quoted_text)
               #   Quoted snippet that the user referenced in their message.
               #
-              #   @param text [String] Quoted text content.
+              #   @param text [String]
+              #     Quoted text content.
               #
-              #   @param type [Symbol, :quoted_text] Type discriminator that is always `quoted_text`.
+              #   @param type [Symbol, :quoted_text]
+              #     Type discriminator that is always `quoted_text`.
             end
 
             # @!method self.variants
@@ -156,15 +167,14 @@ module OpenAI
             )
 
             # @!method initialize(model:, tool_choice:)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions}
-            #   for more details.
-            #
             #   Inference overrides applied to the message. Defaults to null when unset.
             #
-            #   @param model [String, nil] Model name that generated the response. Defaults to null when using the session
+            #   @param model [String, nil]
+            #     Model name that generated the response. Defaults to null when using the session
+            #     default.
             #
-            #   @param tool_choice [OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions::ToolChoice, nil] Preferred tool to invoke. Defaults to null when ChatKit should auto-select.
+            #   @param tool_choice [OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions::ToolChoice, nil]
+            #     Preferred tool to invoke. Defaults to null when ChatKit should auto-select.
 
             # @see OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions#tool_choice
             class ToolChoice < OpenAI::Internal::Type::BaseModel
@@ -177,7 +187,8 @@ module OpenAI
               # @!method initialize(id:)
               #   Preferred tool to invoke. Defaults to null when ChatKit should auto-select.
               #
-              #   @param id [String] Identifier of the requested tool.
+              #   @param id [String]
+              #     Identifier of the requested tool.
             end
           end
         end

data/lib/openai/models/beta/chatkit/chatkit_widget_item.rb

@@ -44,17 +44,23 @@ module OpenAI
           # @!method initialize(id:, created_at:, thread_id:, widget:, object: :"chatkit.thread_item", type: :"chatkit.widget")
           #   Thread item that renders a widget payload.
           #
-          #   @param id [String] Identifier of the thread item.
+          #   @param id [String]
+          #     Identifier of the thread item.
           #
-          #   @param created_at [Integer] Unix timestamp (in seconds) for when the item was created.
+          #   @param created_at [Integer]
+          #     Unix timestamp (in seconds) for when the item was created.
           #
-          #   @param thread_id [String] Identifier of the parent thread.
+          #   @param thread_id [String]
+          #     Identifier of the parent thread.
           #
-          #   @param widget [String] Serialized widget payload rendered in the UI.
+          #   @param widget [String]
+          #     Serialized widget payload rendered in the UI.
           #
-          #   @param object [Symbol, :"chatkit.thread_item"] Type discriminator that is always `chatkit.thread_item`.
+          #   @param object [Symbol, :"chatkit.thread_item"]
+          #     Type discriminator that is always `chatkit.thread_item`.
           #
-          #   @param type [Symbol, :"chatkit.widget"] Type discriminator that is always `chatkit.widget`.
+          #   @param type [Symbol, :"chatkit.widget"]
+          #     Type discriminator that is always `chatkit.widget`.
         end
       end
 

data/lib/openai/models/beta/chatkit/session_create_params.rb

@@ -42,18 +42,22 @@ module OpenAI
           optional :rate_limits, -> { OpenAI::Beta::ChatKit::ChatSessionRateLimitsParam }
 
           # @!method initialize(user:, workflow:, chatkit_configuration: nil, expires_after: nil, rate_limits: nil, request_options: {})
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::ChatKit::SessionCreateParams} for more details.
+          #   @param user [String]
+          #     A free-form string that identifies your end user; ensures this Session can
+          #     access other objects that have the same `user` scope.
           #
-          #   @param user [String] A free-form string that identifies your end user; ensures this Session can acces
+          #   @param workflow [OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam]
+          #     Workflow that powers the session.
           #
-          #   @param workflow [OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam] Workflow that powers the session.
+          #   @param chatkit_configuration [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam]
+          #     Optional overrides for ChatKit runtime configuration features
           #
-          #   @param chatkit_configuration [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam] Optional overrides for ChatKit runtime configuration features
+          #   @param expires_after [OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam]
+          #     Optional override for session expiration timing in seconds from creation.
+          #     Defaults to 10 minutes.
           #
-          #   @param expires_after [OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam] Optional override for session expiration timing in seconds from creation. Defaul
-          #
-          #   @param rate_limits [OpenAI::Models::Beta::ChatKit::ChatSessionRateLimitsParam] Optional override for per-minute request limits. When omitted, defaults to 10.
+          #   @param rate_limits [OpenAI::Models::Beta::ChatKit::ChatSessionRateLimitsParam]
+          #     Optional override for per-minute request limits. When omitted, defaults to 10.
           #
           #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/openai/models/beta/chatkit/thread_delete_response.rb

@@ -27,11 +27,14 @@ module OpenAI
           # @!method initialize(id:, deleted:, object: :"chatkit.thread.deleted")
           #   Confirmation payload returned after deleting a thread.
           #
-          #   @param id [String] Identifier of the deleted thread.
+          #   @param id [String]
+          #     Identifier of the deleted thread.
           #
-          #   @param deleted [Boolean] Indicates that the thread has been deleted.
+          #   @param deleted [Boolean]
+          #     Indicates that the thread has been deleted.
           #
-          #   @param object [Symbol, :"chatkit.thread.deleted"] Type discriminator that is always `chatkit.thread.deleted`.
+          #   @param object [Symbol, :"chatkit.thread.deleted"]
+          #     Type discriminator that is always `chatkit.thread.deleted`.
         end
       end
     end

data/lib/openai/models/beta/chatkit/thread_list_items_params.rb

@@ -41,18 +41,21 @@ module OpenAI
           optional :order, enum: -> { OpenAI::Beta::ChatKit::ThreadListItemsParams::Order }
 
           # @!method initialize(thread_id:, after: nil, before: nil, limit: nil, order: nil, request_options: {})
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::ChatKit::ThreadListItemsParams} for more details.
-          #
           #   @param thread_id [String]
           #
-          #   @param after [String] List items created after this thread item ID. Defaults to null for the first pag
+          #   @param after [String]
+          #     List items created after this thread item ID. Defaults to null for the first
+          #     page.
           #
-          #   @param before [String] List items created before this thread item ID. Defaults to null for the newest r
+          #   @param before [String]
+          #     List items created before this thread item ID. Defaults to null for the newest
+          #     results.
           #
-          #   @param limit [Integer] Maximum number of thread items to return. Defaults to 20.
+          #   @param limit [Integer]
+          #     Maximum number of thread items to return. Defaults to 20.
           #
-          #   @param order [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListItemsParams::Order] Sort order for results by creation time. Defaults to `desc`.
+          #   @param order [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListItemsParams::Order]
+          #     Sort order for results by creation time. Defaults to `desc`.
           #
           #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/openai/models/beta/chatkit/thread_list_params.rb

@@ -43,18 +43,23 @@ module OpenAI
           optional :user, String
 
           # @!method initialize(after: nil, before: nil, limit: nil, order: nil, user: nil, request_options: {})
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::ChatKit::ThreadListParams} for more details.
+          #   @param after [String]
+          #     List items created after this thread item ID. Defaults to null for the first
+          #     page.
           #
-          #   @param after [String] List items created after this thread item ID. Defaults to null for the first pag
+          #   @param before [String]
+          #     List items created before this thread item ID. Defaults to null for the newest
+          #     results.
           #
-          #   @param before [String] List items created before this thread item ID. Defaults to null for the newest r
+          #   @param limit [Integer]
+          #     Maximum number of thread items to return. Defaults to 20.
           #
-          #   @param limit [Integer] Maximum number of thread items to return. Defaults to 20.
+          #   @param order [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListParams::Order]
+          #     Sort order for results by creation time. Defaults to `desc`.
           #
-          #   @param order [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListParams::Order] Sort order for results by creation time. Defaults to `desc`.
-          #
-          #   @param user [String] Filter threads that belong to this user identifier. Defaults to null to return a
+          #   @param user [String]
+          #     Filter threads that belong to this user identifier. Defaults to null to return
+          #     all users.
           #
           #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

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

@@ -35,19 +35,21 @@ module OpenAI
         required :version, String, nil?: true
 
         # @!method initialize(id:, state_variables:, tracing:, version:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::ChatKitWorkflow} for more details.
-        #
         #   Workflow metadata and state returned for the session.
         #
-        #   @param id [String] Identifier of the workflow backing the session.
+        #   @param id [String]
+        #     Identifier of the workflow backing the session.
         #
-        #   @param state_variables [Hash{Symbol=>String, Boolean, Float}, nil] State variable key-value pairs applied when invoking the workflow. Defaults to n
+        #   @param state_variables [Hash{Symbol=>String, Boolean, Float}, nil]
+        #     State variable key-value pairs applied when invoking the workflow. Defaults to
+        #     null when no overrides were provided.
         #
-        #   @param tracing [OpenAI::Models::Beta::ChatKitWorkflow::Tracing] Tracing settings applied to the workflow.
+        #   @param tracing [OpenAI::Models::Beta::ChatKitWorkflow::Tracing]
+        #     Tracing settings applied to the workflow.
         #
-        #   @param version [String, nil] Specific workflow version used for the session. Defaults to null when using the
-
+        #   @param version [String, nil]
+        #     Specific workflow version used for the session. Defaults to null when using the
+        #     latest deployment.
         module StateVariable
           extend OpenAI::Internal::Type::Union
 
@@ -72,7 +74,8 @@ module OpenAI
           # @!method initialize(enabled:)
           #   Tracing settings applied to the workflow.
           #
-          #   @param enabled [Boolean] Indicates whether tracing is enabled.
+          #   @param enabled [Boolean]
+          #     Indicates whether tracing is enabled.
         end
       end
     end

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

@@ -11,7 +11,8 @@ module OpenAI
         required :type, const: :code_interpreter
 
         # @!method initialize(type: :code_interpreter)
-        #   @param type [Symbol, :code_interpreter] The type of tool being defined: `code_interpreter`
+        #   @param type [Symbol, :code_interpreter]
+        #     The type of tool being defined: `code_interpreter`
       end
     end
   end

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

@@ -17,9 +17,11 @@ module OpenAI
         optional :file_search, -> { OpenAI::Beta::FileSearchTool::FileSearch }
 
         # @!method initialize(file_search: nil, type: :file_search)
-        #   @param file_search [OpenAI::Models::Beta::FileSearchTool::FileSearch] Overrides for the file search tool.
+        #   @param file_search [OpenAI::Models::Beta::FileSearchTool::FileSearch]
+        #     Overrides for the file search tool.
         #
-        #   @param type [Symbol, :file_search] The type of tool being defined: `file_search`
+        #   @param type [Symbol, :file_search]
+        #     The type of tool being defined: `file_search`
 
         # @see OpenAI::Models::Beta::FileSearchTool#file_search
         class FileSearch < OpenAI::Internal::Type::BaseModel
@@ -30,7 +32,7 @@ module OpenAI
           #
           #   Note that the file search tool may output fewer than `max_num_results` results.
           #   See the
-          #   [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
+          #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
           #   for more information.
           #
           #   @return [Integer, nil]
@@ -41,21 +43,32 @@ module OpenAI
           #   will use the `auto` ranker and a score_threshold of 0.
           #
           #   See the
-          #   [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
+          #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
           #   for more information.
           #
           #   @return [OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions, nil]
           optional :ranking_options, -> { OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions }
 
           # @!method initialize(max_num_results: nil, ranking_options: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::FileSearchTool::FileSearch} for more details.
-          #
           #   Overrides for the file search tool.
           #
-          #   @param max_num_results [Integer] The maximum number of results the file search tool should output. The default is
+          #   @param max_num_results [Integer]
+          #     The maximum number of results the file search tool should output. The default is
+          #     20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between
+          #     1 and 50 inclusive.
+          #
+          #     Note that the file search tool may output fewer than `max_num_results` results.
+          #     See the
+          #     [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          #     for more information.
           #
-          #   @param ranking_options [OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions] The ranking options for the file search. If not specified, the file search tool
+          #   @param ranking_options [OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions]
+          #     The ranking options for the file search. If not specified, the file search tool
+          #     will use the `auto` ranker and a score_threshold of 0.
+          #
+          #     See the
+          #     [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          #     for more information.
 
           # @see OpenAI::Models::Beta::FileSearchTool::FileSearch#ranking_options
           class RankingOptions < OpenAI::Internal::Type::BaseModel
@@ -74,20 +87,20 @@ module OpenAI
             optional :ranker, enum: -> { OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions::Ranker }
 
             # @!method initialize(score_threshold:, ranker: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions} for more
-            #   details.
-            #
             #   The ranking options for the file search. If not specified, the file search tool
             #   will use the `auto` ranker and a score_threshold of 0.
             #
             #   See the
-            #   [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
+            #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
             #   for more information.
             #
-            #   @param score_threshold [Float] The score threshold for the file search. All values must be a floating point num
+            #   @param score_threshold [Float]
+            #     The score threshold for the file search. All values must be a floating point
+            #     number between 0 and 1.
             #
-            #   @param ranker [Symbol, OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions::Ranker] The ranker to use for the file search. If not specified will use the `auto` rank
+            #   @param ranker [Symbol, OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions::Ranker]
+            #     The ranker to use for the file search. If not specified will use the `auto`
+            #     ranker.
 
             # The ranker to use for the file search. If not specified will use the `auto`
             # ranker.

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

@@ -18,7 +18,8 @@ module OpenAI
         # @!method initialize(function:, type: :function)
         #   @param function [OpenAI::Models::FunctionDefinition]
         #
-        #   @param type [Symbol, :function] The type of tool being defined: `function`
+        #   @param type [Symbol, :function]
+        #     The type of tool being defined: `function`
       end
     end
   end