openai 0.87.0 → 0.88.0

data/lib/openai/resources/beta/assistants.rb

@@ -7,34 +7,87 @@ module OpenAI
       class Assistants
         # @deprecated
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Beta::AssistantCreateParams} for more details.
-        #
         # Create an assistant with a model and instructions.
         #
         # @overload create(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: {})
         #
-        # @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 instructions [String, nil] The system instructions that the assistant uses. The maximum length is 256,000 c
-        #
-        # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
-        #
-        # @param 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 response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil] Specifies the format that the model must output. Compatible with [GPT-4o](https:
-        #
-        # @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
-        #
-        # @param tool_resources [OpenAI::Models::Beta::AssistantCreateParams::ToolResources, nil] A set of resources that are used by the assistant's tools. The resources are spe
-        #
-        # @param tools [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool>] A list of tool enabled on the assistant. There can be a maximum of 128 tools per
-        #
-        # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
+        # @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 description [String, nil]
+        #   The description of the assistant. The maximum length is 512 characters.
+        #
+        # @param instructions [String, nil]
+        #   The system instructions that the assistant uses. The maximum length is 256,000
+        #   characters.
+        #
+        # @param metadata [Hash{Symbol=>String}, nil]
+        #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+        #   for storing additional information about the object in a structured format, and
+        #   querying for objects via API or the dashboard.
+        #
+        #   Keys are strings with a maximum length of 64 characters. Values are strings with
+        #   a maximum length of 512 characters.
+        #
+        # @param 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 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://developers.openai.com/api/docs/models/gpt-4o),
+        #   [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+        #   all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+        #
+        #   Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
+        #   Outputs which ensures the model will match your supplied JSON schema. Learn more
+        #   in the
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+        #
+        #   Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
+        #   message the model generates is valid JSON.
+        #
+        #   **Important:** when using JSON mode, you **must** also instruct the model to
+        #   produce JSON yourself via a system or user message. Without this, the model may
+        #   generate an unending stream of whitespace until the generation reaches the token
+        #   limit, resulting in a long-running and seemingly "stuck" request. Also note that
+        #   the message content may be partially cut off if `finish_reason="length"`, which
+        #   indicates the generation exceeded `max_tokens` or the conversation exceeded the
+        #   max context length.
+        #
+        # @param temperature [Float, nil]
+        #   What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+        #   make the output more random, while lower values like 0.2 will make it more
+        #   focused and deterministic.
+        #
+        # @param tool_resources [OpenAI::Models::Beta::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}, nil]
         #
@@ -59,7 +112,8 @@ module OpenAI
         #
         # @overload retrieve(assistant_id, request_options: {})
         #
-        # @param assistant_id [String] The ID of the assistant to retrieve.
+        # @param assistant_id [String]
+        #   The ID of the assistant to retrieve.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -78,36 +132,90 @@ module OpenAI
 
         # @deprecated
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Beta::AssistantUpdateParams} for more details.
-        #
         # Modifies an assistant.
         #
         # @overload update(assistant_id, description: nil, instructions: nil, metadata: nil, model: nil, name: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_resources: nil, tools: nil, top_p: nil, request_options: {})
         #
