openapi_openai 1.1.0 → 1.2.0

data/docs/CreateAssistantRequestToolResources.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateAssistantRequestToolResources
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_interpreter** | [**CreateAssistantRequestToolResourcesCodeInterpreter**](CreateAssistantRequestToolResourcesCodeInterpreter.md) |  | [optional] |
+| **file_search** | [**CreateAssistantRequestToolResourcesFileSearch**](CreateAssistantRequestToolResourcesFileSearch.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateAssistantRequestToolResources.new(
+  code_interpreter: null,
+  file_search: null
+)
+```
+

data/docs/CreateAssistantRequestToolResourcesCodeInterpreter.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::CreateAssistantRequestToolResourcesCodeInterpreter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_ids** | **Array<String>** | A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateAssistantRequestToolResourcesCodeInterpreter.new(
+  file_ids: null
+)
+```
+

data/docs/CreateAssistantRequestToolResourcesFileSearch.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateAssistantRequestToolResourcesFileSearch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vector_store_ids** | **Array<String>** | The [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.  | [optional] |
+| **vector_stores** | [**Array<CreateAssistantRequestToolResourcesFileSearchVectorStoresInner>**](CreateAssistantRequestToolResourcesFileSearchVectorStoresInner.md) | A helper to create a [vector store](/docs/api-reference/vector-stores/object) with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateAssistantRequestToolResourcesFileSearch.new(
+  vector_store_ids: null,
+  vector_stores: null
+)
+```
+

data/docs/CreateAssistantRequestToolResourcesFileSearchVectorStoresInner.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateAssistantRequestToolResourcesFileSearchVectorStoresInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_ids** | **Array<String>** | A list of [file](/docs/api-reference/files) IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.  | [optional] |
+| **chunking_strategy** | [**CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy**](CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy.md) |  | [optional] |
+| **metadata** | **Object** | Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateAssistantRequestToolResourcesFileSearchVectorStoresInner.new(
+  file_ids: null,
+  chunking_strategy: null,
+  metadata: null
+)
+```
+

data/docs/CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy.md

@@ -0,0 +1,49 @@
+# OpenApiOpenAIClient::CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy.openapi_one_of
+# =>
+# [
+#   :'AutoChunkingStrategy',
+#   :'StaticChunkingStrategy'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy.build(data)
+# => #<AutoChunkingStrategy:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `AutoChunkingStrategy`
+- `StaticChunkingStrategy`
+- `nil` (if no type matches)
+

data/docs/CreateBatchRequest.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::CreateBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input_file_id** | **String** | The ID of an uploaded file that contains requests for the new batch.  See [upload file](/docs/api-reference/files/create) for how to upload a file.  Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/request-input), and must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up to 200 MB in size.  |  |
+| **endpoint** | **String** | The endpoint to be used for all requests in the batch. Currently `/v1/chat/completions`, `/v1/embeddings`, and `/v1/completions` are supported. Note that `/v1/embeddings` batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch. |  |
+| **completion_window** | **String** | The time frame within which the batch should be processed. Currently only `24h` is supported. |  |
+| **metadata** | **Hash<String, String>** | Optional custom metadata for the batch. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateBatchRequest.new(
+  input_file_id: null,
+  endpoint: null,
+  completion_window: null,
+  metadata: null
+)
+```
+

data/docs/CreateChatCompletionRequest.md

@@ -4,24 +4,34 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **messages** | [**Array<ChatCompletionRequestMessage>**](ChatCompletionRequestMessage.md) | A list of messages comprising the conversation so far. [Example Python code](https://cookbook.openai.com/examples/how_to_format_inputs_to_chatgpt_models). |  |
+| **messages** | [**Array<ChatCompletionRequestMessage>**](ChatCompletionRequestMessage.md) | A list of messages comprising the conversation so far. Depending on the [model](/docs/models) you use, different message types (modalities) are supported, like [text](/docs/guides/text-generation), [images](/docs/guides/vision), and [audio](/docs/guides/audio).  |  |
 | **model** | [**CreateChatCompletionRequestModel**](CreateChatCompletionRequestModel.md) |  |  |
-| **frequency_penalty** | **Float** | 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.](/docs/guides/text-generation/parameter-details)  | [optional][default to 0] |
+| **store** | **Boolean** | Whether or not to store the output of this chat completion request for  use in our [model distillation](/docs/guides/distillation) or [evals](/docs/guides/evals) products.  | [optional][default to false] |
+| **reasoning_effort** | **String** | **o1 models only**   Constrains effort on reasoning for  [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `low`, `medium`, and `high`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.  | [optional][default to 'medium'] |
+| **metadata** | **Hash<String, String>** | Developer-defined tags and values used for filtering completions in the [dashboard](https://platform.openai.com/chat-completions).  | [optional] |
+| **frequency_penalty** | **Float** | 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.  | [optional][default to 0] |
 | **logit_bias** | **Hash<String, Integer>** | Modify the likelihood of specified tokens appearing in the completion.  Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. 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.  | [optional] |
-| **logprobs** | **Boolean** | Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. | [optional][default to false] |
-| **top_logprobs** | **Integer** | An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. | [optional] |
-| **max_tokens** | **Integer** | The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.  The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.  | [optional] |
+| **logprobs** | **Boolean** | Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.  | [optional][default to false] |
+| **top_logprobs** | **Integer** | An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.  | [optional] |
+| **max_tokens** | **Integer** | The maximum number of [tokens](/tokenizer) that can be generated in the chat completion. This value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API.  This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with [o1 series models](/docs/guides/reasoning).  | [optional] |
+| **max_completion_tokens** | **Integer** | An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).  | [optional] |
 | **n** | **Integer** | How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. | [optional][default to 1] |
-| **presence_penalty** | **Float** | 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.  [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)  | [optional][default to 0] |
+| **modalities** | **Array<String>** | Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:  `[\"text\"]`  The `gpt-4o-audio-preview` model can also be used to [generate audio](/docs/guides/audio). To request that this model generate both text and audio responses, you can use:  `[\"text\", \"audio\"]`  | [optional] |
+| **prediction** | [**PredictionContent**](PredictionContent.md) |  | [optional] |
+| **audio** | [**CreateChatCompletionRequestAudio**](CreateChatCompletionRequestAudio.md) |  | [optional] |
+| **presence_penalty** | **Float** | 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.  | [optional][default to 0] |
 | **response_format** | [**CreateChatCompletionRequestResponseFormat**](CreateChatCompletionRequestResponseFormat.md) |  | [optional] |
 | **seed** | **Integer** | This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.  | [optional] |
+| **service_tier** | **String** | Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:    - If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.   - If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.   - If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.   - When not set, the default behavior is 'auto'.    When this parameter is set, the response body will include the `service_tier` utilized.  | [optional][default to 'auto'] |
 | **stop** | [**CreateChatCompletionRequestStop**](CreateChatCompletionRequestStop.md) |  | [optional] |
 | **stream** | **Boolean** | If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).  | [optional][default to false] |
-| **temperature** | **Float** | 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.  We generally recommend altering this or `top_p` but not both.  | [optional][default to 1] |
+| **stream_options** | [**ChatCompletionStreamOptions**](ChatCompletionStreamOptions.md) |  | [optional] |
+| **temperature** | **Float** | 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. We generally recommend altering this or `top_p` but not both.  | [optional][default to 1] |
 | **top_p** | **Float** | 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.  We generally recommend altering this or `temperature` but not both.  | [optional][default to 1] |
 | **tools** | [**Array<ChatCompletionTool>**](ChatCompletionTool.md) | 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.  | [optional] |
 | **tool_choice** | [**ChatCompletionToolChoiceOption**](ChatCompletionToolChoiceOption.md) |  | [optional] |
-| **user** | **String** | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).  | [optional] |
+| **parallel_tool_calls** | **Boolean** | Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. | [optional][default to true] |
+| **user** | **String** | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).  | [optional] |
 | **function_call** | [**CreateChatCompletionRequestFunctionCall**](CreateChatCompletionRequestFunctionCall.md) |  | [optional] |
 | **functions** | [**Array<ChatCompletionFunctions>**](ChatCompletionFunctions.md) | Deprecated in favor of `tools`.  A list of functions the model may generate JSON inputs for.  | [optional] |
 
