openai-client 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a80665d3e20f6c56644b2dd0b03b5f7a4231b3e0ef1d947af3094917944c885c
-  data.tar.gz: fd1bb8de6a7d955be8b2265e637a3bad4b09823e538a1c5b49ae8e3b4c8f067a
+  metadata.gz: 3cbf3dd44125f32b91842962afe23cd6c9598d1860134d9bbdf00f7aee8a0324
+  data.tar.gz: 5082017517a67520e653376ee73bc267c7775d2e85979b7fb38ef8a19267fc20
 SHA512:
-  metadata.gz: 5e6414ba8bf6453fb683870b8a90a7ffaea0101461d73baded7c0572a47bddabca443b1854b42f31db9a1ce95f957111a93bde585692d1f69a15a942d6b42ddd
-  data.tar.gz: '043982ac4ac832a6d8c8078996469bbddc794d56f113a35e2d3869338a34d49f2db58888d15cdd6713cb0e36a254d69e5eb9d26ab301bd9442de44e75298fba6'
+  metadata.gz: 24b0f29f7e4c58a3f881fcd06a68d833e8c3185990d572983f43e68d86a97ec4911d2ffa9f906c5408b0aac142e7a8fca6029f406325f3082dcf695a83e8c605
+  data.tar.gz: f82ba652ebcaea9407f6b4667a5b98351af1352c48e112a0a90773a909bd1f043979a1cd2fc261be9bd714c1fe85298b3a95eec32bd2878168307e1336724de9

data/Gemfile.lock

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

data/README.md

@@ -5,14 +5,20 @@ This gem is a wrapper for calling the OpenAI and GPT-3 APIs.
 * [Installation](#installation)
 * [Usage](#usage)
 * [OpenAI Models API](#openai-models-api)
+  * [List Models](#list-models)
+  * [Find Model](#find-model)
 * [OpenAI Completions API](#openai-completions-api)
+  * [Create Completion](#create-completion)
 * [OpenAI Edits API](#openai-edits-api)
+  * [Create Edit](#create-edit)
 * [OpenAI Image API](#openai-image-api)
   * [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)
+  * [Create Embeddings](#create-embeddings)
 * [OpenAI Moderations API](#openai-moderations-api)
+  * [Create Moderation](#create-moderation)
 * [OpenAI Files API](#openai-files-api)
   * [List Files](#list-files)
   * [Find File](#find-file)
@@ -63,6 +69,18 @@ end
 
 ## OpenAI Models API
 
+### List Models
+
+```ruby
+Openai::Client.models.list
+```
+
+### Find Model
+
+```ruby
+Openai::Client.models.find(model_id)
+```
+
 ```ruby
 # Models
 Openai::Client.models.list
@@ -73,6 +91,8 @@ Openai::Client.models.find(model_id)
 
 ## OpenAI Completions API
 
+### Create Completion
+
 ```ruby
 request_body = {
   model: 'text-davinci-003',
@@ -92,6 +112,8 @@ Openai::Client.completions.create(request_body)
 
 ## OpenAI Edits API
 
+### Create Edit
+
 ```ruby
 request_body = {
   model: 'text-davinci-edit-001',
@@ -156,6 +178,8 @@ response = Openai::Client.images.variations(request_body)
 
 ## OpenAI Embeddings API
 
+### Create Embeddings
+
 ```ruby
 request_body = {
   model: 'text-embedding-ada-002',
@@ -168,6 +192,8 @@ Openai::Client.embeddings.create(request_body)
 
 ## OpenAI Moderations API
 
+### Create Moderation
+
 ```ruby
 request_body = {
   model: 'text-moderation-latest', # text-moderation-stable or text-moderation-latest

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -10,3 +11,9 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb'] # optional
+  t.options = ['--any', '--extra', '--opts'] # optional
+  t.stats_options = ['--list-undoc']         # optional
+end

data/lib/openai/client/version.rb

@@ -2,6 +2,6 @@
 
 module Openai
   module Client
-    VERSION = '0.8.0'
+    VERSION = '0.8.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai-client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Ihor Tykhonenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday