ruby-openai 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb70b90b84ff4b23bf8e9ed757ae39b82adf291e5bdcb07b8f0ef5ccbe12394
-  data.tar.gz: 5391b9437fd05d7da1783e5ac960b216a7ad326f22a509ad28a21eb879bdf4a8
+  metadata.gz: a958db13dbbf94dbbeeadb2dba89e9c00eb17c40def662e85074410becbca3c5
+  data.tar.gz: 2ec73b390ef82c2e8f5498d6abf195cf49c40a03e6b446e42f7715df0bfc27fd
 SHA512:
-  metadata.gz: 5cbf287bf8bfc9e1b949bc050ea456d62c5259a5316710db7a617126a7a3b018707c78c03d508a5619ac024a5767865f7e98925e5c6e867dc8cb1f3687e3b9c6
-  data.tar.gz: a45ed235da6d261371ae6f1b26ae45ea2f28dd9ca3f9b362b66045d851666ea1b72e89c0253d64830183c6bae6c3c8093f7c586c65aed940b5b3003d9b652399
+  metadata.gz: ed8d2bcedcc30defd2acb28d29be00c2c07bf80b38dd7748323c0661b90f1b09da5c21c7dd7b6014161d7fd966e9da6854d996236c032744d4f0fe70f0a4abb2
+  data.tar.gz: a846cf9bb2888dd30a89b5796ead927615ccb46647ef803a88cfc281c08e7064857a6ee025f4611d9b7db4b0760198c7504b65257ec1584b88196ca4d27a8423

data/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2021-04-08
+
+### Added
+
+- Add Client#answers endpoint for question/answer response on documents or a file.
+
 ## [1.1.0] - 2021-04-07
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (1.1.0)
+    ruby-openai (1.2.0)
       dotenv (~> 2.7.6)
       httparty (~> 0.18.1)
 

data/README.md

@@ -92,6 +92,32 @@ You can alternatively search using the ID of a file you've uploaded:
     client.search(engine: "ada", file: "abc123", query: "happy")
 ```
 
+### Answers
+
+Pass documents, a question string, and an example question/response to get an answer to a question:
+
+```
+    response = client.answers(parameters: {
+        documents: ["Puppy A is happy.", "Puppy B is sad."],
+        question: "which puppy is happy?",
+        model: "curie",
+        examples_context: "In 2017, U.S. life expectancy was 78.6 years.",
+        examples: [["What is human life expectancy in the United States?","78 years."]],
+    })
+```
+
+You can alternatively search using the ID of a file you've uploaded:
+
+```
+    response = client.answers(parameters: {
+        file: "123abc",
+        question: "which puppy is happy?",
+        model: "curie",
+        examples_context: "In 2017, U.S. life expectancy was 78.6 years.",
+        examples: [["What is human life expectancy in the United States?","78 years."]],
+    })
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ruby/openai/client.rb

@@ -7,6 +7,17 @@ module OpenAI
       @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
     end
 
+    def answers(version: default_version, parameters: {})
+      self.class.post(
+        "/#{version}/answers",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        },
+        body: parameters.to_json
+      )
+    end
+
     def completions(engine:, version: default_version, parameters: {})
       self.class.post(
         "/#{version}/engines/#{engine}/completions",

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "1.1.0".freeze
+    VERSION = "1.2.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv