openai 0.87.0 → 0.89.0

data/lib/openai/resources/completions.rb

@@ -7,9 +7,6 @@ module OpenAI
     class Completions
       # See {OpenAI::Resources::Completions#create_streaming} for streaming counterpart.
       #
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::CompletionCreateParams} for more details.
-      #
       # Creates a completion for the provided prompt and parameters.
       #
       # Returns a completion object, or a sequence of completion objects if the request
@@ -17,39 +14,128 @@ module OpenAI
       #
       # @overload create(model:, prompt:, best_of: nil, echo: nil, frequency_penalty: nil, logit_bias: nil, logprobs: nil, max_tokens: nil, n: nil, presence_penalty: nil, seed: nil, stop: nil, stream_options: nil, suffix: nil, temperature: nil, top_p: nil, user: nil, request_options: {})
       #
-      # @param model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model] ID of the model to use. You can use the [List models](https://platform.openai.co
+      # @param model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model]
+      #   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 prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil]
+      #   The prompt(s) to generate completions for, encoded as a string, array of
+      #   strings, array of tokens, or array of token arrays.
+      #
+      #   Note that <|endoftext|> is the document separator that the model sees during
+      #   training, so if a prompt is not specified the model will generate as if from the
+      #   beginning of a new document.
+      #
+      # @param best_of [Integer, nil]
+      #   Generates `best_of` completions server-side and returns the "best" (the one with
+      #   the highest log probability per token). Results cannot be streamed.
+      #
+      #   When used with `n`, `best_of` controls the number of candidate completions and
+      #   `n` specifies how many to return – `best_of` must be greater than `n`.
+      #
+      #   **Note:** Because this parameter generates many completions, it can quickly
+      #   consume your token quota. Use carefully and ensure that you have reasonable
+      #   settings for `max_tokens` and `stop`.
+      #
+      # @param echo [Boolean, nil]
+      #   Echo back the prompt in addition to the completion
+      #
+      # @param frequency_penalty [Float, nil]
+      #   Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+      #   existing frequency in the text so far, decreasing the model's likelihood to
+      #   repeat the same line verbatim.
+      #
+      #   [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
+      #
+      # @param logit_bias [Hash{Symbol=>Integer}, nil]
+      #   Modify the likelihood of specified tokens appearing in the completion.
+      #
+      #   Accepts a JSON object that maps tokens (specified by their token ID in the GPT
+      #   tokenizer) to an associated bias value from -100 to 100. You can use this
+      #   [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text
+      #   to token IDs. Mathematically, the bias is added to the logits generated by the
+      #   model prior to sampling. The exact effect will vary per model, but values
+      #   between -1 and 1 should decrease or increase likelihood of selection; values
+      #   like -100 or 100 should result in a ban or exclusive selection of the relevant
+      #   token.
+      #
+      #   As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
+      #   from being generated.
+      #
+      # @param logprobs [Integer, nil]
+      #   Include the log probabilities on the `logprobs` most likely output tokens, as
+      #   well the chosen tokens. For example, if `logprobs` is 5, the API will return a
+      #   list of the 5 most likely tokens. The API will always return the `logprob` of
+      #   the sampled token, so there may be up to `logprobs+1` elements in the response.
+      #
+      #   The maximum value for `logprobs` is 5.
+      #
+      # @param max_tokens [Integer, nil]
+      #   The maximum number of [tokens](https://platform.openai.com/tokenizer) that can
+      #   be generated in the completion.
+      #
+      #   The token count of your prompt plus `max_tokens` cannot exceed the model's
+      #   context length.
+      #   [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
+      #   for counting tokens.
       #
-      # @param prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil] The prompt(s) to generate completions for, encoded as a string, array of strings
+      # @param n [Integer, nil]
+      #   How many completions to generate for each prompt.
       #
-      # @param best_of [Integer, nil] Generates `best_of` completions server-side and returns the "best" (the one with
+      #   **Note:** Because this parameter generates many completions, it can quickly
+      #   consume your token quota. Use carefully and ensure that you have reasonable
+      #   settings for `max_tokens` and `stop`.
       #
-      # @param echo [Boolean, nil] Echo back the prompt in addition to the completion
+      # @param presence_penalty [Float, nil]
+      #   Number between -2.0 and 2.0. Positive values penalize new tokens based on
+      #   whether they appear in the text so far, increasing the model's likelihood to
+      #   talk about new topics.
       #
-      # @param frequency_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+      #   [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
       #
