openai.rb 0.0.0 → 0.0.1

data/spec/unit/openai/api/fine_tunes_spec.rb

@@ -0,0 +1,322 @@
+# frozen_string_literal: true
+
+RSpec.describe OpenAI::API, '#fine_tunes' do
+  include_context 'an API Resource'
+
+  let(:resource) { api.fine_tunes }
+  let(:response_body) do
+    {
+      "object": 'list',
+      "data": [
+        {
+          "id": 'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
+          "object": 'fine-tune',
+          "model": 'curie',
+          "created_at": 1_614_807_352,
+          "fine_tuned_model": nil,
+          "hyperparams": {},
+          "organization_id": 'org-...',
+          "result_files": [],
+          "status": 'pending',
+          "validation_files": [],
+          "training_files": [{}],
+          "updated_at": 1_614_807_352
+        },
+        {},
+        {}
+      ]
+    }
+  end
+
+  context 'when listing fine-tunes' do
+    it 'can get a list of fine-tunes' do
+      fine_tunes = resource.list
+
+      expect(http)
+        .to have_received(:get)
+        .with('https://api.openai.com/v1/fine-tunes')
+
+      expect(fine_tunes.object).to eql('list')
+      expect(fine_tunes.data.size).to eql(3)
+      expect(fine_tunes.data.first.id).to eql('ft-AF1WoRqd3aJAHsqc9NY7iL8F')
+      expect(fine_tunes.data.first.object).to eql('fine-tune')
+      expect(fine_tunes.data.first.model).to eql('curie')
+      expect(fine_tunes.data.first.created_at).to eql(1_614_807_352)
+      expect(fine_tunes.data.first.fine_tuned_model).to be_nil
+      expect(fine_tunes.data.first.hyperparams).to eql(
+        described_class::Response::FineTune::Hyperparams.new({})
+      )
+      expect(fine_tunes.data.first.organization_id).to eql('org-...')
+      expect(fine_tunes.data.first.result_files).to eql([])
+      expect(fine_tunes.data.first.status).to eql('pending')
+      expect(fine_tunes.data.first.validation_files).to eql([])
+      expect(fine_tunes.data.first.training_files).to eql(
+        [
+          described_class::Response::FineTune::File.new({})
+        ]
+      )
+      expect(fine_tunes.data.first.updated_at).to eql(1_614_807_352)
+    end
+  end
+
+  context 'when creating a fine-tune' do
+    let(:response_body) do
+      {
+        "id": 'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
+        "object": 'fine-tune',
+        "model": 'curie',
+        "created_at": 1_614_807_352,
+        "events": [
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_352,
+            "level": 'info',
+            "message": 'Job enqueued. Waiting for jobs ahead to complete. Queue number: 0.'
+          }
+        ],
+        "fine_tuned_model": nil,
+        "hyperparams": {
+          "batch_size": 4,
+          "learning_rate_multiplier": 0.1,
+          "n_epochs": 4,
+          "prompt_loss_weight": 0.1
+        },
+        "organization_id": 'org-...',
+        "result_files": [],
+        "status": 'pending',
+        "validation_files": [],
+        "training_files": [
+          {
+            "id": 'file-XGinujblHPwGLSztz8cPS8XY',
+            "object": 'file',
+            "bytes": 1_547_276,
+            "created_at": 1_610_062_281,
+            "filename": 'my-data-train.jsonl',
+            "purpose": 'fine-tune-train'
+          }
+        ],
+        "updated_at": 1_614_807_352
+      }
+    end
+
+    it 'can create a fine-tune' do
+      fine_tune = resource.create(training_file: 'my-data-train.jsonl', model: 'curie')
+
+      expect(http)
+        .to have_received(:post)
+        .with('https://api.openai.com/v1/fine-tunes', hash_including(:json))
+
+      expect(fine_tune.id).to eql('ft-AF1WoRqd3aJAHsqc9NY7iL8F')
+      expect(fine_tune.model).to eql('curie')
+      expect(fine_tune.created_at).to eql(1_614_807_352)
+      expect(fine_tune.events.first.object).to eql('fine-tune-event')
+      expect(fine_tune.events.first.created_at).to eql(1_614_807_352)
+      expect(fine_tune.events.first.level).to eql('info')
+      expect(fine_tune.events.first.message).to eql('Job enqueued. Waiting for jobs ahead to complete. Queue number: 0.')
+      expect(fine_tune.fine_tuned_model).to be_nil
+      expect(fine_tune.hyperparams.batch_size).to eql(4)
+      expect(fine_tune.hyperparams.learning_rate_multiplier).to eql(0.1)
+      expect(fine_tune.hyperparams.n_epochs).to eql(4)
+      expect(fine_tune.hyperparams.prompt_loss_weight).to eql(0.1)
+      expect(fine_tune.organization_id).to eql('org-...')
+      expect(fine_tune.result_files).to be_empty
+      expect(fine_tune.status).to eql('pending')
+      expect(fine_tune.validation_files).to be_empty
+      expect(fine_tune.training_files.first.id).to eql('file-XGinujblHPwGLSztz8cPS8XY')
+      expect(fine_tune.training_files.first.object).to eql('file')
+      expect(fine_tune.training_files.first.bytes).to eql(1_547_276)
+      expect(fine_tune.training_files.first.created_at).to eql(1_610_062_281)
+      expect(fine_tune.training_files.first.filename).to eql('my-data-train.jsonl')
+      expect(fine_tune.training_files.first.purpose).to eql('fine-tune-train')
+      expect(fine_tune.updated_at).to eql(1_614_807_352)
+    end
+  end
+
+  context 'when fetching a fine tune' do
+    let(:response_body) do
+      {
+        "id": 'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
+        "object": 'fine-tune',
+        "model": 'curie',
+        "created_at": 1_614_807_352,
+        "events": [
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_352,
+            "level": 'info',
+            "message": 'Job enqueued. Waiting for jobs ahead to complete. Queue number: 0.'
+          },
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_356,
+            "level": 'info',
+            "message": 'Job started.'
+          },
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_861,
+            "level": 'info',
+            "message": 'Uploaded snapshot: curie:ft-acmeco-2021-03-03-21-44-20.'
+          },
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_864,
+            "level": 'info',
+            "message": 'Uploaded result files: file-QQm6ZpqdNwAaVC3aSz5sWwLT.'
+          },
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_864,
+            "level": 'info',
+            "message": 'Job succeeded.'
+          }
+        ],
+        "fine_tuned_model": 'curie:ft-acmeco-2021-03-03-21-44-20',
+        "hyperparams": {
+          "batch_size": 4,
+          "learning_rate_multiplier": 0.1,
+          "n_epochs": 4,
+          "prompt_loss_weight": 0.1
+        },
+        "organization_id": 'org-...',
+        "result_files": [
+          {
+            "id": 'file-QQm6ZpqdNwAaVC3aSz5sWwLT',
+            "object": 'file',
+            "bytes": 81_509,
+            "created_at": 1_614_807_863,
+            "filename": 'compiled_results.csv',
+            "purpose": 'fine-tune-results'
+          }
+        ],
+        "status": 'succeeded',
+        "validation_files": [],
+        "training_files": [
+          {
+            "id": 'file-XGinujblHPwGLSztz8cPS8XY',
+            "object": 'file',
+            "bytes": 1_547_276,
+            "created_at": 1_610_062_281,
+            "filename": 'my-data-train.jsonl',
+            "purpose": 'fine-tune-train'
+          }
+        ],
+        "updated_at": 1_614_807_865
+      }
+    end
+
+    it 'can get a fine-tune' do
+      fine_tune = resource.fetch('ft-AF1WoRqd3aJAHsqc9NY7iL8F')
+
+      expect(http)
+        .to have_received(:get)
+        .with('https://api.openai.com/v1/fine-tunes/ft-AF1WoRqd3aJAHsqc9NY7iL8F')
+
+      expect(fine_tune.id).to eql('ft-AF1WoRqd3aJAHsqc9NY7iL8F')
+      expect(fine_tune.model).to eql('curie')
+      expect(fine_tune.created_at).to eql(1_614_807_352)
+      expect(fine_tune.events.first.object).to eql('fine-tune-event')
+      expect(fine_tune.events.first.created_at).to eql(1_614_807_352)
+      expect(fine_tune.events.first.level).to eql('info')
+      expect(fine_tune.events.first.message).to eql('Job enqueued. Waiting for jobs ahead to complete. Queue number: 0.')
+      expect(fine_tune.fine_tuned_model).to eql('curie:ft-acmeco-2021-03-03-21-44-20')
+      expect(fine_tune.hyperparams.batch_size).to eql(4)
+      expect(fine_tune.hyperparams.learning_rate_multiplier).to eql(0.1)
+      expect(fine_tune.hyperparams.n_epochs).to eql(4)
+      expect(fine_tune.hyperparams.prompt_loss_weight).to eql(0.1)
+      expect(fine_tune.organization_id).to eql('org-...')
+      expect(fine_tune.result_files.first.id).to eql('file-QQm6ZpqdNwAaVC3aSz5sWwLT')
+      expect(fine_tune.result_files.first.object).to eql('file')
+      expect(fine_tune.result_files.first.bytes).to eql(81_509)
+      expect(fine_tune.result_files.first.created_at).to eql(1_614_807_863)
+      expect(fine_tune.result_files.first.filename).to eql('compiled_results.csv')
+      expect(fine_tune.result_files.first.purpose).to eql('fine-tune-results')
+      expect(fine_tune.status).to eql('succeeded')
+      expect(fine_tune.validation_files).to be_empty
+      expect(fine_tune.training_files.first.id).to eql('file-XGinujblHPwGLSztz8cPS8XY')
+      expect(fine_tune.training_files.first.object).to eql('file')
+      expect(fine_tune.training_files.first.bytes).to eql(1_547_276)
+      expect(fine_tune.training_files.first.created_at).to eql(1_610_062_281)
+      expect(fine_tune.training_files.first.filename).to eql('my-data-train.jsonl')
+      expect(fine_tune.training_files.first.purpose).to eql('fine-tune-train')
+      expect(fine_tune.updated_at).to eql(1_614_807_865)
+    end
+  end
+
+  context 'when canceling a fine-tune' do
+    let(:response_body) do
+      {
+        "id": 'ft-xhrpBbvVUzYGo8oUO1FY4nI7',
+        "status": 'cancelled'
+      }
+    end
+
+    it 'can cancel a fine-tune' do
+      fine_tune = resource.cancel('ft-xhrpBbvVUzYGo8oUO1FY4nI7')
+
+      expect(http)
+        .to have_received(:post)
+        .with('https://api.openai.com/v1/fine-tunes/ft-xhrpBbvVUzYGo8oUO1FY4nI7/cancel', json: {})
+
+      expect(fine_tune.id).to eql('ft-xhrpBbvVUzYGo8oUO1FY4nI7')
+      expect(fine_tune.status).to eql('cancelled')
+    end
+  end
+
+  context 'when listing fine-tune events' do
+    let(:response_body) do
+      {
+        "object": 'list',
+        "data": [
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_352,
+            "level": 'info',
+            "message": 'Job enqueued. Waiting for jobs ahead to complete. Queue number: 0.'
+          },
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_356,
+            "level": 'info',
+            "message": 'Job started.'
+          },
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_861,
+            "level": 'info',
+            "message": 'Uploaded snapshot: curie:ft-acmeco-2021-03-03-21-44-20.'
+          },
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_864,
+            "level": 'info',
+            "message": 'Uploaded result files: file-QQm6ZpqdNwAaVC3aSz5sWwLT.'
+          },
+          {
+            "object": 'fine-tune-event',
+            "created_at": 1_614_807_864,
+            "level": 'info',
+            "message": 'Job succeeded.'
+          }
+        ]
+      }
+    end
+
+    it 'can list fine-tune events' do
+      events = resource.list_events('fine-tune-id')
+
+      expect(http)
+        .to have_received(:get)
+        .with('https://api.openai.com/v1/fine-tunes/fine-tune-id/events')
+
+      expect(events.object).to eql('list')
+      expect(events.data.size).to eql(5)
+
+      event = events.data.first
+      expect(event.object).to eql('fine-tune-event')
+      expect(event.created_at).to eql(1_614_807_352)
+      expect(event.level).to eql('info')
+      expect(event.message).to eql('Job enqueued. Waiting for jobs ahead to complete. Queue number: 0.')
+    end
+  end
+end

