openapi_openai 1.0.0 → 1.1.0

data/spec/api/files_api_spec.rb

@@ -0,0 +1,91 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenApiOpenAIClient::FilesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FilesApi' do
+  before do
+    # run before each test
+    @api_instance = OpenApiOpenAIClient::FilesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FilesApi' do
+    it 'should create an instance of FilesApi' do
+      expect(@api_instance).to be_instance_of(OpenApiOpenAIClient::FilesApi)
+    end
+  end
+
+  # unit tests for create_file
+  # Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB.  The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. See the [Assistants Tools guide](/docs/assistants/tools) to learn more about the types of files supported. The Fine-tuning API only supports `.jsonl` files.  Please [contact us](https://help.openai.com/) if you need to increase these storage limits. 
+  # @param file The File object (not file name) to be uploaded. 
+  # @param purpose The intended purpose of the uploaded file.  Use \\\"fine-tune\\\" for [Fine-tuning](/docs/api-reference/fine-tuning) and \\\"assistants\\\" for [Assistants](/docs/api-reference/assistants) and [Messages](/docs/api-reference/messages). This allows us to validate the format of the uploaded file is correct for fine-tuning. 
+  # @param [Hash] opts the optional parameters
+  # @return [OpenAIFile]
+  describe 'create_file test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_file
+  # Delete a file.
+  # @param file_id The ID of the file to use for this request.
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteFileResponse]
+  describe 'delete_file test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for download_file
+  # Returns the contents of the specified file.
+  # @param file_id The ID of the file to use for this request.
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'download_file test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_files
+  # Returns a list of files that belong to the user's organization.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :purpose Only return files with the given purpose.
+  # @return [ListFilesResponse]
+  describe 'list_files test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for retrieve_file
+  # Returns information about a specific file.
+  # @param file_id The ID of the file to use for this request.
+  # @param [Hash] opts the optional parameters
+  # @return [OpenAIFile]
+  describe 'retrieve_file test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/fine_tuning_api_spec.rb

@@ -0,0 +1,106 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenApiOpenAIClient::FineTuningApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FineTuningApi' do
+  before do
+    # run before each test
+    @api_instance = OpenApiOpenAIClient::FineTuningApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FineTuningApi' do
+    it 'should create an instance of FineTuningApi' do
+      expect(@api_instance).to be_instance_of(OpenApiOpenAIClient::FineTuningApi)
+    end
+  end
+
+  # unit tests for cancel_fine_tuning_job
+  # Immediately cancel a fine-tune job. 
+  # @param fine_tuning_job_id The ID of the fine-tuning job to cancel. 
+  # @param [Hash] opts the optional parameters
+  # @return [FineTuningJob]
+  describe 'cancel_fine_tuning_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_fine_tuning_job
+  # Creates a fine-tuning job which begins the process of creating a new model from a given dataset.  Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.  [Learn more about fine-tuning](/docs/guides/fine-tuning) 
+  # @param create_fine_tuning_job_request 
+  # @param [Hash] opts the optional parameters
+  # @return [FineTuningJob]
+  describe 'create_fine_tuning_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_fine_tuning_events
+  # Get status updates for a fine-tuning job. 
+  # @param fine_tuning_job_id The ID of the fine-tuning job to get events for. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :after Identifier for the last event from the previous pagination request.
+  # @option opts [Integer] :limit Number of events to retrieve.
+  # @return [ListFineTuningJobEventsResponse]
+  describe 'list_fine_tuning_events test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_fine_tuning_job_checkpoints
+  # List checkpoints for a fine-tuning job. 
+  # @param fine_tuning_job_id The ID of the fine-tuning job to get checkpoints for. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :after Identifier for the last checkpoint ID from the previous pagination request.
+  # @option opts [Integer] :limit Number of checkpoints to retrieve.
+  # @return [ListFineTuningJobCheckpointsResponse]
+  describe 'list_fine_tuning_job_checkpoints test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_paginated_fine_tuning_jobs
+  # List your organization's fine-tuning jobs 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :after Identifier for the last job from the previous pagination request.
+  # @option opts [Integer] :limit Number of fine-tuning jobs to retrieve.
+  # @return [ListPaginatedFineTuningJobsResponse]
+  describe 'list_paginated_fine_tuning_jobs test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for retrieve_fine_tuning_job
+  # Get info about a fine-tuning job.  [Learn more about fine-tuning](/docs/guides/fine-tuning) 
+  # @param fine_tuning_job_id The ID of the fine-tuning job. 
+  # @param [Hash] opts the optional parameters
+  # @return [FineTuningJob]
+  describe 'retrieve_fine_tuning_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/images_api_spec.rb

