openai 0.16.0 → 0.17.0

data/rbi/openai/models/vector_store_search_params.rbi

@@ -157,6 +157,7 @@ module OpenAI
             )
           end
 
+        # Enable re-ranking; set to `none` to disable, which can help reduce latency.
         sig do
           returns(
             T.nilable(
@@ -188,7 +189,11 @@ module OpenAI
             score_threshold: Float
           ).returns(T.attached_class)
         end
-        def self.new(ranker: nil, score_threshold: nil)
+        def self.new(
+          # Enable re-ranking; set to `none` to disable, which can help reduce latency.
+          ranker: nil,
+          score_threshold: nil
+        )
         end
 
         sig do
@@ -203,6 +208,7 @@ module OpenAI
         def to_hash
         end
 
+        # Enable re-ranking; set to `none` to disable, which can help reduce latency.
         module Ranker
           extend OpenAI::Internal::Type::Enum
 
@@ -215,6 +221,11 @@ module OpenAI
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+          NONE =
+            T.let(
+              :none,
+              OpenAI::VectorStoreSearchParams::RankingOptions::Ranker::TaggedSymbol
+            )
           AUTO =
             T.let(
               :auto,

data/rbi/openai/models.rbi

@@ -55,6 +55,8 @@ module OpenAI
 
   CreateEmbeddingResponse = OpenAI::Models::CreateEmbeddingResponse
 
+  CustomToolInputFormat = OpenAI::Models::CustomToolInputFormat
+
   Embedding = OpenAI::Models::Embedding
 
   EmbeddingCreateParams = OpenAI::Models::EmbeddingCreateParams
@@ -172,6 +174,10 @@ module OpenAI
 
   ResponseFormatText = OpenAI::Models::ResponseFormatText
 
+  ResponseFormatTextGrammar = OpenAI::Models::ResponseFormatTextGrammar
+
+  ResponseFormatTextPython = OpenAI::Models::ResponseFormatTextPython
+
   Responses = OpenAI::Models::Responses
 
   ResponsesModel = OpenAI::Models::ResponsesModel

data/rbi/openai/resources/beta/assistants.rbi

@@ -60,12 +60,11 @@ module OpenAI
           metadata: nil,
           # The name of the assistant. The maximum length is 256 characters.
           name: nil,
-          # **o-series models only**
-          #
           # Constrains effort on reasoning for
           # [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-          # supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-          # result in faster responses and fewer tokens used on reasoning in a response.
+          # supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+          # effort can result in faster responses and fewer tokens used on reasoning in a
+          # response.
           reasoning_effort: nil,
           # Specifies the format that the model must output. Compatible with
           # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
@@ -188,12 +187,11 @@ module OpenAI
           model: nil,
           # The name of the assistant. The maximum length is 256 characters.
           name: nil,
-          # **o-series models only**
-          #
           # Constrains effort on reasoning for
           # [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-          # supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-          # result in faster responses and fewer tokens used on reasoning in a response.
+          # supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+          # effort can result in faster responses and fewer tokens used on reasoning in a
+          # response.
           reasoning_effort: nil,
           # Specifies the format that the model must output. Compatible with
           # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),

data/rbi/openai/resources/beta/threads/runs.rbi

@@ -123,12 +123,11 @@ module OpenAI
             # [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
             # during tool use.
             parallel_tool_calls: nil,
-            # Body param: **o-series models only**
-            #
-            # Constrains effort on reasoning for
+            # Body param: Constrains effort on reasoning for
             # [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-            # supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-            # result in faster responses and fewer tokens used on reasoning in a response.
+            # supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+            # effort can result in faster responses and fewer tokens used on reasoning in a
+            # response.
             reasoning_effort: nil,
             # Body param: Specifies the format that the model must output. Compatible with
             # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
@@ -303,12 +302,11 @@ module OpenAI
             # [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
             # during tool use.
             parallel_tool_calls: nil,
-            # Body param: **o-series models only**
-            #
-            # Constrains effort on reasoning for
+            # Body param: Constrains effort on reasoning for
             # [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-            # supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-            # result in faster responses and fewer tokens used on reasoning in a response.
+            # supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+            # effort can result in faster responses and fewer tokens used on reasoning in a
+            # response.
             reasoning_effort: nil,
             # Body param: Specifies the format that the model must output. Compatible with
             # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),

data/rbi/openai/resources/chat/completions.rbi

@@ -89,18 +89,25 @@ module OpenAI
             tool_choice:
               T.any(
                 OpenAI::Chat::ChatCompletionToolChoiceOption::Auto::OrSymbol,
-                OpenAI::Chat::ChatCompletionNamedToolChoice::OrHash
+                OpenAI::Chat::ChatCompletionAllowedToolChoice::OrHash,
+                OpenAI::Chat::ChatCompletionNamedToolChoice::OrHash,
+                OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::OrHash
               ),
             tools:
               T::Array[
                 T.any(
-                  OpenAI::Chat::ChatCompletionTool::OrHash,
-                  OpenAI::StructuredOutput::JsonSchemaConverter
+                  OpenAI::StructuredOutput::JsonSchemaConverter,
+                  OpenAI::Chat::ChatCompletionFunctionTool::OrHash,
+                  OpenAI::Chat::ChatCompletionCustomTool::OrHash
                 )
               ],
             top_logprobs: T.nilable(Integer),
             top_p: T.nilable(Float),
             user: String,
+            verbosity:
+              T.nilable(
+                OpenAI::Chat::CompletionCreateParams::Verbosity::OrSymbol
+              ),
             web_search_options:
               OpenAI::Chat::CompletionCreateParams::WebSearchOptions::OrHash,
             stream: T.noreturn,
@@ -210,12 +217,11 @@ module OpenAI
           # hit rates. Replaces the `user` field.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
           prompt_cache_key: nil,
-          # **o-series models only**
-          #
           # Constrains effort on reasoning for
           # [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-          # supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-          # result in faster responses and fewer tokens used on reasoning in a response.
+          # supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+          # effort can result in faster responses and fewer tokens used on reasoning in a
+          # response.
           reasoning_effort: nil,
           # An object specifying the format that the model must output.
           #
@@ -286,9 +292,9 @@ module OpenAI
           # `none` is the default when no tools are present. `auto` is the default if tools
           # are present.
           tool_choice: nil,
-          # A list of tools the model may call. Currently, only functions are supported as a
-          # tool. Use this to provide a list of functions the model may generate JSON inputs
-          # for. A max of 128 functions are supported.
+          # A list of tools the model may call. You can provide either
+          # [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)
+          # or [function tools](https://platform.openai.com/docs/guides/function-calling).
           tools: nil,
           # An integer between 0 and 20 specifying the number of most likely tokens to
           # return at each token position, each with an associated log probability.
@@ -306,6 +312,10 @@ module OpenAI
           # similar requests and to help OpenAI detect and prevent abuse.
           # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
           user: nil,
+          # Constrains the verbosity of the model's response. Lower values will result in
+          # more concise responses, while higher values will result in more verbose
+          # responses. Currently supported values are `low`, `medium`, and `high`.
+          verbosity: nil,
           # This tool searches the web for relevant results to use in a response. Learn more
           # about the
           # [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
@@ -398,12 +408,24 @@ module OpenAI
             tool_choice:
               T.any(
                 OpenAI::Chat::ChatCompletionToolChoiceOption::Auto::OrSymbol,
-                OpenAI::Chat::ChatCompletionNamedToolChoice::OrHash
+                OpenAI::Chat::ChatCompletionAllowedToolChoice::OrHash,
+                OpenAI::Chat::ChatCompletionNamedToolChoice::OrHash,
+                OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::OrHash
               ),
-            tools: T::Array[OpenAI::Chat::ChatCompletionTool::OrHash],
+            tools:
+              T::Array[
+                T.any(
+                  OpenAI::Chat::ChatCompletionFunctionTool::OrHash,
+                  OpenAI::Chat::ChatCompletionCustomTool::OrHash
+                )
+              ],
             top_logprobs: T.nilable(Integer),
             top_p: T.nilable(Float),
             user: String,
+            verbosity:
+              T.nilable(
+                OpenAI::Chat::CompletionCreateParams::Verbosity::OrSymbol
+              ),
             web_search_options:
               OpenAI::Chat::CompletionCreateParams::WebSearchOptions::OrHash,
             stream: T.noreturn,
@@ -513,12 +535,11 @@ module OpenAI
           # hit rates. Replaces the `user` field.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
           prompt_cache_key: nil,
-          # **o-series models only**
-          #
           # Constrains effort on reasoning for
           # [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-          # supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-          # result in faster responses and fewer tokens used on reasoning in a response.
+          # supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+          # effort can result in faster responses and fewer tokens used on reasoning in a
+          # response.
           reasoning_effort: nil,
           # An object specifying the format that the model must output.
           #
@@ -589,9 +610,9 @@ module OpenAI
           # `none` is the default when no tools are present. `auto` is the default if tools
           # are present.
           tool_choice: nil,
-          # A list of tools the model may call. Currently, only functions are supported as a
-          # tool. Use this to provide a list of functions the model may generate JSON inputs
-          # for. A max of 128 functions are supported.
+          # A list of tools the model may call. You can provide either
+          # [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)
+          # or [function tools](https://platform.openai.com/docs/guides/function-calling).
           tools: nil,
           # An integer between 0 and 20 specifying the number of most likely tokens to
           # return at each token position, each with an associated log probability.
@@ -609,6 +630,10 @@ module OpenAI
           # similar requests and to help OpenAI detect and prevent abuse.
           # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
           user: nil,
+          # Constrains the verbosity of the model's response. Lower values will result in
+          # more concise responses, while higher values will result in more verbose
+          # responses. Currently supported values are `low`, `medium`, and `high`.
+          verbosity: nil,
           # This tool searches the web for relevant results to use in a response. Learn more
           # about the
           # [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).