data/spec/unit/openai/api/images_spec.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+RSpec.describe OpenAI::API, '#images' do
+  include_context 'an API Resource'
+
+  let(:resource) { api.images }
+
+  let(:sample_image) { OpenAISpec::SPEC_ROOT.join('data/sample_image.png') }
+
+  context 'when creating an image' do
+    let(:response_body) do
+      {
+        created: Time.now.to_i,
+        data: [
+          { url: 'https://example.com/image1.png' },
+          { url: 'https://example.com/image2.png' }
+        ]
+      }
+    end
+
+    it 'can create an image generation' do
+      image_generation = resource.create(prompt: 'a bird in the forest', size: 512)
+
+      expect(http)
+        .to have_received(:post)
+        .with(
+          'https://api.openai.com/v1/images/generations',
+          hash_including(
+            json: hash_including(prompt: 'a bird in the forest', size: 512)
+          )
+        )
+
+      expect(image_generation.created).to be_within(1).of(Time.now.to_i)
+      expect(image_generation.data.map(&:url)).to contain_exactly('https://example.com/image1.png', 'https://example.com/image2.png')
+    end
+  end
+
+  context 'when editing an image' do
+    let(:sample_mask) { OpenAISpec::SPEC_ROOT.join('data/sample_image_mask.png') }
+
+    let(:response_body) do
+      {
+        "created": 1_589_478_378,
+        "data": [
+          {
+            "url": 'https://...'
+          },
+          {
+            "url": 'https://...'
+          }
+        ]
+      }
+    end
+
+    it 'can edit an image' do
+      image_edit = resource.edit(
+        image: sample_image,
+        mask: sample_mask,
+        prompt: 'Draw a red hat on the person in the image',
+        n: 1,
+        size: '512x512',
+        response_format: 'url',
+        user: 'user-123'
+      )
+
+      expect(http)
+        .to have_received(:post)
+        .with(
+          'https://api.openai.com/v1/images/edits',
+          hash_including(
+            form: hash_including(
+              {
+                image: instance_of(HTTP::FormData::File),
+                mask: instance_of(HTTP::FormData::File),
+                prompt: 'Draw a red hat on the person in the image',
+                n: 1,
+                size: '512x512',
+                response_format: 'url',
+                user: 'user-123'
+              }
+            )
+          )
+        )
+
+      expect(image_edit.created).to eql(1_589_478_378)
+      expect(image_edit.data.first.url).to eql('https://...')
+    end
+  end
+
+  context 'when creating image variations' do
+    let(:response_body) do
+      {
+        "created": 1_589_478_378,
+        "data": [
+          {
+            "url": 'https://...'
+          },
+          {
+            "url": 'https://...'
+          }
+        ]
+      }
+    end
+
+    it 'can create image variations' do
+      image_variations = resource.create_variation(
+        image: sample_image,
+        n: 2,
+        size: '512x512',
+        response_format: 'url',
+        user: 'user123'
+      )
+
+      expect(http)
+        .to have_received(:post)
+        .with(
+          'https://api.openai.com/v1/images/variations',
+          hash_including(
+            form: hash_including(
+              {
+                image: instance_of(HTTP::FormData::File),
+                n: 2,
+                size: '512x512',
+                response_format: 'url',
+                user: 'user123'
+              }
+            )
+          )
+        )
+
+      expect(image_variations.created).to eql(1_589_478_378)
+      expect(image_variations.data.size).to eql(2)
+      expect(image_variations.data.first.url).to eql('https://...')
+      expect(image_variations.data.last.url).to eql('https://...')
+    end
+  end
+end