-        # @param assistant_id [String] The ID of the assistant to modify.
-        #
-        # @param description [String, nil] The description of the assistant. The maximum length is 512 characters.
-        #
-        # @param instructions [String, nil] The system instructions that the assistant uses. The maximum length is 256,000 c
-        #
-        # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
-        #
-        # @param model [String, Symbol, OpenAI::Models::Beta::AssistantUpdateParams::Model] ID of the model to use. You can use the [List models](https://platform.openai.co
-        #
-        # @param name [String, nil] The name of the assistant. The maximum length is 256 characters.
-        #
-        # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
-        #
-        # @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil] Specifies the format that the model must output. Compatible with [GPT-4o](https:
-        #
-        # @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
-        #
-        # @param tool_resources [OpenAI::Models::Beta::AssistantUpdateParams::ToolResources, nil] A set of resources that are used by the assistant's tools. The resources are spe
-        #
-        # @param tools [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool>] A list of tool enabled on the assistant. There can be a maximum of 128 tools per
-        #
-        # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
+        # @param assistant_id [String]
+        #   The ID of the assistant to modify.
+        #
+        # @param description [String, nil]
+        #   The description of the assistant. The maximum length is 512 characters.
+        #
+        # @param instructions [String, nil]
+        #   The system instructions that the assistant uses. The maximum length is 256,000
+        #   characters.
+        #
+        # @param metadata [Hash{Symbol=>String}, nil]
+        #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+        #   for storing additional information about the object in a structured format, and
+        #   querying for objects via API or the dashboard.
+        #
+        #   Keys are strings with a maximum length of 64 characters. Values are strings with
+        #   a maximum length of 512 characters.
+        #
+        # @param model [String, Symbol, OpenAI::Models::Beta::AssistantUpdateParams::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 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 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://developers.openai.com/api/docs/models/gpt-4o),
+        #   [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+        #   all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+        #
+        #   Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
+        #   Outputs which ensures the model will match your supplied JSON schema. Learn more
+        #   in the
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+        #
+        #   Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
+        #   message the model generates is valid JSON.
+        #
+        #   **Important:** when using JSON mode, you **must** also instruct the model to
+        #   produce JSON yourself via a system or user message. Without this, the model may
+        #   generate an unending stream of whitespace until the generation reaches the token
+        #   limit, resulting in a long-running and seemingly "stuck" request. Also note that
+        #   the message content may be partially cut off if `finish_reason="length"`, which
+        #   indicates the generation exceeded `max_tokens` or the conversation exceeded the
+        #   max context length.
+        #
+        # @param temperature [Float, nil]
+        #   What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+        #   make the output more random, while lower values like 0.2 will make it more
+        #   focused and deterministic.
+        #
+        # @param tool_resources [OpenAI::Models::Beta::AssistantUpdateParams::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}, nil]
         #
@@ -128,20 +236,29 @@ module OpenAI
 
         # @deprecated
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Beta::AssistantListParams} for more details.
-        #
         # Returns a list of assistants.
         #
         # @overload list(after: nil, before: nil, limit: nil, order: nil, request_options: {})
         #
-        # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+        # @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 before [String] A cursor for use in pagination. `before` 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 limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+        # @param limit [Integer]
+        #   A limit on the number of objects to be returned. Limit can range between 1 and
+        #   100, and the default is 20.
         #
-        # @param 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}, nil]
         #
@@ -168,7 +285,8 @@ module OpenAI
         #
         # @overload delete(assistant_id, request_options: {})
         #
-        # @param assistant_id [String] The ID of the assistant to delete.
+        # @param assistant_id [String]
+        #   The ID of the assistant to delete.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openai/resources/beta/chatkit/sessions.rb

@@ -5,22 +5,26 @@ module OpenAI
     class Beta
       class ChatKit
         class Sessions
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Beta::ChatKit::SessionCreateParams} for more details.
-          #
           # Create a ChatKit session.
           #
           # @overload create(user:, workflow:, chatkit_configuration: nil, expires_after: nil, rate_limits: nil, request_options: {})
           #
-          # @param user [String] A free-form string that identifies your end user; ensures this Session can acces
+          # @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 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. Defaul
+          # @param expires_after [OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam]
+          #   Optional override for session expiration timing in seconds from creation.
+          #   Defaults to 10 minutes.
           #
-          # @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}, nil]
           #
@@ -45,7 +49,8 @@ module OpenAI
           #
           # @overload cancel(session_id, request_options: {})
           #
-          # @param session_id [String] Unique identifier for the ChatKit session to cancel.
+          # @param session_id [String]
+          #   Unique identifier for the ChatKit session to cancel.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #

data/lib/openai/resources/beta/chatkit/threads.rb

@@ -9,7 +9,8 @@ module OpenAI
           #
           # @overload retrieve(thread_id, request_options: {})
           #
-          # @param thread_id [String] Identifier of the ChatKit thread to retrieve.
+          # @param thread_id [String]
+          #   Identifier of the ChatKit thread to retrieve.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -26,22 +27,27 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Beta::ChatKit::ThreadListParams} for more details.
-          #
           # List ChatKit threads with optional pagination and user filters.
           #
           # @overload list(after: nil, before: nil, limit: nil, order: nil, user: nil, request_options: {})
           #
-          # @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::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}, nil]
           #
@@ -66,7 +72,8 @@ module OpenAI
           #
           # @overload delete(thread_id, request_options: {})
           #
-          # @param thread_id [String] Identifier of the ChatKit thread to delete.
+          # @param thread_id [String]
+          #   Identifier of the ChatKit thread to delete.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -83,22 +90,26 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Beta::ChatKit::ThreadListItemsParams} for more details.
-          #
           # List items that belong to a ChatKit thread.
           #
           # @overload list_items(thread_id, after: nil, before: nil, limit: nil, order: nil, request_options: {})
           #
