openapi_openai 1.0.0 → 1.2.0

data/docs/DefaultApi.md

@@ -0,0 +1,293 @@
+# OpenApiOpenAIClient::DefaultApi
+
+All URIs are relative to *https://api.openai.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**admin_api_keys_create**](DefaultApi.md#admin_api_keys_create) | **POST** /organization/admin_api_keys | Create an organization admin API key |
+| [**admin_api_keys_delete**](DefaultApi.md#admin_api_keys_delete) | **DELETE** /organization/admin_api_keys/{key_id} | Delete an organization admin API key |
+| [**admin_api_keys_get**](DefaultApi.md#admin_api_keys_get) | **GET** /organization/admin_api_keys/{key_id} | Retrieve a single organization API key |
+| [**admin_api_keys_list**](DefaultApi.md#admin_api_keys_list) | **GET** /organization/admin_api_keys | List organization API keys |
+
+
+## admin_api_keys_create
+
+> <AdminApiKey> admin_api_keys_create(admin_api_keys_create_request)
+
+Create an organization admin API key
+
+Create a new admin-level API key for the organization.
+
+### 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::DefaultApi.new
+admin_api_keys_create_request = OpenApiOpenAIClient::AdminApiKeysCreateRequest.new({name: 'New Admin Key'}) # AdminApiKeysCreateRequest | 
+
+begin
+  # Create an organization admin API key
+  result = api_instance.admin_api_keys_create(admin_api_keys_create_request)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling DefaultApi->admin_api_keys_create: #{e}"
+end
+```
+
+#### Using the admin_api_keys_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AdminApiKey>, Integer, Hash)> admin_api_keys_create_with_http_info(admin_api_keys_create_request)
+
+```ruby
+begin
+  # Create an organization admin API key
+  data, status_code, headers = api_instance.admin_api_keys_create_with_http_info(admin_api_keys_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AdminApiKey>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling DefaultApi->admin_api_keys_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **admin_api_keys_create_request** | [**AdminApiKeysCreateRequest**](AdminApiKeysCreateRequest.md) |  |  |
+
+### Return type
+
+[**AdminApiKey**](AdminApiKey.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## admin_api_keys_delete
+
+> <AdminApiKeysDelete200Response> admin_api_keys_delete(key_id)
+
+Delete an organization admin API key
+
+Delete the specified admin API key.
+
+### 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::DefaultApi.new
+key_id = 'key_id_example' # String | 
+
+begin
+  # Delete an organization admin API key
+  result = api_instance.admin_api_keys_delete(key_id)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling DefaultApi->admin_api_keys_delete: #{e}"
+end
+```
+
+#### Using the admin_api_keys_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AdminApiKeysDelete200Response>, Integer, Hash)> admin_api_keys_delete_with_http_info(key_id)
+
+```ruby
+begin
+  # Delete an organization admin API key
+  data, status_code, headers = api_instance.admin_api_keys_delete_with_http_info(key_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AdminApiKeysDelete200Response>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling DefaultApi->admin_api_keys_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key_id** | **String** |  |  |
+
+### Return type
+
+[**AdminApiKeysDelete200Response**](AdminApiKeysDelete200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## admin_api_keys_get
+
+> <AdminApiKey> admin_api_keys_get(key_id)
+
+Retrieve a single organization API key
+
+Get details for a specific organization API key by its ID.
+
+### 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::DefaultApi.new
+key_id = 'key_id_example' # String | 
+
+begin
+  # Retrieve a single organization API key
+  result = api_instance.admin_api_keys_get(key_id)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling DefaultApi->admin_api_keys_get: #{e}"
+end
+```
+
+#### Using the admin_api_keys_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AdminApiKey>, Integer, Hash)> admin_api_keys_get_with_http_info(key_id)
+
+```ruby
+begin
+  # Retrieve a single organization API key
+  data, status_code, headers = api_instance.admin_api_keys_get_with_http_info(key_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AdminApiKey>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling DefaultApi->admin_api_keys_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key_id** | **String** |  |  |
+
+### Return type
+
+[**AdminApiKey**](AdminApiKey.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## admin_api_keys_list
+
+> <ApiKeyList> admin_api_keys_list(opts)
+
+List organization API keys
+
+Retrieve a paginated list of organization admin API keys.
+
+### 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::DefaultApi.new
+opts = {
+  after: 'after_example', # String | 
+  order: 'asc', # String | 
+  limit: 56 # Integer | 
+}
+
+begin
+  # List organization API keys
+  result = api_instance.admin_api_keys_list(opts)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling DefaultApi->admin_api_keys_list: #{e}"
+end
+```
+
+#### Using the admin_api_keys_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiKeyList>, Integer, Hash)> admin_api_keys_list_with_http_info(opts)
+
+```ruby
+begin
+  # List organization API keys
+  data, status_code, headers = api_instance.admin_api_keys_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiKeyList>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling DefaultApi->admin_api_keys_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **after** | **String** |  | [optional] |
+| **order** | **String** |  | [optional][default to &#39;asc&#39;] |
+| **limit** | **Integer** |  | [optional][default to 20] |
+
+### Return type
+
+[**ApiKeyList**](ApiKeyList.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DefaultProjectErrorResponse.md

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

data/docs/DeleteAssistantResponse.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::DeleteAssistantResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::DeleteAssistantResponse.new(
+  id: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/DeleteMessageResponse.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::DeleteMessageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::DeleteMessageResponse.new(
+  id: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/DeleteModelResponse.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **object** | **String** |  |  |
 | **deleted** | **Boolean** |  |  |
+| **object** | **String** |  |  |
 
 ## Example
 
@@ -15,8 +15,8 @@ require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::DeleteModelResponse.new(
   id: null,
-  object: null,
-  deleted: null
+  deleted: null,
+  object: null
 )
 ```
 

data/docs/DeleteThreadResponse.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::DeleteThreadResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::DeleteThreadResponse.new(
+  id: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/DeleteVectorStoreFileResponse.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::DeleteVectorStoreFileResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::DeleteVectorStoreFileResponse.new(
+  id: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/DeleteVectorStoreResponse.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::DeleteVectorStoreResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::DeleteVectorStoreResponse.new(
+  id: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/DoneEvent.md

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

data/docs/Embedding.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::Embedding
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | The index of the embedding in the list of embeddings. |  |
+| **embedding** | **Array<Float>** | The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the [embedding guide](/docs/guides/embeddings).  |  |
+| **object** | **String** | The object type, which is always \"embedding\". |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::Embedding.new(
+  index: null,
+  embedding: null,
+  object: null
+)
+```
+

data/docs/EmbeddingsApi.md

@@ -0,0 +1,75 @@
+# OpenApiOpenAIClient::EmbeddingsApi
+
+All URIs are relative to *https://api.openai.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_embedding**](EmbeddingsApi.md#create_embedding) | **POST** /embeddings | Creates an embedding vector representing the input text. |
+
+
+## create_embedding
+
+> <CreateEmbeddingResponse> create_embedding(create_embedding_request)
+
+Creates an embedding vector representing the input text.
+
+### 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::EmbeddingsApi.new
+create_embedding_request = OpenApiOpenAIClient::CreateEmbeddingRequest.new({input: nil, model: OpenApiOpenAIClient::CreateEmbeddingRequestModel.new}) # CreateEmbeddingRequest | 
+
+begin
+  # Creates an embedding vector representing the input text.
+  result = api_instance.create_embedding(create_embedding_request)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling EmbeddingsApi->create_embedding: #{e}"
+end
+```
+
+#### Using the create_embedding_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateEmbeddingResponse>, Integer, Hash)> create_embedding_with_http_info(create_embedding_request)
+
+```ruby
+begin
+  # Creates an embedding vector representing the input text.
+  data, status_code, headers = api_instance.create_embedding_with_http_info(create_embedding_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateEmbeddingResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling EmbeddingsApi->create_embedding_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_embedding_request** | [**CreateEmbeddingRequest**](CreateEmbeddingRequest.md) |  |  |
+
+### Return type
+
+[**CreateEmbeddingResponse**](CreateEmbeddingResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Error.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** |  |  |
+| **code** | **String** |  |  |
 | **message** | **String** |  |  |
 | **param** | **String** |  |  |
-| **code** | **String** |  |  |
+| **type** | **String** |  |  |
 
 ## Example
 
@@ -15,10 +15,10 @@
 require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::Error.new(
-  type: null,
+  code: null,
   message: null,
   param: null,
-  code: null
+  type: null
 )
 ```
 

data/docs/ErrorEvent.md

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

data/docs/FileSearchRankingOptions.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::FileSearchRankingOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ranker** | **String** | The ranker to use for the file search. If not specified will use the `auto` ranker. | [optional] |
+| **score_threshold** | **Float** | The score threshold for the file search. All values must be a floating point number between 0 and 1. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::FileSearchRankingOptions.new(
+  ranker: null,
+  score_threshold: null
+)
+```
+