@@ -0,0 +1,80 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenApiOpenAIClient::ImagesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ImagesApi' do
+  before do
+    # run before each test
+    @api_instance = OpenApiOpenAIClient::ImagesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImagesApi' do
+    it 'should create an instance of ImagesApi' do
+      expect(@api_instance).to be_instance_of(OpenApiOpenAIClient::ImagesApi)
+    end
+  end
+
+  # unit tests for create_image
+  # Creates an image given a prompt.
+  # @param create_image_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ImagesResponse]
+  describe 'create_image test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_image_edit
+  # Creates an edited or extended image given an original image and a prompt.
+  # @param image The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.
+  # @param prompt A text description of the desired image(s). The maximum length is 1000 characters.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :mask An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`.
+  # @option opts [CreateImageEditRequestModel] :model 
+  # @option opts [Integer] :n The number of images to generate. Must be between 1 and 10.
+  # @option opts [String] :size The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
+  # @option opts [String] :response_format The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
+  # @option opts [String] :user A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids). 
+  # @return [ImagesResponse]
+  describe 'create_image_edit test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_image_variation
+  # Creates a variation of a given image.
+  # @param image The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.
+  # @param [Hash] opts the optional parameters
+  # @option opts [CreateImageEditRequestModel] :model 
+  # @option opts [Integer] :n The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
+  # @option opts [String] :response_format The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
+  # @option opts [String] :size The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
+  # @option opts [String] :user A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids). 
+  # @return [ImagesResponse]
+  describe 'create_image_variation test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/models_api_spec.rb

@@ -0,0 +1,67 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenApiOpenAIClient::ModelsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ModelsApi' do
+  before do
+    # run before each test
+    @api_instance = OpenApiOpenAIClient::ModelsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ModelsApi' do
+    it 'should create an instance of ModelsApi' do
+      expect(@api_instance).to be_instance_of(OpenApiOpenAIClient::ModelsApi)
+    end
+  end
+
+  # unit tests for delete_model
+  # Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
+  # @param model The model to delete
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteModelResponse]
+  describe 'delete_model test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_models
+  # Lists the currently available models, and provides basic information about each one such as the owner and availability.
+  # @param [Hash] opts the optional parameters
+  # @return [ListModelsResponse]
+  describe 'list_models test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for retrieve_model
+  # Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
+  # @param model The ID of the model to use for this request
+  # @param [Hash] opts the optional parameters
+  # @return [Model]
+  describe 'retrieve_model test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/moderations_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenApiOpenAIClient::ModerationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ModerationsApi' do
+  before do
+    # run before each test
+    @api_instance = OpenApiOpenAIClient::ModerationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ModerationsApi' do
+    it 'should create an instance of ModerationsApi' do
+      expect(@api_instance).to be_instance_of(OpenApiOpenAIClient::ModerationsApi)
+    end
+  end
+
+  # unit tests for create_moderation
+  # Classifies if text is potentially harmful.
+  # @param create_moderation_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateModerationResponse]
+  describe 'create_moderation test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/assistant_file_object_spec.rb

@@ -0,0 +1,58 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for OpenApiOpenAIClient::AssistantFileObject
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe OpenApiOpenAIClient::AssistantFileObject do
+  let(:instance) { OpenApiOpenAIClient::AssistantFileObject.new }
+
+  describe 'test an instance of AssistantFileObject' do
+    it 'should create an instance of AssistantFileObject' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(OpenApiOpenAIClient::AssistantFileObject)
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "object"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["assistant.file"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.object = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "assistant_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/assistant_object_spec.rb

@@ -0,0 +1,94 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for OpenApiOpenAIClient::AssistantObject
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe OpenApiOpenAIClient::AssistantObject do
+  let(:instance) { OpenApiOpenAIClient::AssistantObject.new }
+
+  describe 'test an instance of AssistantObject' do
+    it 'should create an instance of AssistantObject' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(OpenApiOpenAIClient::AssistantObject)
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "object"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["assistant"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.object = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "model"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "instructions"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "tools"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "file_ids"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "metadata"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/assistant_object_tools_inner_spec.rb

@@ -0,0 +1,32 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for OpenApiOpenAIClient::AssistantObjectToolsInner
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe OpenApiOpenAIClient::AssistantObjectToolsInner do
+  describe '.openapi_one_of' do
+    it 'lists the items referenced in the oneOf array' do
+      expect(described_class.openapi_one_of).to_not be_empty
+    end
+  end
+
+  describe '.build' do
+    it 'returns the correct model' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+end

data/spec/models/assistant_stream_event_spec.rb

@@ -0,0 +1,32 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for OpenApiOpenAIClient::AssistantStreamEvent
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe OpenApiOpenAIClient::AssistantStreamEvent do
+  describe '.openapi_one_of' do
+    it 'lists the items referenced in the oneOf array' do
+      expect(described_class.openapi_one_of).to_not be_empty
+    end
+  end
+
+  describe '.build' do
+    it 'returns the correct model' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+end

data/spec/models/assistant_tools_code_spec.rb

@@ -0,0 +1,40 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for OpenApiOpenAIClient::AssistantToolsCode
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe OpenApiOpenAIClient::AssistantToolsCode do
+  let(:instance) { OpenApiOpenAIClient::AssistantToolsCode.new }
+
+  describe 'test an instance of AssistantToolsCode' do
+    it 'should create an instance of AssistantToolsCode' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(OpenApiOpenAIClient::AssistantToolsCode)
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["code_interpreter"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.type = value }.not_to raise_error
+      # end
+    end
+  end
+
+end