openai 0.87.0 → 0.88.0

data/lib/openai/models/eval_update_params.rb

@@ -30,14 +30,18 @@ module OpenAI
       optional :name, String
 
       # @!method initialize(eval_id:, metadata: nil, name: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::EvalUpdateParams} for more details.
-      #
       #   @param eval_id [String]
       #
-      #   @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.
+      #
+      #     Keys are strings with a maximum length of 64 characters. Values are strings with
+      #     a maximum length of 512 characters.
       #
-      #   @param name [String] Rename the evaluation.
+      #   @param name [String]
+      #     Rename the evaluation.
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/openai/models/eval_update_response.rb

@@ -55,9 +55,6 @@ module OpenAI
       )
 
       # @!method initialize(id:, created_at:, data_source_config:, metadata:, name:, testing_criteria:, object: :eval)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::EvalUpdateResponse} for more details.
-      #
       #   An Eval object with a data source config and testing criteria. An Eval
       #   represents a task to be done for your LLM integration. Like:
       #
@@ -65,19 +62,31 @@ module OpenAI
       #   - See how well my chatbot handles customer support
       #   - Check if o4-mini is better at my usecase than gpt-6-astra
       #
-      #   @param id [String] Unique identifier for the evaluation.
+      #   @param id [String]
+      #     Unique identifier for the evaluation.
+      #
+      #   @param created_at [Integer]
+      #     The Unix timestamp (in seconds) for when the eval was created.
       #
-      #   @param created_at [Integer] The Unix timestamp (in seconds) for when the eval was created.
+      #   @param data_source_config [OpenAI::Models::EvalCustomDataSourceConfig, OpenAI::Models::EvalUpdateResponse::DataSourceConfig::Logs, OpenAI::Models::EvalStoredCompletionsDataSourceConfig]
+      #     Configuration of data sources used in runs of the evaluation.
       #
-      #   @param data_source_config [OpenAI::Models::EvalCustomDataSourceConfig, OpenAI::Models::EvalUpdateResponse::DataSourceConfig::Logs, OpenAI::Models::EvalStoredCompletionsDataSourceConfig] Configuration of data sources used in runs of the evaluation.
+      #   @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 name [String] The name of the evaluation.
+      #   @param name [String]
+      #     The name of the evaluation.
       #
-      #   @param testing_criteria [Array<OpenAI::Models::Graders::LabelModelGrader, OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::EvalUpdateResponse::TestingCriterion::EvalGraderTextSimilarity, OpenAI::Models::EvalUpdateResponse::TestingCriterion::EvalGraderPython, OpenAI::Models::EvalUpdateResponse::TestingCriterion::EvalGraderScoreModel>] A list of testing criteria.
+      #   @param testing_criteria [Array<OpenAI::Models::Graders::LabelModelGrader, OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::EvalUpdateResponse::TestingCriterion::EvalGraderTextSimilarity, OpenAI::Models::EvalUpdateResponse::TestingCriterion::EvalGraderPython, OpenAI::Models::EvalUpdateResponse::TestingCriterion::EvalGraderScoreModel>]
+      #     A list of testing criteria.
       #
-      #   @param object [Symbol, :eval] The object type.
+      #   @param object [Symbol, :eval]
+      #     The object type.
 
       # Configuration of data sources used in runs of the evaluation.
       #
@@ -128,20 +137,26 @@ module OpenAI
           optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
           # @!method initialize(schema:, metadata: nil, type: :logs)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::EvalUpdateResponse::DataSourceConfig::Logs} for more details.
-          #
           #   A LogsDataSourceConfig which specifies the metadata property of your logs query.
           #   This is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc. The
           #   schema returned by this data source config is used to defined what variables are
           #   available in your evals. `item` and `sample` are both defined when using this
           #   data source config.
           #
-          #   @param schema [Hash{Symbol=>Object}] The json schema for the run data source items.
+          #   @param schema [Hash{Symbol=>Object}]
+          #     The json schema for the run data source items. Learn how to build JSON schemas
+          #     [here](https://json-schema.org/).
           #
-          #   @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 type [Symbol, :logs] The type of data source. Always `logs`.
+          #     Keys are strings with a maximum length of 64 characters. Values are strings with
+          #     a maximum length of 512 characters.
+          #
+          #   @param type [Symbol, :logs]
+          #     The type of data source. Always `logs`.
         end
 
         # @!method self.variants