-          # @param thread_id [String] Identifier of the ChatKit thread whose items are requested.
+          # @param thread_id [String]
+          #   Identifier of the ChatKit thread whose items are requested.
           #
-          # @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}, nil]
           #

data/lib/openai/resources/beta/responses/input_items.rb

@@ -5,24 +5,32 @@ module OpenAI
     class Beta
       class Responses
         class InputItems
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Beta::Responses::InputItemListParams} for more details.
-          #
           # Returns a list of input items for a given response.
           #
           # @overload list(response_id, after: nil, include: nil, limit: nil, order: nil, betas: nil, request_options: {})
           #
-          # @param response_id [String] Path param: The ID of the response to retrieve input items for.
+          # @param response_id [String]
+          #   Path param: The ID of the response to retrieve input items for.
+          #
+          # @param after [String]
+          #   Query param: An item ID to list items after, used in pagination.
           #
-          # @param after [String] Query param: An item ID to list items after, used in pagination.
+          # @param include [Array<Symbol, OpenAI::Models::Beta::BetaResponseIncludable>]
+          #   Query param: Additional fields to include in the response. See the `include`
+          #   parameter for Response creation above for more information.
           #
-          # @param include [Array<Symbol, OpenAI::Models::Beta::BetaResponseIncludable>] Query param: Additional fields to include in the response. See the `include`
+          # @param limit [Integer]
+          #   Query param: 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] Query param: A limit on the number of objects to be returned. Limit can range be
+          # @param order [Symbol, OpenAI::Models::Beta::Responses::InputItemListParams::Order]
+          #   Query param: The order to return the input items in. Default is `desc`.
           #
-          # @param order [Symbol, OpenAI::Models::Beta::Responses::InputItemListParams::Order] Query param: The order to return the input items in. Default is `desc`.
+          #   - `asc`: Return the input items in ascending order.
+          #   - `desc`: Return the input items in descending order.
           #
-          # @param betas [Array<Symbol, OpenAI::Models::Beta::Responses::InputItemListParams::Beta>] Header param: Optional beta features to enable for this request.
+          # @param betas [Array<Symbol, OpenAI::Models::Beta::Responses::InputItemListParams::Beta>]
+          #   Header param: Optional beta features to enable for this request.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #

data/lib/openai/resources/beta/responses/input_tokens.rb

@@ -5,9 +5,6 @@ module OpenAI
     class Beta
       class Responses
         class InputTokens
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Beta::Responses::InputTokenCountParams} for more details.
-          #
           # Returns input token counts of the request.
           #
           # Returns an object with `object` set to `response.input_tokens` and an
@@ -15,31 +12,71 @@ module OpenAI
           #
           # @overload count(conversation: nil, input: nil, instructions: nil, model: nil, parallel_tool_calls: nil, personality: nil, previous_response_id: nil, reasoning: nil, text: nil, tool_choice: nil, tools: nil, truncation: nil, betas: nil, request_options: {})
           #
