spectre_ai 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6cce97e6ac3ab3cde8536f7d422609ff35756847c562769f21305a68421cb89
-  data.tar.gz: cd092c3a8eef87550999630dc77c66eb8900ff24ed4129eff32f8050cb90a5dd
+  metadata.gz: e92299b643fbf7d928b9c45de5ad9a504528cbb246202d56cb24d36a32030030
+  data.tar.gz: 8dc5d19040a9cac2cc929a1a91b55112d0e78fa21ca8de05bb6c3544838af9ed
 SHA512:
-  metadata.gz: e4b701d7447eabb48a5c82e0d1bcbf5585c68497a49c513a81a0091e409aa84fd44d3c45e39b2b88ff53ef4643c63e047f24e88a705c3358b08be408cd0f9ed1
-  data.tar.gz: 639a433617ffc983cc078d26a22b516d415086c66e5091e42e1c85219f6885efe64daf924431182e1589db073a19bb8ab330c8a71793a0d5f7a95a2a2e722237
+  metadata.gz: 8ea61b8b0a0e23d7a5c500fd99e147942fd33538e21d38be0030aff60dda20758a87651b9460d4b4de50f986ffe068da4dd29f172dc0a25a993595eadee34fe6
+  data.tar.gz: b4ef2e616f0143f677c635e6d999e155a1205a1ab90ac47fc2a8c322b95ee6f107522dc4c2d8a16e33a856f3387ffdb1e7ac85ca9f83b3a72960e9b8e6d52ca1

data/CHANGELOG.md

@@ -95,6 +95,7 @@ This version enhances the flexibility and robustness of the Completions class, e
   *	**Example**: If you're using `spectre` inside a gem, the `detect_prompts_path` method will now correctly resolve the prompts path within the gem project root.
   *	If no markers are found, the system falls back to the current working directory (`Dir.pwd`).
 
+
 # Changelog for Version 1.1.3
 
 **Release Date:** [2nd Dec 2024]
@@ -102,4 +103,39 @@ This version enhances the flexibility and robustness of the Completions class, e
 **Fixes:**
 
 * **Removed unnecessary validations in `Completions` class**
-  * Removed redundant validations in the `Completions` class that were causing unnecessary errors in specific edge cases. LLM providers returns a proper errors messages now.
+  * Removed redundant validations in the `Completions` class that were causing unnecessary errors in specific edge cases. LLM providers returns a proper errors messages now.
+
+
+# Changelog for Version 1.1.4
+
+**Release Date:** [5th Dec 2024]
+
+**New Features:**
+
+* Customizable Timeout for API Requests
+* Introduced DEFAULT_TIMEOUT constant (set to 60 seconds) for managing request timeouts across the Completions and Embeddings classes.
+* Added optional arguments (args) to create methods, allowing users to override read_timeout and open_timeout dynamically.
+* This change ensures greater flexibility when dealing with varying network conditions or API response times.
+
+**Example Usage:**
+
+```ruby
+Spectre::Openai::Completions.create(
+  messages: messages,
+  read_timeout: 30,
+  open_timeout: 20
+)
+```
+
+**Key Changes:**
+
+* **Updated Completions class:**
+  * http.read_timeout = args.fetch(:read_timeout, DEFAULT_TIMEOUT)
+  * http.open_timeout = args.fetch(:open_timeout, DEFAULT_TIMEOUT)
+  * Updated Embeddings class with the same timeout handling logic.
+
+**Fixes:**
+
+* Simplified Exception Handling for Timeouts
+* Removed explicit handling of Net::OpenTimeout and Net::ReadTimeout exceptions in both Completions and Embeddings classes.
+* Letting these exceptions propagate ensures clearer and more consistent error messages for timeout issues.

data/README.md