data/spec/unit/openai/api/models_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+RSpec.describe OpenAI::API, '#models' do
+  include_context 'an API Resource'
+
+  let(:resource) { api.models }
+
+  context 'when listing models' do
+    let(:response_body) do
+      {
+        data: [
+          {
+            id: 'model-id-0',
+            object: 'model',
+            owned_by: 'organization-owner',
+            permission: [1, 2, 3]
+          },
+          {
+            id: 'model-id-1',
+            object: 'model',
+            owned_by: 'organization-owner',
+            permission: [4, 5, 6]
+          },
+          {
+            id: 'model-id-2',
+            object: 'model',
+            owned_by: 'openai',
+            permission: [7, 8, 9]
+          }
+        ],
+        object: 'list'
+      }
+    end
+
+    it 'can list all models' do
+      models = resource.list
+
+      expect(http)
+        .to have_received(:get)
+        .with('https://api.openai.com/v1/models')
+
+      expect(models.data.length).to eql(3)
+
+      expect(models.data[0].id).to eql('model-id-0')
+      expect(models.data[0].object).to eql('model')
+      expect(models.data[0].owned_by).to eql('organization-owner')
+      expect(models.data[0].permission).to eql([1, 2, 3])
+
+      expect(models.data[1].id).to eql('model-id-1')
+      expect(models.data[1].object).to eql('model')
+      expect(models.data[1].owned_by).to eql('organization-owner')
+      expect(models.data[1].permission).to eql([4, 5, 6])
+
+      expect(models.data[2].id).to eql('model-id-2')
+      expect(models.data[2].object).to eql('model')
+      expect(models.data[2].owned_by).to eql('openai')
+      expect(models.data[2].permission).to eql([7, 8, 9])
+    end
+  end
+
+  context 'when retrieving a model' do
+    let(:response_body) do
+      {
+        "id": 'text-davinci-002',
+        "object": 'model',
+        "owned_by": 'openai',
+        "permission": %w[
+          query
+          completions
+          models:read
+          models:write
+          engine:read
+          engine:write
+        ]
+      }
+    end
+
+    it 'can retrieve a model' do
+      model = resource.fetch('text-davinci-002')
+
+      expect(http)
+        .to have_received(:get)
+        .with('https://api.openai.com/v1/models/text-davinci-002')
+
+      expect(model.id).to eql('text-davinci-002')
+      expect(model.object).to eql('model')
+      expect(model.owned_by).to eql('openai')
+      expect(model.permission).to eql(%w[
+                                        query
+                                        completions
+                                        models:read
+                                        models:write
+                                        engine:read
+                                        engine:write
+                                      ])
+    end
+  end
+end