@@ -33,21 +43,31 @@ require 'openapi_openai'
 instance = OpenApiOpenAIClient::CreateChatCompletionRequest.new(
   messages: null,
   model: null,
+  store: null,
+  reasoning_effort: null,
+  metadata: null,
   frequency_penalty: null,
   logit_bias: null,
   logprobs: null,
   top_logprobs: null,
   max_tokens: null,
+  max_completion_tokens: null,
   n: 1,
+  modalities: null,
+  prediction: null,
+  audio: null,
   presence_penalty: null,
   response_format: null,
   seed: null,
+  service_tier: null,
   stop: null,
   stream: null,
+  stream_options: null,
   temperature: 1,
   top_p: 1,
   tools: null,
   tool_choice: null,
+  parallel_tool_calls: null,
   user: user-1234,
   function_call: null,
   functions: null

data/docs/CreateChatCompletionRequestAudio.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateChatCompletionRequestAudio
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **voice** | **String** | The voice the model uses to respond. Supported voices are `ash`, `ballad`, `coral`, `sage`, and `verse` (also supported but not recommended are `alloy`, `echo`, and `shimmer`; these voices are less expressive).  |  |
+| **format** | **String** | Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`.  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateChatCompletionRequestAudio.new(
+  voice: null,
+  format: null
+)
+```
+

data/docs/CreateChatCompletionRequestResponseFormat.md

@@ -1,18 +1,51 @@
 # OpenApiOpenAIClient::CreateChatCompletionRequestResponseFormat
 
-## Properties
+## Class instance methods
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | Must be one of `text` or `json_object`. | [optional][default to 'text'] |
+### `openapi_one_of`
 
-## Example
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateChatCompletionRequestResponseFormat.openapi_one_of
+# =>
+# [
+#   :'ResponseFormatJsonObject',
+#   :'ResponseFormatJsonSchema',
+#   :'ResponseFormatText'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
 
 ```ruby
 require 'openapi_openai'
 
-instance = OpenApiOpenAIClient::CreateChatCompletionRequestResponseFormat.new(
-  type: json_object
-)
+OpenApiOpenAIClient::CreateChatCompletionRequestResponseFormat.build(data)
+# => #<ResponseFormatJsonObject:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateChatCompletionRequestResponseFormat.build(data_that_doesnt_match)
+# => nil
 ```
 
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ResponseFormatJsonObject`
+- `ResponseFormatJsonSchema`
+- `ResponseFormatText`
+- `nil` (if no type matches)
+

data/docs/CreateChatCompletionResponse.md

@@ -8,6 +8,7 @@
 | **choices** | [**Array<CreateChatCompletionResponseChoicesInner>**](CreateChatCompletionResponseChoicesInner.md) | A list of chat completion choices. Can be more than one if `n` is greater than 1. |  |
 | **created** | **Integer** | The Unix timestamp (in seconds) of when the chat completion was created. |  |
 | **model** | **String** | The model used for the chat completion. |  |
+| **service_tier** | **String** | The service tier used for processing the request. This field is only included if the `service_tier` parameter is specified in the request. | [optional] |
 | **system_fingerprint** | **String** | This fingerprint represents the backend configuration that the model runs with.  Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.  | [optional] |
 | **object** | **String** | The object type, which is always `chat.completion`. |  |
 | **usage** | [**CompletionUsage**](CompletionUsage.md) |  | [optional] |
@@ -22,6 +23,7 @@ instance = OpenApiOpenAIClient::CreateChatCompletionResponse.new(
   choices: null,
   created: null,
   model: null,
+  service_tier: scale,
   system_fingerprint: null,
   object: null,
   usage: null

data/docs/CreateChatCompletionResponseChoicesInnerLogprobs.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **content** | [**Array<ChatCompletionTokenLogprob>**](ChatCompletionTokenLogprob.md) | A list of message content tokens with log probability information. |  |
+| **refusal** | [**Array<ChatCompletionTokenLogprob>**](ChatCompletionTokenLogprob.md) | A list of message refusal tokens with log probability information. |  |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::CreateChatCompletionResponseChoicesInnerLogprobs.new(
-  content: null
+  content: null,
+  refusal: null
 )
 ```
 

data/docs/CreateChatCompletionStreamResponse.md

@@ -5,11 +5,13 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | A unique identifier for the chat completion. Each chunk has the same ID. |  |
-| **choices** | [**Array<CreateChatCompletionStreamResponseChoicesInner>**](CreateChatCompletionStreamResponseChoicesInner.md) | A list of chat completion choices. Can be more than one if `n` is greater than 1. |  |
+| **choices** | [**Array<CreateChatCompletionStreamResponseChoicesInner>**](CreateChatCompletionStreamResponseChoicesInner.md) | A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the last chunk if you set `stream_options: {\"include_usage\": true}`.  |  |
 | **created** | **Integer** | The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp. |  |
 | **model** | **String** | The model to generate the completion. |  |
+| **service_tier** | **String** | The service tier used for processing the request. This field is only included if the `service_tier` parameter is specified in the request. | [optional] |
 | **system_fingerprint** | **String** | This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.  | [optional] |
 | **object** | **String** | The object type, which is always `chat.completion.chunk`. |  |
+| **usage** | [**CreateChatCompletionStreamResponseUsage**](CreateChatCompletionStreamResponseUsage.md) |  | [optional] |
 
 ## Example
 
@@ -21,8 +23,10 @@ instance = OpenApiOpenAIClient::CreateChatCompletionStreamResponse.new(
   choices: null,
   created: null,
   model: null,
+  service_tier: scale,
   system_fingerprint: null,
-  object: null
+  object: null,
+  usage: null
 )
 ```
 

data/docs/CreateChatCompletionStreamResponseUsage.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateChatCompletionStreamResponseUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completion_tokens** | **Integer** | Number of tokens in the generated completion. |  |
+| **prompt_tokens** | **Integer** | Number of tokens in the prompt. |  |
+| **total_tokens** | **Integer** | Total number of tokens used in the request (prompt + completion). |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateChatCompletionStreamResponseUsage.new(
+  completion_tokens: null,
+  prompt_tokens: null,
+  total_tokens: null
+)
+```
+

data/docs/CreateCompletionRequest.md

@@ -8,19 +8,20 @@
 | **prompt** | [**CreateCompletionRequestPrompt**](CreateCompletionRequestPrompt.md) |  |  |
 | **best_of** | **Integer** | 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`.  | [optional][default to 1] |
 | **echo** | **Boolean** | Echo back the prompt in addition to the completion  | [optional][default to false] |
-| **frequency_penalty** | **Float** | 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.](/docs/guides/text-generation/parameter-details)  | [optional][default to 0] |
+| **frequency_penalty** | **Float** | 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.](/docs/guides/text-generation)  | [optional][default to 0] |
 | **logit_bias** | **Hash<String, Integer>** | 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](/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.  | [optional] |
 | **logprobs** | **Integer** | 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.  | [optional] |
 | **max_tokens** | **Integer** | The maximum number of [tokens](/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.  | [optional][default to 16] |
 | **n** | **Integer** | How many completions to generate for each prompt.  **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`.  | [optional][default to 1] |
-| **presence_penalty** | **Float** | 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.  [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)  | [optional][default to 0] |
+| **presence_penalty** | **Float** | 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.  [See more information about frequency and presence penalties.](/docs/guides/text-generation)  | [optional][default to 0] |
 | **seed** | **Integer** | If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.  Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.  | [optional] |
 | **stop** | [**CreateCompletionRequestStop**](CreateCompletionRequestStop.md) |  | [optional] |
 | **stream** | **Boolean** | Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).  | [optional][default to false] |
+| **stream_options** | [**ChatCompletionStreamOptions**](ChatCompletionStreamOptions.md) |  | [optional] |
 | **suffix** | **String** | The suffix that comes after a completion of inserted text.  This parameter is only supported for `gpt-3.5-turbo-instruct`.  | [optional] |
 | **temperature** | **Float** | 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.  We generally recommend altering this or `top_p` but not both.  | [optional][default to 1] |
 | **top_p** | **Float** | 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.  We generally recommend altering this or `temperature` but not both.  | [optional][default to 1] |
-| **user** | **String** | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).  | [optional] |
+| **user** | **String** | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).  | [optional] |
 
 ## Example
 
@@ -41,6 +42,7 @@ instance = OpenApiOpenAIClient::CreateCompletionRequest.new(
   seed: null,
   stop: null,
   stream: null,
+  stream_options: null,
   suffix: test.,
   temperature: 1,
   top_p: 1,

data/docs/CreateEmbeddingRequest.md

@@ -8,7 +8,7 @@
 | **model** | [**CreateEmbeddingRequestModel**](CreateEmbeddingRequestModel.md) |  |  |
 | **encoding_format** | **String** | The format to return the embeddings in. Can be either `float` or [`base64`](https://pypi.org/project/pybase64/). | [optional][default to 'float'] |
 | **dimensions** | **Integer** | The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.  | [optional] |
-| **user** | **String** | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).  | [optional] |
+| **user** | **String** | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).  | [optional] |
 
 ## Example
 

