openapi_openai 1.0.0 → 1.2.0

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] |
+
+## 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,48 @@
+# 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] |
+| **tool_resources** | [**CreateThreadAndRunRequestToolResources**](CreateThreadAndRunRequestToolResources.md) |  | [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 maximum 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] |
+| **top_p** | **Float** | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.  We generally recommend altering this or temperature but not both.  | [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 `incomplete`. 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] |
+| **parallel_tool_calls** | **Boolean** | Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. | [optional][default to true] |
+| **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,
+  tool_resources: null,
+  metadata: null,
+  temperature: 1,
+  top_p: 1,
+  stream: null,
+  max_prompt_tokens: null,
+  max_completion_tokens: null,
+  truncation_strategy: null,
+  tool_choice: null,
+  parallel_tool_calls: null,
+  response_format: null
+)
+```
+

data/docs/CreateThreadAndRunRequestToolResources.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateThreadAndRunRequestToolResources
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_interpreter** | [**CreateAssistantRequestToolResourcesCodeInterpreter**](CreateAssistantRequestToolResourcesCodeInterpreter.md) |  | [optional] |
+| **file_search** | [**AssistantObjectToolResourcesFileSearch**](AssistantObjectToolResourcesFileSearch.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateThreadAndRunRequestToolResources.new(
+  code_interpreter: null,
+  file_search: 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',
+#   :'AssistantToolsFileSearch',
+#   :'AssistantToolsFunction'
+# ]
+```
+
+### 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`
+- `AssistantToolsFileSearch`
+- `AssistantToolsFunction`
+- `nil` (if no type matches)
+

data/docs/CreateThreadRequest.md

@@ -0,0 +1,22 @@
+# 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] |
+| **tool_resources** | [**CreateThreadRequestToolResources**](CreateThreadRequestToolResources.md) |  | [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 maximum of 512 characters long.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateThreadRequest.new(
+  messages: null,
+  tool_resources: null,
+  metadata: null
+)
+```
+

data/docs/CreateThreadRequestToolResources.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateThreadRequestToolResources
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_interpreter** | [**CreateAssistantRequestToolResourcesCodeInterpreter**](CreateAssistantRequestToolResourcesCodeInterpreter.md) |  | [optional] |
+| **file_search** | [**CreateThreadRequestToolResourcesFileSearch**](CreateThreadRequestToolResourcesFileSearch.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateThreadRequestToolResources.new(
+  code_interpreter: null,
+  file_search: null
+)
+```
+

data/docs/CreateThreadRequestToolResourcesFileSearch.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateThreadRequestToolResourcesFileSearch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vector_store_ids** | **Array<String>** | The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread.  | [optional] |
+| **vector_stores** | [**Array<CreateThreadRequestToolResourcesFileSearchVectorStoresInner>**](CreateThreadRequestToolResourcesFileSearchVectorStoresInner.md) | A helper to create a [vector store](/docs/api-reference/vector-stores/object) with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateThreadRequestToolResourcesFileSearch.new(
+  vector_store_ids: null,
+  vector_stores: null
+)
+```
+

data/docs/CreateThreadRequestToolResourcesFileSearchVectorStoresInner.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CreateThreadRequestToolResourcesFileSearchVectorStoresInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_ids** | **Array<String>** | A list of [file](/docs/api-reference/files) IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.  | [optional] |
+| **chunking_strategy** | [**CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy**](CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy.md) |  | [optional] |
+| **metadata** | **Object** | Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateThreadRequestToolResourcesFileSearchVectorStoresInner.new(
+  file_ids: null,
+  chunking_strategy: 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/CreateUploadRequest.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::CreateUploadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filename** | **String** | The name of the file to upload.  |  |
+| **purpose** | **String** | The intended purpose of the uploaded file.  See the [documentation on File purposes](/docs/api-reference/files/create#files-create-purpose).  |  |
+| **bytes** | **Integer** | The number of bytes in the file you are uploading.  |  |
+| **mime_type** | **String** | The MIME type of the file.  This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateUploadRequest.new(
+  filename: null,
+  purpose: null,
+  bytes: null,
+  mime_type: null
+)
+```
+

data/docs/CreateVectorStoreFileBatchRequest.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateVectorStoreFileBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_ids** | **Array<String>** | A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. |  |
+| **chunking_strategy** | [**ChunkingStrategyRequestParam**](ChunkingStrategyRequestParam.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateVectorStoreFileBatchRequest.new(
+  file_ids: null,
+  chunking_strategy: null
+)
+```
+

data/docs/CreateVectorStoreFileRequest.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::CreateVectorStoreFileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. |  |
+| **chunking_strategy** | [**ChunkingStrategyRequestParam**](ChunkingStrategyRequestParam.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateVectorStoreFileRequest.new(
+  file_id: null,
+  chunking_strategy: null
+)
+```
+

data/docs/CreateVectorStoreRequest.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::CreateVectorStoreRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_ids** | **Array<String>** | A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. | [optional] |
+| **name** | **String** | The name of the vector store. | [optional] |
+| **expires_after** | [**VectorStoreExpirationAfter**](VectorStoreExpirationAfter.md) |  | [optional] |
+| **chunking_strategy** | [**CreateVectorStoreRequestChunkingStrategy**](CreateVectorStoreRequestChunkingStrategy.md) |  | [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 maximum of 512 characters long.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateVectorStoreRequest.new(
+  file_ids: null,
+  name: null,
+  expires_after: null,
+  chunking_strategy: null,
+  metadata: null
+)
+```
+

data/docs/CreateVectorStoreRequestChunkingStrategy.md

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