openapi_openai 1.0.0

data/docs/CreateCompletionResponse.md

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

data/docs/CreateCompletionResponseChoicesInner.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::CreateCompletionResponseChoicesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  |  |
+| **index** | **Integer** |  |  |
+| **logprobs** | [**CreateCompletionResponseChoicesInnerLogprobs**](CreateCompletionResponseChoicesInnerLogprobs.md) |  |  |
+| **finish_reason** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateCompletionResponseChoicesInner.new(
+  text: null,
+  index: null,
+  logprobs: null,
+  finish_reason: null
+)
+```
+

data/docs/CreateCompletionResponseChoicesInnerLogprobs.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::CreateCompletionResponseChoicesInnerLogprobs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tokens** | **Array<String>** |  | [optional] |
+| **token_logprobs** | **Array<Float>** |  | [optional] |
+| **top_logprobs** | **Array<Object>** |  | [optional] |
+| **text_offset** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateCompletionResponseChoicesInnerLogprobs.new(
+  tokens: null,
+  token_logprobs: null,
+  top_logprobs: null,
+  text_offset: null
+)
+```
+

data/docs/CreateCompletionResponseUsage.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateCompletionResponseUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prompt_tokens** | **Integer** |  |  |
+| **completion_tokens** | **Integer** |  |  |
+| **total_tokens** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateCompletionResponseUsage.new(
+  prompt_tokens: null,
+  completion_tokens: null,
+  total_tokens: null
+)
+```
+

data/docs/CreateEditRequest.md

@@ -0,0 +1,28 @@
+# OpenApiOpenAIClient::CreateEditRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**CreateEditRequestModel**](CreateEditRequestModel.md) |  |  |
+| **input** | **String** | The input text to use as a starting point for the edit. | [optional][default to ''] |
+| **instruction** | **String** | The instruction that tells the model how to edit the prompt. |  |
+| **n** | **Integer** | How many edits to generate for the input and instruction. | [optional][default to 1] |
+| **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] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateEditRequest.new(
+  model: null,
+  input: What day of the wek is it?,
+  instruction: Fix the spelling mistakes.,
+  n: 1,
+  temperature: 1,
+  top_p: 1
+)
+```
+

data/docs/CreateEditRequestModel.md

@@ -0,0 +1,47 @@
+# OpenApiOpenAIClient::CreateEditRequestModel
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateEditRequestModel.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::CreateEditRequestModel.build(data)
+# => #<String:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateEditRequestModel.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/CreateEditResponse.md

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

data/docs/CreateEditResponseChoicesInner.md

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

data/docs/CreateEmbeddingRequest.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateEmbeddingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**CreateEmbeddingRequestModel**](CreateEmbeddingRequestModel.md) |  |  |
+| **input** | [**CreateEmbeddingRequestInput**](CreateEmbeddingRequestInput.md) |  |  |
+| **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::CreateEmbeddingRequest.new(
+  model: null,
+  input: null,
+  user: user-1234
+)
+```
+

data/docs/CreateEmbeddingRequestInput.md

@@ -0,0 +1,53 @@
+# OpenApiOpenAIClient::CreateEmbeddingRequestInput
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateEmbeddingRequestInput.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::CreateEmbeddingRequestInput.build(data)
+# => #<Array<Array<Integer>>:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateEmbeddingRequestInput.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/CreateEmbeddingRequestModel.md

@@ -0,0 +1,47 @@
+# OpenApiOpenAIClient::CreateEmbeddingRequestModel
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateEmbeddingRequestModel.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::CreateEmbeddingRequestModel.build(data)
+# => #<String:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateEmbeddingRequestModel.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/CreateEmbeddingResponse.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::CreateEmbeddingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **model** | **String** |  |  |
+| **data** | [**Array<CreateEmbeddingResponseDataInner>**](CreateEmbeddingResponseDataInner.md) |  |  |
+| **usage** | [**CreateEmbeddingResponseUsage**](CreateEmbeddingResponseUsage.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateEmbeddingResponse.new(
+  object: null,
+  model: null,
+  data: null,
+  usage: null
+)
+```
+

data/docs/CreateEmbeddingResponseDataInner.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateEmbeddingResponseDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** |  |  |
+| **object** | **String** |  |  |
+| **embedding** | **Array<Float>** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateEmbeddingResponseDataInner.new(
+  index: null,
+  object: null,
+  embedding: null
+)
+```
+

data/docs/CreateEmbeddingResponseUsage.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateEmbeddingResponseUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prompt_tokens** | **Integer** |  |  |
+| **total_tokens** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateEmbeddingResponseUsage.new(
+  prompt_tokens: null,
+  total_tokens: null
+)
+```
+

data/docs/CreateFineTuneRequest.md

@@ -0,0 +1,40 @@
+# OpenApiOpenAIClient::CreateFineTuneRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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, where each training example is a JSON object with the keys \"prompt\" and \"completion\". Additionally, you must upload your file with the purpose `fine-tune`.  See the [fine-tuning guide](/docs/guides/fine-tuning/creating-training-data) for more details.  |  |
+| **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](/docs/guides/fine-tuning/analyzing-your-fine-tuned-model). Your train and validation data should be mutually exclusive.  Your dataset must be formatted as a JSONL file, where each validation example is a JSON object with the keys \"prompt\" and \"completion\". Additionally, you must upload your file with the purpose `fine-tune`.  See the [fine-tuning guide](/docs/guides/fine-tuning/creating-training-data) for more details.  | [optional] |
+| **model** | [**CreateFineTuneRequestModel**](CreateFineTuneRequestModel.md) |  | [optional] |
+| **n_epochs** | **Integer** | The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.  | [optional][default to 4] |
+| **batch_size** | **Integer** | The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.  By default, the batch size will be dynamically configured to be ~0.2% of the number of examples in the training set, capped at 256 - in general, we've found that larger batch sizes tend to work better for larger datasets.  | [optional] |
+| **learning_rate_multiplier** | **Float** | The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pretraining multiplied by this value.  By default, the learning rate multiplier is the 0.05, 0.1, or 0.2 depending on final `batch_size` (larger learning rates tend to perform better with larger batch sizes). We recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.  | [optional] |
+| **prompt_loss_weight** | **Float** | The weight to use for loss on the prompt tokens. This controls how much the model tries to learn to generate the prompt (as compared to the completion which always has a weight of 1.0), and can add a stabilizing effect to training when completions are short.  If prompts are extremely long (relative to completions), it may make sense to reduce this weight so as to avoid over-prioritizing learning the prompt.  | [optional][default to 0.01] |
+| **compute_classification_metrics** | **Boolean** | If set, we calculate classification-specific metrics such as accuracy and F-1 score using the validation set at the end of every epoch. These metrics can be viewed in the [results file](/docs/guides/fine-tuning/analyzing-your-fine-tuned-model).  In order to compute classification metrics, you must provide a `validation_file`. Additionally, you must specify `classification_n_classes` for multiclass classification or `classification_positive_class` for binary classification.  | [optional][default to false] |
+| **classification_n_classes** | **Integer** | The number of classes in a classification task.  This parameter is required for multiclass classification.  | [optional] |
+| **classification_positive_class** | **String** | The positive class in binary classification.  This parameter is needed to generate precision, recall, and F1 metrics when doing binary classification.  | [optional] |
+| **classification_betas** | **Array<Float>** | If this is provided, we calculate F-beta scores at the specified beta values. The F-beta score is a generalization of F-1 score. This is only used for binary classification.  With a beta of 1 (i.e. the F-1 score), precision and recall are given the same weight. A larger beta score puts more weight on recall and less on precision. A smaller beta score puts more weight on precision and less on recall.  | [optional] |
+| **suffix** | **String** | A string of up to 40 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 `ada:ft-your-org:custom-model-name-2022-02-15-04-21-04`.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateFineTuneRequest.new(
+  training_file: file-ajSREls59WBbvgSzJSVWxMCB,
+  validation_file: file-XjSREls59WBbvgSzJSVWxMCa,
+  model: null,
+  n_epochs: null,
+  batch_size: null,
+  learning_rate_multiplier: null,
+  prompt_loss_weight: null,
+  compute_classification_metrics: null,
+  classification_n_classes: null,
+  classification_positive_class: null,
+  classification_betas: [0.6,1,1.5,2],
+  suffix: null
+)
+```
+

data/docs/CreateFineTuneRequestModel.md

@@ -0,0 +1,47 @@
+# OpenApiOpenAIClient::CreateFineTuneRequestModel
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateFineTuneRequestModel.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::CreateFineTuneRequestModel.build(data)
+# => #<String:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateFineTuneRequestModel.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/CreateImageRequest.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::CreateImageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prompt** | **String** | A text description of the desired image(s). The maximum length is 1000 characters. |  |
+| **n** | **Integer** | The number of images to generate. Must be between 1 and 10. | [optional][default to 1] |
+| **size** | **String** | The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`. | [optional][default to '1024x1024'] |
+| **response_format** | **String** | The format in which the generated images are returned. Must be one of `url` or `b64_json`. | [optional][default to 'url'] |
+| **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::CreateImageRequest.new(
+  prompt: A cute baby sea otter,
+  n: 1,
+  size: 1024x1024,
+  response_format: url,
+  user: user-1234
+)
+```
+

data/docs/CreateModerationRequest.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateModerationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | [**CreateModerationRequestInput**](CreateModerationRequestInput.md) |  |  |
+| **model** | [**CreateModerationRequestModel**](CreateModerationRequestModel.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateModerationRequest.new(
+  input: null,
+  model: null
+)
+```
+

data/docs/CreateModerationRequestInput.md

@@ -0,0 +1,49 @@
+# OpenApiOpenAIClient::CreateModerationRequestInput
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateModerationRequestInput.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::CreateModerationRequestInput.build(data)
+# => #<Array<String>:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateModerationRequestInput.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/CreateModerationRequestModel.md

@@ -0,0 +1,47 @@
+# OpenApiOpenAIClient::CreateModerationRequestModel
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::CreateModerationRequestModel.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::CreateModerationRequestModel.build(data)
+# => #<String:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::CreateModerationRequestModel.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/CreateModerationResponse.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateModerationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **model** | **String** |  |  |
+| **results** | [**Array<CreateModerationResponseResultsInner>**](CreateModerationResponseResultsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateModerationResponse.new(
+  id: null,
+  model: null,
+  results: null
+)
+```
+