openai 0.87.0 → 0.88.0

data/lib/openai/resources/conversations.rb

@@ -8,16 +8,21 @@ module OpenAI
       # @return [OpenAI::Resources::Conversations::Items]
       attr_reader :items
 
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::Conversations::ConversationCreateParams} for more details.
-      #
       # Create a conversation.
       #
       # @overload create(items: nil, metadata: nil, request_options: {})
       #
-      # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>, nil] Initial items to include in the conversation context. You may add up to 20 items
+      # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>, nil]
+      #   Initial items to include in the conversation context. You may add up to 20 items
+      #   at a time.
+      #
+      # @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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -40,7 +45,8 @@ module OpenAI
       #
       # @overload retrieve(conversation_id, request_options: {})
       #
-      # @param conversation_id [String] The ID of the conversation to retrieve.
+      # @param conversation_id [String]
+      #   The ID of the conversation to retrieve.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -57,16 +63,20 @@ module OpenAI
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::Conversations::ConversationUpdateParams} for more details.
-      #
       # Update a conversation
       #
       # @overload update(conversation_id, metadata:, request_options: {})
       #
-      # @param conversation_id [String] The ID of the conversation to update.
+      # @param conversation_id [String]
+      #   The ID of the conversation to update.
+      #
+      # @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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -89,7 +99,8 @@ module OpenAI
       #
       # @overload delete(conversation_id, request_options: {})
       #
-      # @param conversation_id [String] The ID of the conversation to delete.
+      # @param conversation_id [String]
+      #   The ID of the conversation to delete.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/openai/resources/embeddings.rb

@@ -5,22 +5,40 @@ module OpenAI
     # Get a vector representation of a given input that can be easily consumed by
     # machine learning models and algorithms.
     class Embeddings
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::EmbeddingCreateParams} for more details.
-      #
       # Creates an embedding vector representing the input text.
       #
       # @overload create(input:, model:, dimensions: nil, encoding_format: nil, user: nil, request_options: {})
       #
-      # @param input [String, Array<String>, Array<Integer>, Array<Array<Integer>>] Input text to embed, encoded as a string or array of tokens. To embed multiple i
+      # @param input [String, Array<String>, Array<Integer>, Array<Array<Integer>>]
+      #   Input text to embed, encoded as a string or array of tokens. To embed multiple
+      #   inputs in a single request, pass an array of strings or array of token arrays.
+      #   The input must not exceed the max input tokens for the model (8192 tokens for
+      #   all embedding models), cannot be an empty string, and any array must be 2048
+      #   dimensions or less.
+      #   [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
+      #   for counting tokens. In addition to the per-input token limit, all embedding
+      #   models enforce a maximum of 300,000 tokens summed across all inputs in a single
+      #   request.
       #
-      # @param model [String, Symbol, OpenAI::Models::EmbeddingModel] ID of the model to use. You can use the [List models](https://platform.openai.co
+      # @param model [String, Symbol, OpenAI::Models::EmbeddingModel]
+      #   ID of the model to use. You can use the
+      #   [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+      #   API to see all of your available models, or see our
+      #   [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+      #   of them.
       #
-      # @param dimensions [Integer] The number of dimensions the resulting output embeddings should have. Only suppo
+      # @param dimensions [Integer]
+      #   The number of dimensions the resulting output embeddings should have. Only
+      #   supported in `text-embedding-3` and later models.
       #
-      # @param encoding_format [Symbol, OpenAI::Models::EmbeddingCreateParams::EncodingFormat] The format to return the embeddings in. Can be either `float` or [`base64`](http
+      # @param encoding_format [Symbol, OpenAI::Models::EmbeddingCreateParams::EncodingFormat]
+      #   The format to return the embeddings in. Can be either `float` or
+      #   [`base64`](https://pypi.org/project/pybase64/).
       #
-      # @param user [String] A unique identifier representing your end-user, which can help OpenAI to monitor
+      # @param user [String]
+      #   A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   and detect abuse.
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/openai/resources/evals/runs/output_items.rb

@@ -10,11 +10,14 @@ module OpenAI
           #
           # @overload retrieve(output_item_id, eval_id:, run_id:, request_options: {})
           #
