openapi_openai 1.0.0

data/bin/ruby-rewrite

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby2.7
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-rewrite' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("parser", "ruby-rewrite")

data/docs/ChatCompletionFunctions.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionFunctions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |  |
+| **description** | **String** | The description of what the function does. | [optional] |
+| **parameters** | **Hash<String, Object>** | The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionFunctions.new(
+  name: null,
+  description: null,
+  parameters: null
+)
+```
+

data/docs/ChatCompletionRequestMessage.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::ChatCompletionRequestMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role** | **String** | The role of the messages author. One of `system`, `user`, `assistant`, or `function`. |  |
+| **content** | **String** | The contents of the message. `content` is required for all messages except assistant messages with function calls. | [optional] |
+| **name** | **String** | The name of the author of this message. `name` is required if role is `function`, and it should be the name of the function whose response is in the `content`. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters. | [optional] |
+| **function_call** | [**ChatCompletionRequestMessageFunctionCall**](ChatCompletionRequestMessageFunctionCall.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestMessage.new(
+  role: null,
+  content: null,
+  name: null,
+  function_call: null
+)
+```
+

data/docs/ChatCompletionRequestMessageFunctionCall.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::ChatCompletionRequestMessageFunctionCall
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the function to call. | [optional] |
+| **arguments** | **String** | The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestMessageFunctionCall.new(
+  name: null,
+  arguments: null
+)
+```
+

data/docs/ChatCompletionResponseMessage.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionResponseMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role** | **String** | The role of the author of this message. |  |
+| **content** | **String** | The contents of the message. | [optional] |
+| **function_call** | [**ChatCompletionRequestMessageFunctionCall**](ChatCompletionRequestMessageFunctionCall.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionResponseMessage.new(
+  role: null,
+  content: null,
+  function_call: null
+)
+```
+

data/docs/ChatCompletionStreamResponseDelta.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionStreamResponseDelta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role** | **String** | The role of the author of this message. | [optional] |
+| **content** | **String** | The contents of the chunk message. | [optional] |
+| **function_call** | [**ChatCompletionRequestMessageFunctionCall**](ChatCompletionRequestMessageFunctionCall.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionStreamResponseDelta.new(
+  role: null,
+  content: null,
+  function_call: null
+)
+```
+

data/docs/CreateChatCompletionRequest.md

@@ -0,0 +1,44 @@
+# OpenApiOpenAIClient::CreateChatCompletionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**CreateChatCompletionRequestModel**](CreateChatCompletionRequestModel.md) |  |  |
+| **messages** | [**Array<ChatCompletionRequestMessage>**](ChatCompletionRequestMessage.md) | A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb). |  |
+| **functions** | [**Array<ChatCompletionFunctions>**](ChatCompletionFunctions.md) | A list of functions the model may generate JSON inputs for. | [optional] |
+| **function_call** | [**CreateChatCompletionRequestFunctionCall**](CreateChatCompletionRequestFunctionCall.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] |
+| **n** | **Integer** | How many chat completion choices to generate for each input message. | [optional][default to 1] |
+| **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://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).  | [optional][default to false] |
+| **stop** | [**CreateChatCompletionRequestStop**](CreateChatCompletionRequestStop.md) |  | [optional] |
+| **max_tokens** | **Integer** | The maximum number of [tokens](/tokenizer) to generate 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://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb) for counting tokens.  | [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.  [See more information about frequency and presence penalties.](/docs/api-reference/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/api-reference/parameter-details)  | [optional][default to 0] |
+| **logit_bias** | **Object** | 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] |
+| **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
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateChatCompletionRequest.new(
+  model: null,
+  messages: null,
+  functions: null,
+  function_call: null,
+  temperature: 1,
+  top_p: 1,
+  n: 1,
+  stream: null,
+  stop: null,
+  max_tokens: null,
+  presence_penalty: null,
+  frequency_penalty: null,
+  logit_bias: null,
+  user: user-1234
+)
+```
+

data/docs/CreateChatCompletionRequestFunctionCall.md

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

data/docs/CreateChatCompletionRequestFunctionCallOneOf.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::CreateChatCompletionRequestFunctionCallOneOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the function to call. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateChatCompletionRequestFunctionCallOneOf.new(
+  name: null
+)
+```
+

data/docs/CreateChatCompletionRequestModel.md

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

data/docs/CreateChatCompletionRequestStop.md

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

data/docs/CreateChatCompletionResponse.md

@@ -0,0 +1,28 @@
+# OpenApiOpenAIClient::CreateChatCompletionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **object** | **String** |  |  |
+| **created** | **Integer** |  |  |
+| **model** | **String** |  |  |
+| **choices** | [**Array<CreateChatCompletionResponseChoicesInner>**](CreateChatCompletionResponseChoicesInner.md) |  |  |
+| **usage** | [**CreateCompletionResponseUsage**](CreateCompletionResponseUsage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateChatCompletionResponse.new(
+  id: null,
+  object: null,
+  created: null,
+  model: null,
+  choices: null,
+  usage: null
+)
+```
+

data/docs/CreateChatCompletionResponseChoicesInner.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateChatCompletionResponseChoicesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** |  | [optional] |
+| **message** | [**ChatCompletionResponseMessage**](ChatCompletionResponseMessage.md) |  | [optional] |
+| **finish_reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateChatCompletionResponseChoicesInner.new(
+  index: null,
+  message: null,
+  finish_reason: null
+)
+```
+

data/docs/CreateChatCompletionStreamResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::CreateChatCompletionStreamResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **object** | **String** |  |  |
+| **created** | **Integer** |  |  |
+| **model** | **String** |  |  |
+| **choices** | [**Array<CreateChatCompletionStreamResponseChoicesInner>**](CreateChatCompletionStreamResponseChoicesInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateChatCompletionStreamResponse.new(
+  id: null,
+  object: null,
+  created: null,
+  model: null,
+  choices: null
+)
+```
+

data/docs/CreateChatCompletionStreamResponseChoicesInner.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateChatCompletionStreamResponseChoicesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** |  | [optional] |
+| **delta** | [**ChatCompletionStreamResponseDelta**](ChatCompletionStreamResponseDelta.md) |  | [optional] |
+| **finish_reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateChatCompletionStreamResponseChoicesInner.new(
+  index: null,
+  delta: null,
+  finish_reason: null
+)
+```
+

data/docs/CreateCompletionRequest.md

@@ -0,0 +1,48 @@
+# OpenApiOpenAIClient::CreateCompletionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**CreateCompletionRequestModel**](CreateCompletionRequestModel.md) |  |  |
+| **prompt** | [**CreateCompletionRequestPrompt**](CreateCompletionRequestPrompt.md) |  |  |
+| **suffix** | **String** | The suffix that comes after a completion of inserted text. | [optional] |
+| **max_tokens** | **Integer** | The maximum number of [tokens](/tokenizer) to generate in the completion.  The token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb) for counting tokens.  | [optional][default to 16] |
+| **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] |
+| **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] |
+| **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://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).  | [optional][default to false] |
+| **logprobs** | **Integer** | Include the log probabilities on the `logprobs` most likely 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] |
+| **echo** | **Boolean** | Echo back the prompt in addition to the completion  | [optional][default to false] |
+| **stop** | [**CreateCompletionRequestStop**](CreateCompletionRequestStop.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.  [See more information about frequency and presence penalties.](/docs/api-reference/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/api-reference/parameter-details)  | [optional][default to 0] |
+| **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] |
+| **logit_bias** | **Object** | 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) (which works for both GPT-2 and GPT-3) 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] |
+| **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
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateCompletionRequest.new(
+  model: null,
+  prompt: null,
+  suffix: test.,
+  max_tokens: 16,
+  temperature: 1,
+  top_p: 1,
+  n: 1,
+  stream: null,
+  logprobs: null,
+  echo: null,
+  stop: null,
+  presence_penalty: null,
+  frequency_penalty: null,
+  best_of: null,
+  logit_bias: null,
+  user: user-1234
+)
+```
+

data/docs/CreateCompletionRequestModel.md

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

data/docs/CreateCompletionRequestPrompt.md

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

data/docs/CreateCompletionRequestStop.md

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