openai 0.87.0 → 0.89.0

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

@@ -17,18 +17,28 @@ module OpenAI
 
         # @deprecated The Assistants API is deprecated in favor of the Responses API
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Beta::ThreadCreateParams} for more details.
-        #
         # Create a thread.
         #
         # @overload create(messages: nil, metadata: nil, tool_resources: nil, request_options: {})
         #
-        # @param messages [Array<OpenAI::Models::Beta::ThreadCreateParams::Message>] A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
+        # @param messages [Array<OpenAI::Models::Beta::ThreadCreateParams::Message>]
+        #   A list of
+        #   [messages](https://developers.openai.com/api/docs/assistants/migration) to start
+        #   the thread with.
+        #
+        # @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 tool_resources [OpenAI::Models::Beta::ThreadCreateParams::ToolResources, nil] A set of resources that are made available to the assistant's tools in this thre
+        # @param tool_resources [OpenAI::Models::Beta::ThreadCreateParams::ToolResources, nil]
+        #   A set of resources that are made available to the assistant's tools in this
+        #   thread. 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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -53,7 +63,8 @@ module OpenAI
         #
         # @overload retrieve(thread_id, request_options: {})
         #
-        # @param thread_id [String] The ID of the thread to retrieve.
+        # @param thread_id [String]
+        #   The ID of the thread to retrieve.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -72,18 +83,26 @@ module OpenAI
 
         # @deprecated The Assistants API is deprecated in favor of the Responses API
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Beta::ThreadUpdateParams} for more details.
-        #
         # Modifies a thread.
         #
         # @overload update(thread_id, metadata: nil, tool_resources: nil, request_options: {})
         #
-        # @param thread_id [String] The ID of the thread to modify. Only the `metadata` can be modified.
+        # @param thread_id [String]
+        #   The ID of the thread to modify. Only the `metadata` can be modified.
         #
-        # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        # @param metadata [Hash{Symbol=>String}, nil]
+        #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+        #   for storing additional information about the object in a structured format, and
+        #   querying for objects via API or the dashboard.
         #
-        # @param tool_resources [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, nil] A set of resources that are made available to the assistant's tools in this thre
+        #   Keys are strings with a maximum length of 64 characters. Values are strings with
+        #   a maximum length of 512 characters.
+        #
+        # @param tool_resources [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, nil]
+        #   A set of resources that are made available to the assistant's tools in this
+        #   thread. 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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -108,7 +127,8 @@ module OpenAI
         #
         # @overload delete(thread_id, request_options: {})
         #
-        # @param thread_id [String] The ID of the thread to delete.
+        # @param thread_id [String]
+        #   The ID of the thread to delete.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -129,42 +149,113 @@ module OpenAI
         #
         # See {OpenAI::Resources::Beta::Threads#stream_raw} for streaming counterpart.
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Beta::ThreadCreateAndRunParams} for more details.
-        #
         # Create a thread and run it in one request.
         #
         # @overload create_and_run(assistant_id:, instructions: nil, max_completion_tokens: nil, max_prompt_tokens: nil, metadata: nil, model: nil, parallel_tool_calls: nil, response_format: nil, temperature: nil, thread: nil, tool_choice: nil, tool_resources: nil, tools: nil, top_p: nil, truncation_strategy: nil, request_options: {})
         #