data/spec/unit/openai/api/moderations_spec.rb

@@ -0,0 +1,61 @@
+RSpec.describe OpenAI::API, '#moderations' do
+  include_context 'an API Resource'
+
+  let(:resource) { api.moderations }
+
+  let(:response_body) do
+    {
+      "id": 'modr-5MWoLO',
+      "model": 'text-moderation-001',
+      "results": [
+        {
+          "categories": {
+            "hate": false,
+            "hate/threatening": true,
+            "self-harm": false,
+            "sexual": false,
+            "sexual/minors": false,
+            "violence": true,
+            "violence/graphic": false
+          },
+          "category_scores": {
+            "hate": 0.22714105248451233,
+            "hate/threatening": 0.4132447838783264,
+            "self-harm": 0.005232391878962517,
+            "sexual": 0.01407341007143259,
+            "sexual/minors": 0.0038522258400917053,
+            "violence": 0.9223177433013916,
+            "violence/graphic": 0.036865197122097015
+          },
+          "flagged": true
+        }
+      ]
+    }
+  end
+
+  it 'can create a moderation' do
+    moderation = resource.create(input: 'This is a test', model: 'text-moderation-001')
+
+    expect(http)
+      .to have_received(:post)
+      .with('https://api.openai.com/v1/moderations', hash_including(:json))
+
+    expect(moderation.id).to eql('modr-5MWoLO')
+    expect(moderation.model).to eql('text-moderation-001')
+    expect(moderation.results.first.categories.hate).to be_falsey
+    expect(moderation.results.first.categories.hate_threatening).to be_truthy
+    expect(moderation.results.first.categories.self_harm).to be_falsey
+    expect(moderation.results.first.categories.sexual).to be_falsey
+    expect(moderation.results.first.categories.sexual_minors).to be_falsey
+    expect(moderation.results.first.categories.violence).to be_truthy
+    expect(moderation.results.first.categories.violence_graphic).to be_falsey
+    expect(moderation.results.first.category_scores.hate).to eql(0.22714105248451233)
+    expect(moderation.results.first.category_scores.hate_threatening).to eql(0.4132447838783264)
+    expect(moderation.results.first.category_scores.self_harm).to eql(0.005232391878962517)
+    expect(moderation.results.first.category_scores.sexual).to eql(0.01407341007143259)
+    expect(moderation.results.first.category_scores.sexual_minors).to eql(0.0038522258400917053)
+    expect(moderation.results.first.category_scores.violence).to eql(0.9223177433013916)
+    expect(moderation.results.first.category_scores.violence_graphic).to eql(0.036865197122097015)
+    expect(moderation.results.first.flagged).to be_truthy
+  end
+end