@@ -1,4 +1,6 @@
-# Spectre [![Gem Version](https://badge.fury.io/rb/spectre_ai.svg)](https://badge.fury.io/rb/spectre_ai)
+# <img src='logo.svg' height='120' alt='Spectre Logo' />
+
+[![Gem Version](https://badge.fury.io/rb/spectre_ai.svg)](https://badge.fury.io/rb/spectre_ai)
 
 **Spectre** is a Ruby gem that makes it easy to AI-enable your Ruby on Rails application. Currently, Spectre focuses on helping developers create embeddings, perform vector-based searches, create chat completions, and manage dynamic prompts — ideal for applications that are featuring RAG (Retrieval-Augmented Generation), chatbots and dynamic prompts.
 

data/lib/spectre/openai/completions.rb

@@ -9,6 +9,7 @@ module Spectre
     class Completions
       API_URL = 'https://api.openai.com/v1/chat/completions'
       DEFAULT_MODEL = 'gpt-4o-mini'
+      DEFAULT_TIMEOUT = 60
 
       # Class method to generate a completion based on user messages and optional tools
       #
@@ -17,10 +18,11 @@ module Spectre
       # @param json_schema [Hash, nil] An optional JSON schema to enforce structured output
       # @param max_tokens [Integer] The maximum number of tokens for the completion (default: 50)
       # @param tools [Array<Hash>, nil] An optional array of tool definitions for function calling
+      # @param args [Hash] Optional arguments like timeouts
       # @return [Hash] The parsed response including any function calls or content
       # @raise [APIKeyNotConfiguredError] If the API key is not set
       # @raise [RuntimeError] For general API errors or unexpected issues
-      def self.create(messages:, model: DEFAULT_MODEL, json_schema: nil, max_tokens: nil, tools: nil)
+      def self.create(messages:, model: DEFAULT_MODEL, json_schema: nil, max_tokens: nil, tools: nil, **args)
         api_key = Spectre.api_key
         raise APIKeyNotConfiguredError, "API key is not configured" unless api_key
 
@@ -29,8 +31,8 @@ module Spectre
         uri = URI(API_URL)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
-        http.read_timeout = 10 # seconds
-        http.open_timeout = 10 # seconds
+        http.read_timeout = args.fetch(:read_timeout, DEFAULT_TIMEOUT)
+        http.open_timeout = args.fetch(:open_timeout, DEFAULT_TIMEOUT)
 
         request = Net::HTTP::Post.new(uri.path, {
           'Content-Type' => 'application/json',
@@ -49,8 +51,6 @@ module Spectre
         handle_response(parsed_response)
       rescue JSON::ParserError => e
         raise "JSON Parse Error: #{e.message}"
-      rescue Net::OpenTimeout, Net::ReadTimeout => e
-        raise "Request Timeout: #{e.message}"
       end
 
       private

data/lib/spectre/openai/embeddings.rb

@@ -9,23 +9,25 @@ module Spectre
     class Embeddings
       API_URL = 'https://api.openai.com/v1/embeddings'
       DEFAULT_MODEL = 'text-embedding-3-small'
+      DEFAULT_TIMEOUT = 60
 
       # Class method to generate embeddings for a given text
       #
       # @param text [String] the text input for which embeddings are to be generated
       # @param model [String] the model to be used for generating embeddings, defaults to DEFAULT_MODEL
+      # # @param args [Hash] Optional arguments like timeouts
       # @return [Array<Float>] the generated embedding vector
       # @raise [APIKeyNotConfiguredError] if the API key is not set
       # @raise [RuntimeError] for general API errors or unexpected issues
-      def self.create(text, model: DEFAULT_MODEL)
+      def self.create(text, model: DEFAULT_MODEL, **args)
         api_key = Spectre.api_key
         raise APIKeyNotConfiguredError, "API key is not configured" unless api_key
 
         uri = URI(API_URL)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
-        http.read_timeout = 10 # seconds
-        http.open_timeout = 10 # seconds
+        http.read_timeout = args.fetch(:read_timeout, DEFAULT_TIMEOUT)
+        http.open_timeout = args.fetch(:open_timeout, DEFAULT_TIMEOUT)
 
         request = Net::HTTP::Post.new(uri.path, {
           'Content-Type' => 'application/json',
@@ -42,8 +44,6 @@ module Spectre
         JSON.parse(response.body).dig('data', 0, 'embedding')
       rescue JSON::ParserError => e
         raise "JSON Parse Error: #{e.message}"
-      rescue Net::OpenTimeout, Net::ReadTimeout => e
-        raise "Request Timeout: #{e.message}"
       end
     end
   end

data/lib/spectre/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spectre # :nodoc:all
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectre_ai
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Ilya Klapatok
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails