openai 0.6.0 → 0.7.0

data/rbi/openai/models/evals/run_list_response.rbi

@@ -1052,6 +1052,66 @@ module OpenAI
               sig { params(temperature: Float).void }
               attr_writer :temperature
 
+              # Configuration options for a text response from the model. Can be plain text or
+              # structured JSON data. Learn more:
+              #
+              # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+              # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+              sig do
+                returns(
+                  T.nilable(
+                    OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text
+                  )
+                )
+              end
+              attr_reader :text
+
+              sig do
+                params(
+                  text:
+                    OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text::OrHash
+                ).void
+              end
+              attr_writer :text
+
+              # 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.
+              #
+              # The two categories of tools you can provide the model are:
+              #
+              # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
+              #   capabilities, like
+              #   [web search](https://platform.openai.com/docs/guides/tools-web-search) or
+              #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
+              #   Learn more about
+              #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+              # - **Function calls (custom tools)**: Functions that are defined by you, enabling
+              #   the model to call your own code. Learn more about
+              #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+              sig do
+                returns(T.nilable(T::Array[OpenAI::Responses::Tool::Variants]))
+              end
+              attr_reader :tools
+
+              sig do
+                params(
+                  tools:
+                    T::Array[
+                      T.any(
+                        OpenAI::Responses::FunctionTool::OrHash,
+                        OpenAI::Responses::FileSearchTool::OrHash,
+                        OpenAI::Responses::ComputerTool::OrHash,
+                        OpenAI::Responses::Tool::Mcp::OrHash,
+                        OpenAI::Responses::Tool::CodeInterpreter::OrHash,
+                        OpenAI::Responses::Tool::ImageGeneration::OrHash,
+                        OpenAI::Responses::Tool::LocalShell::OrHash,
+                        OpenAI::Responses::WebSearchTool::OrHash
+                      )
+                    ]
+                ).void
+              end
+              attr_writer :tools
+
               # An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
               sig { returns(T.nilable(Float)) }
               attr_reader :top_p
@@ -1064,6 +1124,21 @@ module OpenAI
                   max_completion_tokens: Integer,
                   seed: Integer,
                   temperature: Float,
+                  text:
+                    OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text::OrHash,
+                  tools:
+                    T::Array[
+                      T.any(
+                        OpenAI::Responses::FunctionTool::OrHash,
+                        OpenAI::Responses::FileSearchTool::OrHash,
+                        OpenAI::Responses::ComputerTool::OrHash,
+                        OpenAI::Responses::Tool::Mcp::OrHash,
+                        OpenAI::Responses::Tool::CodeInterpreter::OrHash,
+                        OpenAI::Responses::Tool::ImageGeneration::OrHash,
+                        OpenAI::Responses::Tool::LocalShell::OrHash,
+                        OpenAI::Responses::WebSearchTool::OrHash
+                      )
+                    ],
                   top_p: Float
                 ).returns(T.attached_class)
               end
@@ -1074,6 +1149,27 @@ module OpenAI
                 seed: nil,
                 # A higher temperature increases randomness in the outputs.
                 temperature: nil,
+                # Configuration options for a text response from the model. Can be plain text or
+                # structured JSON data. Learn more:
+                #
+                # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+                # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+                text: nil,
+                # 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.
+                #
+                # The two categories of tools you can provide the model are:
+                #
+                # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
+                #   capabilities, like
+                #   [web search](https://platform.openai.com/docs/guides/tools-web-search) or
+                #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
+                #   Learn more about
+                #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+                # - **Function calls (custom tools)**: Functions that are defined by you, enabling
+                #   the model to call your own code. Learn more about
+                #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+                tools: nil,
                 # An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
                 top_p: nil
               )
@@ -1085,12 +1181,103 @@ module OpenAI
                     max_completion_tokens: Integer,
                     seed: Integer,
                     temperature: Float,
+                    text:
+                      OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text,
+                    tools: T::Array[OpenAI::Responses::Tool::Variants],
                     top_p: Float
                   }
                 )
               end
               def to_hash
               end
