openapi_openai 1.0.0 → 1.1.0

data/docs/RunStreamEventOneOf4.md

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

data/docs/RunStreamEventOneOf5.md

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

data/docs/RunStreamEventOneOf6.md

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

data/docs/RunStreamEventOneOf7.md

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

data/docs/RunStreamEventOneOf8.md

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

data/docs/RunToolCallObject.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::RunToolCallObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint. |  |
+| **type** | **String** | The type of tool call the output is required for. For now, this is always `function`. |  |
+| **function** | [**RunToolCallObjectFunction**](RunToolCallObjectFunction.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunToolCallObject.new(
+  id: null,
+  type: null,
+  function: null
+)
+```
+

data/docs/RunToolCallObjectFunction.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunToolCallObjectFunction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the function. |  |
+| **arguments** | **String** | The arguments that the model expects you to pass to the function. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunToolCallObjectFunction.new(
+  name: null,
+  arguments: null
+)
+```
+

data/docs/SubmitToolOutputsRunRequest.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::SubmitToolOutputsRunRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tool_outputs** | [**Array<SubmitToolOutputsRunRequestToolOutputsInner>**](SubmitToolOutputsRunRequestToolOutputsInner.md) | A list of tools for which the outputs are being submitted. |  |
+| **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] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::SubmitToolOutputsRunRequest.new(
+  tool_outputs: null,
+  stream: null
+)
+```
+

data/docs/SubmitToolOutputsRunRequestToolOutputsInner.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::SubmitToolOutputsRunRequestToolOutputsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tool_call_id** | **String** | The ID of the tool call in the `required_action` object within the run object the output is being submitted for. | [optional] |
+| **output** | **String** | The output of the tool call to be submitted to continue the run. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::SubmitToolOutputsRunRequestToolOutputsInner.new(
+  tool_call_id: null,
+  output: null
+)
+```
+

data/docs/ThreadObject.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::ThreadObject
+
+## 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`. |  |
+| **created_at** | **Integer** | The Unix timestamp (in seconds) for when the thread was created. |  |
+| **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.  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ThreadObject.new(
+  id: null,
+  object: null,
+  created_at: null,
+  metadata: null
+)
+```
+

data/docs/{CreateEditRequestModel.md → ThreadStreamEvent.md}

@@ -1,4 +1,4 @@
-# OpenApiOpenAIClient::CreateEditRequestModel
+# OpenApiOpenAIClient::ThreadStreamEvent
 
 ## Class instance methods
 
@@ -11,10 +11,10 @@ Returns the list of classes defined in oneOf.
 ```ruby
 require 'openapi_openai'
 
-OpenApiOpenAIClient::CreateEditRequestModel.openapi_one_of
+OpenApiOpenAIClient::ThreadStreamEvent.openapi_one_of
 # =>
 # [
-#   :'String'
+#   :'ThreadStreamEventOneOf'
 # ]
 ```
 
@@ -27,10 +27,10 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 ```ruby
 require 'openapi_openai'
 
-OpenApiOpenAIClient::CreateEditRequestModel.build(data)
-# => #<String:0x00007fdd4aab02a0>
+OpenApiOpenAIClient::ThreadStreamEvent.build(data)
+# => #<ThreadStreamEventOneOf:0x00007fdd4aab02a0>
 
-OpenApiOpenAIClient::CreateEditRequestModel.build(data_that_doesnt_match)
+OpenApiOpenAIClient::ThreadStreamEvent.build(data_that_doesnt_match)
 # => nil
 ```
 
@@ -42,6 +42,6 @@ OpenApiOpenAIClient::CreateEditRequestModel.build(data_that_doesnt_match)
 
 #### Return type
 
-- `String`
+- `ThreadStreamEventOneOf`
 - `nil` (if no type matches)
 

data/docs/ThreadStreamEventOneOf.md

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

data/docs/TranscriptionSegment.md

@@ -0,0 +1,36 @@
+# OpenApiOpenAIClient::TranscriptionSegment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unique identifier of the segment. |  |
+| **seek** | **Integer** | Seek offset of the segment. |  |
+| **start** | **Float** | Start time of the segment in seconds. |  |
+| **_end** | **Float** | End time of the segment in seconds. |  |
+| **text** | **String** | Text content of the segment. |  |
+| **tokens** | **Array<Integer>** | Array of token IDs for the text content. |  |
+| **temperature** | **Float** | Temperature parameter used for generating the segment. |  |
+| **avg_logprob** | **Float** | Average logprob of the segment. If the value is lower than -1, consider the logprobs failed. |  |
+| **compression_ratio** | **Float** | Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed. |  |
+| **no_speech_prob** | **Float** | Probability of no speech in the segment. If the value is higher than 1.0 and the `avg_logprob` is below -1, consider this segment silent. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::TranscriptionSegment.new(
+  id: null,
+  seek: null,
+  start: null,
+  _end: null,
+  text: null,
+  tokens: null,
+  temperature: null,
+  avg_logprob: null,
+  compression_ratio: null,
+  no_speech_prob: null
+)
+```
+

data/docs/TranscriptionWord.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::TranscriptionWord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **word** | **String** | The text content of the word. |  |
+| **start** | **Float** | Start time of the word in seconds. |  |
+| **_end** | **Float** | End time of the word in seconds. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::TranscriptionWord.new(
+  word: null,
+  start: null,
+  _end: null
+)
+```
+

data/docs/TruncationObject.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::TruncationObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. | [optional] |
+| **last_messages** | **Integer** | The number of most recent messages from the thread when constructing the context for the run. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::TruncationObject.new(
+  type: null,
+  last_messages: null
+)
+```
+