openapi_openai 1.0.0 → 1.2.0

data/docs/RunStepDetailsToolCallsCodeObject.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsCodeObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the tool call. |  |
+| **type** | **String** | The type of tool call. This is always going to be `code_interpreter` for this type of tool call. |  |
+| **code_interpreter** | [**RunStepDetailsToolCallsCodeObjectCodeInterpreter**](RunStepDetailsToolCallsCodeObjectCodeInterpreter.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsCodeObject.new(
+  id: null,
+  type: null,
+  code_interpreter: null
+)
+```
+

data/docs/RunStepDetailsToolCallsCodeObjectCodeInterpreter.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsCodeObjectCodeInterpreter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | **String** | The input to the Code Interpreter tool call. |  |
+| **outputs** | [**Array<RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner>**](RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner.md) | The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsCodeObjectCodeInterpreter.new(
+  input: null,
+  outputs: null
+)
+```
+

data/docs/RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner.md

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

data/docs/RunStepDetailsToolCallsCodeOutputImageObject.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputImageObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Always `image`. |  |
+| **image** | [**RunStepDetailsToolCallsCodeOutputImageObjectImage**](RunStepDetailsToolCallsCodeOutputImageObjectImage.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputImageObject.new(
+  type: null,
+  image: null
+)
+```
+

data/docs/RunStepDetailsToolCallsCodeOutputImageObjectImage.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputImageObjectImage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The [file](/docs/api-reference/files) ID of the image. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputImageObjectImage.new(
+  file_id: null
+)
+```
+

data/docs/RunStepDetailsToolCallsCodeOutputLogsObject.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputLogsObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Always `logs`. |  |
+| **logs** | **String** | The text output from the Code Interpreter tool call. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputLogsObject.new(
+  type: null,
+  logs: null
+)
+```
+

data/docs/RunStepDetailsToolCallsFileSearchObject.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the tool call object. |  |
+| **type** | **String** | The type of tool call. This is always going to be `file_search` for this type of tool call. |  |
+| **file_search** | [**RunStepDetailsToolCallsFileSearchObjectFileSearch**](RunStepDetailsToolCallsFileSearchObjectFileSearch.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchObject.new(
+  id: null,
+  type: null,
+  file_search: null
+)
+```
+

data/docs/RunStepDetailsToolCallsFileSearchObjectFileSearch.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchObjectFileSearch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ranking_options** | [**RunStepDetailsToolCallsFileSearchRankingOptionsObject**](RunStepDetailsToolCallsFileSearchRankingOptionsObject.md) |  | [optional] |
+| **results** | [**Array<RunStepDetailsToolCallsFileSearchResultObject>**](RunStepDetailsToolCallsFileSearchResultObject.md) | The results of the file search. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchObjectFileSearch.new(
+  ranking_options: null,
+  results: null
+)
+```
+

data/docs/RunStepDetailsToolCallsFileSearchRankingOptionsObject.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchRankingOptionsObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ranker** | **String** | The ranker used for the file search. |  |
+| **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::RunStepDetailsToolCallsFileSearchRankingOptionsObject.new(
+  ranker: null,
+  score_threshold: null
+)
+```
+

data/docs/RunStepDetailsToolCallsFileSearchResultObject.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchResultObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The ID of the file that result was found in. |  |
+| **file_name** | **String** | The name of the file that result was found in. |  |
+| **score** | **Float** | The score of the result. All values must be a floating point number between 0 and 1. |  |
+| **content** | [**Array<RunStepDetailsToolCallsFileSearchResultObjectContentInner>**](RunStepDetailsToolCallsFileSearchResultObjectContentInner.md) | The content of the result that was found. The content is only included if requested via the include query parameter. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchResultObject.new(
+  file_id: null,
+  file_name: null,
+  score: null,
+  content: null
+)
+```
+

data/docs/RunStepDetailsToolCallsFileSearchResultObjectContentInner.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchResultObjectContentInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of the content. | [optional] |
+| **text** | **String** | The text content of the file. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchResultObjectContentInner.new(
+  type: null,
+  text: null
+)
+```
+

data/docs/RunStepDetailsToolCallsFunctionObject.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsFunctionObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the tool call object. |  |
+| **type** | **String** | The type of tool call. This is always going to be `function` for this type of tool call. |  |
+| **function** | [**RunStepDetailsToolCallsFunctionObjectFunction**](RunStepDetailsToolCallsFunctionObjectFunction.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsFunctionObject.new(
+  id: null,
+  type: null,
+  function: null
+)
+```
+

data/docs/RunStepDetailsToolCallsFunctionObjectFunction.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsFunctionObjectFunction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the function. |  |
+| **arguments** | **String** | The arguments passed to the function. |  |
+| **output** | **String** | The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsFunctionObjectFunction.new(
+  name: null,
+  arguments: null,
+  output: null
+)
+```
+

data/docs/RunStepDetailsToolCallsObject.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunStepDetailsToolCallsObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Always `tool_calls`. |  |
+| **tool_calls** | [**Array<RunStepDetailsToolCallsObjectToolCallsInner>**](RunStepDetailsToolCallsObjectToolCallsInner.md) | An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepDetailsToolCallsObject.new(
+  type: null,
+  tool_calls: null
+)
+```
+

data/docs/RunStepDetailsToolCallsObjectToolCallsInner.md

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

data/docs/RunStepObject.md

@@ -0,0 +1,48 @@
+# OpenApiOpenAIClient::RunStepObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The identifier of the run step, which can be referenced in API endpoints. |  |
+| **object** | **String** | The object type, which is always `thread.run.step`. |  |
+| **created_at** | **Integer** | The Unix timestamp (in seconds) for when the run step was created. |  |
+| **assistant_id** | **String** | The ID of the [assistant](/docs/api-reference/assistants) associated with the run step. |  |
+| **thread_id** | **String** | The ID of the [thread](/docs/api-reference/threads) that was run. |  |
+| **run_id** | **String** | The ID of the [run](/docs/api-reference/runs) that this run step is a part of. |  |
+| **type** | **String** | The type of run step, which can be either `message_creation` or `tool_calls`. |  |
+| **status** | **String** | The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. |  |
+| **step_details** | [**RunStepObjectStepDetails**](RunStepObjectStepDetails.md) |  |  |
+| **last_error** | [**RunStepObjectLastError**](RunStepObjectLastError.md) |  |  |
+| **expired_at** | **Integer** | The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired. |  |
+| **cancelled_at** | **Integer** | The Unix timestamp (in seconds) for when the run step was cancelled. |  |
+| **failed_at** | **Integer** | The Unix timestamp (in seconds) for when the run step failed. |  |
+| **completed_at** | **Integer** | The Unix timestamp (in seconds) for when the run step completed. |  |
+| **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.  |  |
+| **usage** | [**RunStepCompletionUsage**](RunStepCompletionUsage.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepObject.new(
+  id: null,
+  object: null,
+  created_at: null,
+  assistant_id: null,
+  thread_id: null,
+  run_id: null,
+  type: null,
+  status: null,
+  step_details: null,
+  last_error: null,
+  expired_at: null,
+  cancelled_at: null,
+  failed_at: null,
+  completed_at: null,
+  metadata: null,
+  usage: null
+)
+```
+

data/docs/RunStepObjectLastError.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::RunStepObjectLastError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | One of `server_error` or `rate_limit_exceeded`. |  |
+| **message** | **String** | A human-readable description of the error. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::RunStepObjectLastError.new(
+  code: null,
+  message: null
+)
+```
+

data/docs/RunStepObjectStepDetails.md

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

data/docs/RunStepStreamEvent.md

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

data/docs/RunStepStreamEventOneOf.md

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

data/docs/RunStepStreamEventOneOf1.md

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

data/docs/RunStepStreamEventOneOf2.md

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

data/docs/RunStepStreamEventOneOf3.md

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

data/docs/RunStepStreamEventOneOf4.md

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