-      # @param logit_bias [Hash{Symbol=>Integer}, nil] Modify the likelihood of specified tokens appearing in the completion.
+      # @param seed [Integer, nil]
+      #   If specified, our system will make a best effort to sample deterministically,
+      #   such that repeated requests with the same `seed` and parameters should return
+      #   the same result.
       #
-      # @param logprobs [Integer, nil] Include the log probabilities on the `logprobs` most likely output tokens, as we
+      #   Determinism is not guaranteed, and you should refer to the `system_fingerprint`
+      #   response parameter to monitor changes in the backend.
       #
-      # @param max_tokens [Integer, nil] The maximum number of [tokens](/tokenizer) that can be generated in the completi
+      # @param stop [String, Array<String>, nil]
+      #   Not supported with latest reasoning models `o3` and `o4-mini`.
       #
-      # @param n [Integer, nil] How many completions to generate for each prompt.
+      #   Up to 4 sequences where the API will stop generating further tokens. The
+      #   returned text will not contain the stop sequence.
       #
-      # @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on whethe
+      # @param stream_options [OpenAI::Models::Chat::ChatCompletionStreamOptions, nil]
+      #   Options for streaming response. Only set this when you set `stream: true`.
       #
-      # @param seed [Integer, nil] If specified, our system will make a best effort to sample deterministically, su
+      # @param suffix [String, nil]
+      #   The suffix that comes after a completion of inserted text.
       #
-      # @param stop [String, Array<String>, nil] Not supported with latest reasoning models `o3` and `o4-mini`.
+      #   This parameter is only supported for `gpt-3.5-turbo-instruct`.
       #
-      # @param stream_options [OpenAI::Models::Chat::ChatCompletionStreamOptions, nil] Options for streaming response. Only set this when you set `stream: true`.
+      # @param temperature [Float, nil]
+      #   What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+      #   make the output more random, while lower values like 0.2 will make it more
+      #   focused and deterministic.
       #
-      # @param suffix [String, nil] The suffix that comes after a completion of inserted text.
+      #   We generally recommend altering this or `top_p` but not both.
       #
-      # @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
+      # @param top_p [Float, nil]
+      #   An alternative to sampling with temperature, called nucleus sampling, where the
+      #   model considers the results of the tokens with top_p probability mass. So 0.1
+      #   means only the tokens comprising the top 10% probability mass are considered.
       #
-      # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
+      #   We generally recommend altering this or `temperature` but not both.
       #
-      # @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]
       #
@@ -75,9 +161,6 @@ module OpenAI
 
       # See {OpenAI::Resources::Completions#create} for non-streaming counterpart.
       #
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::CompletionCreateParams} for more details.
-      #
       # Creates a completion for the provided prompt and parameters.
       #
       # Returns a completion object, or a sequence of completion objects if the request
@@ -85,39 +168,128 @@ module OpenAI
       #
       # @overload create_streaming(model:, prompt:, best_of: nil, echo: nil, frequency_penalty: nil, logit_bias: nil, logprobs: nil, max_tokens: nil, n: nil, presence_penalty: nil, seed: nil, stop: nil, stream_options: nil, suffix: nil, temperature: nil, top_p: nil, user: nil, request_options: {})
       #
-      # @param model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model] ID of the model to use. You can use the [List models](https://platform.openai.co
+      # @param model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model]
+      #   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 prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil]
+      #   The prompt(s) to generate completions for, encoded as a string, array of
+      #   strings, array of tokens, or array of token arrays.
+      #
+      #   Note that <|endoftext|> is the document separator that the model sees during
+      #   training, so if a prompt is not specified the model will generate as if from the
+      #   beginning of a new document.
+      #
+      # @param best_of [Integer, nil]
+      #   Generates `best_of` completions server-side and returns the "best" (the one with
+      #   the highest log probability per token). Results cannot be streamed.
+      #
+      #   When used with `n`, `best_of` controls the number of candidate completions and
+      #   `n` specifies how many to return – `best_of` must be greater than `n`.
+      #
+      #   **Note:** Because this parameter generates many completions, it can quickly
+      #   consume your token quota. Use carefully and ensure that you have reasonable
+      #   settings for `max_tokens` and `stop`.
+      #
+      # @param echo [Boolean, nil]
+      #   Echo back the prompt in addition to the completion
+      #
+      # @param frequency_penalty [Float, nil]
+      #   Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+      #   existing frequency in the text so far, decreasing the model's likelihood to
+      #   repeat the same line verbatim.
+      #
+      #   [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
+      #
+      # @param logit_bias [Hash{Symbol=>Integer}, nil]
+      #   Modify the likelihood of specified tokens appearing in the completion.
+      #
+      #   Accepts a JSON object that maps tokens (specified by their token ID in the GPT
+      #   tokenizer) to an associated bias value from -100 to 100. You can use this
+      #   [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text
+      #   to token IDs. Mathematically, the bias is added to the logits generated by the
+      #   model prior to sampling. The exact effect will vary per model, but values
+      #   between -1 and 1 should decrease or increase likelihood of selection; values
+      #   like -100 or 100 should result in a ban or exclusive selection of the relevant
+      #   token.
+      #
+      #   As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
+      #   from being generated.
+      #
+      # @param logprobs [Integer, nil]
+      #   Include the log probabilities on the `logprobs` most likely output tokens, as
+      #   well the chosen tokens. For example, if `logprobs` is 5, the API will return a
+      #   list of the 5 most likely tokens. The API will always return the `logprob` of
+      #   the sampled token, so there may be up to `logprobs+1` elements in the response.
+      #
+      #   The maximum value for `logprobs` is 5.
+      #
+      # @param max_tokens [Integer, nil]
+      #   The maximum number of [tokens](https://platform.openai.com/tokenizer) that can
+      #   be generated in the completion.
+      #
+      #   The token count of your prompt plus `max_tokens` cannot exceed the model's
+      #   context length.
+      #   [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
+      #   for counting tokens.
       #
