openapi_openai 1.0.0 → 1.1.0

data/docs/ChatCompletionRequestFunctionMessage.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionRequestFunctionMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role** | **String** | The role of the messages author, in this case `function`. |  |
+| **content** | **String** | The contents of the function message. |  |
+| **name** | **String** | The name of the function to call. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestFunctionMessage.new(
+  role: null,
+  content: null,
+  name: null
+)
+```
+

data/docs/ChatCompletionRequestMessage.md

@@ -1,24 +1,55 @@
 # OpenApiOpenAIClient::ChatCompletionRequestMessage
 
-## Properties
+## Class instance methods
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **role** | **String** | The role of the messages author. One of `system`, `user`, `assistant`, or `function`. |  |
-| **content** | **String** | The contents of the message. `content` is required for all messages except assistant messages with function calls. | [optional] |
-| **name** | **String** | The name of the author of this message. `name` is required if role is `function`, and it should be the name of the function whose response is in the `content`. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters. | [optional] |
-| **function_call** | [**ChatCompletionRequestMessageFunctionCall**](ChatCompletionRequestMessageFunctionCall.md) |  | [optional] |
+### `openapi_one_of`
 
-## Example
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'openapi_openai'
+
+OpenApiOpenAIClient::ChatCompletionRequestMessage.openapi_one_of
+# =>
+# [
+#   :'ChatCompletionRequestAssistantMessage',
+#   :'ChatCompletionRequestFunctionMessage',
+#   :'ChatCompletionRequestSystemMessage',
+#   :'ChatCompletionRequestToolMessage',
+#   :'ChatCompletionRequestUserMessage'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
 
 ```ruby
 require 'openapi_openai'
 
-instance = OpenApiOpenAIClient::ChatCompletionRequestMessage.new(
-  role: null,
-  content: null,
-  name: null,
-  function_call: null
-)
+OpenApiOpenAIClient::ChatCompletionRequestMessage.build(data)
+# => #<ChatCompletionRequestAssistantMessage:0x00007fdd4aab02a0>
+
+OpenApiOpenAIClient::ChatCompletionRequestMessage.build(data_that_doesnt_match)
+# => nil
 ```
 
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ChatCompletionRequestAssistantMessage`
+- `ChatCompletionRequestFunctionMessage`
+- `ChatCompletionRequestSystemMessage`
+- `ChatCompletionRequestToolMessage`
+- `ChatCompletionRequestUserMessage`
+- `nil` (if no type matches)
+

data/docs/ChatCompletionRequestMessageContentPart.md

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

data/docs/ChatCompletionRequestMessageContentPartImage.md

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

data/docs/ChatCompletionRequestMessageContentPartImageImageUrl.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::ChatCompletionRequestMessageContentPartImageImageUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Either a URL of the image or the base64 encoded image data. |  |
+| **detail** | **String** | Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision/low-or-high-fidelity-image-understanding). | [optional][default to 'auto'] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestMessageContentPartImageImageUrl.new(
+  url: null,
+  detail: null
+)
+```
+

data/docs/ChatCompletionRequestMessageContentPartText.md

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

data/docs/ChatCompletionRequestSystemMessage.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionRequestSystemMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | The contents of the system message. |  |
+| **role** | **String** | The role of the messages author, in this case `system`. |  |
+| **name** | **String** | An optional name for the participant. Provides the model information to differentiate between participants of the same role. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestSystemMessage.new(
+  content: null,
+  role: null,
+  name: null
+)
+```
+

data/docs/ChatCompletionRequestToolMessage.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionRequestToolMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role** | **String** | The role of the messages author, in this case `tool`. |  |
+| **content** | **String** | The contents of the tool message. |  |
+| **tool_call_id** | **String** | Tool call that this message is responding to. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestToolMessage.new(
+  role: null,
+  content: null,
+  tool_call_id: null
+)
+```
+

data/docs/ChatCompletionRequestUserMessage.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionRequestUserMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | [**ChatCompletionRequestUserMessageContent**](ChatCompletionRequestUserMessageContent.md) |  |  |
+| **role** | **String** | The role of the messages author, in this case `user`. |  |
+| **name** | **String** | An optional name for the participant. Provides the model information to differentiate between participants of the same role. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRequestUserMessage.new(
+  content: null,
+  role: null,
+  name: null
+)
+```
+

data/docs/ChatCompletionRequestUserMessageContent.md

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

data/docs/ChatCompletionResponseMessage.md

@@ -4,9 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **content** | **String** | The contents of the message. |  |
+| **tool_calls** | [**Array<ChatCompletionMessageToolCall>**](ChatCompletionMessageToolCall.md) | The tool calls generated by the model, such as function calls. | [optional] |
 | **role** | **String** | The role of the author of this message. |  |
-| **content** | **String** | The contents of the message. | [optional] |
-| **function_call** | [**ChatCompletionRequestMessageFunctionCall**](ChatCompletionRequestMessageFunctionCall.md) |  | [optional] |
+| **function_call** | [**ChatCompletionRequestAssistantMessageFunctionCall**](ChatCompletionRequestAssistantMessageFunctionCall.md) |  | [optional] |
 
 ## Example
 
@@ -14,8 +15,9 @@
 require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::ChatCompletionResponseMessage.new(
-  role: null,
   content: null,
+  tool_calls: null,
+  role: null,
   function_call: null
 )
 ```

data/docs/ChatCompletionRole.md

@@ -0,0 +1,15 @@
+# OpenApiOpenAIClient::ChatCompletionRole
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionRole.new()
+```
+

data/docs/ChatCompletionStreamResponseDelta.md

@@ -4,9 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **role** | **String** | The role of the author of this message. | [optional] |
 | **content** | **String** | The contents of the chunk message. | [optional] |
-| **function_call** | [**ChatCompletionRequestMessageFunctionCall**](ChatCompletionRequestMessageFunctionCall.md) |  | [optional] |
+| **function_call** | [**ChatCompletionStreamResponseDeltaFunctionCall**](ChatCompletionStreamResponseDeltaFunctionCall.md) |  | [optional] |
+| **tool_calls** | [**Array<ChatCompletionMessageToolCallChunk>**](ChatCompletionMessageToolCallChunk.md) |  | [optional] |
+| **role** | **String** | The role of the author of this message. | [optional] |
 
 ## Example
 
@@ -14,9 +15,10 @@
 require 'openapi_openai'
 
 instance = OpenApiOpenAIClient::ChatCompletionStreamResponseDelta.new(
-  role: null,
   content: null,
-  function_call: null
+  function_call: null,
+  tool_calls: null,
+  role: null
 )
 ```
 

data/docs/ChatCompletionStreamResponseDeltaFunctionCall.md

@@ -0,0 +1,20 @@
+# OpenApiOpenAIClient::ChatCompletionStreamResponseDeltaFunctionCall
+
+## 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. | [optional] |
+| **name** | **String** | The name of the function to call. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionStreamResponseDeltaFunctionCall.new(
+  arguments: null,
+  name: null
+)
+```
+

data/docs/ChatCompletionTokenLogprob.md

@@ -0,0 +1,24 @@
+# OpenApiOpenAIClient::ChatCompletionTokenLogprob
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The token. |  |
+| **logprob** | **Float** | The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. |  |
+| **bytes** | **Array<Integer>** | A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. |  |
+| **top_logprobs** | [**Array<ChatCompletionTokenLogprobTopLogprobsInner>**](ChatCompletionTokenLogprobTopLogprobsInner.md) | List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionTokenLogprob.new(
+  token: null,
+  logprob: null,
+  bytes: null,
+  top_logprobs: null
+)
+```
+

data/docs/ChatCompletionTokenLogprobTopLogprobsInner.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::ChatCompletionTokenLogprobTopLogprobsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The token. |  |
+| **logprob** | **Float** | The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. |  |
+| **bytes** | **Array<Integer>** | A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::ChatCompletionTokenLogprobTopLogprobsInner.new(
+  token: null,
+  logprob: null,
+  bytes: null
+)
+```
+

data/docs/ChatCompletionTool.md

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

data/docs/ChatCompletionToolChoiceOption.md

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

data/docs/CompletionUsage.md

@@ -0,0 +1,22 @@
+# OpenApiOpenAIClient::CompletionUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completion_tokens** | **Integer** | Number of tokens in the generated completion. |  |
+| **prompt_tokens** | **Integer** | Number of tokens in the prompt. |  |
+| **total_tokens** | **Integer** | Total number of tokens used in the request (prompt + completion). |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CompletionUsage.new(
+  completion_tokens: null,
+  prompt_tokens: null,
+  total_tokens: null
+)
+```
+

data/docs/CompletionsApi.md

@@ -0,0 +1,75 @@
+# OpenApiOpenAIClient::CompletionsApi
+
+All URIs are relative to *https://api.openai.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_completion**](CompletionsApi.md#create_completion) | **POST** /completions | Creates a completion for the provided prompt and parameters. |
+
+
+## create_completion
+
+> <CreateCompletionResponse> create_completion(create_completion_request)
+
+Creates a completion for the provided prompt and parameters.
+
+### 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::CompletionsApi.new
+create_completion_request = OpenApiOpenAIClient::CreateCompletionRequest.new({model: OpenApiOpenAIClient::CreateCompletionRequestModel.new, prompt: nil}) # CreateCompletionRequest | 
+
+begin
+  # Creates a completion for the provided prompt and parameters.
+  result = api_instance.create_completion(create_completion_request)
+  p result
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling CompletionsApi->create_completion: #{e}"
+end
+```
+
+#### Using the create_completion_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCompletionResponse>, Integer, Hash)> create_completion_with_http_info(create_completion_request)
+
+```ruby
+begin
+  # Creates a completion for the provided prompt and parameters.
+  data, status_code, headers = api_instance.create_completion_with_http_info(create_completion_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCompletionResponse>
+rescue OpenApiOpenAIClient::ApiError => e
+  puts "Error when calling CompletionsApi->create_completion_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_completion_request** | [**CreateCompletionRequest**](CreateCompletionRequest.md) |  |  |
+
+### Return type
+
+[**CreateCompletionResponse**](CreateCompletionResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CreateAssistantFileRequest.md

@@ -0,0 +1,18 @@
+# OpenApiOpenAIClient::CreateAssistantFileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | A [File](/docs/api-reference/files) ID (with `purpose=\"assistants\"`) that the assistant should use. Useful for tools like `retrieval` and `code_interpreter` that can access files. |  |
+
+## Example
+
+```ruby
+require 'openapi_openai'
+
+instance = OpenApiOpenAIClient::CreateAssistantFileRequest.new(
+  file_id: null
+)
+```
+