openai-client 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fdb9832b6b6a5b14a1b14537ac74595fa1a85a689f84fc7f2411651812b6131
-  data.tar.gz: 57d4465e713d0ff02e7c5b97dcc32b3db7e96085b3850d00a4076eb2de8509ae
+  metadata.gz: be7dc55119b7220165c1025d64ddf0f9a9f4a05efb79f4ffd03fece3c7cd60be
+  data.tar.gz: 591cdc0fe81065d49db7907a0b9f740a17962744cdb9cc3ecdf1b9d40967c50e
 SHA512:
-  metadata.gz: 78fb79a3c56a1ad02ac6574f619dc8c5492b30d167478b5678730768e40b1c91adccebebceb238440a51915337d331472de8de9b711133d4276fd49066a33123
-  data.tar.gz: bd23759e786d446ed0e14ad63b7db1e4b438f5b7291cb68ec97b38928e00e3be38e73664909f3c6837c0b7391154f317ef45b23e95628cef5fe35fc97c955742
+  metadata.gz: 8d6f2dc7fa5cc014cf77a2defd2e0efce3f6da336612d3812c9b7df74befba4fc9a069c24c2491d16fc518fd22b985422d6a9c7e06f63c217728d70a6caf4eb4
+  data.tar.gz: ba737dc9d234a49fb20afc98223354dee5a66f1efbac4d95df3b0676b0a8cad95688fbd1b4c38a49d24f5fe8f9001269b33596b03b7fd979aaaa1c39225e300b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openai-client (0.4.1)
+    openai-client (0.5.0)
       faraday (~> 1.8)
       faraday_middleware (~> 1.2)
 

data/README.md

@@ -11,8 +11,7 @@ This gem is a wrapper for calling the OpenAI and GPT-3 APIs.
   * [Create an Image](#create-an-image)
   * [Create an Image Edit](#create-an-image-edit)
   * [Create an Image Variation](#create-an-image-variation)
-
-
+* [OpenAI Embeddings API](#openai-embeddings-api)
 
 ## Installation
 
@@ -141,6 +140,18 @@ response = Openai::Client.images.variations(request_body)
 
 [Request body documentation](https://platform.openai.com/docs/api-reference/images/create-variation)
 
+## OpenAI Embeddings API
+
+```ruby
+request_body = {
+  model: 'text-embedding-ada-002',
+  input: 'The food was delicious and the waiter...'
+}
+Openai::Client.embeddings.create(request_body)
+```
+
+[Request body documentation](https://platform.openai.com/docs/api-reference/embeddings/create)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/itikhonenko/openai-client>.

data/lib/openai/client/embeddings.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Embeddings
+      PATH = 'embeddings'
+
+      # @api public
+      # Public: Makes an API call to create an embedding.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] an embedding
+      def create(body)
+        Http.new.post(PATH, body).body
+      rescue Faraday::Error
+        nil
+      end
+    end
+  end
+end

data/lib/openai/client/version.rb

@@ -2,6 +2,6 @@
 
 module Openai
   module Client
-    VERSION = '0.4.1'
+    VERSION = '0.5.0'
   end
 end

data/lib/openai/client.rb

@@ -12,12 +12,13 @@ require 'openai/client/models'
 require 'openai/client/edits'
 require 'openai/client/completions'
 require 'openai/client/images'
+require 'openai/client/embeddings'
 
 module Openai
   module Client
     extend Configurable
 
-    ATTRS = ['models', 'edits', 'completions', 'images'].freeze
+    ATTRS = ['models', 'edits', 'completions', 'images', 'embeddings'].freeze
 
     class << self
       ATTRS.each do |attr|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai-client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ihor Tykhonenko
@@ -58,6 +58,7 @@ files:
 - lib/openai/client/configurable.rb
 - lib/openai/client/configuration.rb
 - lib/openai/client/edits.rb
+- lib/openai/client/embeddings.rb
 - lib/openai/client/http.rb
 - lib/openai/client/images.rb
 - lib/openai/client/models.rb