-      # @param prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil] The prompt(s) to generate completions for, encoded as a string, array of strings
+      # @param n [Integer, nil]
+      #   How many completions to generate for each prompt.
       #
-      # @param best_of [Integer, nil] Generates `best_of` completions server-side and returns the "best" (the one with
+      #   **Note:** Because this parameter generates many completions, it can quickly
+      #   consume your token quota. Use carefully and ensure that you have reasonable
+      #   settings for `max_tokens` and `stop`.
       #
-      # @param echo [Boolean, nil] Echo back the prompt in addition to the completion
+      # @param presence_penalty [Float, nil]
+      #   Number between -2.0 and 2.0. Positive values penalize new tokens based on
+      #   whether they appear in the text so far, increasing the model's likelihood to
+      #   talk about new topics.
       #
-      # @param frequency_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+      #   [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
       #
-      # @param logit_bias [Hash{Symbol=>Integer}, nil] Modify the likelihood of specified tokens appearing in the completion.
+      # @param seed [Integer, nil]
+      #   If specified, our system will make a best effort to sample deterministically,
+      #   such that repeated requests with the same `seed` and parameters should return
+      #   the same result.
       #
-      # @param logprobs [Integer, nil] Include the log probabilities on the `logprobs` most likely output tokens, as we
+      #   Determinism is not guaranteed, and you should refer to the `system_fingerprint`
+      #   response parameter to monitor changes in the backend.
       #
-      # @param max_tokens [Integer, nil] The maximum number of [tokens](/tokenizer) that can be generated in the completi
+      # @param stop [String, Array<String>, nil]
+      #   Not supported with latest reasoning models `o3` and `o4-mini`.
       #
-      # @param n [Integer, nil] How many completions to generate for each prompt.
+      #   Up to 4 sequences where the API will stop generating further tokens. The
+      #   returned text will not contain the stop sequence.
       #
-      # @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on whethe
+      # @param stream_options [OpenAI::Models::Chat::ChatCompletionStreamOptions, nil]
+      #   Options for streaming response. Only set this when you set `stream: true`.
       #
-      # @param seed [Integer, nil] If specified, our system will make a best effort to sample deterministically, su
+      # @param suffix [String, nil]
+      #   The suffix that comes after a completion of inserted text.
       #
-      # @param stop [String, Array<String>, nil] Not supported with latest reasoning models `o3` and `o4-mini`.
+      #   This parameter is only supported for `gpt-3.5-turbo-instruct`.
       #
-      # @param stream_options [OpenAI::Models::Chat::ChatCompletionStreamOptions, nil] Options for streaming response. Only set this when you set `stream: true`.
+      # @param temperature [Float, nil]
+      #   What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+      #   make the output more random, while lower values like 0.2 will make it more
+      #   focused and deterministic.
       #
-      # @param suffix [String, nil] The suffix that comes after a completion of inserted text.
+      #   We generally recommend altering this or `top_p` but not both.
       #
-      # @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
+      # @param top_p [Float, nil]
+      #   An alternative to sampling with temperature, called nucleus sampling, where the
+      #   model considers the results of the tokens with top_p probability mass. So 0.1
+      #   means only the tokens comprising the top 10% probability mass are considered.
       #