-        # @param assistant_id [String] The ID of the [assistant](https://platform.openai.com/docs/api-reference/assista
-        #
-        # @param instructions [String, nil] Override the default system message of the assistant. This is useful for modifyi
-        #
-        # @param max_completion_tokens [Integer, nil] The maximum number of completion tokens that may be used over the course of the
-        #
-        # @param max_prompt_tokens [Integer, nil] The maximum number of prompt tokens that may be used over the course of the run.
-        #
-        # @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::ChatModel, nil] The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to
-        #
-        # @param parallel_tool_calls [Boolean] Whether to enable [parallel function calling](https://platform.openai.com/docs/g
-        #
-        # @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 thread [OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread] Options to create a new thread. If no thread is provided when running a
-        #
-        # @param tool_choice [Symbol, OpenAI::Models::Beta::AssistantToolChoiceOption::Auto, OpenAI::Models::Beta::AssistantToolChoice, nil] Controls which (if any) tool is called by the model.
-        #
-        # @param tool_resources [OpenAI::Models::Beta::ThreadCreateAndRunParams::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>, nil] Override the tools the assistant can use for this run. This is useful for modify
-        #
-        # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
-        #
-        # @param truncation_strategy [OpenAI::Models::Beta::ThreadCreateAndRunParams::TruncationStrategy, nil] Controls for how a thread will be truncated prior to the run. Use this to contro
+        # @param assistant_id [String]
+        #   The ID of the
+        #   [assistant](https://developers.openai.com/api/docs/assistants/migration) to use
+        #   to execute this run.
+        #
+        # @param instructions [String, nil]
+        #   Override the default system message of the assistant. This is useful for
+        #   modifying the behavior on a per-run basis.
+        #
+        # @param max_completion_tokens [Integer, nil]
+        #   The maximum number of completion tokens that may be used over the course of the
+        #   run. The run will make a best effort to use only the number of completion tokens
+        #   specified, across multiple turns of the run. If the run exceeds the number of
+        #   completion tokens specified, the run will end with status `incomplete`. See
+        #   `incomplete_details` for more info.
+        #
+        # @param max_prompt_tokens [Integer, nil]
+        #   The maximum number of prompt tokens that may be used over the course of the run.
+        #   The run will make a best effort to use only the number of prompt tokens
+        #   specified, across multiple turns of the run. If the run exceeds the number of
+        #   prompt tokens specified, the run will end with status `incomplete`. See
+        #   `incomplete_details` for more info.
+        #
+        # @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::ChatModel, nil]
+        #   The ID of the
+        #   [Model](https://developers.openai.com/api/reference/resources/models) to be used
+        #   to execute this run. If a value is provided here, it will override the model
+        #   associated with the assistant. If not, the model associated with the assistant
+        #   will be used.
+        #
+        # @param parallel_tool_calls [Boolean]
+        #   Whether to enable
+        #   [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
+        #   during tool use.
+        #
+        # @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 thread [OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread]
+        #   Options to create a new thread. If no thread is provided when running a request,
+        #   an empty thread will be created.
+        #
+        # @param tool_choice [Symbol, OpenAI::Models::Beta::AssistantToolChoiceOption::Auto, OpenAI::Models::Beta::AssistantToolChoice, nil]
+        #   Controls which (if any) tool is called by the model. `none` means the model will
+        #   not call any tools and instead generates a message. `auto` is the default value
+        #   and means the model can pick between generating a message or calling one or more
+        #   tools. `required` means the model must call one or more tools before responding
+        #   to the user. Specifying a particular tool like `{"type": "file_search"}` or
+        #   `{"type": "function", "function": {"name": "my_function"}}` forces the model to
+        #   call that tool.
+        #
+        # @param tool_resources [OpenAI::Models::Beta::ThreadCreateAndRunParams::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>, nil]
+        #   Override the tools the assistant can use for this run. This is useful for
+        #   modifying the behavior on a per-run basis.
+        #
+        # @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 truncation_strategy [OpenAI::Models::Beta::ThreadCreateAndRunParams::TruncationStrategy, nil]
+        #   Controls for how a thread will be truncated prior to the run. Use this to
+        #   control the initial context window of the run.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -197,42 +288,113 @@ module OpenAI
         # See {OpenAI::Resources::Beta::Threads#create_and_run} for non-streaming
         # counterpart.
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Beta::ThreadCreateAndRunParams} for more details.
-        #
         # Create a thread and run it in one request.
         #
         # @overload stream_raw(assistant_id:, instructions: nil, max_completion_tokens: nil, max_prompt_tokens: nil, metadata: nil, model: nil, parallel_tool_calls: nil, response_format: nil, temperature: nil, thread: nil, tool_choice: nil, tool_resources: nil, tools: nil, top_p: nil, truncation_strategy: nil, request_options: {})
         #