data/docs/CreateFineTuningJobRequest.md

@@ -5,12 +5,13 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **model** | [**CreateFineTuningJobRequestModel**](CreateFineTuningJobRequestModel.md) |  |  |
-| **training_file** | **String** | The ID of an uploaded file that contains training data.  See [upload file](/docs/api-reference/files/upload) for how to upload a file.  Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose `fine-tune`.  See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.  |  |
+| **training_file** | **String** | The ID of an uploaded file that contains training data.  See [upload file](/docs/api-reference/files/create) for how to upload a file.  Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose `fine-tune`.  The contents of the file should differ depending on if the model uses the [chat](/docs/api-reference/fine-tuning/chat-input), [completions](/docs/api-reference/fine-tuning/completions-input) format, or if the fine-tuning method uses the [preference](/docs/api-reference/fine-tuning/preference-input) format.  See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.  |  |
 | **hyperparameters** | [**CreateFineTuningJobRequestHyperparameters**](CreateFineTuningJobRequestHyperparameters.md) |  | [optional] |
-| **suffix** | **String** | A string of up to 18 characters that will be added to your fine-tuned model name.  For example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel`.  | [optional] |
+| **suffix** | **String** | A string of up to 64 characters that will be added to your fine-tuned model name.  For example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.  | [optional] |
 | **validation_file** | **String** | The ID of an uploaded file that contains validation data.  If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files.  Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.  See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.  | [optional] |
 | **integrations** | [**Array<CreateFineTuningJobRequestIntegrationsInner>**](CreateFineTuningJobRequestIntegrationsInner.md) | A list of integrations to enable for your fine-tuning job. | [optional] |
 | **seed** | **Integer** | The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.  | [optional] |
+| **method** | [**FineTuneMethod**](FineTuneMethod.md) |  | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = OpenApiOpenAIClient::CreateFineTuningJobRequest.new(
   suffix: null,
   validation_file: file-abc123,
   integrations: null,
-  seed: 42
+  seed: 42,
+  method: null
 )
 ```
 

data/docs/CreateFineTuningJobRequestIntegrationsInner.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | [**CreateFineTuningJobRequestIntegrationsInnerType**](CreateFineTuningJobRequestIntegrationsInnerType.md) |  |  |
+| **type** | **String** |  |  |
 | **wandb** | [**CreateFineTuningJobRequestIntegrationsInnerWandb**](CreateFineTuningJobRequestIntegrationsInnerWandb.md) |  |  |
 
 ## Example

data/docs/CreateImageRequest.md

@@ -11,7 +11,7 @@
 | **response_format** | **String** | The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. | [optional][default to 'url'] |
 | **size** | **String** | The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`. Must be one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3` models. | [optional][default to '1024x1024'] |
 | **style** | **String** | The style of the generated images. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for `dall-e-3`. | [optional][default to 'vivid'] |
-| **user** | **String** | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).  | [optional] |
+| **user** | **String** | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).  | [optional] |
 
 ## Example
 

data/docs/CreateMessageRequest.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **role** | **String** | The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.  |  |
-| **content** | **String** | The content of the message. |  |
-| **file_ids** | **Array<String>** | A list of [File](/docs/api-reference/files) IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like `retrieval` and `code_interpreter` that can access and use files. | [optional] |
-| **metadata** | **Object** | 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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.  | [optional] |
+| **content** | [**CreateMessageRequestContent**](CreateMessageRequestContent.md) |  |  |
+| **attachments** | [**Array<CreateMessageRequestAttachmentsInner>**](CreateMessageRequestAttachmentsInner.md) | A list of files attached to the message, and the tools they should be added to. | [optional] |
+| **metadata** | **Object** | 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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.  | [optional] |
 
 ## Example
 
@@ -17,7 +17,7 @@ require 'openapi_openai'
 instance = OpenApiOpenAIClient::CreateMessageRequest.new(
   role: null,
   content: null,
-  file_ids: null,
+  attachments: null,
   metadata: null
 )
 ```

data/docs/CreateMessageRequestAttachmentsInner.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateMessageRequestAttachmentsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The ID of the file to attach to the message. | [optional] |
+| **tools** | [**Array<CreateMessageRequestAttachmentsInnerToolsInner>**](CreateMessageRequestAttachmentsInnerToolsInner.md) | The tools to add this file to. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateMessageRequestAttachmentsInner.new(
+  file_id: null,
+  tools: null
+)
+```
+

data/docs/CreateMessageRequestAttachmentsInnerToolsInner.md

@@ -0,0 +1,49 @@
+# OpenApiOpenAIClient::CreateMessageRequestAttachmentsInnerToolsInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateMessageRequestAttachmentsInnerToolsInner.openapi_one_of
+# =>
+# [
+#   :'AssistantToolsCode',
+#   :'AssistantToolsFileSearchTypeOnly'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateMessageRequestAttachmentsInnerToolsInner.build(data)
+# => #<AssistantToolsCode:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateMessageRequestAttachmentsInnerToolsInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `AssistantToolsCode`
+- `AssistantToolsFileSearchTypeOnly`
+- `nil` (if no type matches)
+