@@ -177,23 +192,26 @@ module OpenAI
           required :pass_threshold, Float
 
           # @!method initialize(evaluation_metric:, input:, name:, reference:, pass_threshold:, type: :text_similarity)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::EvalUpdateResponse::TestingCriterion::EvalGraderTextSimilarity}
-          #   for more details.
-          #
           #   A TextSimilarityGrader object which grades text based on similarity metrics.
           #
-          #   @param evaluation_metric [Symbol, OpenAI::Models::Graders::TextSimilarityGrader::EvaluationMetric] The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`,
+          #   @param evaluation_metric [Symbol, OpenAI::Models::Graders::TextSimilarityGrader::EvaluationMetric]
+          #     The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, `gleu`,
+          #     `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.
           #
-          #   @param input [String] The text being graded.
+          #   @param input [String]
+          #     The text being graded.
           #
-          #   @param name [String] The name of the grader.
+          #   @param name [String]
+          #     The name of the grader.
           #
-          #   @param reference [String] The text being graded against.
+          #   @param reference [String]
+          #     The text being graded against.
           #
-          #   @param pass_threshold [Float] The threshold for the score.
+          #   @param pass_threshold [Float]
+          #     The threshold for the score.
           #
-          #   @param type [Symbol, :text_similarity] The type of grader.
+          #   @param type [Symbol, :text_similarity]
+          #     The type of grader.
         end
 
         class EvalGraderPython < OpenAI::Models::Graders::PythonGrader
@@ -206,15 +224,20 @@ module OpenAI
           # @!method initialize(name:, source:, image_tag: nil, pass_threshold: nil, type: :python)
           #   A PythonGrader object that runs a python script on the input.
           #
-          #   @param name [String] The name of the grader.
+          #   @param name [String]
+          #     The name of the grader.
           #
-          #   @param source [String] The source code of the python script.
+          #   @param source [String]
+          #     The source code of the python script.
           #
-          #   @param image_tag [String] The image tag to use for the python script.
+          #   @param image_tag [String]
+          #     The image tag to use for the python script.
           #
-          #   @param pass_threshold [Float] The threshold for the score.
+          #   @param pass_threshold [Float]
+          #     The threshold for the score.
           #
-          #   @param type [Symbol, :python] The object type, which is always `python`.
+          #   @param type [Symbol, :python]
+          #     The object type, which is always `python`.
         end
 
         class EvalGraderScoreModel < OpenAI::Models::Graders::ScoreModelGrader
@@ -225,25 +248,29 @@ module OpenAI
           optional :pass_threshold, Float
 
           # @!method initialize(input:, model:, name:, range: nil, sampling_params: nil, pass_threshold: nil, type: :score_model)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::EvalUpdateResponse::TestingCriterion::EvalGraderScoreModel} for
-          #   more details.
-          #
           #   A ScoreModelGrader object that uses a model to assign a score to the input.
           #
-          #   @param input [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>] The input messages evaluated by the grader. Supports text, output text, input im
+          #   @param input [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>]
+          #     The input messages evaluated by the grader. Supports text, output text, input
+          #     image, and input audio content blocks, and may include template strings.
           #
-          #   @param model [String] The model to use for the evaluation.
+          #   @param model [String]
+          #     The model to use for the evaluation.
           #
-          #   @param name [String] The name of the grader.
+          #   @param name [String]
+          #     The name of the grader.
           #
-          #   @param range [Array<Float>] The range of the score. Defaults to `[0, 1]`.
+          #   @param range [Array<Float>]
+          #     The range of the score. Defaults to `[0, 1]`.
           #
-          #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams] The sampling parameters for the model.
+          #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams]
+          #     The sampling parameters for the model.
           #
-          #   @param pass_threshold [Float] The threshold for the score.
+          #   @param pass_threshold [Float]
+          #     The threshold for the score.
           #
-          #   @param type [Symbol, :score_model] The object type, which is always `score_model`.
+          #   @param type [Symbol, :score_model]
+          #     The object type, which is always `score_model`.
         end
 
         # @!method self.variants

data/lib/openai/models/evals/create_eval_completions_run_data_source.rb

@@ -37,18 +37,22 @@ module OpenAI
         optional :sampling_params, -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::SamplingParams }
 
         # @!method initialize(source:, type:, input_messages: nil, model: nil, sampling_params: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource} for more details.
-        #
         #   A CompletionsRunDataSource object describing a model sampling configuration.
         #
-        #   @param source [OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::FileContent, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::FileID, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::StoredCompletions] Determines what populates the `item` namespace in this run's data source.
+        #   @param source [OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::FileContent, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::FileID, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::StoredCompletions]
+        #     Determines what populates the `item` namespace in this run's data source.
         #
-        #   @param type [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Type] The type of run data source. Always `completions`.
+        #   @param type [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Type]
+        #     The type of run data source. Always `completions`.
         #
-        #   @param input_messages [OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::ItemReference] Used when sampling from a model. Dictates the structure of the messages passed i
+        #   @param input_messages [OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::ItemReference]
+        #     Used when sampling from a model. Dictates the structure of the messages passed
+        #     into the model. Can either be a reference to a prebuilt trajectory (ie,
+        #     `item.input_trajectory`), or a template with variable references to the `item`
+        #     namespace.
         #
-        #   @param model [String] The name of the model to use for generating completions (e.g. "o3-mini").
+        #   @param model [String]
+        #     The name of the model to use for generating completions (e.g. "o3-mini").
         #
         #   @param sampling_params [OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams]
 
@@ -91,10 +95,11 @@ module OpenAI
             required :type, const: :file_content
 
             # @!method initialize(content:, type: :file_content)
-            #   @param content [Array<OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::FileContent::Content>] The content of the jsonl file.
+            #   @param content [Array<OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::FileContent::Content>]
+            #     The content of the jsonl file.
             #
-            #   @param type [Symbol, :file_content] The type of jsonl source. Always `file_content`.
-
+            #   @param type [Symbol, :file_content]
+            #     The type of jsonl source. Always `file_content`.
             class Content < OpenAI::Internal::Type::BaseModel
               # @!attribute item
               #
@@ -126,9 +131,11 @@ module OpenAI
             required :type, const: :file_id
 
             # @!method initialize(id:, type: :file_id)
-            #   @param id [String] The identifier of the file.
+            #   @param id [String]
+            #     The identifier of the file.
             #
-            #   @param type [Symbol, :file_id] The type of jsonl source. Always `file_id`.
+            #   @param type [Symbol, :file_id]
+            #     The type of jsonl source. Always `file_id`.
           end
 
           class StoredCompletions < OpenAI::Internal::Type::BaseModel
@@ -174,23 +181,30 @@ module OpenAI
             optional :model, String, nil?: true
 
             # @!method initialize(created_after: nil, created_before: nil, limit: nil, metadata: nil, model: nil, type: :stored_completions)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::StoredCompletions}
-            #   for more details.
-            #
             #   A StoredCompletionsRunDataSource configuration describing a set of filters
             #
-            #   @param created_after [Integer, nil] An optional Unix timestamp to filter items created after this time.
+            #   @param created_after [Integer, nil]
+            #     An optional Unix timestamp to filter items created after this time.
             #
-            #   @param created_before [Integer, nil] An optional Unix timestamp to filter items created before this time.
+            #   @param created_before [Integer, nil]
+            #     An optional Unix timestamp to filter items created before this time.
             #
-            #   @param limit [Integer, nil] An optional maximum number of items to return.
+            #   @param limit [Integer, nil]
+            #     An optional maximum number of items to return.
             #
-            #   @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 model [String, nil] An optional model to filter by (e.g., 'gpt-6-astra').
+            #     Keys are strings with a maximum length of 64 characters. Values are strings with
+            #     a maximum length of 512 characters.
             #
-            #   @param type [Symbol, :stored_completions] The type of source. Always `stored_completions`.
+            #   @param model [String, nil]
+            #     An optional model to filter by (e.g., 'gpt-6-astra').
+            #
+            #   @param type [Symbol, :stored_completions]
+            #     The type of source. Always `stored_completions`.
           end
 
           # @!method self.variants
@@ -249,13 +263,12 @@ module OpenAI
             required :type, const: :template
 
             # @!method initialize(template:, type: :template)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template}
-            #   for more details.
-            #
-            #   @param template [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem>] A list of chat messages forming the prompt or context. May include variable refe
+            #   @param template [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem>]
+            #     A list of chat messages forming the prompt or context. May include variable
+            #     references to the `item` namespace, ie {{item.name}}.
             #
