openapi_openai 1.0.0 → 1.1.0

data/docs/AssistantsApiNamedToolChoice.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::AssistantsApiNamedToolChoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of the tool. If type is `function`, the function name must be set |  |
+| **function** | [**ChatCompletionNamedToolChoiceFunction**](ChatCompletionNamedToolChoiceFunction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::AssistantsApiNamedToolChoice.new(
+  type: null,
+  function: null
+)
+```
+

data/docs/AssistantsApiResponseFormat.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::AssistantsApiResponseFormat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Must be one of `text` or `json_object`. | [optional][default to 'text'] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::AssistantsApiResponseFormat.new(
+  type: json_object
+)
+```
+

data/docs/AssistantsApiResponseFormatOption.md

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

data/docs/AssistantsApiToolChoiceOption.md

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

data/docs/AudioApi.md

@@ -0,0 +1,235 @@
+# OpenApiOpenAIClient::AudioApi
+
+All URIs are relative to *https://api.openai.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_speech**](AudioApi.md#create_speech) | **POST** /audio/speech | Generates audio from the input text. |
+| [**create_transcription**](AudioApi.md#create_transcription) | **POST** /audio/transcriptions | Transcribes audio into the input language. |
+| [**create_translation**](AudioApi.md#create_translation) | **POST** /audio/translations | Translates audio into English. |
+
+
+## create_speech
+
+> File create_speech(create_speech_request)
+
+Generates audio from the input text.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_openai'
+# setup authorization
+OpenApiOpenAIClient.configure do |config|
+  # Configure Bearer authorization: ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenApiOpenAIClient::AudioApi.new
+create_speech_request = OpenApiOpenAIClient::CreateSpeechRequest.new({model: OpenApiOpenAIClient::CreateSpeechRequestModel.new, input: 'input_example', voice: 'alloy'}) # CreateSpeechRequest | 
+
+begin
+  # Generates audio from the input text.
+  result = api_instance.create_speech(create_speech_request)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling AudioApi->create_speech: #{e}"
+end
+```
+
+#### Using the create_speech_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> create_speech_with_http_info(create_speech_request)
+
+```ruby
+begin
+  # Generates audio from the input text.
+  data, status_code, headers = api_instance.create_speech_with_http_info(create_speech_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling AudioApi->create_speech_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_speech_request** | [**CreateSpeechRequest**](CreateSpeechRequest.md) |  |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/octet-stream
+
+
+## create_transcription
+
+> <CreateTranscription200Response> create_transcription(file, model, opts)
+
+Transcribes audio into the input language.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_openai'
+# setup authorization
+OpenApiOpenAIClient.configure do |config|
+  # Configure Bearer authorization: ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenApiOpenAIClient::AudioApi.new
+file = File.new('/path/to/some/file') # File | The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. 
+model = OpenApiOpenAIClient::CreateTranscriptionRequestModel.new # CreateTranscriptionRequestModel | 
+opts = {
+  language: 'language_example', # String | The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will improve accuracy and latency. 
+  prompt: 'prompt_example', # String | An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should match the audio language. 
+  response_format: 'json', # String | The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`. 
+  temperature: 8.14, # Float | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit. 
+  timestamp_granularities: ['word'] # Array<String> | The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. 
+}
+
+begin
+  # Transcribes audio into the input language.
+  result = api_instance.create_transcription(file, model, opts)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling AudioApi->create_transcription: #{e}"
+end
+```
+
+#### Using the create_transcription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateTranscription200Response>, Integer, Hash)> create_transcription_with_http_info(file, model, opts)
+
+```ruby
+begin
+  # Transcribes audio into the input language.
+  data, status_code, headers = api_instance.create_transcription_with_http_info(file, model, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateTranscription200Response>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling AudioApi->create_transcription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** | The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.  |  |
+| **model** | [**CreateTranscriptionRequestModel**](CreateTranscriptionRequestModel.md) |  |  |
+| **language** | **String** | The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will improve accuracy and latency.  | [optional] |
+| **prompt** | **String** | An optional text to guide the model&#39;s style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should match the audio language.  | [optional] |
+| **response_format** | **String** | The format of the transcript output, in one of these options: &#x60;json&#x60;, &#x60;text&#x60;, &#x60;srt&#x60;, &#x60;verbose_json&#x60;, or &#x60;vtt&#x60;.  | [optional][default to &#39;json&#39;] |
+| **temperature** | **Float** | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.  | [optional][default to 0] |
+| **timestamp_granularities** | [**Array&lt;String&gt;**](String.md) | The timestamp granularities to populate for this transcription. &#x60;response_format&#x60; must be set &#x60;verbose_json&#x60; to use timestamp granularities. Either or both of these options are supported: &#x60;word&#x60;, or &#x60;segment&#x60;. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.  | [optional] |
+
+### Return type
+
+[**CreateTranscription200Response**](CreateTranscription200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+
+
+## create_translation
+
+> <CreateTranslation200Response> create_translation(file, model, opts)
+
+Translates audio into English.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_openai'
+# setup authorization
+OpenApiOpenAIClient.configure do |config|
+  # Configure Bearer authorization: ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenApiOpenAIClient::AudioApi.new
+file = File.new('/path/to/some/file') # File | The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. 
+model = OpenApiOpenAIClient::CreateTranscriptionRequestModel.new # CreateTranscriptionRequestModel | 
+opts = {
+  prompt: 'prompt_example', # String | An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should be in English. 
+  response_format: 'response_format_example', # String | The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`. 
+  temperature: 8.14 # Float | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit. 
+}
+
+begin
+  # Translates audio into English.
+  result = api_instance.create_translation(file, model, opts)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling AudioApi->create_translation: #{e}"
+end
+```
+
+#### Using the create_translation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateTranslation200Response>, Integer, Hash)> create_translation_with_http_info(file, model, opts)
+
+```ruby
+begin
+  # Translates audio into English.
+  data, status_code, headers = api_instance.create_translation_with_http_info(file, model, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateTranslation200Response>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling AudioApi->create_translation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** | The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.  |  |
+| **model** | [**CreateTranscriptionRequestModel**](CreateTranscriptionRequestModel.md) |  |  |
+| **prompt** | **String** | An optional text to guide the model&#39;s style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should be in English.  | [optional] |
+| **response_format** | **String** | The format of the transcript output, in one of these options: &#x60;json&#x60;, &#x60;text&#x60;, &#x60;srt&#x60;, &#x60;verbose_json&#x60;, or &#x60;vtt&#x60;.  | [optional][default to &#39;json&#39;] |
+| **temperature** | **Float** | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.  | [optional][default to 0] |
+
+### Return type
+
+[**CreateTranslation200Response**](CreateTranslation200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/ChatApi.md

@@ -0,0 +1,75 @@
+# OpenApiOpenAIClient::ChatApi
+
+All URIs are relative to *https://api.openai.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_chat_completion**](ChatApi.md#create_chat_completion) | **POST** /chat/completions | Creates a model response for the given chat conversation. |
+
+
+## create_chat_completion
+
+> <CreateChatCompletionResponse> create_chat_completion(create_chat_completion_request)
+
+Creates a model response for the given chat conversation.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_openai'
+# setup authorization
+OpenApiOpenAIClient.configure do |config|
+  # Configure Bearer authorization: ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenApiOpenAIClient::ChatApi.new
+create_chat_completion_request = OpenApiOpenAIClient::CreateChatCompletionRequest.new({messages: [OpenApiOpenAIClient::ChatCompletionRequestAssistantMessage.new({role: 'assistant'})], model: OpenApiOpenAIClient::CreateChatCompletionRequestModel.new}) # CreateChatCompletionRequest | 
+
+begin
+  # Creates a model response for the given chat conversation.
+  result = api_instance.create_chat_completion(create_chat_completion_request)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ChatApi->create_chat_completion: #{e}"
+end
+```
+
+#### Using the create_chat_completion_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateChatCompletionResponse>, Integer, Hash)> create_chat_completion_with_http_info(create_chat_completion_request)
+
+```ruby
+begin
+  # Creates a model response for the given chat conversation.
+  data, status_code, headers = api_instance.create_chat_completion_with_http_info(create_chat_completion_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateChatCompletionResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling ChatApi->create_chat_completion_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_chat_completion_request** | [**CreateChatCompletionRequest**](CreateChatCompletionRequest.md) |  |  |
+
+### Return type
+
+[**CreateChatCompletionResponse**](CreateChatCompletionResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/{CreateChatCompletionRequestFunctionCallOneOf.md → ChatCompletionFunctionCallOption.md}

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

data/docs/ChatCompletionFunctions.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **description** | **String** | A description of what the function does, used by the model to choose when and how to call the function. | [optional] |
 | **name** | **String** | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |  |
-| **description** | **String** | The description of what the function does. | [optional] |
-| **parameters** | **Hash<String, Object>** | The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. | [optional] |
+| **parameters** | **Hash<String, Object>** | The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.   Omitting `parameters` defines a function with an empty parameter list. | [optional] |
 
 ## Example
 
@@ -14,8 +14,8 @@
 require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::ChatCompletionFunctions.new(
-  name: null,
   description: null,
+  name: null,
   parameters: null
 )
 ```

data/docs/ChatCompletionMessageToolCall.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionMessageToolCall
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the tool call. |  |
+| **type** | **String** | The type of the tool. Currently, only `function` is supported. |  |
+| **function** | [**ChatCompletionMessageToolCallFunction**](ChatCompletionMessageToolCallFunction.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionMessageToolCall.new(
+  id: null,
+  type: null,
+  function: null
+)
+```
+

data/docs/ChatCompletionMessageToolCallChunk.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::ChatCompletionMessageToolCallChunk
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** |  |  |
+| **id** | **String** | The ID of the tool call. | [optional] |
+| **type** | **String** | The type of the tool. Currently, only `function` is supported. | [optional] |
+| **function** | [**ChatCompletionMessageToolCallChunkFunction**](ChatCompletionMessageToolCallChunkFunction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionMessageToolCallChunk.new(
+  index: null,
+  id: null,
+  type: null,
+  function: null
+)
+```
+

data/docs/{ChatCompletionRequestMessageFunctionCall.md → ChatCompletionMessageToolCallChunkFunction.md}

@@ -1,4 +1,4 @@
-# OpenApiOpenAIClient::ChatCompletionRequestMessageFunctionCall
+# OpenApiOpenAIClient::ChatCompletionMessageToolCallChunkFunction
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'openapi_openai'
 
-instance = OpenApiOpenAIClient::ChatCompletionRequestMessageFunctionCall.new(
+instance = OpenApiOpenAIClient::ChatCompletionMessageToolCallChunkFunction.new(
   name: null,
   arguments: null
 )

data/docs/ChatCompletionMessageToolCallFunction.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::ChatCompletionMessageToolCallFunction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the function to call. |  |
+| **arguments** | **String** | The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionMessageToolCallFunction.new(
+  name: null,
+  arguments: null
+)
+```
+

data/docs/ChatCompletionNamedToolChoice.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::ChatCompletionNamedToolChoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of the tool. Currently, only `function` is supported. |  |
+| **function** | [**ChatCompletionNamedToolChoiceFunction**](ChatCompletionNamedToolChoiceFunction.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionNamedToolChoice.new(
+  type: null,
+  function: null
+)
+```
+

data/docs/ChatCompletionNamedToolChoiceFunction.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::ChatCompletionNamedToolChoiceFunction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the function to call. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionNamedToolChoiceFunction.new(
+  name: null
+)
+```
+

data/docs/ChatCompletionRequestAssistantMessage.md

@@ -0,0 +1,26 @@
+# OpenApiOpenAIClient::ChatCompletionRequestAssistantMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.  | [optional] |
+| **role** | **String** | The role of the messages author, in this case `assistant`. |  |
+| **name** | **String** | An optional name for the participant. Provides the model information to differentiate between participants of the same role. | [optional] |
+| **tool_calls** | [**Array<ChatCompletionMessageToolCall>**](ChatCompletionMessageToolCall.md) | The tool calls generated by the model, such as function calls. | [optional] |
+| **function_call** | [**ChatCompletionRequestAssistantMessageFunctionCall**](ChatCompletionRequestAssistantMessageFunctionCall.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestAssistantMessage.new(
+  content: null,
+  role: null,
+  name: null,
+  tool_calls: null,
+  function_call: null
+)
+```
+

data/docs/ChatCompletionRequestAssistantMessageFunctionCall.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::ChatCompletionRequestAssistantMessageFunctionCall
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **arguments** | **String** | The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. |  |
+| **name** | **String** | The name of the function to call. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestAssistantMessageFunctionCall.new(
+  arguments: null,
+  name: null
+)
+```
+