Changed the name of completions class method from generate to create

hiremav · Sep 13, 2024 · 5d02751 · 5d02751
1 parent 76a072b
commit 5d02751
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/lib/spectre/openai/completions.rb b/lib/spectre/openai/completions.rb
@@ -21,7 +21,7 @@ class Completions
       # @return [String] the generated completion text
       # @raise [APIKeyNotConfiguredError] if the API key is not set
       # @raise [RuntimeError] for general API errors or unexpected issues
-      def self.generate(user_prompt:, system_prompt: "You are a helpful assistant.", assistant_prompt: nil, model: DEFAULT_MODEL, json_schema: nil, max_tokens: nil)
+      def self.create(user_prompt:, system_prompt: "You are a helpful assistant.", assistant_prompt: nil, model: DEFAULT_MODEL, json_schema: nil, max_tokens: nil)
         api_key = Spectre.api_key
         raise APIKeyNotConfiguredError, "API key is not configured" unless api_key
 

diff --git a/spec/spectre/openai/completions_spec.rb b/spec/spectre/openai/completions_spec.rb
@@ -22,7 +22,7 @@
 
       it 'raises an APIKeyNotConfiguredError' do
         expect {
-          described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt)
+          described_class.create(user_prompt: user_prompt, system_prompt: system_prompt)
         }.to raise_error(Spectre::APIKeyNotConfiguredError, 'API key is not configured')
       end
     end
@@ -34,7 +34,7 @@
       end
 
       it 'returns the completion text' do
-        result = described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt, assistant_prompt: assistant_prompt)
+        result = described_class.create(user_prompt: user_prompt, system_prompt: system_prompt, assistant_prompt: assistant_prompt)
         expect(result).to eq(completion)
       end
     end
@@ -47,7 +47,7 @@
 
       it 'raises an error with the API response' do
         expect {
-          described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt)
+          described_class.create(user_prompt: user_prompt, system_prompt: system_prompt)
         }.to raise_error(RuntimeError, /OpenAI API Error/)
       end
     end
@@ -60,7 +60,7 @@
 
       it 'raises a JSON Parse Error' do
         expect {
-          described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt)
+          described_class.create(user_prompt: user_prompt, system_prompt: system_prompt)
         }.to raise_error(RuntimeError, /JSON Parse Error/)
       end
     end
@@ -73,7 +73,7 @@
 
       it 'raises a Request Timeout error' do
         expect {
-          described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt)
+          described_class.create(user_prompt: user_prompt, system_prompt: system_prompt)
         }.to raise_error(RuntimeError, /Request Timeout/)
       end
     end
@@ -88,7 +88,7 @@
 
       it 'raises an incomplete response error' do
         expect {
-          described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt)
+          described_class.create(user_prompt: user_prompt, system_prompt: system_prompt)
         }.to raise_error(RuntimeError, /Incomplete response: The completion was cut off due to token limit./)
       end
     end
@@ -102,7 +102,7 @@
       end
 
       it 'sends the max_tokens parameter in the request' do
-        described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt, max_tokens: max_tokens)
+        described_class.create(user_prompt: user_prompt, system_prompt: system_prompt, max_tokens: max_tokens)
 
         expect(a_request(:post, Spectre::Openai::Completions::API_URL)
                  .with(body: hash_including(max_tokens: max_tokens))).to have_been_made
@@ -118,7 +118,7 @@
       end
 
       it 'sends the json_schema in the request' do
-        described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt, json_schema: json_schema)
+        described_class.create(user_prompt: user_prompt, system_prompt: system_prompt, json_schema: json_schema)
 
         expect(a_request(:post, Spectre::Openai::Completions::API_URL)
                  .with { |req| JSON.parse(req.body)['response_format']['json_schema'] == JSON.parse(json_schema.to_json) }).to have_been_made.once
@@ -137,7 +137,7 @@
 
       it 'raises a refusal error' do
         expect {
-          described_class.generate(user_prompt: user_prompt, system_prompt: system_prompt)
+          described_class.create(user_prompt: user_prompt, system_prompt: system_prompt)
         }.to raise_error(RuntimeError, /Refusal: I'm sorry, I cannot assist with that request./)
       end
     end