-          # @param output_item_id [String] The ID of the output item to retrieve.
+          # @param output_item_id [String]
+          #   The ID of the output item to retrieve.
           #
-          # @param eval_id [String] The ID of the evaluation to retrieve runs for.
+          # @param eval_id [String]
+          #   The ID of the evaluation to retrieve runs for.
           #
-          # @param run_id [String] The ID of the run to retrieve.
+          # @param run_id [String]
+          #   The ID of the run to retrieve.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -40,24 +43,30 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Evals::Runs::OutputItemListParams} for more details.
-          #
           # Get a list of output items for an evaluation run.
           #
           # @overload list(run_id, eval_id:, after: nil, limit: nil, order: nil, status: nil, request_options: {})
           #
-          # @param run_id [String] Path param: The ID of the run to retrieve output items for.
+          # @param run_id [String]
+          #   Path param: The ID of the run to retrieve output items for.
           #
-          # @param eval_id [String] Path param: The ID of the evaluation to retrieve runs for.
+          # @param eval_id [String]
+          #   Path param: The ID of the evaluation to retrieve runs for.
           #
-          # @param after [String] Query param: Identifier for the last output item from the previous pagination re
+          # @param after [String]
+          #   Query param: Identifier for the last output item from the previous pagination
+          #   request.
           #
-          # @param limit [Integer] Query param: Number of output items to retrieve.
+          # @param limit [Integer]
+          #   Query param: Number of output items to retrieve.
           #
-          # @param order [Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Order] Query param: Sort order for output items by timestamp. Use `asc` for ascending o
+          # @param order [Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Order]
+          #   Query param: Sort order for output items by timestamp. Use `asc` for ascending
+          #   order or `desc` for descending order. Defaults to `asc`.
           #
-          # @param status [Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Status] Query param: Filter output items by status. Use `failed` to filter by failed out
+          # @param status [Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Status]
+          #   Query param: Filter output items by status. Use `failed` to filter by failed
+          #   output items or `pass` to filter by passed output items.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #

data/lib/openai/resources/evals/runs.rb

@@ -9,22 +9,28 @@ module OpenAI
         # @return [OpenAI::Resources::Evals::Runs::OutputItems]
         attr_reader :output_items
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Evals::RunCreateParams} for more details.
-        #
         # Kicks off a new run for a given evaluation, specifying the data source, and what
         # model configuration to use to test. The datasource will be validated against the
         # schema specified in the config of the evaluation.
         #
         # @overload create(eval_id, data_source:, metadata: nil, name: nil, request_options: {})
         #
-        # @param eval_id [String] The ID of the evaluation to create a run for.
+        # @param eval_id [String]
+        #   The ID of the evaluation to create a run for.
+        #
+        # @param data_source [OpenAI::Models::Evals::CreateEvalJSONLRunDataSource, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource]
+        #   Details about the run's data source.
         #
-        # @param data_source [OpenAI::Models::Evals::CreateEvalJSONLRunDataSource, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource] Details about the run's data source.
+        # @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 run.
+        # @param name [String]
+        #   The name of the run.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -47,9 +53,11 @@ module OpenAI
         #
         # @overload retrieve(run_id, eval_id:, request_options: {})
         #
-        # @param run_id [String] The ID of the run to retrieve.
+        # @param run_id [String]
+        #   The ID of the run to retrieve.
         #
-        # @param eval_id [String] The ID of the evaluation to retrieve runs for.
+        # @param eval_id [String]
+        #   The ID of the evaluation to retrieve runs for.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -71,22 +79,26 @@ module OpenAI
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Evals::RunListParams} for more details.
-        #
         # Get a list of runs for an evaluation.
         #
         # @overload list(eval_id, after: nil, limit: nil, order: nil, status: nil, request_options: {})
         #
-        # @param eval_id [String] The ID of the evaluation to retrieve runs for.
+        # @param eval_id [String]
+        #   The ID of the evaluation to retrieve runs for.
         #
-        # @param after [String] Identifier for the last run from the previous pagination request.
+        # @param after [String]
+        #   Identifier for the last run from the previous pagination request.
         #
-        # @param limit [Integer] Number of runs to retrieve.
+        # @param limit [Integer]
+        #   Number of runs to retrieve.
         #
-        # @param order [Symbol, OpenAI::Models::Evals::RunListParams::Order] Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for de
+        # @param order [Symbol, OpenAI::Models::Evals::RunListParams::Order]
+        #   Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for
+        #   descending order. Defaults to `asc`.
         #
-        # @param status [Symbol, OpenAI::Models::Evals::RunListParams::Status] Filter runs by status. One of `queued` | `in_progress` | `failed` | `completed`
+        # @param status [Symbol, OpenAI::Models::Evals::RunListParams::Status]
+        #   Filter runs by status. One of `queued` | `in_progress` | `failed` | `completed`
+        #   | `canceled`.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -111,9 +123,11 @@ module OpenAI
         #
         # @overload delete(run_id, eval_id:, request_options: {})
         #
-        # @param run_id [String] The ID of the run to delete.
+        # @param run_id [String]
+        #   The ID of the run to delete.
         #
-        # @param eval_id [String] The ID of the evaluation to delete the run from.
+        # @param eval_id [String]
+        #   The ID of the evaluation to delete the run from.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -139,9 +153,11 @@ module OpenAI
         #
         # @overload cancel(run_id, eval_id:, request_options: {})
         #
-        # @param run_id [String] The ID of the run to cancel.
+        # @param run_id [String]
+        #   The ID of the run to cancel.
         #
-        # @param eval_id [String] The ID of the evaluation whose run you want to cancel.
+        # @param eval_id [String]
+        #   The ID of the evaluation whose run you want to cancel.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openai/resources/evals.rb

@@ -8,25 +8,35 @@ module OpenAI
       # @return [OpenAI::Resources::Evals::Runs]
       attr_reader :runs
 
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::EvalCreateParams} for more details.
-      #
       # Create the structure of an evaluation that can be used to test a model's
       # performance. An evaluation is a set of testing criteria and the config for a
       # data source, which dictates the schema of the data used in the evaluation. After
       # creating an evaluation, you can run it on different models and model parameters.
       # We support several types of graders and datasources. For more information, see
-      # the [Evals guide](https://platform.openai.com/docs/guides/evals).
+      # the [Evals guide](https://developers.openai.com/api/docs/guides/evals).
       #
       # @overload create(data_source_config:, testing_criteria:, metadata: nil, name: nil, request_options: {})
       #
-      # @param data_source_config [OpenAI::Models::EvalCreateParams::DataSourceConfig::Custom, OpenAI::Models::EvalCreateParams::DataSourceConfig::Logs, OpenAI::Models::EvalCreateParams::DataSourceConfig::StoredCompletions] The configuration for the data source used for the evaluation runs. Dictates the
+      # @param data_source_config [OpenAI::Models::EvalCreateParams::DataSourceConfig::Custom, OpenAI::Models::EvalCreateParams::DataSourceConfig::Logs, OpenAI::Models::EvalCreateParams::DataSourceConfig::StoredCompletions]
+      #   The configuration for the data source used for the evaluation runs. Dictates the
+      #   schema of the data used in the evaluation.
+      #
+      # @param testing_criteria [Array<OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel, OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::EvalCreateParams::TestingCriterion::TextSimilarity, OpenAI::Models::EvalCreateParams::TestingCriterion::Python, OpenAI::Models::EvalCreateParams::TestingCriterion::ScoreModel>]
+      #   A list of graders for all eval runs in this group. Graders can reference
+      #   variables in the data source using double curly braces notation, like
+      #   `{{item.variable_name}}`. To reference the model's output, use the `sample`
+      #   namespace (ie, `{{sample.output_text}}`).
       #
-      # @param testing_criteria [Array<OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel, OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::EvalCreateParams::TestingCriterion::TextSimilarity, OpenAI::Models::EvalCreateParams::TestingCriterion::Python, OpenAI::Models::EvalCreateParams::TestingCriterion::ScoreModel>] A list of graders for all eval runs in this group. Graders can reference variabl
+      # @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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -49,7 +59,8 @@ module OpenAI
       #
       # @overload retrieve(eval_id, request_options: {})
       #
-      # @param eval_id [String] The ID of the evaluation to retrieve.
+      # @param eval_id [String]
+      #   The ID of the evaluation to retrieve.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -66,18 +77,23 @@ module OpenAI
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::EvalUpdateParams} for more details.
-      #
       # Update certain properties of an evaluation.
       #
       # @overload update(eval_id, metadata: nil, name: nil, request_options: {})
       #
-      # @param eval_id [String] The ID of the evaluation to update.
+      # @param eval_id [String]
+      #   The ID of the evaluation to update.
       #
-      # @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 name [String] Rename the evaluation.
+      #   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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -96,20 +112,23 @@ module OpenAI
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::EvalListParams} for more details.
-      #
       # List evaluations for a project.
       #
       # @overload list(after: nil, limit: nil, order: nil, order_by: nil, request_options: {})
       #
-      # @param after [String] Identifier for the last eval from the previous pagination request.
+      # @param after [String]
+      #   Identifier for the last eval from the previous pagination request.
       #
-      # @param limit [Integer] Number of evals to retrieve.
+      # @param limit [Integer]
+      #   Number of evals to retrieve.
       #
-      # @param order [Symbol, OpenAI::Models::EvalListParams::Order] Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for d
+      # @param order [Symbol, OpenAI::Models::EvalListParams::Order]
+      #   Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for
+      #   descending order.
       #
-      # @param order_by [Symbol, OpenAI::Models::EvalListParams::OrderBy] Evals can be ordered by creation time or last updated time. Use
+      # @param order_by [Symbol, OpenAI::Models::EvalListParams::OrderBy]
+      #   Evals can be ordered by creation time or last updated time. Use `created_at` for
+      #   creation time or `updated_at` for last updated time.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -134,7 +153,8 @@ module OpenAI
       #
       # @overload delete(eval_id, request_options: {})
       #
-      # @param eval_id [String] The ID of the evaluation to delete.
+      # @param eval_id [String]
+      #   The ID of the evaluation to delete.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/openai/resources/files.rb

@@ -7,9 +7,6 @@ module OpenAI
     # Files are used to upload documents that can be used with features like
     # Assistants and Fine-tuning.
     class Files
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::FileCreateParams} for more details.
-      #
       # Upload a file that can be used across various endpoints. Individual files can be
       # up to 512 MB, and each project can store up to 2.5 TB of files in total. There
       # is no organization-wide storage limit. Uploads to this endpoint are rate-limited
@@ -17,20 +14,20 @@ module OpenAI
       #
       # - The Assistants API supports files up to 2 million tokens and of specific file
       #   types. See the
-      #   [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools)
+      #   [Assistants Tools guide](https://developers.openai.com/api/docs/guides/tools)
       #   for details.
       # - The Fine-tuning API only supports `.jsonl` files. The input also has certain
       #   required formats for fine-tuning
-      #   [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
+      #   [chat](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data)
       #   or
-      #   [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
+      #   [completions](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data)
       #   models.
       # - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
       #   also has a specific required
-      #   [format](https://platform.openai.com/docs/api-reference/batch/request-input).
+      #   [format](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file).
       # - For Retrieval or `file_search` ingestion, upload files here first. If you need
       #   to attach multiple uploaded files to the same vector store, use
-      #   [`/vector_stores/{vector_store_id}/file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+      #   [`/vector_stores/{vector_store_id}/file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create)
       #   instead of attaching them one by one. Vector store attachment has separate
       #   limits from file upload, including 2,000 attached files per minute per
       #   organization.
@@ -44,11 +41,26 @@ module OpenAI
       #
       # @overload create(file:, purpose:, expires_after: nil, request_options: {})
       #
-      # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The File object (not file name) to be uploaded.
+      # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart]
+      #   The File object (not file name) to be uploaded.
+      #
+      #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #   content type.
       #
-      # @param purpose [Symbol, OpenAI::Models::FilePurpose] The intended purpose of the uploaded file. One of:
+      # @param purpose [Symbol, OpenAI::Models::FilePurpose]
+      #   The intended purpose of the uploaded file. One of:
       #