-          # @param conversation [String, OpenAI::Models::Beta::BetaResponseConversationParam, nil] Body param: The conversation that this response belongs to. Items from this conv
-          #
-          # @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] Body param: Text, image, or file inputs to the model, used to generate a respons
-          #
-          # @param instructions [String, nil] Body param: A system (or developer) message inserted into the model's context.
-          #
-          # @param model [String, nil] Body param: Model ID used to generate the response, like `gpt-4o` or `o3`. OpenA
-          #
-          # @param parallel_tool_calls [Boolean, nil] Body param: Whether to allow the model to run tool calls in parallel.
-          #
-          # @param personality [String, Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Personality] Body param: A model-owned style preset to apply to this request. Omit this param
-          #
-          # @param previous_response_id [String, nil] Body param: The unique ID of the previous response to the model. Use this to cre
-          #
-          # @param reasoning [OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning, nil] Body param: **gpt-5 and o-series models only** Configuration options for [reason
-          #
-          # @param text [OpenAI::Models::Beta::Responses::InputTokenCountParams::Text, nil] Body param: Configuration options for a text response from the model. Can be pla
-          #
-          # @param tool_choice [Symbol, OpenAI::Models::Beta::BetaToolChoiceOptions, OpenAI::Models::Beta::BetaToolChoiceAllowed, OpenAI::Models::Beta::BetaToolChoiceTypes, OpenAI::Models::Beta::BetaToolChoiceFunction, OpenAI::Models::Beta::BetaToolChoiceMcp, OpenAI::Models::Beta::BetaToolChoiceCustom, OpenAI::Models::Beta::Responses::InputTokenCountParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam, OpenAI::Models::Beta::BetaToolChoiceApplyPatch, OpenAI::Models::Beta::BetaToolChoiceShell, nil] Body param: Controls which tool the model should use, if any.
-          #
-          # @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>, nil] Body param: An array of tools the model may call while generating a response. Yo
-          #
-          # @param truncation [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Truncation] Body param: The truncation strategy to use for the model response. - `auto`: If
-          #
-          # @param betas [Array<Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Beta>] Header param: Optional beta features to enable for this request.
+          # @param conversation [String, OpenAI::Models::Beta::BetaResponseConversationParam, nil]
+          #   Body param: The conversation that this response belongs to. Items from this
+          #   conversation are prepended to `input_items` for this response request. Input
+          #   items and output items from this response are automatically added to this
+          #   conversation after this response completes.
+          #
+          # @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil]
+          #   Body param: Text, image, or file inputs to the model, used to generate a
+          #   response
+          #
+          # @param instructions [String, nil]
+          #   Body param: A system (or developer) message inserted into the model's context.
+          #   When used along with `previous_response_id`, the instructions from a previous
+          #   response will not be carried over to the next response. This makes it simple to
+          #   swap out system (or developer) messages in new responses.
+          #
+          # @param model [String, nil]
+          #   Body param: Model ID used to generate the response, like `gpt-4o` or `o3`.
+          #   OpenAI offers a wide range of models with different capabilities, performance
+          #   characteristics, and price points. Refer to the
+          #   [model guide](https://developers.openai.com/api/docs/models) to browse and
+          #   compare available models.
+          #
+          # @param parallel_tool_calls [Boolean, nil]
+          #   Body param: Whether to allow the model to run tool calls in parallel.
+          #
+          # @param personality [String, Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Personality]
+          #   Body param: A model-owned style preset to apply to this request. Omit this
+          #   parameter to use the model's default style. Supported values may expand over
+          #   time. Values must be at most 64 characters.
+          #
+          # @param previous_response_id [String, nil]
+          #   Body param: The unique ID of the previous response to the model. Use this to
+          #   create multi-turn conversations. Learn more about
+          #   [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
+          #   Cannot be used in conjunction with `conversation`.
+          #
+          # @param reasoning [OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning, nil]
+          #   Body param: **gpt-5 and o-series models only** Configuration options for
+          #   [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
+          #
+          # @param text [OpenAI::Models::Beta::Responses::InputTokenCountParams::Text, nil]
+          #   Body param: Configuration options for a text response from the model. Can be
+          #   plain text or structured JSON data. Learn more:
+          #
+          #   - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+          #   - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
+          #
+          # @param tool_choice [Symbol, OpenAI::Models::Beta::BetaToolChoiceOptions, OpenAI::Models::Beta::BetaToolChoiceAllowed, OpenAI::Models::Beta::BetaToolChoiceTypes, OpenAI::Models::Beta::BetaToolChoiceFunction, OpenAI::Models::Beta::BetaToolChoiceMcp, OpenAI::Models::Beta::BetaToolChoiceCustom, OpenAI::Models::Beta::Responses::InputTokenCountParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam, OpenAI::Models::Beta::BetaToolChoiceApplyPatch, OpenAI::Models::Beta::BetaToolChoiceShell, nil]
+          #   Body param: Controls which tool the model should use, if any.
+          #
+          # @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>, nil]
+          #   Body param: An array of tools the model may call while generating a response.
+          #   You can specify which tool to use by setting the `tool_choice` parameter.
+          #
+          # @param truncation [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Truncation]
+          #   Body param: The truncation strategy to use for the model response. - `auto`: If
+          #   the input to this Response exceeds the model's context window size, the model
+          #   will truncate the response to fit the context window by dropping items from the
+          #   beginning of the conversation. - `disabled` (default): If the input size will
+          #   exceed the context window size for a model, the request will fail with a 400
+          #   error.
+          #
+          # @param betas [Array<Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Beta>]
+          #   Header param: Optional beta features to enable for this request.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #