openapi_openai 1.0.0 → 1.1.0

data/docs/MessageContentTextAnnotationsFileCitationObject.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::MessageContentTextAnnotationsFileCitationObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Always `file_citation`. |  |
+| **text** | **String** | The text in the message content that needs to be replaced. |  |
+| **file_citation** | [**MessageContentTextAnnotationsFileCitationObjectFileCitation**](MessageContentTextAnnotationsFileCitationObjectFileCitation.md) |  |  |
+| **start_index** | **Integer** |  |  |
+| **end_index** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageContentTextAnnotationsFileCitationObject.new(
+  type: null,
+  text: null,
+  file_citation: null,
+  start_index: null,
+  end_index: null
+)
+```
+

data/docs/MessageContentTextAnnotationsFileCitationObjectFileCitation.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageContentTextAnnotationsFileCitationObjectFileCitation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The ID of the specific File the citation is from. |  |
+| **quote** | **String** | The specific quote in the file. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageContentTextAnnotationsFileCitationObjectFileCitation.new(
+  file_id: null,
+  quote: null
+)
+```
+

data/docs/MessageContentTextAnnotationsFilePathObject.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::MessageContentTextAnnotationsFilePathObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Always `file_path`. |  |
+| **text** | **String** | The text in the message content that needs to be replaced. |  |
+| **file_path** | [**MessageContentTextAnnotationsFilePathObjectFilePath**](MessageContentTextAnnotationsFilePathObjectFilePath.md) |  |  |
+| **start_index** | **Integer** |  |  |
+| **end_index** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageContentTextAnnotationsFilePathObject.new(
+  type: null,
+  text: null,
+  file_path: null,
+  start_index: null,
+  end_index: null
+)
+```
+

data/docs/MessageContentTextAnnotationsFilePathObjectFilePath.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::MessageContentTextAnnotationsFilePathObjectFilePath
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The ID of the file that was generated. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageContentTextAnnotationsFilePathObjectFilePath.new(
+  file_id: null
+)
+```
+

data/docs/MessageContentTextObject.md

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

data/docs/MessageContentTextObjectText.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageContentTextObjectText
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The data that makes up the text. |  |
+| **annotations** | [**Array<MessageContentTextObjectTextAnnotationsInner>**](MessageContentTextObjectTextAnnotationsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageContentTextObjectText.new(
+  value: null,
+  annotations: null
+)
+```
+

data/docs/MessageContentTextObjectTextAnnotationsInner.md

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

data/docs/MessageDeltaContentImageFileObject.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::MessageDeltaContentImageFileObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | The index of the content part in the message. |  |
+| **type** | **String** | Always `image_file`. |  |
+| **image_file** | [**MessageDeltaContentImageFileObjectImageFile**](MessageDeltaContentImageFileObjectImageFile.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaContentImageFileObject.new(
+  index: null,
+  type: null,
+  image_file: null
+)
+```
+

data/docs/MessageDeltaContentImageFileObjectImageFile.md

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

data/docs/MessageDeltaContentTextAnnotationsFileCitationObject.md

@@ -0,0 +1,28 @@
+# OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | The index of the annotation in the text content part. |  |
+| **type** | **String** | Always `file_citation`. |  |
+| **text** | **String** | The text in the message content that needs to be replaced. | [optional] |
+| **file_citation** | [**MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation**](MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation.md) |  | [optional] |
+| **start_index** | **Integer** |  | [optional] |
+| **end_index** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObject.new(
+  index: null,
+  type: null,
+  text: null,
+  file_citation: null,
+  start_index: null,
+  end_index: null
+)
+```
+

data/docs/MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The ID of the specific File the citation is from. | [optional] |
+| **quote** | **String** | The specific quote in the file. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation.new(
+  file_id: null,
+  quote: null
+)
+```
+

data/docs/MessageDeltaContentTextAnnotationsFilePathObject.md

@@ -0,0 +1,28 @@
+# OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFilePathObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | The index of the annotation in the text content part. |  |
+| **type** | **String** | Always `file_path`. |  |
+| **text** | **String** | The text in the message content that needs to be replaced. | [optional] |
+| **file_path** | [**MessageDeltaContentTextAnnotationsFilePathObjectFilePath**](MessageDeltaContentTextAnnotationsFilePathObjectFilePath.md) |  | [optional] |
+| **start_index** | **Integer** |  | [optional] |
+| **end_index** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFilePathObject.new(
+  index: null,
+  type: null,
+  text: null,
+  file_path: null,
+  start_index: null,
+  end_index: null
+)
+```
+

data/docs/MessageDeltaContentTextAnnotationsFilePathObjectFilePath.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFilePathObjectFilePath
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The ID of the file that was generated. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFilePathObjectFilePath.new(
+  file_id: null
+)
+```
+

data/docs/MessageDeltaContentTextObject.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::MessageDeltaContentTextObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | The index of the content part in the message. |  |
+| **type** | **String** | Always `text`. |  |
+| **text** | [**MessageDeltaContentTextObjectText**](MessageDeltaContentTextObjectText.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaContentTextObject.new(
+  index: null,
+  type: null,
+  text: null
+)
+```
+

data/docs/MessageDeltaContentTextObjectText.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::MessageDeltaContentTextObjectText
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The data that makes up the text. | [optional] |
+| **annotations** | [**Array<MessageDeltaContentTextObjectTextAnnotationsInner>**](MessageDeltaContentTextObjectTextAnnotationsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaContentTextObjectText.new(
+  value: null,
+  annotations: null
+)
+```
+

data/docs/MessageDeltaContentTextObjectTextAnnotationsInner.md

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

data/docs/MessageDeltaObject.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::MessageDeltaObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The identifier of the message, which can be referenced in API endpoints. |  |
+| **object** | **String** | The object type, which is always `thread.message.delta`. |  |
+| **delta** | [**MessageDeltaObjectDelta**](MessageDeltaObjectDelta.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaObject.new(
+  id: null,
+  object: null,
+  delta: null
+)
+```
+

data/docs/MessageDeltaObjectDelta.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::MessageDeltaObjectDelta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role** | **String** | The entity that produced the message. One of `user` or `assistant`. | [optional] |
+| **content** | [**Array<MessageDeltaObjectDeltaContentInner>**](MessageDeltaObjectDeltaContentInner.md) | The content of the message in array of text and/or images. | [optional] |
+| **file_ids** | **Array<String>** | A list of [file](/docs/api-reference/files) IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageDeltaObjectDelta.new(
+  role: null,
+  content: null,
+  file_ids: null
+)
+```
+

data/docs/MessageDeltaObjectDeltaContentInner.md

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

data/docs/MessageFileObject.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::MessageFileObject
+
+## 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.message.file`. |  |
+| **created_at** | **Integer** | The Unix timestamp (in seconds) for when the message file was created. |  |
+| **message_id** | **String** | The ID of the [message](/docs/api-reference/messages) that the [File](/docs/api-reference/files) is attached to. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageFileObject.new(
+  id: null,
+  object: null,
+  created_at: null,
+  message_id: null
+)
+```
+

data/docs/MessageObject.md

@@ -0,0 +1,44 @@
+# OpenApiOpenAIClient::MessageObject
+
+## 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.message`. |  |
+| **created_at** | **Integer** | The Unix timestamp (in seconds) for when the message was created. |  |
+| **thread_id** | **String** | The [thread](/docs/api-reference/threads) ID that this message belongs to. |  |
+| **status** | **String** | The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. |  |
+| **incomplete_details** | [**MessageObjectIncompleteDetails**](MessageObjectIncompleteDetails.md) |  |  |
+| **completed_at** | **Integer** | The Unix timestamp (in seconds) for when the message was completed. |  |
+| **incomplete_at** | **Integer** | The Unix timestamp (in seconds) for when the message was marked as incomplete. |  |
+| **role** | **String** | The entity that produced the message. One of `user` or `assistant`. |  |
+| **content** | [**Array<MessageObjectContentInner>**](MessageObjectContentInner.md) | The content of the message in array of text and/or images. |  |
+| **assistant_id** | **String** | If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message. |  |
+| **run_id** | **String** | The ID of the [run](/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. |  |
+| **file_ids** | **Array<String>** | A list of [file](/docs/api-reference/files) IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message. |  |
+| **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::MessageObject.new(
+  id: null,
+  object: null,
+  created_at: null,
+  thread_id: null,
+  status: null,
+  incomplete_details: null,
+  completed_at: null,
+  incomplete_at: null,
+  role: null,
+  content: null,
+  assistant_id: null,
+  run_id: null,
+  file_ids: null,
+  metadata: null
+)
+```
+

data/docs/MessageObjectContentInner.md

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

data/docs/MessageObjectIncompleteDetails.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::MessageObjectIncompleteDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** | The reason the message is incomplete. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::MessageObjectIncompleteDetails.new(
+  reason: null
+)
+```
+