-      # @param expires_after [OpenAI::Models::FileCreateParams::ExpiresAfter] The expiration policy for a file. By default, files with `purpose=batch` expire
+      #   - `assistants`: Used in the Assistants API
+      #   - `batch`: Used in the Batch API
+      #   - `fine-tune`: Used for fine-tuning
+      #   - `vision`: Images used for vision fine-tuning
+      #   - `user_data`: Flexible file type for any purpose
+      #   - `evals`: Used for eval data sets
+      #
+      # @param expires_after [OpenAI::Models::FileCreateParams::ExpiresAfter]
+      #   The expiration policy for a file. By default, files with `purpose=batch` expire
+      #   after 30 days and all other files are persisted until they are manually deleted.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -72,7 +84,8 @@ module OpenAI
       #
       # @overload retrieve(file_id, request_options: {})
       #
-      # @param file_id [String] The ID of the file to use for this request.
+      # @param file_id [String]
+      #   The ID of the file to use for this request.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -89,20 +102,26 @@ module OpenAI
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::FileListParams} for more details.
-      #
       # Returns a list of files.
       #
       # @overload list(after: nil, limit: nil, order: nil, purpose: nil, request_options: {})
       #
-      # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+      # @param after [String]
+      #   A cursor for use in pagination. `after` is an object ID that defines your place
+      #   in the list. For instance, if you make a list request and receive 100 objects,
+      #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+      #   fetch the next page of the list.
       #
-      # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+      # @param limit [Integer]
+      #   A limit on the number of objects to be returned. Limit can range between 1 and
+      #   10,000, and the default is 10,000.
       #
-      # @param order [Symbol, OpenAI::Models::FileListParams::Order] Sort order by the `created_at` timestamp of the objects. `asc` for ascending ord
+      # @param order [Symbol, OpenAI::Models::FileListParams::Order]
+      #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      #   order and `desc` for descending order.
       #
-      # @param purpose [String] Only return files with the given purpose.
+      # @param purpose [String]
+      #   Only return files with the given purpose.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -127,7 +146,8 @@ module OpenAI
       #
       # @overload delete(file_id, request_options: {})
       #
-      # @param file_id [String] The ID of the file to use for this request.
+      # @param file_id [String]
+      #   The ID of the file to use for this request.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -148,7 +168,8 @@ module OpenAI
       #
       # @overload content(file_id, request_options: {})
       #
-      # @param file_id [String] The ID of the file to use for this request.
+      # @param file_id [String]
+      #   The ID of the file to use for this request.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/openai/resources/fine_tuning/alpha/graders.rb

@@ -6,18 +6,25 @@ module OpenAI
       class Alpha
         # Manage fine-tuning jobs to tailor a model to your specific training data.
         class Graders
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::FineTuning::Alpha::GraderRunParams} for more details.
-          #
           # Run a grader.
           #
           # @overload run(grader:, model_sample:, item: nil, request_options: {})
           #
-          # @param grader [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::MultiGrader] The grader used for the fine-tuning job.
+          # @param grader [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::MultiGrader]
+          #   The grader used for the fine-tuning job.
           #
-          # @param model_sample [String] The model sample to be evaluated. This value will be used to populate
+          # @param model_sample [String]
+          #   The model sample to be evaluated. This value will be used to populate the
+          #   `sample` namespace. See
+          #   [the guide](https://developers.openai.com/api/docs/guides/graders) for more
+          #   details. The `output_json` variable will be populated if the model sample is a
+          #   valid JSON string.
           #
-          # @param item [Object] The dataset item provided to the grader. This will be used to populate
+          # @param item [Object]
+          #   The dataset item provided to the grader. This will be used to populate the
+          #   `item` namespace. See
+          #   [the guide](https://developers.openai.com/api/docs/guides/graders) for more
+          #   details.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -40,7 +47,8 @@ module OpenAI
           #
           # @overload validate(grader:, request_options: {})
           #
-          # @param grader [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::MultiGrader] The grader used for the fine-tuning job.
+          # @param grader [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::MultiGrader]
+          #   The grader used for the fine-tuning job.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #