openapi_openai 1.0.0 → 1.1.0

data/docs/MessageStreamEvent.md

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

data/docs/MessageStreamEventOneOf.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageStreamEventOneOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **data** | [**MessageObject**](MessageObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageStreamEventOneOf.new(
+  event: null,
+  data: null
+)
+```
+

data/docs/MessageStreamEventOneOf1.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageStreamEventOneOf1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **data** | [**MessageObject**](MessageObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageStreamEventOneOf1.new(
+  event: null,
+  data: null
+)
+```
+

data/docs/MessageStreamEventOneOf2.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageStreamEventOneOf2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **data** | [**MessageDeltaObject**](MessageDeltaObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageStreamEventOneOf2.new(
+  event: null,
+  data: null
+)
+```
+

data/docs/MessageStreamEventOneOf3.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageStreamEventOneOf3
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **data** | [**MessageObject**](MessageObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageStreamEventOneOf3.new(
+  event: null,
+  data: null
+)
+```
+

data/docs/MessageStreamEventOneOf4.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageStreamEventOneOf4
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **data** | [**MessageObject**](MessageObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageStreamEventOneOf4.new(
+  event: null,
+  data: null
+)
+```
+

data/docs/Model.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **object** | **String** |  |  |
-| **created** | **Integer** |  |  |
-| **owned_by** | **String** |  |  |
+| **id** | **String** | The model identifier, which can be referenced in the API endpoints. |  |
+| **created** | **Integer** | The Unix timestamp (in seconds) when the model was created. |  |
+| **object** | **String** | The object type, which is always \"model\". |  |
+| **owned_by** | **String** | The organization that owns the model. |  |
 
 ## Example
 
@@ -16,8 +16,8 @@ require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::Model.new(
   id: null,
-  object: null,
   created: null,
+  object: null,
   owned_by: null
 )
 ```

data/docs/ModelsApi.md

@@ -0,0 +1,208 @@
+# OpenApiOpenAIClient::ModelsApi
+
+All URIs are relative to *https://api.openai.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_model**](ModelsApi.md#delete_model) | **DELETE** /models/{model} | Delete a fine-tuned model. You must have the Owner role in your organization to delete a model. |
+| [**list_models**](ModelsApi.md#list_models) | **GET** /models | Lists the currently available models, and provides basic information about each one such as the owner and availability. |
+| [**retrieve_model**](ModelsApi.md#retrieve_model) | **GET** /models/{model} | Retrieves a model instance, providing basic information about the model such as the owner and permissioning. |
+
+
+## delete_model
+
+> <DeleteModelResponse> delete_model(model)
+
+Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
+
+### 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::ModelsApi.new
+model = 'ft:gpt-3.5-turbo:acemeco:suffix:abc123' # String | The model to delete
+
+begin
+  # Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
+  result = api_instance.delete_model(model)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ModelsApi->delete_model: #{e}"
+end
+```
+
+#### Using the delete_model_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteModelResponse>, Integer, Hash)> delete_model_with_http_info(model)
+
+```ruby
+begin
+  # Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
+  data, status_code, headers = api_instance.delete_model_with_http_info(model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteModelResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ModelsApi->delete_model_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | **String** | The model to delete |  |
+
+### Return type
+
+[**DeleteModelResponse**](DeleteModelResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_models
+
+> <ListModelsResponse> list_models
+
+Lists the currently available models, and provides basic information about each one such as the owner and availability.
+
+### 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::ModelsApi.new
+
+begin
+  # Lists the currently available models, and provides basic information about each one such as the owner and availability.
+  result = api_instance.list_models
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ModelsApi->list_models: #{e}"
+end
+```
+
+#### Using the list_models_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListModelsResponse>, Integer, Hash)> list_models_with_http_info
+
+```ruby
+begin
+  # Lists the currently available models, and provides basic information about each one such as the owner and availability.
+  data, status_code, headers = api_instance.list_models_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListModelsResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ModelsApi->list_models_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListModelsResponse**](ListModelsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## retrieve_model
+
+> <Model> retrieve_model(model)
+
+Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
+
+### 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::ModelsApi.new
+model = 'gpt-3.5-turbo' # String | The ID of the model to use for this request
+
+begin
+  # Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
+  result = api_instance.retrieve_model(model)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ModelsApi->retrieve_model: #{e}"
+end
+```
+
+#### Using the retrieve_model_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Model>, Integer, Hash)> retrieve_model_with_http_info(model)
+
+```ruby
+begin
+  # Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
+  data, status_code, headers = api_instance.retrieve_model_with_http_info(model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Model>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ModelsApi->retrieve_model_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | **String** | The ID of the model to use for this request |  |
+
+### Return type
+
+[**Model**](Model.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ModerationsApi.md

@@ -0,0 +1,75 @@
+# OpenApiOpenAIClient::ModerationsApi
+
+All URIs are relative to *https://api.openai.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_moderation**](ModerationsApi.md#create_moderation) | **POST** /moderations | Classifies if text is potentially harmful. |
+
+
+## create_moderation
+
+> <CreateModerationResponse> create_moderation(create_moderation_request)
+
+Classifies if text is potentially harmful.
+
+### 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::ModerationsApi.new
+create_moderation_request = OpenApiOpenAIClient::CreateModerationRequest.new({input: nil}) # CreateModerationRequest | 
+
+begin
+  # Classifies if text is potentially harmful.
+  result = api_instance.create_moderation(create_moderation_request)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ModerationsApi->create_moderation: #{e}"
+end
+```
+
+#### Using the create_moderation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateModerationResponse>, Integer, Hash)> create_moderation_with_http_info(create_moderation_request)
+
+```ruby
+begin
+  # Classifies if text is potentially harmful.
+  data, status_code, headers = api_instance.create_moderation_with_http_info(create_moderation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateModerationResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ModerationsApi->create_moderation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_moderation_request** | [**CreateModerationRequest**](CreateModerationRequest.md) |  |  |
+
+### Return type
+
+[**CreateModerationResponse**](CreateModerationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ModifyAssistantRequest.md

@@ -0,0 +1,30 @@
+# OpenApiOpenAIClient::ModifyAssistantRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | **String** |  | [optional] |
+| **name** | **String** | The name of the assistant. The maximum length is 256 characters.  | [optional] |
+| **description** | **String** | The description of the assistant. The maximum length is 512 characters.  | [optional] |
+| **instructions** | **String** | The system instructions that the assistant uses. The maximum length is 256,000 characters.  | [optional] |
+| **tools** | [**Array<AssistantObjectToolsInner>**](AssistantObjectToolsInner.md) | A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.  | [optional] |
+| **file_ids** | **Array<String>** | A list of [File](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order. If a file was previously attached to the list but does not show up in the list, it will be deleted from the assistant.  | [optional] |
+| **metadata** | **Object** | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ModifyAssistantRequest.new(
+  model: null,
+  name: null,
+  description: null,
+  instructions: null,
+  tools: null,
+  file_ids: null,
+  metadata: null
+)
+```
+

data/docs/ModifyMessageRequest.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::ModifyMessageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | **Object** | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ModifyMessageRequest.new(
+  metadata: null
+)
+```
+

data/docs/ModifyRunRequest.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::ModifyRunRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | **Object** | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ModifyRunRequest.new(
+  metadata: null
+)
+```
+

data/docs/ModifyThreadRequest.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::ModifyThreadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | **Object** | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ModifyThreadRequest.new(
+  metadata: null
+)
+```
+

data/docs/OpenAIFile.md

@@ -4,14 +4,14 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **object** | **String** |  |  |
-| **bytes** | **Integer** |  |  |
-| **created_at** | **Integer** |  |  |
-| **filename** | **String** |  |  |
-| **purpose** | **String** |  |  |
-| **status** | **String** |  | [optional] |
-| **status_details** | **Object** |  | [optional] |
+| **id** | **String** | The file identifier, which can be referenced in the API endpoints. |  |
+| **bytes** | **Integer** | The size of the file, in bytes. |  |
+| **created_at** | **Integer** | The Unix timestamp (in seconds) for when the file was created. |  |
+| **filename** | **String** | The name of the file. |  |
+| **object** | **String** | The object type, which is always `file`. |  |
+| **purpose** | **String** | The intended purpose of the file. Supported values are `fine-tune`, `fine-tune-results`, `assistants`, and `assistants_output`. |  |
+| **status** | **String** | Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`. |  |
+| **status_details** | **String** | Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`. | [optional] |
 
 ## Example
 
@@ -20,10 +20,10 @@ require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::OpenAIFile.new(
   id: null,
-  object: null,
   bytes: null,
   created_at: null,
   filename: null,
+  object: null,
   purpose: null,
   status: null,
   status_details: null

data/docs/RunCompletionUsage.md

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

data/docs/RunObject.md

@@ -0,0 +1,68 @@
+# OpenApiOpenAIClient::RunObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The identifier, which can be referenced in API endpoints. |  |
+| **object** | **String** | The object type, which is always `thread.run`. |  |
+| **created_at** | **Integer** | The Unix timestamp (in seconds) for when the run was created. |  |
+| **thread_id** | **String** | The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run. |  |
+| **assistant_id** | **String** | The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run. |  |
+| **status** | **String** | The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`. |  |
+| **required_action** | [**RunObjectRequiredAction**](RunObjectRequiredAction.md) |  |  |
+| **last_error** | [**RunObjectLastError**](RunObjectLastError.md) |  |  |
+| **expires_at** | **Integer** | The Unix timestamp (in seconds) for when the run will expire. |  |
+| **started_at** | **Integer** | The Unix timestamp (in seconds) for when the run was started. |  |
+| **cancelled_at** | **Integer** | The Unix timestamp (in seconds) for when the run was cancelled. |  |
+| **failed_at** | **Integer** | The Unix timestamp (in seconds) for when the run failed. |  |
+| **completed_at** | **Integer** | The Unix timestamp (in seconds) for when the run was completed. |  |
+| **incomplete_details** | [**RunObjectIncompleteDetails**](RunObjectIncompleteDetails.md) |  |  |
+| **model** | **String** | The model that the [assistant](/docs/api-reference/assistants) used for this run. |  |
+| **instructions** | **String** | The instructions that the [assistant](/docs/api-reference/assistants) used for this run. |  |
+| **tools** | [**Array<AssistantObjectToolsInner>**](AssistantObjectToolsInner.md) | The list of tools that the [assistant](/docs/api-reference/assistants) used for this run. |  |
+| **file_ids** | **Array<String>** | The list of [File](/docs/api-reference/files) IDs the [assistant](/docs/api-reference/assistants) used for this run. |  |
+| **metadata** | **Object** | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.  |  |
+| **usage** | [**RunCompletionUsage**](RunCompletionUsage.md) |  |  |
+| **temperature** | **Float** | The sampling temperature used for this run. If not set, defaults to 1. | [optional] |
+| **max_prompt_tokens** | **Integer** | The maximum number of prompt tokens specified to have been used over the course of the run.  |  |
+| **max_completion_tokens** | **Integer** | The maximum number of completion tokens specified to have been used over the course of the run.  |  |
+| **truncation_strategy** | [**TruncationObject**](TruncationObject.md) |  |  |
+| **tool_choice** | [**AssistantsApiToolChoiceOption**](AssistantsApiToolChoiceOption.md) |  |  |
+| **response_format** | [**AssistantsApiResponseFormatOption**](AssistantsApiResponseFormatOption.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunObject.new(
+  id: null,
+  object: null,
+  created_at: null,
+  thread_id: null,
+  assistant_id: null,
+  status: null,
+  required_action: null,
+  last_error: null,
+  expires_at: null,
+  started_at: null,
+  cancelled_at: null,
+  failed_at: null,
+  completed_at: null,
+  incomplete_details: null,
+  model: null,
+  instructions: null,
+  tools: null,
+  file_ids: null,
+  metadata: null,
+  usage: null,
+  temperature: null,
+  max_prompt_tokens: null,
+  max_completion_tokens: null,
+  truncation_strategy: null,
+  tool_choice: null,
+  response_format: null
+)
+```
+