openapi_openai 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (206) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +72 -0
  4. data/README.md +171 -0
  5. data/Rakefile +10 -0
  6. data/bin/bundle +109 -0
  7. data/bin/byebug +27 -0
  8. data/bin/coderay +27 -0
  9. data/bin/htmldiff +27 -0
  10. data/bin/ldiff +27 -0
  11. data/bin/pry +27 -0
  12. data/bin/racc +27 -0
  13. data/bin/rake +27 -0
  14. data/bin/rspec +27 -0
  15. data/bin/rubocop +27 -0
  16. data/bin/ruby-parse +27 -0
  17. data/bin/ruby-rewrite +27 -0
  18. data/docs/ChatCompletionFunctions.md +22 -0
  19. data/docs/ChatCompletionRequestMessage.md +24 -0
  20. data/docs/ChatCompletionRequestMessageFunctionCall.md +20 -0
  21. data/docs/ChatCompletionResponseMessage.md +22 -0
  22. data/docs/ChatCompletionStreamResponseDelta.md +22 -0
  23. data/docs/CreateChatCompletionRequest.md +44 -0
  24. data/docs/CreateChatCompletionRequestFunctionCall.md +49 -0
  25. data/docs/CreateChatCompletionRequestFunctionCallOneOf.md +18 -0
  26. data/docs/CreateChatCompletionRequestModel.md +47 -0
  27. data/docs/CreateChatCompletionRequestStop.md +49 -0
  28. data/docs/CreateChatCompletionResponse.md +28 -0
  29. data/docs/CreateChatCompletionResponseChoicesInner.md +22 -0
  30. data/docs/CreateChatCompletionStreamResponse.md +26 -0
  31. data/docs/CreateChatCompletionStreamResponseChoicesInner.md +22 -0
  32. data/docs/CreateCompletionRequest.md +48 -0
  33. data/docs/CreateCompletionRequestModel.md +47 -0
  34. data/docs/CreateCompletionRequestPrompt.md +53 -0
  35. data/docs/CreateCompletionRequestStop.md +49 -0
  36. data/docs/CreateCompletionResponse.md +28 -0
  37. data/docs/CreateCompletionResponseChoicesInner.md +24 -0
  38. data/docs/CreateCompletionResponseChoicesInnerLogprobs.md +24 -0
  39. data/docs/CreateCompletionResponseUsage.md +22 -0
  40. data/docs/CreateEditRequest.md +28 -0
  41. data/docs/CreateEditRequestModel.md +47 -0
  42. data/docs/CreateEditResponse.md +24 -0
  43. data/docs/CreateEditResponseChoicesInner.md +24 -0
  44. data/docs/CreateEmbeddingRequest.md +22 -0
  45. data/docs/CreateEmbeddingRequestInput.md +53 -0
  46. data/docs/CreateEmbeddingRequestModel.md +47 -0
  47. data/docs/CreateEmbeddingResponse.md +24 -0
  48. data/docs/CreateEmbeddingResponseDataInner.md +22 -0
  49. data/docs/CreateEmbeddingResponseUsage.md +20 -0
  50. data/docs/CreateFineTuneRequest.md +40 -0
  51. data/docs/CreateFineTuneRequestModel.md +47 -0
  52. data/docs/CreateImageRequest.md +26 -0
  53. data/docs/CreateModerationRequest.md +20 -0
  54. data/docs/CreateModerationRequestInput.md +49 -0
  55. data/docs/CreateModerationRequestModel.md +47 -0
  56. data/docs/CreateModerationResponse.md +22 -0
  57. data/docs/CreateModerationResponseResultsInner.md +22 -0
  58. data/docs/CreateModerationResponseResultsInnerCategories.md +30 -0
  59. data/docs/CreateModerationResponseResultsInnerCategoryScores.md +30 -0
  60. data/docs/CreateTranscriptionRequestModel.md +47 -0
  61. data/docs/CreateTranscriptionResponse.md +18 -0
  62. data/docs/CreateTranslationResponse.md +18 -0
  63. data/docs/DeleteFileResponse.md +22 -0
  64. data/docs/DeleteModelResponse.md +22 -0
  65. data/docs/Error.md +24 -0
  66. data/docs/ErrorResponse.md +18 -0
  67. data/docs/FineTune.md +42 -0
  68. data/docs/FineTuneEvent.md +24 -0
  69. data/docs/ImagesResponse.md +20 -0
  70. data/docs/ImagesResponseDataInner.md +20 -0
  71. data/docs/ListFilesResponse.md +20 -0
  72. data/docs/ListFineTuneEventsResponse.md +20 -0
  73. data/docs/ListFineTunesResponse.md +20 -0
  74. data/docs/ListModelsResponse.md +20 -0
  75. data/docs/Model.md +24 -0
  76. data/docs/OpenAIApi.md +1499 -0
  77. data/docs/OpenAIFile.md +32 -0
  78. data/git_push.sh +57 -0
  79. data/lib/openapi_openai/api/open_ai_api.rb +1583 -0
  80. data/lib/openapi_openai/api_client.rb +393 -0
  81. data/lib/openapi_openai/api_error.rb +58 -0
  82. data/lib/openapi_openai/configuration.rb +291 -0
  83. data/lib/openapi_openai/models/chat_completion_functions.rb +244 -0
  84. data/lib/openapi_openai/models/chat_completion_request_message.rb +285 -0
  85. data/lib/openapi_openai/models/chat_completion_request_message_function_call.rb +226 -0
  86. data/lib/openapi_openai/models/chat_completion_response_message.rb +276 -0
  87. data/lib/openapi_openai/models/chat_completion_stream_response_delta.rb +269 -0
  88. data/lib/openapi_openai/models/create_chat_completion_request.rb +537 -0
  89. data/lib/openapi_openai/models/create_chat_completion_request_function_call.rb +106 -0
  90. data/lib/openapi_openai/models/create_chat_completion_request_function_call_one_of.rb +222 -0
  91. data/lib/openapi_openai/models/create_chat_completion_request_model.rb +105 -0
  92. data/lib/openapi_openai/models/create_chat_completion_request_stop.rb +106 -0
  93. data/lib/openapi_openai/models/create_chat_completion_response.rb +296 -0
  94. data/lib/openapi_openai/models/create_chat_completion_response_choices_inner.rb +266 -0
  95. data/lib/openapi_openai/models/create_chat_completion_stream_response.rb +287 -0
  96. data/lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb +266 -0
  97. data/lib/openapi_openai/models/create_completion_request.rb +586 -0
  98. data/lib/openapi_openai/models/create_completion_request_model.rb +105 -0
  99. data/lib/openapi_openai/models/create_completion_request_prompt.rb +108 -0
  100. data/lib/openapi_openai/models/create_completion_request_stop.rb +106 -0
  101. data/lib/openapi_openai/models/create_completion_response.rb +296 -0
  102. data/lib/openapi_openai/models/create_completion_response_choices_inner.rb +299 -0
  103. data/lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb +249 -0
  104. data/lib/openapi_openai/models/create_completion_response_usage.rb +253 -0
  105. data/lib/openapi_openai/models/create_edit_request.rb +362 -0
  106. data/lib/openapi_openai/models/create_edit_request_model.rb +105 -0
  107. data/lib/openapi_openai/models/create_edit_response.rb +271 -0
  108. data/lib/openapi_openai/models/create_edit_response_choices_inner.rb +276 -0
  109. data/lib/openapi_openai/models/create_embedding_request.rb +247 -0
  110. data/lib/openapi_openai/models/create_embedding_request_input.rb +108 -0
  111. data/lib/openapi_openai/models/create_embedding_request_model.rb +105 -0
  112. data/lib/openapi_openai/models/create_embedding_response.rb +271 -0
  113. data/lib/openapi_openai/models/create_embedding_response_data_inner.rb +255 -0
  114. data/lib/openapi_openai/models/create_embedding_response_usage.rb +237 -0
  115. data/lib/openapi_openai/models/create_fine_tune_request.rb +374 -0
  116. data/lib/openapi_openai/models/create_fine_tune_request_model.rb +105 -0
  117. data/lib/openapi_openai/models/create_image_request.rb +341 -0
  118. data/lib/openapi_openai/models/create_moderation_request.rb +230 -0
  119. data/lib/openapi_openai/models/create_moderation_request_input.rb +106 -0
  120. data/lib/openapi_openai/models/create_moderation_request_model.rb +105 -0
  121. data/lib/openapi_openai/models/create_moderation_response.rb +255 -0
  122. data/lib/openapi_openai/models/create_moderation_response_results_inner.rb +253 -0
  123. data/lib/openapi_openai/models/create_moderation_response_results_inner_categories.rb +317 -0
  124. data/lib/openapi_openai/models/create_moderation_response_results_inner_category_scores.rb +317 -0
  125. data/lib/openapi_openai/models/create_transcription_request_model.rb +105 -0
  126. data/lib/openapi_openai/models/create_transcription_response.rb +221 -0
  127. data/lib/openapi_openai/models/create_translation_response.rb +221 -0
  128. data/lib/openapi_openai/models/delete_file_response.rb +253 -0
  129. data/lib/openapi_openai/models/delete_model_response.rb +253 -0
  130. data/lib/openapi_openai/models/error.rb +261 -0
  131. data/lib/openapi_openai/models/error_response.rb +221 -0
  132. data/lib/openapi_openai/models/fine_tune.rb +410 -0
  133. data/lib/openapi_openai/models/fine_tune_event.rb +269 -0
  134. data/lib/openapi_openai/models/images_response.rb +239 -0
  135. data/lib/openapi_openai/models/images_response_data_inner.rb +223 -0
  136. data/lib/openapi_openai/models/list_files_response.rb +239 -0
  137. data/lib/openapi_openai/models/list_fine_tune_events_response.rb +239 -0
  138. data/lib/openapi_openai/models/list_fine_tunes_response.rb +239 -0
  139. data/lib/openapi_openai/models/list_models_response.rb +239 -0
  140. data/lib/openapi_openai/models/model.rb +269 -0
  141. data/lib/openapi_openai/models/open_ai_file.rb +320 -0
  142. data/lib/openapi_openai/version.rb +15 -0
  143. data/lib/openapi_openai.rb +99 -0
  144. data/openapi_openai.gemspec +39 -0
  145. data/spec/api/open_ai_api_spec.rb +306 -0
  146. data/spec/models/chat_completion_functions_spec.rb +48 -0
  147. data/spec/models/chat_completion_request_message_function_call_spec.rb +42 -0
  148. data/spec/models/chat_completion_request_message_spec.rb +58 -0
  149. data/spec/models/chat_completion_response_message_spec.rb +52 -0
  150. data/spec/models/chat_completion_stream_response_delta_spec.rb +52 -0
  151. data/spec/models/create_chat_completion_request_function_call_one_of_spec.rb +36 -0
  152. data/spec/models/create_chat_completion_request_function_call_spec.rb +32 -0
  153. data/spec/models/create_chat_completion_request_model_spec.rb +32 -0
  154. data/spec/models/create_chat_completion_request_spec.rb +114 -0
  155. data/spec/models/create_chat_completion_request_stop_spec.rb +32 -0
  156. data/spec/models/create_chat_completion_response_choices_inner_spec.rb +52 -0
  157. data/spec/models/create_chat_completion_response_spec.rb +66 -0
  158. data/spec/models/create_chat_completion_stream_response_choices_inner_spec.rb +52 -0
  159. data/spec/models/create_chat_completion_stream_response_spec.rb +60 -0
  160. data/spec/models/create_completion_request_model_spec.rb +32 -0
  161. data/spec/models/create_completion_request_prompt_spec.rb +32 -0
  162. data/spec/models/create_completion_request_spec.rb +126 -0
  163. data/spec/models/create_completion_request_stop_spec.rb +32 -0
  164. data/spec/models/create_completion_response_choices_inner_logprobs_spec.rb +54 -0
  165. data/spec/models/create_completion_response_choices_inner_spec.rb +58 -0
  166. data/spec/models/create_completion_response_spec.rb +66 -0
  167. data/spec/models/create_completion_response_usage_spec.rb +48 -0
  168. data/spec/models/create_edit_request_model_spec.rb +32 -0
  169. data/spec/models/create_edit_request_spec.rb +66 -0
  170. data/spec/models/create_edit_response_choices_inner_spec.rb +58 -0
  171. data/spec/models/create_edit_response_spec.rb +54 -0
  172. data/spec/models/create_embedding_request_input_spec.rb +32 -0
  173. data/spec/models/create_embedding_request_model_spec.rb +32 -0
  174. data/spec/models/create_embedding_request_spec.rb +48 -0
  175. data/spec/models/create_embedding_response_data_inner_spec.rb +48 -0
  176. data/spec/models/create_embedding_response_spec.rb +54 -0
  177. data/spec/models/create_embedding_response_usage_spec.rb +42 -0
  178. data/spec/models/create_fine_tune_request_model_spec.rb +32 -0
  179. data/spec/models/create_fine_tune_request_spec.rb +102 -0
  180. data/spec/models/create_image_request_spec.rb +68 -0
  181. data/spec/models/create_moderation_request_input_spec.rb +32 -0
  182. data/spec/models/create_moderation_request_model_spec.rb +32 -0
  183. data/spec/models/create_moderation_request_spec.rb +42 -0
  184. data/spec/models/create_moderation_response_results_inner_categories_spec.rb +72 -0
  185. data/spec/models/create_moderation_response_results_inner_category_scores_spec.rb +72 -0
  186. data/spec/models/create_moderation_response_results_inner_spec.rb +48 -0
  187. data/spec/models/create_moderation_response_spec.rb +48 -0
  188. data/spec/models/create_transcription_request_model_spec.rb +32 -0
  189. data/spec/models/create_transcription_response_spec.rb +36 -0
  190. data/spec/models/create_translation_response_spec.rb +36 -0
  191. data/spec/models/delete_file_response_spec.rb +48 -0
  192. data/spec/models/delete_model_response_spec.rb +48 -0
  193. data/spec/models/error_response_spec.rb +36 -0
  194. data/spec/models/error_spec.rb +54 -0
  195. data/spec/models/fine_tune_event_spec.rb +54 -0
  196. data/spec/models/fine_tune_spec.rb +108 -0
  197. data/spec/models/images_response_data_inner_spec.rb +42 -0
  198. data/spec/models/images_response_spec.rb +42 -0
  199. data/spec/models/list_files_response_spec.rb +42 -0
  200. data/spec/models/list_fine_tune_events_response_spec.rb +42 -0
  201. data/spec/models/list_fine_tunes_response_spec.rb +42 -0
  202. data/spec/models/list_models_response_spec.rb +42 -0
  203. data/spec/models/model_spec.rb +54 -0
  204. data/spec/models/open_ai_file_spec.rb +78 -0
  205. data/spec/spec_helper.rb +111 -0
  206. metadata +348 -0
data/docs/OpenAIApi.md ADDED
@@ -0,0 +1,1499 @@
1
+ # OpenApiOpenAIClient::OpenAIApi
2
+
3
+ All URIs are relative to *https://api.openai.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**cancel_fine_tune**](OpenAIApi.md#cancel_fine_tune) | **POST** /fine-tunes/{fine_tune_id}/cancel | Immediately cancel a fine-tune job. |
8
+ | [**create_chat_completion**](OpenAIApi.md#create_chat_completion) | **POST** /chat/completions | Creates a model response for the given chat conversation. |
9
+ | [**create_completion**](OpenAIApi.md#create_completion) | **POST** /completions | Creates a completion for the provided prompt and parameters. |
10
+ | [**create_edit**](OpenAIApi.md#create_edit) | **POST** /edits | Creates a new edit for the provided input, instruction, and parameters. |
11
+ | [**create_embedding**](OpenAIApi.md#create_embedding) | **POST** /embeddings | Creates an embedding vector representing the input text. |
12
+ | [**create_file**](OpenAIApi.md#create_file) | **POST** /files | Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit. |
13
+ | [**create_fine_tune**](OpenAIApi.md#create_fine_tune) | **POST** /fine-tunes | Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning) |
14
+ | [**create_image**](OpenAIApi.md#create_image) | **POST** /images/generations | Creates an image given a prompt. |
15
+ | [**create_image_edit**](OpenAIApi.md#create_image_edit) | **POST** /images/edits | Creates an edited or extended image given an original image and a prompt. |
16
+ | [**create_image_variation**](OpenAIApi.md#create_image_variation) | **POST** /images/variations | Creates a variation of a given image. |
17
+ | [**create_moderation**](OpenAIApi.md#create_moderation) | **POST** /moderations | Classifies if text violates OpenAI's Content Policy |
18
+ | [**create_transcription**](OpenAIApi.md#create_transcription) | **POST** /audio/transcriptions | Transcribes audio into the input language. |
19
+ | [**create_translation**](OpenAIApi.md#create_translation) | **POST** /audio/translations | Translates audio into English. |
20
+ | [**delete_file**](OpenAIApi.md#delete_file) | **DELETE** /files/{file_id} | Delete a file. |
21
+ | [**delete_model**](OpenAIApi.md#delete_model) | **DELETE** /models/{model} | Delete a fine-tuned model. You must have the Owner role in your organization. |
22
+ | [**download_file**](OpenAIApi.md#download_file) | **GET** /files/{file_id}/content | Returns the contents of the specified file |
23
+ | [**list_files**](OpenAIApi.md#list_files) | **GET** /files | Returns a list of files that belong to the user's organization. |
24
+ | [**list_fine_tune_events**](OpenAIApi.md#list_fine_tune_events) | **GET** /fine-tunes/{fine_tune_id}/events | Get fine-grained status updates for a fine-tune job. |
25
+ | [**list_fine_tunes**](OpenAIApi.md#list_fine_tunes) | **GET** /fine-tunes | List your organization's fine-tuning jobs |
26
+ | [**list_models**](OpenAIApi.md#list_models) | **GET** /models | Lists the currently available models, and provides basic information about each one such as the owner and availability. |
27
+ | [**retrieve_file**](OpenAIApi.md#retrieve_file) | **GET** /files/{file_id} | Returns information about a specific file. |
28
+ | [**retrieve_fine_tune**](OpenAIApi.md#retrieve_fine_tune) | **GET** /fine-tunes/{fine_tune_id} | Gets info about the fine-tune job. [Learn more about Fine-tuning](/docs/guides/fine-tuning) |
29
+ | [**retrieve_model**](OpenAIApi.md#retrieve_model) | **GET** /models/{model} | Retrieves a model instance, providing basic information about the model such as the owner and permissioning. |
30
+
31
+
32
+ ## cancel_fine_tune
33
+
34
+ > <FineTune> cancel_fine_tune(fine_tune_id)
35
+
36
+ Immediately cancel a fine-tune job.
37
+
38
+ ### Examples
39
+
40
+ ```ruby
41
+ require 'time'
42
+ require 'openapi_openai'
43
+
44
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
45
+ fine_tune_id = 'ft-AF1WoRqd3aJAHsqc9NY7iL8F' # String | The ID of the fine-tune job to cancel
46
+
47
+ begin
48
+ # Immediately cancel a fine-tune job.
49
+ result = api_instance.cancel_fine_tune(fine_tune_id)
50
+ p result
51
+ rescue OpenApiOpenAIClient::ApiError => e
52
+ puts "Error when calling OpenAIApi->cancel_fine_tune: #{e}"
53
+ end
54
+ ```
55
+
56
+ #### Using the cancel_fine_tune_with_http_info variant
57
+
58
+ This returns an Array which contains the response data, status code and headers.
59
+
60
+ > <Array(<FineTune>, Integer, Hash)> cancel_fine_tune_with_http_info(fine_tune_id)
61
+
62
+ ```ruby
63
+ begin
64
+ # Immediately cancel a fine-tune job.
65
+ data, status_code, headers = api_instance.cancel_fine_tune_with_http_info(fine_tune_id)
66
+ p status_code # => 2xx
67
+ p headers # => { ... }
68
+ p data # => <FineTune>
69
+ rescue OpenApiOpenAIClient::ApiError => e
70
+ puts "Error when calling OpenAIApi->cancel_fine_tune_with_http_info: #{e}"
71
+ end
72
+ ```
73
+
74
+ ### Parameters
75
+
76
+ | Name | Type | Description | Notes |
77
+ | ---- | ---- | ----------- | ----- |
78
+ | **fine_tune_id** | **String** | The ID of the fine-tune job to cancel | |
79
+
80
+ ### Return type
81
+
82
+ [**FineTune**](FineTune.md)
83
+
84
+ ### Authorization
85
+
86
+ No authorization required
87
+
88
+ ### HTTP request headers
89
+
90
+ - **Content-Type**: Not defined
91
+ - **Accept**: application/json
92
+
93
+
94
+ ## create_chat_completion
95
+
96
+ > <CreateChatCompletionResponse> create_chat_completion(create_chat_completion_request)
97
+
98
+ Creates a model response for the given chat conversation.
99
+
100
+ ### Examples
101
+
102
+ ```ruby
103
+ require 'time'
104
+ require 'openapi_openai'
105
+
106
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
107
+ create_chat_completion_request = OpenApiOpenAIClient::CreateChatCompletionRequest.new({model: nil, messages: [OpenApiOpenAIClient::ChatCompletionRequestMessage.new({role: 'system'})]}) # CreateChatCompletionRequest |
108
+
109
+ begin
110
+ # Creates a model response for the given chat conversation.
111
+ result = api_instance.create_chat_completion(create_chat_completion_request)
112
+ p result
113
+ rescue OpenApiOpenAIClient::ApiError => e
114
+ puts "Error when calling OpenAIApi->create_chat_completion: #{e}"
115
+ end
116
+ ```
117
+
118
+ #### Using the create_chat_completion_with_http_info variant
119
+
120
+ This returns an Array which contains the response data, status code and headers.
121
+
122
+ > <Array(<CreateChatCompletionResponse>, Integer, Hash)> create_chat_completion_with_http_info(create_chat_completion_request)
123
+
124
+ ```ruby
125
+ begin
126
+ # Creates a model response for the given chat conversation.
127
+ data, status_code, headers = api_instance.create_chat_completion_with_http_info(create_chat_completion_request)
128
+ p status_code # => 2xx
129
+ p headers # => { ... }
130
+ p data # => <CreateChatCompletionResponse>
131
+ rescue OpenApiOpenAIClient::ApiError => e
132
+ puts "Error when calling OpenAIApi->create_chat_completion_with_http_info: #{e}"
133
+ end
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+ | Name | Type | Description | Notes |
139
+ | ---- | ---- | ----------- | ----- |
140
+ | **create_chat_completion_request** | [**CreateChatCompletionRequest**](CreateChatCompletionRequest.md) | | |
141
+
142
+ ### Return type
143
+
144
+ [**CreateChatCompletionResponse**](CreateChatCompletionResponse.md)
145
+
146
+ ### Authorization
147
+
148
+ No authorization required
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: application/json
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## create_completion
157
+
158
+ > <CreateCompletionResponse> create_completion(create_completion_request)
159
+
160
+ Creates a completion for the provided prompt and parameters.
161
+
162
+ ### Examples
163
+
164
+ ```ruby
165
+ require 'time'
166
+ require 'openapi_openai'
167
+
168
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
169
+ create_completion_request = OpenApiOpenAIClient::CreateCompletionRequest.new({model: nil, prompt: nil}) # CreateCompletionRequest |
170
+
171
+ begin
172
+ # Creates a completion for the provided prompt and parameters.
173
+ result = api_instance.create_completion(create_completion_request)
174
+ p result
175
+ rescue OpenApiOpenAIClient::ApiError => e
176
+ puts "Error when calling OpenAIApi->create_completion: #{e}"
177
+ end
178
+ ```
179
+
180
+ #### Using the create_completion_with_http_info variant
181
+
182
+ This returns an Array which contains the response data, status code and headers.
183
+
184
+ > <Array(<CreateCompletionResponse>, Integer, Hash)> create_completion_with_http_info(create_completion_request)
185
+
186
+ ```ruby
187
+ begin
188
+ # Creates a completion for the provided prompt and parameters.
189
+ data, status_code, headers = api_instance.create_completion_with_http_info(create_completion_request)
190
+ p status_code # => 2xx
191
+ p headers # => { ... }
192
+ p data # => <CreateCompletionResponse>
193
+ rescue OpenApiOpenAIClient::ApiError => e
194
+ puts "Error when calling OpenAIApi->create_completion_with_http_info: #{e}"
195
+ end
196
+ ```
197
+
198
+ ### Parameters
199
+
200
+ | Name | Type | Description | Notes |
201
+ | ---- | ---- | ----------- | ----- |
202
+ | **create_completion_request** | [**CreateCompletionRequest**](CreateCompletionRequest.md) | | |
203
+
204
+ ### Return type
205
+
206
+ [**CreateCompletionResponse**](CreateCompletionResponse.md)
207
+
208
+ ### Authorization
209
+
210
+ No authorization required
211
+
212
+ ### HTTP request headers
213
+
214
+ - **Content-Type**: application/json
215
+ - **Accept**: application/json
216
+
217
+
218
+ ## create_edit
219
+
220
+ > <CreateEditResponse> create_edit(create_edit_request)
221
+
222
+ Creates a new edit for the provided input, instruction, and parameters.
223
+
224
+ ### Examples
225
+
226
+ ```ruby
227
+ require 'time'
228
+ require 'openapi_openai'
229
+
230
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
231
+ create_edit_request = OpenApiOpenAIClient::CreateEditRequest.new({model: nil, instruction: 'Fix the spelling mistakes.'}) # CreateEditRequest |
232
+
233
+ begin
234
+ # Creates a new edit for the provided input, instruction, and parameters.
235
+ result = api_instance.create_edit(create_edit_request)
236
+ p result
237
+ rescue OpenApiOpenAIClient::ApiError => e
238
+ puts "Error when calling OpenAIApi->create_edit: #{e}"
239
+ end
240
+ ```
241
+
242
+ #### Using the create_edit_with_http_info variant
243
+
244
+ This returns an Array which contains the response data, status code and headers.
245
+
246
+ > <Array(<CreateEditResponse>, Integer, Hash)> create_edit_with_http_info(create_edit_request)
247
+
248
+ ```ruby
249
+ begin
250
+ # Creates a new edit for the provided input, instruction, and parameters.
251
+ data, status_code, headers = api_instance.create_edit_with_http_info(create_edit_request)
252
+ p status_code # => 2xx
253
+ p headers # => { ... }
254
+ p data # => <CreateEditResponse>
255
+ rescue OpenApiOpenAIClient::ApiError => e
256
+ puts "Error when calling OpenAIApi->create_edit_with_http_info: #{e}"
257
+ end
258
+ ```
259
+
260
+ ### Parameters
261
+
262
+ | Name | Type | Description | Notes |
263
+ | ---- | ---- | ----------- | ----- |
264
+ | **create_edit_request** | [**CreateEditRequest**](CreateEditRequest.md) | | |
265
+
266
+ ### Return type
267
+
268
+ [**CreateEditResponse**](CreateEditResponse.md)
269
+
270
+ ### Authorization
271
+
272
+ No authorization required
273
+
274
+ ### HTTP request headers
275
+
276
+ - **Content-Type**: application/json
277
+ - **Accept**: application/json
278
+
279
+
280
+ ## create_embedding
281
+
282
+ > <CreateEmbeddingResponse> create_embedding(create_embedding_request)
283
+
284
+ Creates an embedding vector representing the input text.
285
+
286
+ ### Examples
287
+
288
+ ```ruby
289
+ require 'time'
290
+ require 'openapi_openai'
291
+
292
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
293
+ create_embedding_request = OpenApiOpenAIClient::CreateEmbeddingRequest.new({model: nil, input: nil}) # CreateEmbeddingRequest |
294
+
295
+ begin
296
+ # Creates an embedding vector representing the input text.
297
+ result = api_instance.create_embedding(create_embedding_request)
298
+ p result
299
+ rescue OpenApiOpenAIClient::ApiError => e
300
+ puts "Error when calling OpenAIApi->create_embedding: #{e}"
301
+ end
302
+ ```
303
+
304
+ #### Using the create_embedding_with_http_info variant
305
+
306
+ This returns an Array which contains the response data, status code and headers.
307
+
308
+ > <Array(<CreateEmbeddingResponse>, Integer, Hash)> create_embedding_with_http_info(create_embedding_request)
309
+
310
+ ```ruby
311
+ begin
312
+ # Creates an embedding vector representing the input text.
313
+ data, status_code, headers = api_instance.create_embedding_with_http_info(create_embedding_request)
314
+ p status_code # => 2xx
315
+ p headers # => { ... }
316
+ p data # => <CreateEmbeddingResponse>
317
+ rescue OpenApiOpenAIClient::ApiError => e
318
+ puts "Error when calling OpenAIApi->create_embedding_with_http_info: #{e}"
319
+ end
320
+ ```
321
+
322
+ ### Parameters
323
+
324
+ | Name | Type | Description | Notes |
325
+ | ---- | ---- | ----------- | ----- |
326
+ | **create_embedding_request** | [**CreateEmbeddingRequest**](CreateEmbeddingRequest.md) | | |
327
+
328
+ ### Return type
329
+
330
+ [**CreateEmbeddingResponse**](CreateEmbeddingResponse.md)
331
+
332
+ ### Authorization
333
+
334
+ No authorization required
335
+
336
+ ### HTTP request headers
337
+
338
+ - **Content-Type**: application/json
339
+ - **Accept**: application/json
340
+
341
+
342
+ ## create_file
343
+
344
+ > <OpenAIFile> create_file(file, purpose)
345
+
346
+ Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
347
+
348
+ ### Examples
349
+
350
+ ```ruby
351
+ require 'time'
352
+ require 'openapi_openai'
353
+
354
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
355
+ file = File.new('/path/to/some/file') # File | Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded. If the `purpose` is set to \\\"fine-tune\\\", each line is a JSON record with \\\"prompt\\\" and \\\"completion\\\" fields representing your [training examples](/docs/guides/fine-tuning/prepare-training-data).
356
+ purpose = 'purpose_example' # String | The intended purpose of the uploaded documents. Use \\\"fine-tune\\\" for [Fine-tuning](/docs/api-reference/fine-tunes). This allows us to validate the format of the uploaded file.
357
+
358
+ begin
359
+ # Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
360
+ result = api_instance.create_file(file, purpose)
361
+ p result
362
+ rescue OpenApiOpenAIClient::ApiError => e
363
+ puts "Error when calling OpenAIApi->create_file: #{e}"
364
+ end
365
+ ```
366
+
367
+ #### Using the create_file_with_http_info variant
368
+
369
+ This returns an Array which contains the response data, status code and headers.
370
+
371
+ > <Array(<OpenAIFile>, Integer, Hash)> create_file_with_http_info(file, purpose)
372
+
373
+ ```ruby
374
+ begin
375
+ # Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
376
+ data, status_code, headers = api_instance.create_file_with_http_info(file, purpose)
377
+ p status_code # => 2xx
378
+ p headers # => { ... }
379
+ p data # => <OpenAIFile>
380
+ rescue OpenApiOpenAIClient::ApiError => e
381
+ puts "Error when calling OpenAIApi->create_file_with_http_info: #{e}"
382
+ end
383
+ ```
384
+
385
+ ### Parameters
386
+
387
+ | Name | Type | Description | Notes |
388
+ | ---- | ---- | ----------- | ----- |
389
+ | **file** | **File** | Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded. If the &#x60;purpose&#x60; is set to \\\&quot;fine-tune\\\&quot;, each line is a JSON record with \\\&quot;prompt\\\&quot; and \\\&quot;completion\\\&quot; fields representing your [training examples](/docs/guides/fine-tuning/prepare-training-data). | |
390
+ | **purpose** | **String** | The intended purpose of the uploaded documents. Use \\\&quot;fine-tune\\\&quot; for [Fine-tuning](/docs/api-reference/fine-tunes). This allows us to validate the format of the uploaded file. | |
391
+
392
+ ### Return type
393
+
394
+ [**OpenAIFile**](OpenAIFile.md)
395
+
396
+ ### Authorization
397
+
398
+ No authorization required
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: multipart/form-data
403
+ - **Accept**: application/json
404
+
405
+
406
+ ## create_fine_tune
407
+
408
+ > <FineTune> create_fine_tune(create_fine_tune_request)
409
+
410
+ Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
411
+
412
+ ### Examples
413
+
414
+ ```ruby
415
+ require 'time'
416
+ require 'openapi_openai'
417
+
418
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
419
+ create_fine_tune_request = OpenApiOpenAIClient::CreateFineTuneRequest.new({training_file: 'file-ajSREls59WBbvgSzJSVWxMCB'}) # CreateFineTuneRequest |
420
+
421
+ begin
422
+ # Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
423
+ result = api_instance.create_fine_tune(create_fine_tune_request)
424
+ p result
425
+ rescue OpenApiOpenAIClient::ApiError => e
426
+ puts "Error when calling OpenAIApi->create_fine_tune: #{e}"
427
+ end
428
+ ```
429
+
430
+ #### Using the create_fine_tune_with_http_info variant
431
+
432
+ This returns an Array which contains the response data, status code and headers.
433
+
434
+ > <Array(<FineTune>, Integer, Hash)> create_fine_tune_with_http_info(create_fine_tune_request)
435
+
436
+ ```ruby
437
+ begin
438
+ # Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
439
+ data, status_code, headers = api_instance.create_fine_tune_with_http_info(create_fine_tune_request)
440
+ p status_code # => 2xx
441
+ p headers # => { ... }
442
+ p data # => <FineTune>
443
+ rescue OpenApiOpenAIClient::ApiError => e
444
+ puts "Error when calling OpenAIApi->create_fine_tune_with_http_info: #{e}"
445
+ end
446
+ ```
447
+
448
+ ### Parameters
449
+
450
+ | Name | Type | Description | Notes |
451
+ | ---- | ---- | ----------- | ----- |
452
+ | **create_fine_tune_request** | [**CreateFineTuneRequest**](CreateFineTuneRequest.md) | | |
453
+
454
+ ### Return type
455
+
456
+ [**FineTune**](FineTune.md)
457
+
458
+ ### Authorization
459
+
460
+ No authorization required
461
+
462
+ ### HTTP request headers
463
+
464
+ - **Content-Type**: application/json
465
+ - **Accept**: application/json
466
+
467
+
468
+ ## create_image
469
+
470
+ > <ImagesResponse> create_image(create_image_request)
471
+
472
+ Creates an image given a prompt.
473
+
474
+ ### Examples
475
+
476
+ ```ruby
477
+ require 'time'
478
+ require 'openapi_openai'
479
+
480
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
481
+ create_image_request = OpenApiOpenAIClient::CreateImageRequest.new({prompt: 'A cute baby sea otter'}) # CreateImageRequest |
482
+
483
+ begin
484
+ # Creates an image given a prompt.
485
+ result = api_instance.create_image(create_image_request)
486
+ p result
487
+ rescue OpenApiOpenAIClient::ApiError => e
488
+ puts "Error when calling OpenAIApi->create_image: #{e}"
489
+ end
490
+ ```
491
+
492
+ #### Using the create_image_with_http_info variant
493
+
494
+ This returns an Array which contains the response data, status code and headers.
495
+
496
+ > <Array(<ImagesResponse>, Integer, Hash)> create_image_with_http_info(create_image_request)
497
+
498
+ ```ruby
499
+ begin
500
+ # Creates an image given a prompt.
501
+ data, status_code, headers = api_instance.create_image_with_http_info(create_image_request)
502
+ p status_code # => 2xx
503
+ p headers # => { ... }
504
+ p data # => <ImagesResponse>
505
+ rescue OpenApiOpenAIClient::ApiError => e
506
+ puts "Error when calling OpenAIApi->create_image_with_http_info: #{e}"
507
+ end
508
+ ```
509
+
510
+ ### Parameters
511
+
512
+ | Name | Type | Description | Notes |
513
+ | ---- | ---- | ----------- | ----- |
514
+ | **create_image_request** | [**CreateImageRequest**](CreateImageRequest.md) | | |
515
+
516
+ ### Return type
517
+
518
+ [**ImagesResponse**](ImagesResponse.md)
519
+
520
+ ### Authorization
521
+
522
+ No authorization required
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: application/json
527
+ - **Accept**: application/json
528
+
529
+
530
+ ## create_image_edit
531
+
532
+ > <ImagesResponse> create_image_edit(image, prompt, opts)
533
+
534
+ Creates an edited or extended image given an original image and a prompt.
535
+
536
+ ### Examples
537
+
538
+ ```ruby
539
+ require 'time'
540
+ require 'openapi_openai'
541
+
542
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
543
+ 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.
544
+ prompt = 'prompt_example' # String | A text description of the desired image(s). The maximum length is 1000 characters.
545
+ opts = {
546
+ 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`.
547
+ n: 56, # Integer | The number of images to generate. Must be between 1 and 10.
548
+ size: '256x256', # String | The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
549
+ response_format: 'url', # String | The format in which the generated images are returned. Must be one of `url` or `b64_json`.
550
+ 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).
551
+ }
552
+
553
+ begin
554
+ # Creates an edited or extended image given an original image and a prompt.
555
+ result = api_instance.create_image_edit(image, prompt, opts)
556
+ p result
557
+ rescue OpenApiOpenAIClient::ApiError => e
558
+ puts "Error when calling OpenAIApi->create_image_edit: #{e}"
559
+ end
560
+ ```
561
+
562
+ #### Using the create_image_edit_with_http_info variant
563
+
564
+ This returns an Array which contains the response data, status code and headers.
565
+
566
+ > <Array(<ImagesResponse>, Integer, Hash)> create_image_edit_with_http_info(image, prompt, opts)
567
+
568
+ ```ruby
569
+ begin
570
+ # Creates an edited or extended image given an original image and a prompt.
571
+ data, status_code, headers = api_instance.create_image_edit_with_http_info(image, prompt, opts)
572
+ p status_code # => 2xx
573
+ p headers # => { ... }
574
+ p data # => <ImagesResponse>
575
+ rescue OpenApiOpenAIClient::ApiError => e
576
+ puts "Error when calling OpenAIApi->create_image_edit_with_http_info: #{e}"
577
+ end
578
+ ```
579
+
580
+ ### Parameters
581
+
582
+ | Name | Type | Description | Notes |
583
+ | ---- | ---- | ----------- | ----- |
584
+ | **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. | |
585
+ | **prompt** | **String** | A text description of the desired image(s). The maximum length is 1000 characters. | |
586
+ | **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] |
587
+ | **n** | **Integer** | The number of images to generate. Must be between 1 and 10. | [optional][default to 1] |
588
+ | **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;] |
589
+ | **response_format** | **String** | The format in which the generated images are returned. Must be one of &#x60;url&#x60; or &#x60;b64_json&#x60;. | [optional][default to &#39;url&#39;] |
590
+ | **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] |
591
+
592
+ ### Return type
593
+
594
+ [**ImagesResponse**](ImagesResponse.md)
595
+
596
+ ### Authorization
597
+
598
+ No authorization required
599
+
600
+ ### HTTP request headers
601
+
602
+ - **Content-Type**: multipart/form-data
603
+ - **Accept**: application/json
604
+
605
+
606
+ ## create_image_variation
607
+
608
+ > <ImagesResponse> create_image_variation(image, opts)
609
+
610
+ Creates a variation of a given image.
611
+
612
+ ### Examples
613
+
614
+ ```ruby
615
+ require 'time'
616
+ require 'openapi_openai'
617
+
618
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
619
+ 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.
620
+ opts = {
621
+ n: 56, # Integer | The number of images to generate. Must be between 1 and 10.
622
+ size: '256x256', # String | The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
623
+ response_format: 'url', # String | The format in which the generated images are returned. Must be one of `url` or `b64_json`.
624
+ 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).
625
+ }
626
+
627
+ begin
628
+ # Creates a variation of a given image.
629
+ result = api_instance.create_image_variation(image, opts)
630
+ p result
631
+ rescue OpenApiOpenAIClient::ApiError => e
632
+ puts "Error when calling OpenAIApi->create_image_variation: #{e}"
633
+ end
634
+ ```
635
+
636
+ #### Using the create_image_variation_with_http_info variant
637
+
638
+ This returns an Array which contains the response data, status code and headers.
639
+
640
+ > <Array(<ImagesResponse>, Integer, Hash)> create_image_variation_with_http_info(image, opts)
641
+
642
+ ```ruby
643
+ begin
644
+ # Creates a variation of a given image.
645
+ data, status_code, headers = api_instance.create_image_variation_with_http_info(image, opts)
646
+ p status_code # => 2xx
647
+ p headers # => { ... }
648
+ p data # => <ImagesResponse>
649
+ rescue OpenApiOpenAIClient::ApiError => e
650
+ puts "Error when calling OpenAIApi->create_image_variation_with_http_info: #{e}"
651
+ end
652
+ ```
653
+
654
+ ### Parameters
655
+
656
+ | Name | Type | Description | Notes |
657
+ | ---- | ---- | ----------- | ----- |
658
+ | **image** | **File** | The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square. | |
659
+ | **n** | **Integer** | The number of images to generate. Must be between 1 and 10. | [optional][default to 1] |
660
+ | **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;] |
661
+ | **response_format** | **String** | The format in which the generated images are returned. Must be one of &#x60;url&#x60; or &#x60;b64_json&#x60;. | [optional][default to &#39;url&#39;] |
662
+ | **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] |
663
+
664
+ ### Return type
665
+
666
+ [**ImagesResponse**](ImagesResponse.md)
667
+
668
+ ### Authorization
669
+
670
+ No authorization required
671
+
672
+ ### HTTP request headers
673
+
674
+ - **Content-Type**: multipart/form-data
675
+ - **Accept**: application/json
676
+
677
+
678
+ ## create_moderation
679
+
680
+ > <CreateModerationResponse> create_moderation(create_moderation_request)
681
+
682
+ Classifies if text violates OpenAI's Content Policy
683
+
684
+ ### Examples
685
+
686
+ ```ruby
687
+ require 'time'
688
+ require 'openapi_openai'
689
+
690
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
691
+ create_moderation_request = OpenApiOpenAIClient::CreateModerationRequest.new({input: nil}) # CreateModerationRequest |
692
+
693
+ begin
694
+ # Classifies if text violates OpenAI's Content Policy
695
+ result = api_instance.create_moderation(create_moderation_request)
696
+ p result
697
+ rescue OpenApiOpenAIClient::ApiError => e
698
+ puts "Error when calling OpenAIApi->create_moderation: #{e}"
699
+ end
700
+ ```
701
+
702
+ #### Using the create_moderation_with_http_info variant
703
+
704
+ This returns an Array which contains the response data, status code and headers.
705
+
706
+ > <Array(<CreateModerationResponse>, Integer, Hash)> create_moderation_with_http_info(create_moderation_request)
707
+
708
+ ```ruby
709
+ begin
710
+ # Classifies if text violates OpenAI's Content Policy
711
+ data, status_code, headers = api_instance.create_moderation_with_http_info(create_moderation_request)
712
+ p status_code # => 2xx
713
+ p headers # => { ... }
714
+ p data # => <CreateModerationResponse>
715
+ rescue OpenApiOpenAIClient::ApiError => e
716
+ puts "Error when calling OpenAIApi->create_moderation_with_http_info: #{e}"
717
+ end
718
+ ```
719
+
720
+ ### Parameters
721
+
722
+ | Name | Type | Description | Notes |
723
+ | ---- | ---- | ----------- | ----- |
724
+ | **create_moderation_request** | [**CreateModerationRequest**](CreateModerationRequest.md) | | |
725
+
726
+ ### Return type
727
+
728
+ [**CreateModerationResponse**](CreateModerationResponse.md)
729
+
730
+ ### Authorization
731
+
732
+ No authorization required
733
+
734
+ ### HTTP request headers
735
+
736
+ - **Content-Type**: application/json
737
+ - **Accept**: application/json
738
+
739
+
740
+ ## create_transcription
741
+
742
+ > <CreateTranscriptionResponse> create_transcription(file, model, opts)
743
+
744
+ Transcribes audio into the input language.
745
+
746
+ ### Examples
747
+
748
+ ```ruby
749
+ require 'time'
750
+ require 'openapi_openai'
751
+
752
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
753
+ file = File.new('/path/to/some/file') # File | The audio file object (not file name) to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
754
+ model = nil # CreateTranscriptionRequestModel |
755
+ opts = {
756
+ prompt: 'prompt_example', # String | An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should match the audio language.
757
+ response_format: 'response_format_example', # String | The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.
758
+ temperature: 8.14, # Float | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.
759
+ language: 'language_example' # String | The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will improve accuracy and latency.
760
+ }
761
+
762
+ begin
763
+ # Transcribes audio into the input language.
764
+ result = api_instance.create_transcription(file, model, opts)
765
+ p result
766
+ rescue OpenApiOpenAIClient::ApiError => e
767
+ puts "Error when calling OpenAIApi->create_transcription: #{e}"
768
+ end
769
+ ```
770
+
771
+ #### Using the create_transcription_with_http_info variant
772
+
773
+ This returns an Array which contains the response data, status code and headers.
774
+
775
+ > <Array(<CreateTranscriptionResponse>, Integer, Hash)> create_transcription_with_http_info(file, model, opts)
776
+
777
+ ```ruby
778
+ begin
779
+ # Transcribes audio into the input language.
780
+ data, status_code, headers = api_instance.create_transcription_with_http_info(file, model, opts)
781
+ p status_code # => 2xx
782
+ p headers # => { ... }
783
+ p data # => <CreateTranscriptionResponse>
784
+ rescue OpenApiOpenAIClient::ApiError => e
785
+ puts "Error when calling OpenAIApi->create_transcription_with_http_info: #{e}"
786
+ end
787
+ ```
788
+
789
+ ### Parameters
790
+
791
+ | Name | Type | Description | Notes |
792
+ | ---- | ---- | ----------- | ----- |
793
+ | **file** | **File** | The audio file object (not file name) to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm. | |
794
+ | **model** | [**CreateTranscriptionRequestModel**](CreateTranscriptionRequestModel.md) | | |
795
+ | **prompt** | **String** | An optional text to guide the model&#39;s style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should match the audio language. | [optional] |
796
+ | **response_format** | **String** | The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt. | [optional][default to &#39;json&#39;] |
797
+ | **temperature** | **Float** | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit. | [optional][default to 0] |
798
+ | **language** | **String** | The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will improve accuracy and latency. | [optional] |
799
+
800
+ ### Return type
801
+
802
+ [**CreateTranscriptionResponse**](CreateTranscriptionResponse.md)
803
+
804
+ ### Authorization
805
+
806
+ No authorization required
807
+
808
+ ### HTTP request headers
809
+
810
+ - **Content-Type**: multipart/form-data
811
+ - **Accept**: application/json
812
+
813
+
814
+ ## create_translation
815
+
816
+ > <CreateTranslationResponse> create_translation(file, model, opts)
817
+
818
+ Translates audio into English.
819
+
820
+ ### Examples
821
+
822
+ ```ruby
823
+ require 'time'
824
+ require 'openapi_openai'
825
+
826
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
827
+ file = File.new('/path/to/some/file') # File | The audio file object (not file name) translate, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
828
+ model = nil # CreateTranscriptionRequestModel |
829
+ opts = {
830
+ prompt: 'prompt_example', # String | An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should be in English.
831
+ response_format: 'response_format_example', # String | The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.
832
+ temperature: 8.14 # Float | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.
833
+ }
834
+
835
+ begin
836
+ # Translates audio into English.
837
+ result = api_instance.create_translation(file, model, opts)
838
+ p result
839
+ rescue OpenApiOpenAIClient::ApiError => e
840
+ puts "Error when calling OpenAIApi->create_translation: #{e}"
841
+ end
842
+ ```
843
+
844
+ #### Using the create_translation_with_http_info variant
845
+
846
+ This returns an Array which contains the response data, status code and headers.
847
+
848
+ > <Array(<CreateTranslationResponse>, Integer, Hash)> create_translation_with_http_info(file, model, opts)
849
+
850
+ ```ruby
851
+ begin
852
+ # Translates audio into English.
853
+ data, status_code, headers = api_instance.create_translation_with_http_info(file, model, opts)
854
+ p status_code # => 2xx
855
+ p headers # => { ... }
856
+ p data # => <CreateTranslationResponse>
857
+ rescue OpenApiOpenAIClient::ApiError => e
858
+ puts "Error when calling OpenAIApi->create_translation_with_http_info: #{e}"
859
+ end
860
+ ```
861
+
862
+ ### Parameters
863
+
864
+ | Name | Type | Description | Notes |
865
+ | ---- | ---- | ----------- | ----- |
866
+ | **file** | **File** | The audio file object (not file name) translate, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm. | |
867
+ | **model** | [**CreateTranscriptionRequestModel**](CreateTranscriptionRequestModel.md) | | |
868
+ | **prompt** | **String** | An optional text to guide the model&#39;s style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should be in English. | [optional] |
869
+ | **response_format** | **String** | The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt. | [optional][default to &#39;json&#39;] |
870
+ | **temperature** | **Float** | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit. | [optional][default to 0] |
871
+
872
+ ### Return type
873
+
874
+ [**CreateTranslationResponse**](CreateTranslationResponse.md)
875
+
876
+ ### Authorization
877
+
878
+ No authorization required
879
+
880
+ ### HTTP request headers
881
+
882
+ - **Content-Type**: multipart/form-data
883
+ - **Accept**: application/json
884
+
885
+
886
+ ## delete_file
887
+
888
+ > <DeleteFileResponse> delete_file(file_id)
889
+
890
+ Delete a file.
891
+
892
+ ### Examples
893
+
894
+ ```ruby
895
+ require 'time'
896
+ require 'openapi_openai'
897
+
898
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
899
+ file_id = 'file_id_example' # String | The ID of the file to use for this request
900
+
901
+ begin
902
+ # Delete a file.
903
+ result = api_instance.delete_file(file_id)
904
+ p result
905
+ rescue OpenApiOpenAIClient::ApiError => e
906
+ puts "Error when calling OpenAIApi->delete_file: #{e}"
907
+ end
908
+ ```
909
+
910
+ #### Using the delete_file_with_http_info variant
911
+
912
+ This returns an Array which contains the response data, status code and headers.
913
+
914
+ > <Array(<DeleteFileResponse>, Integer, Hash)> delete_file_with_http_info(file_id)
915
+
916
+ ```ruby
917
+ begin
918
+ # Delete a file.
919
+ data, status_code, headers = api_instance.delete_file_with_http_info(file_id)
920
+ p status_code # => 2xx
921
+ p headers # => { ... }
922
+ p data # => <DeleteFileResponse>
923
+ rescue OpenApiOpenAIClient::ApiError => e
924
+ puts "Error when calling OpenAIApi->delete_file_with_http_info: #{e}"
925
+ end
926
+ ```
927
+
928
+ ### Parameters
929
+
930
+ | Name | Type | Description | Notes |
931
+ | ---- | ---- | ----------- | ----- |
932
+ | **file_id** | **String** | The ID of the file to use for this request | |
933
+
934
+ ### Return type
935
+
936
+ [**DeleteFileResponse**](DeleteFileResponse.md)
937
+
938
+ ### Authorization
939
+
940
+ No authorization required
941
+
942
+ ### HTTP request headers
943
+
944
+ - **Content-Type**: Not defined
945
+ - **Accept**: application/json
946
+
947
+
948
+ ## delete_model
949
+
950
+ > <DeleteModelResponse> delete_model(model)
951
+
952
+ Delete a fine-tuned model. You must have the Owner role in your organization.
953
+
954
+ ### Examples
955
+
956
+ ```ruby
957
+ require 'time'
958
+ require 'openapi_openai'
959
+
960
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
961
+ model = 'curie:ft-acmeco-2021-03-03-21-44-20' # String | The model to delete
962
+
963
+ begin
964
+ # Delete a fine-tuned model. You must have the Owner role in your organization.
965
+ result = api_instance.delete_model(model)
966
+ p result
967
+ rescue OpenApiOpenAIClient::ApiError => e
968
+ puts "Error when calling OpenAIApi->delete_model: #{e}"
969
+ end
970
+ ```
971
+
972
+ #### Using the delete_model_with_http_info variant
973
+
974
+ This returns an Array which contains the response data, status code and headers.
975
+
976
+ > <Array(<DeleteModelResponse>, Integer, Hash)> delete_model_with_http_info(model)
977
+
978
+ ```ruby
979
+ begin
980
+ # Delete a fine-tuned model. You must have the Owner role in your organization.
981
+ data, status_code, headers = api_instance.delete_model_with_http_info(model)
982
+ p status_code # => 2xx
983
+ p headers # => { ... }
984
+ p data # => <DeleteModelResponse>
985
+ rescue OpenApiOpenAIClient::ApiError => e
986
+ puts "Error when calling OpenAIApi->delete_model_with_http_info: #{e}"
987
+ end
988
+ ```
989
+
990
+ ### Parameters
991
+
992
+ | Name | Type | Description | Notes |
993
+ | ---- | ---- | ----------- | ----- |
994
+ | **model** | **String** | The model to delete | |
995
+
996
+ ### Return type
997
+
998
+ [**DeleteModelResponse**](DeleteModelResponse.md)
999
+
1000
+ ### Authorization
1001
+
1002
+ No authorization required
1003
+
1004
+ ### HTTP request headers
1005
+
1006
+ - **Content-Type**: Not defined
1007
+ - **Accept**: application/json
1008
+
1009
+
1010
+ ## download_file
1011
+
1012
+ > String download_file(file_id)
1013
+
1014
+ Returns the contents of the specified file
1015
+
1016
+ ### Examples
1017
+
1018
+ ```ruby
1019
+ require 'time'
1020
+ require 'openapi_openai'
1021
+
1022
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
1023
+ file_id = 'file_id_example' # String | The ID of the file to use for this request
1024
+
1025
+ begin
1026
+ # Returns the contents of the specified file
1027
+ result = api_instance.download_file(file_id)
1028
+ p result
1029
+ rescue OpenApiOpenAIClient::ApiError => e
1030
+ puts "Error when calling OpenAIApi->download_file: #{e}"
1031
+ end
1032
+ ```
1033
+
1034
+ #### Using the download_file_with_http_info variant
1035
+
1036
+ This returns an Array which contains the response data, status code and headers.
1037
+
1038
+ > <Array(String, Integer, Hash)> download_file_with_http_info(file_id)
1039
+
1040
+ ```ruby
1041
+ begin
1042
+ # Returns the contents of the specified file
1043
+ data, status_code, headers = api_instance.download_file_with_http_info(file_id)
1044
+ p status_code # => 2xx
1045
+ p headers # => { ... }
1046
+ p data # => String
1047
+ rescue OpenApiOpenAIClient::ApiError => e
1048
+ puts "Error when calling OpenAIApi->download_file_with_http_info: #{e}"
1049
+ end
1050
+ ```
1051
+
1052
+ ### Parameters
1053
+
1054
+ | Name | Type | Description | Notes |
1055
+ | ---- | ---- | ----------- | ----- |
1056
+ | **file_id** | **String** | The ID of the file to use for this request | |
1057
+
1058
+ ### Return type
1059
+
1060
+ **String**
1061
+
1062
+ ### Authorization
1063
+
1064
+ No authorization required
1065
+
1066
+ ### HTTP request headers
1067
+
1068
+ - **Content-Type**: Not defined
1069
+ - **Accept**: application/json
1070
+
1071
+
1072
+ ## list_files
1073
+
1074
+ > <ListFilesResponse> list_files
1075
+
1076
+ Returns a list of files that belong to the user's organization.
1077
+
1078
+ ### Examples
1079
+
1080
+ ```ruby
1081
+ require 'time'
1082
+ require 'openapi_openai'
1083
+
1084
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
1085
+
1086
+ begin
1087
+ # Returns a list of files that belong to the user's organization.
1088
+ result = api_instance.list_files
1089
+ p result
1090
+ rescue OpenApiOpenAIClient::ApiError => e
1091
+ puts "Error when calling OpenAIApi->list_files: #{e}"
1092
+ end
1093
+ ```
1094
+
1095
+ #### Using the list_files_with_http_info variant
1096
+
1097
+ This returns an Array which contains the response data, status code and headers.
1098
+
1099
+ > <Array(<ListFilesResponse>, Integer, Hash)> list_files_with_http_info
1100
+
1101
+ ```ruby
1102
+ begin
1103
+ # Returns a list of files that belong to the user's organization.
1104
+ data, status_code, headers = api_instance.list_files_with_http_info
1105
+ p status_code # => 2xx
1106
+ p headers # => { ... }
1107
+ p data # => <ListFilesResponse>
1108
+ rescue OpenApiOpenAIClient::ApiError => e
1109
+ puts "Error when calling OpenAIApi->list_files_with_http_info: #{e}"
1110
+ end
1111
+ ```
1112
+
1113
+ ### Parameters
1114
+
1115
+ This endpoint does not need any parameter.
1116
+
1117
+ ### Return type
1118
+
1119
+ [**ListFilesResponse**](ListFilesResponse.md)
1120
+
1121
+ ### Authorization
1122
+
1123
+ No authorization required
1124
+
1125
+ ### HTTP request headers
1126
+
1127
+ - **Content-Type**: Not defined
1128
+ - **Accept**: application/json
1129
+
1130
+
1131
+ ## list_fine_tune_events
1132
+
1133
+ > <ListFineTuneEventsResponse> list_fine_tune_events(fine_tune_id, opts)
1134
+
1135
+ Get fine-grained status updates for a fine-tune job.
1136
+
1137
+ ### Examples
1138
+
1139
+ ```ruby
1140
+ require 'time'
1141
+ require 'openapi_openai'
1142
+
1143
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
1144
+ fine_tune_id = 'ft-AF1WoRqd3aJAHsqc9NY7iL8F' # String | The ID of the fine-tune job to get events for.
1145
+ opts = {
1146
+ stream: true # Boolean | Whether to stream events for the fine-tune job. If set to true, events 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. The stream will terminate with a `data: [DONE]` message when the job is finished (succeeded, cancelled, or failed). If set to false, only events generated so far will be returned.
1147
+ }
1148
+
1149
+ begin
1150
+ # Get fine-grained status updates for a fine-tune job.
1151
+ result = api_instance.list_fine_tune_events(fine_tune_id, opts)
1152
+ p result
1153
+ rescue OpenApiOpenAIClient::ApiError => e
1154
+ puts "Error when calling OpenAIApi->list_fine_tune_events: #{e}"
1155
+ end
1156
+ ```
1157
+
1158
+ #### Using the list_fine_tune_events_with_http_info variant
1159
+
1160
+ This returns an Array which contains the response data, status code and headers.
1161
+
1162
+ > <Array(<ListFineTuneEventsResponse>, Integer, Hash)> list_fine_tune_events_with_http_info(fine_tune_id, opts)
1163
+
1164
+ ```ruby
1165
+ begin
1166
+ # Get fine-grained status updates for a fine-tune job.
1167
+ data, status_code, headers = api_instance.list_fine_tune_events_with_http_info(fine_tune_id, opts)
1168
+ p status_code # => 2xx
1169
+ p headers # => { ... }
1170
+ p data # => <ListFineTuneEventsResponse>
1171
+ rescue OpenApiOpenAIClient::ApiError => e
1172
+ puts "Error when calling OpenAIApi->list_fine_tune_events_with_http_info: #{e}"
1173
+ end
1174
+ ```
1175
+
1176
+ ### Parameters
1177
+
1178
+ | Name | Type | Description | Notes |
1179
+ | ---- | ---- | ----------- | ----- |
1180
+ | **fine_tune_id** | **String** | The ID of the fine-tune job to get events for. | |
1181
+ | **stream** | **Boolean** | Whether to stream events for the fine-tune job. If set to true, events 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. The stream will terminate with a &#x60;data: [DONE]&#x60; message when the job is finished (succeeded, cancelled, or failed). If set to false, only events generated so far will be returned. | [optional][default to false] |
1182
+
1183
+ ### Return type
1184
+
1185
+ [**ListFineTuneEventsResponse**](ListFineTuneEventsResponse.md)
1186
+
1187
+ ### Authorization
1188
+
1189
+ No authorization required
1190
+
1191
+ ### HTTP request headers
1192
+
1193
+ - **Content-Type**: Not defined
1194
+ - **Accept**: application/json
1195
+
1196
+
1197
+ ## list_fine_tunes
1198
+
1199
+ > <ListFineTunesResponse> list_fine_tunes
1200
+
1201
+ List your organization's fine-tuning jobs
1202
+
1203
+ ### Examples
1204
+
1205
+ ```ruby
1206
+ require 'time'
1207
+ require 'openapi_openai'
1208
+
1209
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
1210
+
1211
+ begin
1212
+ # List your organization's fine-tuning jobs
1213
+ result = api_instance.list_fine_tunes
1214
+ p result
1215
+ rescue OpenApiOpenAIClient::ApiError => e
1216
+ puts "Error when calling OpenAIApi->list_fine_tunes: #{e}"
1217
+ end
1218
+ ```
1219
+
1220
+ #### Using the list_fine_tunes_with_http_info variant
1221
+
1222
+ This returns an Array which contains the response data, status code and headers.
1223
+
1224
+ > <Array(<ListFineTunesResponse>, Integer, Hash)> list_fine_tunes_with_http_info
1225
+
1226
+ ```ruby
1227
+ begin
1228
+ # List your organization's fine-tuning jobs
1229
+ data, status_code, headers = api_instance.list_fine_tunes_with_http_info
1230
+ p status_code # => 2xx
1231
+ p headers # => { ... }
1232
+ p data # => <ListFineTunesResponse>
1233
+ rescue OpenApiOpenAIClient::ApiError => e
1234
+ puts "Error when calling OpenAIApi->list_fine_tunes_with_http_info: #{e}"
1235
+ end
1236
+ ```
1237
+
1238
+ ### Parameters
1239
+
1240
+ This endpoint does not need any parameter.
1241
+
1242
+ ### Return type
1243
+
1244
+ [**ListFineTunesResponse**](ListFineTunesResponse.md)
1245
+
1246
+ ### Authorization
1247
+
1248
+ No authorization required
1249
+
1250
+ ### HTTP request headers
1251
+
1252
+ - **Content-Type**: Not defined
1253
+ - **Accept**: application/json
1254
+
1255
+
1256
+ ## list_models
1257
+
1258
+ > <ListModelsResponse> list_models
1259
+
1260
+ Lists the currently available models, and provides basic information about each one such as the owner and availability.
1261
+
1262
+ ### Examples
1263
+
1264
+ ```ruby
1265
+ require 'time'
1266
+ require 'openapi_openai'
1267
+
1268
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
1269
+
1270
+ begin
1271
+ # Lists the currently available models, and provides basic information about each one such as the owner and availability.
1272
+ result = api_instance.list_models
1273
+ p result
1274
+ rescue OpenApiOpenAIClient::ApiError => e
1275
+ puts "Error when calling OpenAIApi->list_models: #{e}"
1276
+ end
1277
+ ```
1278
+
1279
+ #### Using the list_models_with_http_info variant
1280
+
1281
+ This returns an Array which contains the response data, status code and headers.
1282
+
1283
+ > <Array(<ListModelsResponse>, Integer, Hash)> list_models_with_http_info
1284
+
1285
+ ```ruby
1286
+ begin
1287
+ # Lists the currently available models, and provides basic information about each one such as the owner and availability.
1288
+ data, status_code, headers = api_instance.list_models_with_http_info
1289
+ p status_code # => 2xx
1290
+ p headers # => { ... }
1291
+ p data # => <ListModelsResponse>
1292
+ rescue OpenApiOpenAIClient::ApiError => e
1293
+ puts "Error when calling OpenAIApi->list_models_with_http_info: #{e}"
1294
+ end
1295
+ ```
1296
+
1297
+ ### Parameters
1298
+
1299
+ This endpoint does not need any parameter.
1300
+
1301
+ ### Return type
1302
+
1303
+ [**ListModelsResponse**](ListModelsResponse.md)
1304
+
1305
+ ### Authorization
1306
+
1307
+ No authorization required
1308
+
1309
+ ### HTTP request headers
1310
+
1311
+ - **Content-Type**: Not defined
1312
+ - **Accept**: application/json
1313
+
1314
+
1315
+ ## retrieve_file
1316
+
1317
+ > <OpenAIFile> retrieve_file(file_id)
1318
+
1319
+ Returns information about a specific file.
1320
+
1321
+ ### Examples
1322
+
1323
+ ```ruby
1324
+ require 'time'
1325
+ require 'openapi_openai'
1326
+
1327
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
1328
+ file_id = 'file_id_example' # String | The ID of the file to use for this request
1329
+
1330
+ begin
1331
+ # Returns information about a specific file.
1332
+ result = api_instance.retrieve_file(file_id)
1333
+ p result
1334
+ rescue OpenApiOpenAIClient::ApiError => e
1335
+ puts "Error when calling OpenAIApi->retrieve_file: #{e}"
1336
+ end
1337
+ ```
1338
+
1339
+ #### Using the retrieve_file_with_http_info variant
1340
+
1341
+ This returns an Array which contains the response data, status code and headers.
1342
+
1343
+ > <Array(<OpenAIFile>, Integer, Hash)> retrieve_file_with_http_info(file_id)
1344
+
1345
+ ```ruby
1346
+ begin
1347
+ # Returns information about a specific file.
1348
+ data, status_code, headers = api_instance.retrieve_file_with_http_info(file_id)
1349
+ p status_code # => 2xx
1350
+ p headers # => { ... }
1351
+ p data # => <OpenAIFile>
1352
+ rescue OpenApiOpenAIClient::ApiError => e
1353
+ puts "Error when calling OpenAIApi->retrieve_file_with_http_info: #{e}"
1354
+ end
1355
+ ```
1356
+
1357
+ ### Parameters
1358
+
1359
+ | Name | Type | Description | Notes |
1360
+ | ---- | ---- | ----------- | ----- |
1361
+ | **file_id** | **String** | The ID of the file to use for this request | |
1362
+
1363
+ ### Return type
1364
+
1365
+ [**OpenAIFile**](OpenAIFile.md)
1366
+
1367
+ ### Authorization
1368
+
1369
+ No authorization required
1370
+
1371
+ ### HTTP request headers
1372
+
1373
+ - **Content-Type**: Not defined
1374
+ - **Accept**: application/json
1375
+
1376
+
1377
+ ## retrieve_fine_tune
1378
+
1379
+ > <FineTune> retrieve_fine_tune(fine_tune_id)
1380
+
1381
+ Gets info about the fine-tune job. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
1382
+
1383
+ ### Examples
1384
+
1385
+ ```ruby
1386
+ require 'time'
1387
+ require 'openapi_openai'
1388
+
1389
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
1390
+ fine_tune_id = 'ft-AF1WoRqd3aJAHsqc9NY7iL8F' # String | The ID of the fine-tune job
1391
+
1392
+ begin
1393
+ # Gets info about the fine-tune job. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
1394
+ result = api_instance.retrieve_fine_tune(fine_tune_id)
1395
+ p result
1396
+ rescue OpenApiOpenAIClient::ApiError => e
1397
+ puts "Error when calling OpenAIApi->retrieve_fine_tune: #{e}"
1398
+ end
1399
+ ```
1400
+
1401
+ #### Using the retrieve_fine_tune_with_http_info variant
1402
+
1403
+ This returns an Array which contains the response data, status code and headers.
1404
+
1405
+ > <Array(<FineTune>, Integer, Hash)> retrieve_fine_tune_with_http_info(fine_tune_id)
1406
+
1407
+ ```ruby
1408
+ begin
1409
+ # Gets info about the fine-tune job. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
1410
+ data, status_code, headers = api_instance.retrieve_fine_tune_with_http_info(fine_tune_id)
1411
+ p status_code # => 2xx
1412
+ p headers # => { ... }
1413
+ p data # => <FineTune>
1414
+ rescue OpenApiOpenAIClient::ApiError => e
1415
+ puts "Error when calling OpenAIApi->retrieve_fine_tune_with_http_info: #{e}"
1416
+ end
1417
+ ```
1418
+
1419
+ ### Parameters
1420
+
1421
+ | Name | Type | Description | Notes |
1422
+ | ---- | ---- | ----------- | ----- |
1423
+ | **fine_tune_id** | **String** | The ID of the fine-tune job | |
1424
+
1425
+ ### Return type
1426
+
1427
+ [**FineTune**](FineTune.md)
1428
+
1429
+ ### Authorization
1430
+
1431
+ No authorization required
1432
+
1433
+ ### HTTP request headers
1434
+
1435
+ - **Content-Type**: Not defined
1436
+ - **Accept**: application/json
1437
+
1438
+
1439
+ ## retrieve_model
1440
+
1441
+ > <Model> retrieve_model(model)
1442
+
1443
+ Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
1444
+
1445
+ ### Examples
1446
+
1447
+ ```ruby
1448
+ require 'time'
1449
+ require 'openapi_openai'
1450
+
1451
+ api_instance = OpenApiOpenAIClient::OpenAIApi.new
1452
+ model = 'text-davinci-001' # String | The ID of the model to use for this request
1453
+
1454
+ begin
1455
+ # Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
1456
+ result = api_instance.retrieve_model(model)
1457
+ p result
1458
+ rescue OpenApiOpenAIClient::ApiError => e
1459
+ puts "Error when calling OpenAIApi->retrieve_model: #{e}"
1460
+ end
1461
+ ```
1462
+
1463
+ #### Using the retrieve_model_with_http_info variant
1464
+
1465
+ This returns an Array which contains the response data, status code and headers.
1466
+
1467
+ > <Array(<Model>, Integer, Hash)> retrieve_model_with_http_info(model)
1468
+
1469
+ ```ruby
1470
+ begin
1471
+ # Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
1472
+ data, status_code, headers = api_instance.retrieve_model_with_http_info(model)
1473
+ p status_code # => 2xx
1474
+ p headers # => { ... }
1475
+ p data # => <Model>
1476
+ rescue OpenApiOpenAIClient::ApiError => e
1477
+ puts "Error when calling OpenAIApi->retrieve_model_with_http_info: #{e}"
1478
+ end
1479
+ ```
1480
+
1481
+ ### Parameters
1482
+
1483
+ | Name | Type | Description | Notes |
1484
+ | ---- | ---- | ----------- | ----- |
1485
+ | **model** | **String** | The ID of the model to use for this request | |
1486
+
1487
+ ### Return type
1488
+
1489
+ [**Model**](Model.md)
1490
+
1491
+ ### Authorization
1492
+
1493
+ No authorization required
1494
+
1495
+ ### HTTP request headers
1496
+
1497
+ - **Content-Type**: Not defined
1498
+ - **Accept**: application/json
1499
+