openapi_openai 1.0.0 → 1.1.0

data/docs/FineTuningJobIntegrationsInner.md

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

data/docs/FunctionObject.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::FunctionObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | A description of what the function does, used by the model to choose when and how to call the function. | [optional] |
+| **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. |  |
+| **parameters** | **Hash<String, Object>** | The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.   Omitting `parameters` defines a function with an empty parameter list. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::FunctionObject.new(
+  description: null,
+  name: null,
+  parameters: null
+)
+```
+

data/docs/Image.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::Image
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **b64_json** | **String** | The base64-encoded JSON of the generated image, if `response_format` is `b64_json`. | [optional] |
+| **url** | **String** | The URL of the generated image, if `response_format` is `url` (default). | [optional] |
+| **revised_prompt** | **String** | The prompt that was used to generate the image, if there was any revision to the prompt. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::Image.new(
+  b64_json: null,
+  url: null,
+  revised_prompt: null
+)
+```
+

data/docs/ImagesApi.md

@@ -0,0 +1,239 @@
+# OpenApiOpenAIClient::ImagesApi
+
+All URIs are relative to *https://api.openai.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_image**](ImagesApi.md#create_image) | **POST** /images/generations | Creates an image given a prompt. |
+| [**create_image_edit**](ImagesApi.md#create_image_edit) | **POST** /images/edits | Creates an edited or extended image given an original image and a prompt. |
+| [**create_image_variation**](ImagesApi.md#create_image_variation) | **POST** /images/variations | Creates a variation of a given image. |
+
+
+## create_image
+
+> <ImagesResponse> create_image(create_image_request)
+
+Creates an image given a prompt.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_openai'
+# setup authorization
+OpenApiOpenAIClient.configure do |config|
+  # Configure Bearer authorization: ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenApiOpenAIClient::ImagesApi.new
+create_image_request = OpenApiOpenAIClient::CreateImageRequest.new({prompt: 'A cute baby sea otter'}) # CreateImageRequest | 
+
+begin
+  # Creates an image given a prompt.
+  result = api_instance.create_image(create_image_request)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ImagesApi->create_image: #{e}"
+end
+```
+
+#### Using the create_image_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImagesResponse>, Integer, Hash)> create_image_with_http_info(create_image_request)
+
+```ruby
+begin
+  # Creates an image given a prompt.
+  data, status_code, headers = api_instance.create_image_with_http_info(create_image_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImagesResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ImagesApi->create_image_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_image_request** | [**CreateImageRequest**](CreateImageRequest.md) |  |  |
+
+### Return type
+
+[**ImagesResponse**](ImagesResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_image_edit
+
+> <ImagesResponse> create_image_edit(image, prompt, opts)
+
+Creates an edited or extended image given an original image and a prompt.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_openai'
+# setup authorization
+OpenApiOpenAIClient.configure do |config|
+  # Configure Bearer authorization: ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenApiOpenAIClient::ImagesApi.new
+image = File.new('/path/to/some/file') # File | The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.
+prompt = 'prompt_example' # String | A text description of the desired image(s). The maximum length is 1000 characters.
+opts = {
+  mask: File.new('/path/to/some/file'), # File | An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`.
+  model: OpenApiOpenAIClient::CreateImageEditRequestModel.new, # CreateImageEditRequestModel | 
+  n: 56, # Integer | The number of images to generate. Must be between 1 and 10.
+  size: '256x256', # String | The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
+  response_format: 'url', # 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.
+  user: 'user_example' # 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). 
+}
+
+begin
+  # Creates an edited or extended image given an original image and a prompt.
+  result = api_instance.create_image_edit(image, prompt, opts)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ImagesApi->create_image_edit: #{e}"
+end
+```
+
+#### Using the create_image_edit_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImagesResponse>, Integer, Hash)> create_image_edit_with_http_info(image, prompt, opts)
+
+```ruby
+begin
+  # Creates an edited or extended image given an original image and a prompt.
+  data, status_code, headers = api_instance.create_image_edit_with_http_info(image, prompt, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImagesResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ImagesApi->create_image_edit_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image** | **File** | The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask. |  |
+| **prompt** | **String** | A text description of the desired image(s). The maximum length is 1000 characters. |  |
+| **mask** | **File** | An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where &#x60;image&#x60; should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as &#x60;image&#x60;. | [optional] |
+| **model** | [**CreateImageEditRequestModel**](CreateImageEditRequestModel.md) |  | [optional] |
+| **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 &#x60;256x256&#x60;, &#x60;512x512&#x60;, or &#x60;1024x1024&#x60;. | [optional][default to &#39;1024x1024&#39;] |
+| **response_format** | **String** | The format in which the generated images are returned. Must be one of &#x60;url&#x60; or &#x60;b64_json&#x60;. URLs are only valid for 60 minutes after the image has been generated. | [optional][default to &#39;url&#39;] |
+| **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] |
+
+### Return type
+
+[**ImagesResponse**](ImagesResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+
+
+## create_image_variation
+
+> <ImagesResponse> create_image_variation(image, opts)
+
+Creates a variation of a given image.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_openai'
+# setup authorization
+OpenApiOpenAIClient.configure do |config|
+  # Configure Bearer authorization: ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenApiOpenAIClient::ImagesApi.new
+image = File.new('/path/to/some/file') # File | The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.
+opts = {
+  model: OpenApiOpenAIClient::CreateImageEditRequestModel.new, # CreateImageEditRequestModel | 
+  n: 56, # Integer | The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
+  response_format: 'url', # 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.
+  size: '256x256', # String | The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
+  user: 'user_example' # 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). 
+}
+
+begin
+  # Creates a variation of a given image.
+  result = api_instance.create_image_variation(image, opts)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ImagesApi->create_image_variation: #{e}"
+end
+```
+
+#### Using the create_image_variation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImagesResponse>, Integer, Hash)> create_image_variation_with_http_info(image, opts)
+
+```ruby
+begin
+  # Creates a variation of a given image.
+  data, status_code, headers = api_instance.create_image_variation_with_http_info(image, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImagesResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ImagesApi->create_image_variation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image** | **File** | The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square. |  |
+| **model** | [**CreateImageEditRequestModel**](CreateImageEditRequestModel.md) |  | [optional] |
+| **n** | **Integer** | The number of images to generate. Must be between 1 and 10. For &#x60;dall-e-3&#x60;, only &#x60;n&#x3D;1&#x60; is supported. | [optional][default to 1] |
+| **response_format** | **String** | The format in which the generated images are returned. Must be one of &#x60;url&#x60; or &#x60;b64_json&#x60;. URLs are only valid for 60 minutes after the image has been generated. | [optional][default to &#39;url&#39;] |
+| **size** | **String** | The size of the generated images. Must be one of &#x60;256x256&#x60;, &#x60;512x512&#x60;, or &#x60;1024x1024&#x60;. | [optional][default to &#39;1024x1024&#39;] |
+| **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] |
+
+### Return type
+
+[**ImagesResponse**](ImagesResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/ImagesResponse.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **created** | **Integer** |  |  |
-| **data** | [**Array<ImagesResponseDataInner>**](ImagesResponseDataInner.md) |  |  |
+| **data** | [**Array<Image>**](Image.md) |  |  |
 
 ## Example
 

data/docs/ListAssistantFilesResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ListAssistantFilesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **data** | [**Array<AssistantFileObject>**](AssistantFileObject.md) |  |  |
+| **first_id** | **String** |  |  |
+| **last_id** | **String** |  |  |
+| **has_more** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListAssistantFilesResponse.new(
+  object: list,
+  data: null,
+  first_id: file-abc123,
+  last_id: file-abc456,
+  has_more: false
+)
+```
+

data/docs/ListAssistantsResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ListAssistantsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **data** | [**Array<AssistantObject>**](AssistantObject.md) |  |  |
+| **first_id** | **String** |  |  |
+| **last_id** | **String** |  |  |
+| **has_more** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListAssistantsResponse.new(
+  object: list,
+  data: null,
+  first_id: asst_abc123,
+  last_id: asst_abc456,
+  has_more: false
+)
+```
+

data/docs/ListFilesResponse.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** |  |  |
 | **data** | [**Array<OpenAIFile>**](OpenAIFile.md) |  |  |
+| **object** | **String** |  |  |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::ListFilesResponse.new(
-  object: null,
-  data: null
+  data: null,
+  object: null
 )
 ```
 

data/docs/ListFineTuningJobCheckpointsResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ListFineTuningJobCheckpointsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<FineTuningJobCheckpoint>**](FineTuningJobCheckpoint.md) |  |  |
+| **object** | **String** |  |  |
+| **first_id** | **String** |  | [optional] |
+| **last_id** | **String** |  | [optional] |
+| **has_more** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListFineTuningJobCheckpointsResponse.new(
+  data: null,
+  object: null,
+  first_id: null,
+  last_id: null,
+  has_more: null
+)
+```
+

data/docs/ListFineTuningJobEventsResponse.md

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

data/docs/ListMessageFilesResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ListMessageFilesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **data** | [**Array<MessageFileObject>**](MessageFileObject.md) |  |  |
+| **first_id** | **String** |  |  |
+| **last_id** | **String** |  |  |
+| **has_more** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListMessageFilesResponse.new(
+  object: list,
+  data: null,
+  first_id: file-abc123,
+  last_id: file-abc456,
+  has_more: false
+)
+```
+

data/docs/ListMessagesResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ListMessagesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **data** | [**Array<MessageObject>**](MessageObject.md) |  |  |
+| **first_id** | **String** |  |  |
+| **last_id** | **String** |  |  |
+| **has_more** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListMessagesResponse.new(
+  object: list,
+  data: null,
+  first_id: msg_abc123,
+  last_id: msg_abc123,
+  has_more: false
+)
+```
+

data/docs/ListPaginatedFineTuningJobsResponse.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ListPaginatedFineTuningJobsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<FineTuningJob>**](FineTuningJob.md) |  |  |
+| **has_more** | **Boolean** |  |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListPaginatedFineTuningJobsResponse.new(
+  data: null,
+  has_more: null,
+  object: null
+)
+```
+

data/docs/ListRunStepsResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ListRunStepsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **data** | [**Array<RunStepObject>**](RunStepObject.md) |  |  |
+| **first_id** | **String** |  |  |
+| **last_id** | **String** |  |  |
+| **has_more** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListRunStepsResponse.new(
+  object: list,
+  data: null,
+  first_id: step_abc123,
+  last_id: step_abc456,
+  has_more: false
+)
+```
+

data/docs/ListRunsResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ListRunsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **data** | [**Array<RunObject>**](RunObject.md) |  |  |
+| **first_id** | **String** |  |  |
+| **last_id** | **String** |  |  |
+| **has_more** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListRunsResponse.new(
+  object: list,
+  data: null,
+  first_id: run_abc123,
+  last_id: run_abc456,
+  has_more: false
+)
+```
+

data/docs/ListThreadsResponse.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ListThreadsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **data** | [**Array<ThreadObject>**](ThreadObject.md) |  |  |
+| **first_id** | **String** |  |  |
+| **last_id** | **String** |  |  |
+| **has_more** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ListThreadsResponse.new(
+  object: list,
+  data: null,
+  first_id: asst_abc123,
+  last_id: asst_abc456,
+  has_more: false
+)
+```
+

data/docs/MessageContentImageFileObject.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageContentImageFileObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Always `image_file`. |  |
+| **image_file** | [**MessageContentImageFileObjectImageFile**](MessageContentImageFileObjectImageFile.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageContentImageFileObject.new(
+  type: null,
+  image_file: null
+)
+```
+

data/docs/MessageContentImageFileObjectImageFile.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::MessageContentImageFileObjectImageFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The [File](/docs/api-reference/files) ID of the image in the message content. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageContentImageFileObjectImageFile.new(
+  file_id: null
+)
+```
+