-        # @param assistant_id [String] The ID of the [assistant](https://platform.openai.com/docs/api-reference/assista
-        #
-        # @param instructions [String, nil] Override the default system message of the assistant. This is useful for modifyi
-        #
-        # @param max_completion_tokens [Integer, nil] The maximum number of completion tokens that may be used over the course of the
-        #
-        # @param max_prompt_tokens [Integer, nil] The maximum number of prompt tokens that may be used over the course of the run.
-        #
-        # @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::ChatModel, nil] The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to
-        #
-        # @param parallel_tool_calls [Boolean] Whether to enable [parallel function calling](https://platform.openai.com/docs/g
-        #
-        # @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 thread [OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread] Options to create a new thread. If no thread is provided when running a
-        #
-        # @param tool_choice [Symbol, OpenAI::Models::Beta::AssistantToolChoiceOption::Auto, OpenAI::Models::Beta::AssistantToolChoice, nil] Controls which (if any) tool is called by the model.
-        #
-        # @param tool_resources [OpenAI::Models::Beta::ThreadCreateAndRunParams::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>, nil] Override the tools the assistant can use for this run. This is useful for modify
-        #
-        # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
-        #
-        # @param truncation_strategy [OpenAI::Models::Beta::ThreadCreateAndRunParams::TruncationStrategy, nil] Controls for how a thread will be truncated prior to the run. Use this to contro
+        # @param assistant_id [String]
+        #   The ID of the
+        #   [assistant](https://developers.openai.com/api/docs/assistants/migration) to use
+        #   to execute this run.
+        #
+        # @param instructions [String, nil]
+        #   Override the default system message of the assistant. This is useful for
+        #   modifying the behavior on a per-run basis.
+        #
+        # @param max_completion_tokens [Integer, nil]
+        #   The maximum number of completion tokens that may be used over the course of the
+        #   run. The run will make a best effort to use only the number of completion tokens
+        #   specified, across multiple turns of the run. If the run exceeds the number of
+        #   completion tokens specified, the run will end with status `incomplete`. See
+        #   `incomplete_details` for more info.
+        #
+        # @param max_prompt_tokens [Integer, nil]
+        #   The maximum number of prompt tokens that may be used over the course of the run.
+        #   The run will make a best effort to use only the number of prompt tokens
+        #   specified, across multiple turns of the run. If the run exceeds the number of
+        #   prompt tokens specified, the run will end with status `incomplete`. See
+        #   `incomplete_details` for more info.
+        #
+        # @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::ChatModel, nil]
+        #   The ID of the
+        #   [Model](https://developers.openai.com/api/reference/resources/models) to be used
+        #   to execute this run. If a value is provided here, it will override the model
+        #   associated with the assistant. If not, the model associated with the assistant
+        #   will be used.
+        #
+        # @param parallel_tool_calls [Boolean]
+        #   Whether to enable
+        #   [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
+        #   during tool use.
+        #
+        # @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 thread [OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread]
+        #   Options to create a new thread. If no thread is provided when running a request,
+        #   an empty thread will be created.
+        #
+        # @param tool_choice [Symbol, OpenAI::Models::Beta::AssistantToolChoiceOption::Auto, OpenAI::Models::Beta::AssistantToolChoice, nil]
+        #   Controls which (if any) tool is called by the model. `none` means the model will
+        #   not call any tools and instead generates a message. `auto` is the default value
+        #   and means the model can pick between generating a message or calling one or more
+        #   tools. `required` means the model must call one or more tools before responding
+        #   to the user. Specifying a particular tool like `{"type": "file_search"}` or
+        #   `{"type": "function", "function": {"name": "my_function"}}` forces the model to
+        #   call that tool.
+        #
+        # @param tool_resources [OpenAI::Models::Beta::ThreadCreateAndRunParams::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>, nil]
+        #   Override the tools the assistant can use for this run. This is useful for
+        #   modifying the behavior on a per-run basis.
+        #
+        # @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 truncation_strategy [OpenAI::Models::Beta::ThreadCreateAndRunParams::TruncationStrategy, nil]
+        #   Controls for how a thread will be truncated prior to the run. Use this to
+        #   control the initial context window of the run.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openai/resources/chat/completions/messages.rb

@@ -7,21 +7,23 @@ module OpenAI
         # Given a list of messages comprising a conversation, the model will return a
         # response.
         class Messages
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Chat::Completions::MessageListParams} for more details.
-          #
           # Get the messages in a stored chat completion. Only Chat Completions that have
           # been created with the `store` parameter set to `true` will be returned.
           #
           # @overload list(completion_id, after: nil, limit: nil, order: nil, request_options: {})
           #
-          # @param completion_id [String] The ID of the chat completion to retrieve messages from.
+          # @param completion_id [String]
+          #   The ID of the chat completion to retrieve messages from.
           #
-          # @param after [String] Identifier for the last message from the previous pagination request.
+          # @param after [String]
+          #   Identifier for the last message from the previous pagination request.
           #
-          # @param limit [Integer] Number of messages to retrieve.
+          # @param limit [Integer]
+          #   Number of messages to retrieve.
           #
-          # @param order [Symbol, OpenAI::Models::Chat::Completions::MessageListParams::Order] Sort order for messages by timestamp. Use `asc` for ascending order or `desc` fo
+          # @param order [Symbol, OpenAI::Models::Chat::Completions::MessageListParams::Order]
+          #   Sort order for messages by timestamp. Use `asc` for ascending order or `desc`
+          #   for descending order. Defaults to `asc`.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #