openapi_openai 1.0.0 → 1.1.0

data/docs/CreateModerationResponseResultsInnerCategoryScores.md

@@ -4,13 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **hate** | **Float** |  |  |
-| **hate_threatening** | **Float** |  |  |
-| **self_harm** | **Float** |  |  |
-| **sexual** | **Float** |  |  |
-| **sexual_minors** | **Float** |  |  |
-| **violence** | **Float** |  |  |
-| **violence_graphic** | **Float** |  |  |
+| **hate** | **Float** | The score for the category 'hate'. |  |
+| **hate_threatening** | **Float** | The score for the category 'hate/threatening'. |  |
+| **harassment** | **Float** | The score for the category 'harassment'. |  |
+| **harassment_threatening** | **Float** | The score for the category 'harassment/threatening'. |  |
+| **self_harm** | **Float** | The score for the category 'self-harm'. |  |
+| **self_harm_intent** | **Float** | The score for the category 'self-harm/intent'. |  |
+| **self_harm_instructions** | **Float** | The score for the category 'self-harm/instructions'. |  |
+| **sexual** | **Float** | The score for the category 'sexual'. |  |
+| **sexual_minors** | **Float** | The score for the category 'sexual/minors'. |  |
+| **violence** | **Float** | The score for the category 'violence'. |  |
+| **violence_graphic** | **Float** | The score for the category 'violence/graphic'. |  |
 
 ## Example
 
@@ -20,7 +24,11 @@ require 'openapi_openai'
 instance = OpenApiOpenAIClient::CreateModerationResponseResultsInnerCategoryScores.new(
   hate: null,
   hate_threatening: null,
+  harassment: null,
+  harassment_threatening: null,
   self_harm: null,
+  self_harm_intent: null,
+  self_harm_instructions: null,
   sexual: null,
   sexual_minors: null,
   violence: null,

data/docs/CreateRunRequest.md

@@ -0,0 +1,44 @@
+# OpenApiOpenAIClient::CreateRunRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assistant_id** | **String** | The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run. |  |
+| **model** | [**CreateRunRequestModel**](CreateRunRequestModel.md) |  | [optional] |
+| **instructions** | **String** | Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis. | [optional] |
+| **additional_instructions** | **String** | Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions. | [optional] |
+| **additional_messages** | [**Array<CreateMessageRequest>**](CreateMessageRequest.md) | Adds additional messages to the thread before creating the run. | [optional] |
+| **tools** | [**Array<AssistantObjectToolsInner>**](AssistantObjectToolsInner.md) | Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. | [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] |
+| **temperature** | **Float** | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.  | [optional][default to 1] |
+| **stream** | **Boolean** | If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.  | [optional] |
+| **max_prompt_tokens** | **Integer** | The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `complete`. See `incomplete_details` for more info.  | [optional] |
+| **max_completion_tokens** | **Integer** | The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `complete`. See `incomplete_details` for more info.  | [optional] |
+| **truncation_strategy** | [**TruncationObject**](TruncationObject.md) |  | [optional] |
+| **tool_choice** | [**AssistantsApiToolChoiceOption**](AssistantsApiToolChoiceOption.md) |  | [optional] |
+| **response_format** | [**AssistantsApiResponseFormatOption**](AssistantsApiResponseFormatOption.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateRunRequest.new(
+  assistant_id: null,
+  model: null,
+  instructions: null,
+  additional_instructions: null,
+  additional_messages: null,
+  tools: null,
+  metadata: null,
+  temperature: 1,
+  stream: null,
+  max_prompt_tokens: null,
+  max_completion_tokens: null,
+  truncation_strategy: null,
+  tool_choice: null,
+  response_format: null
+)
+```
+

data/docs/CreateRunRequestModel.md

@@ -0,0 +1,15 @@
+# OpenApiOpenAIClient::CreateRunRequestModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateRunRequestModel.new()
+```
+

data/docs/CreateSpeechRequest.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::CreateSpeechRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**CreateSpeechRequestModel**](CreateSpeechRequestModel.md) |  |  |
+| **input** | **String** | The text to generate audio for. The maximum length is 4096 characters. |  |
+| **voice** | **String** | The voice to use when generating the audio. Supported voices are `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech/voice-options). |  |
+| **response_format** | **String** | The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`. | [optional][default to 'mp3'] |
+| **speed** | **Float** | The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default. | [optional][default to 1.0] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateSpeechRequest.new(
+  model: null,
+  input: null,
+  voice: null,
+  response_format: null,
+  speed: null
+)
+```
+

data/docs/CreateSpeechRequestModel.md

@@ -0,0 +1,15 @@
+# OpenApiOpenAIClient::CreateSpeechRequestModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateSpeechRequestModel.new()
+```
+

data/docs/CreateThreadAndRunRequest.md

@@ -0,0 +1,42 @@
+# OpenApiOpenAIClient::CreateThreadAndRunRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assistant_id** | **String** | The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run. |  |
+| **thread** | [**CreateThreadRequest**](CreateThreadRequest.md) |  | [optional] |
+| **model** | [**CreateRunRequestModel**](CreateRunRequestModel.md) |  | [optional] |
+| **instructions** | **String** | Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. | [optional] |
+| **tools** | [**Array<CreateThreadAndRunRequestToolsInner>**](CreateThreadAndRunRequestToolsInner.md) | Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. | [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] |
+| **temperature** | **Float** | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.  | [optional][default to 1] |
+| **stream** | **Boolean** | If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.  | [optional] |
+| **max_prompt_tokens** | **Integer** | The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `complete`. See `incomplete_details` for more info.  | [optional] |
+| **max_completion_tokens** | **Integer** | The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.  | [optional] |
+| **truncation_strategy** | [**TruncationObject**](TruncationObject.md) |  | [optional] |
+| **tool_choice** | [**AssistantsApiToolChoiceOption**](AssistantsApiToolChoiceOption.md) |  | [optional] |
+| **response_format** | [**AssistantsApiResponseFormatOption**](AssistantsApiResponseFormatOption.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateThreadAndRunRequest.new(
+  assistant_id: null,
+  thread: null,
+  model: null,
+  instructions: null,
+  tools: null,
+  metadata: null,
+  temperature: 1,
+  stream: null,
+  max_prompt_tokens: null,
+  max_completion_tokens: null,
+  truncation_strategy: null,
+  tool_choice: null,
+  response_format: null
+)
+```
+

data/docs/CreateThreadAndRunRequestToolsInner.md

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

data/docs/CreateThreadRequest.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateThreadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **messages** | [**Array<CreateMessageRequest>**](CreateMessageRequest.md) | A list of [messages](/docs/api-reference/messages) to start the thread with. | [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::CreateThreadRequest.new(
+  messages: null,
+  metadata: null
+)
+```
+

data/docs/CreateTranscription200Response.md

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

data/docs/CreateTranscriptionRequestModel.md

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

data/docs/CreateTranscriptionResponseJson.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::CreateTranscriptionResponseJson
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The transcribed text. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateTranscriptionResponseJson.new(
+  text: null
+)
+```
+

data/docs/CreateTranscriptionResponseVerboseJson.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::CreateTranscriptionResponseVerboseJson
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **language** | **String** | The language of the input audio. |  |
+| **duration** | **String** | The duration of the input audio. |  |
+| **text** | **String** | The transcribed text. |  |
+| **words** | [**Array<TranscriptionWord>**](TranscriptionWord.md) | Extracted words and their corresponding timestamps. | [optional] |
+| **segments** | [**Array<TranscriptionSegment>**](TranscriptionSegment.md) | Segments of the transcribed text and their corresponding details. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateTranscriptionResponseVerboseJson.new(
+  language: null,
+  duration: null,
+  text: null,
+  words: null,
+  segments: null
+)
+```
+

data/docs/CreateTranslation200Response.md

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

data/docs/{CreateTranscriptionResponse.md → CreateTranslationResponseJson.md}

@@ -1,4 +1,4 @@
-# OpenApiOpenAIClient::CreateTranscriptionResponse
+# OpenApiOpenAIClient::CreateTranslationResponseJson
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'openapi_openai'
 
-instance = OpenApiOpenAIClient::CreateTranscriptionResponse.new(
+instance = OpenApiOpenAIClient::CreateTranslationResponseJson.new(
   text: null
 )
 ```

data/docs/CreateTranslationResponseVerboseJson.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::CreateTranslationResponseVerboseJson
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **language** | **String** | The language of the output translation (always `english`). |  |
+| **duration** | **String** | The duration of the input audio. |  |
+| **text** | **String** | The translated text. |  |
+| **segments** | [**Array<TranscriptionSegment>**](TranscriptionSegment.md) | Segments of the translated text and their corresponding details. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateTranslationResponseVerboseJson.new(
+  language: null,
+  duration: null,
+  text: null,
+  segments: null
+)
+```
+

data/docs/DeleteAssistantFileResponse.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::DeleteAssistantFileResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::DeleteAssistantFileResponse.new(
+  id: null,
+  deleted: null,
+  object: 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/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
+)
+```
+