-      # @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling, where the
+      #   We generally recommend altering this or `temperature` but not both.
       #
-      # @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/containers/files.rb

@@ -7,9 +7,6 @@ module OpenAI
         # @return [OpenAI::Resources::Containers::Files::Content]
         attr_reader :content
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Containers::FileCreateParams} for more details.
-        #
         # Create a Container File
         #
         # You can send either a multipart/form-data request with the raw file content, or
@@ -23,9 +20,15 @@ module OpenAI
         #
         # @param container_id [String]
         #
-        # @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 file_id [String] Name of the file to create.
+        # @param file_id [String]
+        #   Name of the file to create.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -71,20 +74,25 @@ module OpenAI
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Containers::FileListParams} for more details.
-        #
         # List Container files
         #
         # @overload list(container_id, after: nil, limit: nil, order: nil, request_options: {})
         #
         # @param container_id [String]
         #
-        # @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
+        #   100, and the default is 20.
         #
-        # @param order [Symbol, OpenAI::Models::Containers::FileListParams::Order] Sort order by the `created_at` timestamp of the objects. `asc` for ascending ord
+        # @param order [Symbol, OpenAI::Models::Containers::FileListParams::Order]
+        #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+        #   order and `desc` for descending order.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openai/resources/containers.rb

@@ -10,17 +10,23 @@ module OpenAI
       #
       # @overload create(name:, expires_after: nil, file_ids: nil, memory_limit: nil, network_policy: nil, skills: nil, request_options: {})
       #
-      # @param name [String] Name of the container to create.
+      # @param name [String]
+      #   Name of the container to create.
       #
-      # @param expires_after [OpenAI::Models::ContainerCreateParams::ExpiresAfter] Container expiration time in seconds relative to the 'anchor' time.
+      # @param expires_after [OpenAI::Models::ContainerCreateParams::ExpiresAfter]
+      #   Container expiration time in seconds relative to the 'anchor' time.
       #
-      # @param file_ids [Array<String>] IDs of files to copy to the container.
+      # @param file_ids [Array<String>]
+      #   IDs of files to copy to the container.
       #
-      # @param memory_limit [Symbol, OpenAI::Models::ContainerCreateParams::MemoryLimit] Optional memory limit for the container. Defaults to "1g".
+      # @param memory_limit [Symbol, OpenAI::Models::ContainerCreateParams::MemoryLimit]
+      #   Optional memory limit for the container. Defaults to "1g".
       #
-      # @param network_policy [OpenAI::Models::Responses::ContainerNetworkPolicyDisabled, OpenAI::Models::Responses::ContainerNetworkPolicyAllowlist] Network access policy for the container.
+      # @param network_policy [OpenAI::Models::Responses::ContainerNetworkPolicyDisabled, OpenAI::Models::Responses::ContainerNetworkPolicyAllowlist]
+      #   Network access policy for the container.
       #
-      # @param skills [Array<OpenAI::Models::Responses::SkillReference, OpenAI::Models::Responses::InlineSkill>] An optional list of skills referenced by id or inline data.
+      # @param skills [Array<OpenAI::Models::Responses::SkillReference, OpenAI::Models::Responses::InlineSkill>]
+      #   An optional list of skills referenced by id or inline data.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -59,20 +65,26 @@ module OpenAI
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::ContainerListParams} for more details.
-      #
       # List Containers
       #
       # @overload list(after: nil, limit: nil, name: nil, order: 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
+      #   100, and the default is 20.
       #
-      # @param name [String] Filter results by container name.
+      # @param name [String]
+      #   Filter results by container name.
       #
-      # @param order [Symbol, OpenAI::Models::ContainerListParams::Order] Sort order by the `created_at` timestamp of the objects. `asc` for ascending ord
+      # @param order [Symbol, OpenAI::Models::ContainerListParams::Order]
+      #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      #   order and `desc` for descending order.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -97,7 +109,8 @@ module OpenAI
       #
       # @overload delete(container_id, request_options: {})
       #
-      # @param container_id [String] The ID of the container to delete.
+      # @param container_id [String]
+      #   The ID of the container to delete.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/openai/resources/content_provenance_checks.rb

@@ -4,7 +4,7 @@ module OpenAI
   module Resources
     class ContentProvenanceChecks
       # Check whether an image or audio file contains known OpenAI provenance signals.
-      # [Learn more about content provenance](/api/docs/guides/content-provenance).
+      # [Learn more about content provenance](https://developers.openai.com/api/docs/guides/content-provenance).
       #
       # If `not_detected`, it means the tool did not find supported signals in the
       # uploaded file. The content could still have been generated by OpenAI if the