-            #   @param type [Symbol, :template] The type of input messages. Always `template`.
+            #   @param type [Symbol, :template]
+            #     The type of input messages. Always `template`.
 
             # A message input to the model with a role indicating instruction following
             # hierarchy. Instructions given with the `developer` or `system` role take
@@ -318,21 +331,22 @@ module OpenAI
                 )
 
                 # @!method initialize(content:, role:, type: nil)
-                #   Some parameter documentations has been truncated, see
-                #   {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem}
-                #   for more details.
-                #
                 #   A message input to the model with a role indicating instruction following
                 #   hierarchy. Instructions given with the `developer` or `system` role take
                 #   precedence over instructions given with the `user` role. Messages with the
                 #   `assistant` role are presumed to have been generated by the model in previous
                 #   interactions.
                 #
-                #   @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>] Inputs to the model - can contain template strings. Supports text, output text,
+                #   @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>]
+                #     Inputs to the model - can contain template strings. Supports text, output text,
+                #     input images, and input audio, either as a single item or an array of items.
                 #
-                #   @param role [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role] The role of the message input. One of `user`, `assistant`, `system`, or
+                #   @param role [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role]
+                #     The role of the message input. One of `user`, `assistant`, `system`, or
+                #     `developer`.
                 #
-                #   @param type [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type] The type of the message input. Always `message`.
+                #   @param type [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type]
+                #     The type of the message input. Always `message`.
 
                 # Inputs to the model - can contain template strings. Supports text, output text,
                 # input images, and input audio, either as a single item or an array of items.
@@ -382,15 +396,13 @@ module OpenAI
                     required :type, const: :output_text
 
                     # @!method initialize(text:, type: :output_text)
-                    #   Some parameter documentations has been truncated, see
-                    #   {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText}
-                    #   for more details.
-                    #
                     #   A text output from the model.
                     #
-                    #   @param text [String] The text output from the model.
+                    #   @param text [String]
+                    #     The text output from the model.
                     #
-                    #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
+                    #   @param type [Symbol, :output_text]
+                    #     The type of the output text. Always `output_text`.
                   end
 
                   class InputImage < OpenAI::Internal::Type::BaseModel
@@ -414,17 +426,17 @@ module OpenAI
                     optional :detail, String
 
                     # @!method initialize(image_url:, detail: nil, type: :input_image)
-                    #   Some parameter documentations has been truncated, see
-                    #   {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage}
-                    #   for more details.
-                    #
                     #   An image input block used within EvalItem content arrays.
                     #
-                    #   @param image_url [String] The URL of the image input.
+                    #   @param image_url [String]
+                    #     The URL of the image input.
                     #
-                    #   @param detail [String] The detail level of the image to be sent to the model. One of `high`, `low`, or
+                    #   @param detail [String]
+                    #     The detail level of the image to be sent to the model. One of `high`, `low`, or
+                    #     `auto`. Defaults to `auto`.
                     #
-                    #   @param type [Symbol, :input_image] The type of the image input. Always `input_image`.
+                    #   @param type [Symbol, :input_image]
+                    #     The type of the image input. Always `input_image`.
                   end
 
                   # @!method self.variants
@@ -479,9 +491,11 @@ module OpenAI
             required :type, const: :item_reference
 
             # @!method initialize(item_reference:, type: :item_reference)
-            #   @param item_reference [String] A reference to a variable in the `item` namespace. Ie, "item.input_trajectory"
+            #   @param item_reference [String]
+            #     A reference to a variable in the `item` namespace. Ie, "item.input_trajectory"
             #
-            #   @param type [Symbol, :item_reference] The type of input messages. Always `item_reference`.
+            #   @param type [Symbol, :item_reference]
+            #     The type of input messages. Always `item_reference`.
           end
 
           # @!method self.variants
@@ -501,7 +515,7 @@ module OpenAI
           #   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://platform.openai.com/docs/guides/reasoning) for
+          #   [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
           #   model-specific support.
           #
           #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
@@ -513,7 +527,7 @@ module OpenAI
           #   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://platform.openai.com/docs/guides/structured-outputs).
+          #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
           #
           #   Setting to `{ "type": "json_object" }` enables the older JSON mode, which
           #   ensures the message the model generates is valid JSON. Using `json_schema` is
@@ -552,30 +566,49 @@ module OpenAI
           optional :top_p, Float
 
           # @!method initialize(max_completion_tokens: nil, reasoning_effort: nil, response_format: nil, seed: nil, temperature: nil, tools: nil, top_p: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams} for
-          #   more details.
+          #   @param max_completion_tokens [Integer]
+          #     The maximum number of tokens in the generated output.
+          #
+          #   @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 max_completion_tokens [Integer] The maximum number of tokens in the generated output.
+          #   @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject]
+          #     An object specifying the format that the model must output.
           #
-          #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
+          #     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).
           #
-          #   @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject] An object specifying the format that the model must output.
+          #     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.
           #
-          #   @param seed [Integer] A seed value to initialize the randomness, during sampling.
+          #   @param seed [Integer]
+          #     A seed value to initialize the randomness, during sampling.
           #
-          #   @param temperature [Float] A higher temperature increases randomness in the outputs.
+          #   @param temperature [Float]
+          #     A higher temperature increases randomness in the outputs.
           #
-          #   @param tools [Array<OpenAI::Models::Chat::ChatCompletionFunctionTool>] A list of tools the model may call. Currently, only functions are supported as a
+          #   @param tools [Array<OpenAI::Models::Chat::ChatCompletionFunctionTool>]
+          #     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.
           #
-          #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
+          #   @param top_p [Float]
+          #     An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
 
           # An object specifying the format that the model must output.
           #
           # 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://platform.openai.com/docs/guides/structured-outputs).
+          # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
           #
           # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
           # ensures the message the model generates is valid JSON. Using `json_schema` is
@@ -589,7 +622,7 @@ module OpenAI
             variant -> { OpenAI::ResponseFormatText }
 
             # JSON Schema response format. Used to generate structured JSON responses.
-            # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+            # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
             variant -> { OpenAI::ResponseFormatJSONSchema }
 
             # JSON object response format. An older method of generating JSON responses.

data/lib/openai/models/evals/create_eval_jsonl_run_data_source.rb

@@ -20,9 +20,11 @@ module OpenAI
         #   A JsonlRunDataSource object with that specifies a JSONL file that matches the
         #   eval
         #
-        #   @param source [OpenAI::Models::Evals::CreateEvalJSONLRunDataSource::Source::FileContent, OpenAI::Models::Evals::CreateEvalJSONLRunDataSource::Source::FileID] Determines what populates the `item` namespace in the data source.
+        #   @param source [OpenAI::Models::Evals::CreateEvalJSONLRunDataSource::Source::FileContent, OpenAI::Models::Evals::CreateEvalJSONLRunDataSource::Source::FileID]
+        #     Determines what populates the `item` namespace in the data source.
         #
-        #   @param type [Symbol, :jsonl] The type of data source. Always `jsonl`.
+        #   @param type [Symbol, :jsonl]
+        #     The type of data source. Always `jsonl`.
 
         # Determines what populates the `item` namespace in the data source.
         #
@@ -57,10 +59,11 @@ module OpenAI
             required :type, const: :file_content
 
             # @!method initialize(content:, type: :file_content)
-            #   @param content [Array<OpenAI::Models::Evals::CreateEvalJSONLRunDataSource::Source::FileContent::Content>] The content of the jsonl file.
+            #   @param content [Array<OpenAI::Models::Evals::CreateEvalJSONLRunDataSource::Source::FileContent::Content>]
+            #     The content of the jsonl file.
             #
-            #   @param type [Symbol, :file_content] The type of jsonl source. Always `file_content`.
-
+            #   @param type [Symbol, :file_content]
+            #     The type of jsonl source. Always `file_content`.
             class Content < OpenAI::Internal::Type::BaseModel
               # @!attribute item
               #
@@ -92,9 +95,11 @@ module OpenAI
             required :type, const: :file_id
 
             # @!method initialize(id:, type: :file_id)
-            #   @param id [String] The identifier of the file.
+            #   @param id [String]
+            #     The identifier of the file.
             #
-            #   @param type [Symbol, :file_id] The type of jsonl source. Always `file_id`.
+            #   @param type [Symbol, :file_id]
+            #     The type of jsonl source. Always `file_id`.
           end
 
           # @!method self.variants

data/lib/openai/models/evals/eval_api_error.rb

@@ -19,9 +19,11 @@ module OpenAI
         # @!method initialize(code:, message:)
         #   An object representing an error response from the Eval API.
         #
-        #   @param code [String] The error code.
+        #   @param code [String]
+        #     The error code.
         #
-        #   @param message [String] The error message.
+        #   @param message [String]
+        #     The error message.
       end
     end