+
+              class Text < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # An object specifying the format that the model must output.
+                #
+                # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+                # ensures the model will match your supplied JSON schema. Learn more in the
+                # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+                #
+                # The default format is `{ "type": "text" }` with no additional options.
+                #
+                # **Not recommended for gpt-4o and newer models:**
+                #
+                # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+                # ensures the message the model generates is valid JSON. Using `json_schema` is
+                # preferred for models that support it.
+                sig do
+                  returns(
+                    T.nilable(
+                      OpenAI::Responses::ResponseFormatTextConfig::Variants
+                    )
+                  )
+                end
+                attr_reader :format_
+
+                sig do
+                  params(
+                    format_:
+                      T.any(
+                        OpenAI::ResponseFormatText::OrHash,
+                        OpenAI::Responses::ResponseFormatTextJSONSchemaConfig::OrHash,
+                        OpenAI::ResponseFormatJSONObject::OrHash
+                      )
+                  ).void
+                end
+                attr_writer :format_
+
+                # Configuration options for a text response from the model. Can be plain text or
+                # structured JSON data. Learn more:
+                #
+                # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+                # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+                sig do
+                  params(
+                    format_:
+                      T.any(
+                        OpenAI::ResponseFormatText::OrHash,
+                        OpenAI::Responses::ResponseFormatTextJSONSchemaConfig::OrHash,
+                        OpenAI::ResponseFormatJSONObject::OrHash
+                      )
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # An object specifying the format that the model must output.
+                  #
+                  # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+                  # ensures the model will match your supplied JSON schema. Learn more in the
+                  # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+                  #
+                  # The default format is `{ "type": "text" }` with no additional options.
+                  #
+                  # **Not recommended for gpt-4o and newer models:**
+                  #
+                  # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+                  # ensures the message the model generates is valid JSON. Using `json_schema` is
+                  # preferred for models that support it.
+                  format_: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      format_:
+                        OpenAI::Responses::ResponseFormatTextConfig::Variants
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
             end
           end
 

data/rbi/openai/models/evals/run_retrieve_response.rbi

@@ -1058,6 +1058,66 @@ module OpenAI
               sig { params(temperature: Float).void }
               attr_writer :temperature
 
+              # Configuration options for a text response from the model. Can be plain text or
+              # structured JSON data. Learn more:
+              #
+              # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+              # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+              sig do
+                returns(
+                  T.nilable(
+                    OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text
+                  )
+                )
+              end
+              attr_reader :text
+
+              sig do
+                params(
+                  text:
+                    OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text::OrHash
+                ).void
+              end
+              attr_writer :text
+
+              # 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.
+              #
+              # The two categories of tools you can provide the model are:
+              #
+              # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
+              #   capabilities, like
+              #   [web search](https://platform.openai.com/docs/guides/tools-web-search) or
+              #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
+              #   Learn more about
+              #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+              # - **Function calls (custom tools)**: Functions that are defined by you, enabling
+              #   the model to call your own code. Learn more about
+              #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+              sig do
+                returns(T.nilable(T::Array[OpenAI::Responses::Tool::Variants]))
+              end
+              attr_reader :tools
+
+              sig do
+                params(
+                  tools:
+                    T::Array[
+                      T.any(
+                        OpenAI::Responses::FunctionTool::OrHash,
+                        OpenAI::Responses::FileSearchTool::OrHash,
+                        OpenAI::Responses::ComputerTool::OrHash,
+                        OpenAI::Responses::Tool::Mcp::OrHash,
+                        OpenAI::Responses::Tool::CodeInterpreter::OrHash,
+                        OpenAI::Responses::Tool::ImageGeneration::OrHash,
+                        OpenAI::Responses::Tool::LocalShell::OrHash,
+                        OpenAI::Responses::WebSearchTool::OrHash
+                      )
+                    ]
+                ).void
+              end
+              attr_writer :tools
+
               # An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
               sig { returns(T.nilable(Float)) }
               attr_reader :top_p
@@ -1070,6 +1130,21 @@ module OpenAI
                   max_completion_tokens: Integer,
                   seed: Integer,
                   temperature: Float,
+                  text:
+                    OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text::OrHash,
+                  tools:
+                    T::Array[
+                      T.any(
+                        OpenAI::Responses::FunctionTool::OrHash,
+                        OpenAI::Responses::FileSearchTool::OrHash,
+                        OpenAI::Responses::ComputerTool::OrHash,
+                        OpenAI::Responses::Tool::Mcp::OrHash,
+                        OpenAI::Responses::Tool::CodeInterpreter::OrHash,
+                        OpenAI::Responses::Tool::ImageGeneration::OrHash,
+                        OpenAI::Responses::Tool::LocalShell::OrHash,
+                        OpenAI::Responses::WebSearchTool::OrHash
+                      )
+                    ],
                   top_p: Float
                 ).returns(T.attached_class)
               end
@@ -1080,6 +1155,27 @@ module OpenAI
                 seed: nil,
                 # A higher temperature increases randomness in the outputs.
                 temperature: nil,
+                # Configuration options for a text response from the model. Can be plain text or
+                # structured JSON data. Learn more:
+                #
+                # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+                # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+                text: nil,
+                # 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.
+                #
+                # The two categories of tools you can provide the model are:
+                #
+                # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
+                #   capabilities, like
+                #   [web search](https://platform.openai.com/docs/guides/tools-web-search) or
+                #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
+                #   Learn more about
+                #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+                # - **Function calls (custom tools)**: Functions that are defined by you, enabling
+                #   the model to call your own code. Learn more about
+                #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+                tools: nil,
                 # An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
                 top_p: nil
               )
@@ -1091,12 +1187,103 @@ module OpenAI
                     max_completion_tokens: Integer,
                     seed: Integer,
                     temperature: Float,
+                    text:
+                      OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text,
+                    tools: T::Array[OpenAI::Responses::Tool::Variants],
                     top_p: Float
                   }
                 )
               end
               def to_hash
               end
+
+              class Text < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # An object specifying the format that the model must output.
+                #
+                # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+                # ensures the model will match your supplied JSON schema. Learn more in the
+                # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+                #
+                # The default format is `{ "type": "text" }` with no additional options.
+                #
+                # **Not recommended for gpt-4o and newer models:**
+                #
+                # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+                # ensures the message the model generates is valid JSON. Using `json_schema` is
+                # preferred for models that support it.
+                sig do
+                  returns(
+                    T.nilable(
+                      OpenAI::Responses::ResponseFormatTextConfig::Variants
+                    )
+                  )
+                end
+                attr_reader :format_
+
+                sig do
+                  params(
+                    format_:
+                      T.any(
+                        OpenAI::ResponseFormatText::OrHash,
+                        OpenAI::Responses::ResponseFormatTextJSONSchemaConfig::OrHash,
+                        OpenAI::ResponseFormatJSONObject::OrHash
+                      )
+                  ).void
+                end
+                attr_writer :format_
+
+                # Configuration options for a text response from the model. Can be plain text or
+                # structured JSON data. Learn more:
+                #
+                # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+                # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+                sig do
+                  params(
+                    format_:
+                      T.any(
+                        OpenAI::ResponseFormatText::OrHash,
+                        OpenAI::Responses::ResponseFormatTextJSONSchemaConfig::OrHash,
+                        OpenAI::ResponseFormatJSONObject::OrHash
+                      )
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # An object specifying the format that the model must output.
+                  #
+                  # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+                  # ensures the model will match your supplied JSON schema. Learn more in the
+                  # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+                  #
+                  # The default format is `{ "type": "text" }` with no additional options.
+                  #
+                  # **Not recommended for gpt-4o and newer models:**
+                  #
+                  # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+                  # ensures the message the model generates is valid JSON. Using `json_schema` is
+                  # preferred for models that support it.
+                  format_: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      format_:
+                        OpenAI::Responses::ResponseFormatTextConfig::Variants
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
             end
           end
 

data/sig/openai/models/evals/create_eval_completions_run_data_source.rbs

@@ -303,8 +303,10 @@ module OpenAI
         type sampling_params =
           {
             max_completion_tokens: Integer,
+            response_format: OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::response_format,
             seed: Integer,
             temperature: Float,
+            tools: ::Array[OpenAI::Chat::ChatCompletionTool],
             top_p: Float
           }
 
@@ -313,6 +315,12 @@ module OpenAI
 
           def max_completion_tokens=: (Integer) -> Integer
 
+          attr_reader response_format: OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::response_format?
+
+          def response_format=: (
+            OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::response_format
+          ) -> OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::response_format
+
           attr_reader seed: Integer?
 
           def seed=: (Integer) -> Integer
@@ -321,23 +329,44 @@ module OpenAI
 
           def temperature=: (Float) -> Float
 
+          attr_reader tools: ::Array[OpenAI::Chat::ChatCompletionTool]?
+
+          def tools=: (
+            ::Array[OpenAI::Chat::ChatCompletionTool]
+          ) -> ::Array[OpenAI::Chat::ChatCompletionTool]
+
           attr_reader top_p: Float?
 
           def top_p=: (Float) -> Float
 
           def initialize: (
             ?max_completion_tokens: Integer,
+            ?response_format: OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::response_format,
             ?seed: Integer,
             ?temperature: Float,
+            ?tools: ::Array[OpenAI::Chat::ChatCompletionTool],
             ?top_p: Float
           ) -> void
 
           def to_hash: -> {
             max_completion_tokens: Integer,
+            response_format: OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::response_format,
             seed: Integer,
             temperature: Float,
+            tools: ::Array[OpenAI::Chat::ChatCompletionTool],
             top_p: Float
           }
+
+          type response_format =
+            OpenAI::ResponseFormatText
+            | OpenAI::ResponseFormatJSONSchema
+            | OpenAI::ResponseFormatJSONObject
+
+          module ResponseFormat
+            extend OpenAI::Internal::Type::Union
+
+            def self?.variants: -> ::Array[OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::response_format]
+          end
         end
       end
     end

data/sig/openai/models/evals/run_cancel_response.rbs

@@ -427,6 +427,8 @@ module OpenAI
                 max_completion_tokens: Integer,
                 seed: Integer,
                 temperature: Float,
+                text: OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text,
+                tools: ::Array[OpenAI::Models::Responses::tool],
                 top_p: Float
               }
 
@@ -443,6 +445,18 @@ module OpenAI
 
               def temperature=: (Float) -> Float
 
+              attr_reader text: OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text?
+
+              def text=: (
+                OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text
+              ) -> OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text
+
+              attr_reader tools: ::Array[OpenAI::Models::Responses::tool]?
+
+              def tools=: (
+                ::Array[OpenAI::Models::Responses::tool]
+              ) -> ::Array[OpenAI::Models::Responses::tool]
+
               attr_reader top_p: Float?
 
               def top_p=: (Float) -> Float
@@ -451,6 +465,8 @@ module OpenAI
                 ?max_completion_tokens: Integer,
                 ?seed: Integer,
                 ?temperature: Float,
+                ?text: OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text,
+                ?tools: ::Array[OpenAI::Models::Responses::tool],
                 ?top_p: Float
               ) -> void
 
@@ -458,8 +474,31 @@ module OpenAI
                 max_completion_tokens: Integer,
                 seed: Integer,
                 temperature: Float,
+                text: OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text,
+                tools: ::Array[OpenAI::Models::Responses::tool],
                 top_p: Float
               }
+
+              type text =
+                {
+                  format_: OpenAI::Models::Responses::response_format_text_config
+                }
+
+              class Text < OpenAI::Internal::Type::BaseModel
+                attr_reader format_: OpenAI::Models::Responses::response_format_text_config?
+
+                def format_=: (
+                  OpenAI::Models::Responses::response_format_text_config
+                ) -> OpenAI::Models::Responses::response_format_text_config
+
+                def initialize: (
+                  ?format_: OpenAI::Models::Responses::response_format_text_config
+                ) -> void
+
+                def to_hash: -> {
+                  format_: OpenAI::Models::Responses::response_format_text_config
+                }
+              end
             end
           end
 

data/sig/openai/models/evals/run_create_params.rbs

@@ -390,6 +390,8 @@ module OpenAI
                 max_completion_tokens: Integer,
                 seed: Integer,
                 temperature: Float,
+                text: OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text,
+                tools: ::Array[OpenAI::Models::Responses::tool],
                 top_p: Float
               }
 
@@ -406,6 +408,18 @@ module OpenAI
 
               def temperature=: (Float) -> Float
 
+              attr_reader text: OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text?
+
+              def text=: (
+                OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text
+              ) -> OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text
+
+              attr_reader tools: ::Array[OpenAI::Models::Responses::tool]?
+
+              def tools=: (
+                ::Array[OpenAI::Models::Responses::tool]
+              ) -> ::Array[OpenAI::Models::Responses::tool]
+
               attr_reader top_p: Float?
 
               def top_p=: (Float) -> Float
@@ -414,6 +428,8 @@ module OpenAI
                 ?max_completion_tokens: Integer,
                 ?seed: Integer,
                 ?temperature: Float,
+                ?text: OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text,
+                ?tools: ::Array[OpenAI::Models::Responses::tool],
                 ?top_p: Float
               ) -> void
 
@@ -421,8 +437,31 @@ module OpenAI
                 max_completion_tokens: Integer,
                 seed: Integer,
                 temperature: Float,
+                text: OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text,
+                tools: ::Array[OpenAI::Models::Responses::tool],
                 top_p: Float
               }
+
+              type text =
+                {
+                  format_: OpenAI::Models::Responses::response_format_text_config
+                }
+
+              class Text < OpenAI::Internal::Type::BaseModel
+                attr_reader format_: OpenAI::Models::Responses::response_format_text_config?
+
+                def format_=: (
+                  OpenAI::Models::Responses::response_format_text_config
+                ) -> OpenAI::Models::Responses::response_format_text_config
+
+                def initialize: (
+                  ?format_: OpenAI::Models::Responses::response_format_text_config
+                ) -> void
+
+                def to_hash: -> {
+                  format_: OpenAI::Models::Responses::response_format_text_config
+                }
+              end
             end
           end