openai 0.15.0 → 0.17.0

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

@@ -65,6 +65,7 @@ module OpenAI
             prediction:
               T.nilable(OpenAI::Chat::ChatCompletionPredictionContent::OrHash),
             presence_penalty: T.nilable(Float),
+            prompt_cache_key: String,
             reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
             response_format:
               T.any(
@@ -73,6 +74,7 @@ module OpenAI
                 OpenAI::StructuredOutput::JsonSchemaConverter,
                 OpenAI::ResponseFormatJSONObject::OrHash
               ),
+            safety_identifier: String,
             seed: T.nilable(Integer),
             service_tier:
               T.nilable(
@@ -87,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,
@@ -204,12 +213,15 @@ module OpenAI
           # whether they appear in the text so far, increasing the model's likelihood to
           # talk about new topics.
           presence_penalty: nil,
-          # **o-series models only**
-          #
+          # Used by OpenAI to cache responses for similar requests to optimize your cache
+          # hit rates. Replaces the `user` field.
+          # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+          prompt_cache_key: nil,
           # 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.
           #
@@ -222,6 +234,12 @@ module OpenAI
           # ensures the message the model generates is valid JSON. Using `json_schema` is
           # preferred for models that support it.
           response_format: nil,
+          # A stable identifier used to help detect users of your application that may be
+          # violating OpenAI's usage policies. The IDs should be a string that uniquely
+          # identifies each user. We recommend hashing their username or email address, in
+          # order to avoid sending us any identifying information.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+          safety_identifier: nil,
           # This feature is in Beta. If specified, our system will make a best effort to
           # sample deterministically, such that repeated requests with the same `seed` and
           # parameters should return the same result. Determinism is not guaranteed, and you
@@ -274,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.
@@ -288,10 +306,16 @@ module OpenAI
           #
           # We generally recommend altering this or `temperature` but not both.
           top_p: nil,
-          # A stable identifier for your end-users. Used to boost cache hit rates by better
-          # bucketing similar requests and to help OpenAI detect and prevent abuse.
-          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+          # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+          # `prompt_cache_key` instead to maintain caching optimizations. A stable
+          # identifier for your end-users. Used to boost cache hit rates by better bucketing
+          # 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).
@@ -361,6 +385,7 @@ module OpenAI
             prediction:
               T.nilable(OpenAI::Chat::ChatCompletionPredictionContent::OrHash),
             presence_penalty: T.nilable(Float),
+            prompt_cache_key: String,
             reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
             response_format:
               T.any(
@@ -368,6 +393,7 @@ module OpenAI
                 OpenAI::ResponseFormatJSONSchema::OrHash,
                 OpenAI::ResponseFormatJSONObject::OrHash
               ),
+            safety_identifier: String,
             seed: T.nilable(Integer),
             service_tier:
               T.nilable(
@@ -382,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,
@@ -493,12 +531,15 @@ module OpenAI
           # whether they appear in the text so far, increasing the model's likelihood to
           # talk about new topics.
           presence_penalty: nil,
-          # **o-series models only**
-          #
+          # Used by OpenAI to cache responses for similar requests to optimize your cache
+          # hit rates. Replaces the `user` field.
+          # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+          prompt_cache_key: nil,
           # 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.
           #
@@ -511,6 +552,12 @@ module OpenAI
           # ensures the message the model generates is valid JSON. Using `json_schema` is
           # preferred for models that support it.
           response_format: nil,
+          # A stable identifier used to help detect users of your application that may be
+          # violating OpenAI's usage policies. The IDs should be a string that uniquely
+          # identifies each user. We recommend hashing their username or email address, in
+          # order to avoid sending us any identifying information.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+          safety_identifier: nil,
           # This feature is in Beta. If specified, our system will make a best effort to
           # sample deterministically, such that repeated requests with the same `seed` and
           # parameters should return the same result. Determinism is not guaranteed, and you
@@ -563,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.
@@ -577,10 +624,16 @@ module OpenAI
           #
           # We generally recommend altering this or `temperature` but not both.
           top_p: nil,
-          # A stable identifier for your end-users. Used to boost cache hit rates by better
-          # bucketing similar requests and to help OpenAI detect and prevent abuse.
-          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+          # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+          # `prompt_cache_key` instead to maintain caching optimizations. A stable
+          # identifier for your end-users. Used to boost cache hit rates by better bucketing
+          # 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).