@@ -19,7 +19,12 @@ module OpenAI
       #
       # @overload create(file:, request_options: {})
       #
-      # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The image or audio file to check for supported OpenAI provenance signals.
+      # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart]
+      #   The image or audio file to check for supported OpenAI provenance signals.
+      #
+      #   `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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/openai/resources/conversations/items.rb

@@ -5,18 +5,22 @@ module OpenAI
     class Conversations
       # Manage conversations and conversation items.
       class Items
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Conversations::ItemCreateParams} for more details.
-        #
         # Create items in a conversation with the given ID.
         #
         # @overload create(conversation_id, items:, include: nil, request_options: {})
         #
-        # @param conversation_id [String] Path param: The ID of the conversation to add the item to.
+        # @param conversation_id [String]
+        #   Path param: The ID of the conversation to add the item to.
         #
-        # @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>] Body param: The items to add to the conversation. You may add up to 20 items at
+        # @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>]
+        #   Body param: The items to add to the conversation. You may add up to 20 items at
+        #   a time.
         #
-        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Query param: Additional fields to include in the response. See the `include`
+        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
+        #   Query param: Additional fields to include in the response. See the `include`
+        #   parameter for
+        #   [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        #   for more information.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -38,18 +42,21 @@ module OpenAI
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Conversations::ItemRetrieveParams} for more details.
-        #
         # Get a single item from a conversation with the given IDs.
         #
         # @overload retrieve(item_id, conversation_id:, include: nil, request_options: {})
         #
-        # @param item_id [String] Path param: The ID of the item to retrieve.
+        # @param item_id [String]
+        #   Path param: The ID of the item to retrieve.
         #
-        # @param conversation_id [String] Path param: The ID of the conversation that contains the item.
+        # @param conversation_id [String]
+        #   Path param: The ID of the conversation that contains the item.
         #
-        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Query param: Additional fields to include in the response. See the `include`
+        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
+        #   Query param: Additional fields to include in the response. See the `include`
+        #   parameter for
+        #   [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        #   for more information.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -73,22 +80,45 @@ module OpenAI
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Conversations::ItemListParams} for more details.
-        #
         # List all items for a conversation with the given ID.
         #
         # @overload list(conversation_id, after: nil, include: nil, limit: nil, order: nil, request_options: {})
         #
-        # @param conversation_id [String] The ID of the conversation to list items for.
-        #
-        # @param after [String] An item ID to list items after, used in pagination.
-        #
-        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Specify additional output data to include in the model response. Currently suppo
-        #
-        # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between
-        #
-        # @param order [Symbol, OpenAI::Models::Conversations::ItemListParams::Order] The order to return the input items in. Default is `desc`.
+        # @param conversation_id [String]
+        #   The ID of the conversation to list items for.
+        #
+        # @param after [String]
+        #   An item ID to list items after, used in pagination.
+        #
+        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
+        #   Specify additional output data to include in the model response. Currently
+        #   supported values are:
+        #
+        #   - `web_search_call.action.sources`: Include the sources of the web search tool
+        #     call.
+        #   - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #     in code interpreter tool call items.
+        #   - `computer_call_output.output.image_url`: Include image urls from the computer
+        #     call output.
+        #   - `file_search_call.results`: Include the search results of the file search tool
+        #     call.
+        #   - `message.input_image.image_url`: Include image urls from the input message.
+        #   - `message.output_text.logprobs`: Include logprobs with assistant messages.
+        #   - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+        #     tokens in reasoning item outputs. This enables reasoning items to be used in
+        #     multi-turn conversations when using the Responses API statelessly (like when
+        #     the `store` parameter is set to `false`, or when an organization is enrolled
+        #     in the zero data retention program).
+        #
+        # @param limit [Integer]
+        #   A limit on the number of objects to be returned. Limit can range between 1 and
+        #   100, and the default is 20.
+        #
+        # @param order [Symbol, OpenAI::Models::Conversations::ItemListParams::Order]
+        #   The order to return the input items in. Default is `desc`.
+        #
+        #   - `asc`: Return the input items in ascending order.
+        #   - `desc`: Return the input items in descending order.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -113,9 +143,11 @@ module OpenAI
         #
         # @overload delete(item_id, conversation_id:, request_options: {})
         #
-        # @param item_id [String] The ID of the item to delete.
+        # @param item_id [String]
+        #   The ID of the item to delete.
         #
-        # @param conversation_id [String] The ID of the conversation that contains the item.
+        # @param conversation_id [String]
+        #   The ID of the conversation that contains the item.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #