omniai-openai 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9541bdbe54c24be244b7bacd347eb4457d2f8686151cec1d4474889bf23bf6d0
-  data.tar.gz: 5fabc408441ca53da67d05f221d14cb74f6c178e30696ec1a76598adb18ec4c8
+  metadata.gz: 3ff87839fda74772081155dca341df25a7112ac9fb40940d3a9ce027702f78fa
+  data.tar.gz: c4f892dc84bf3c9c6f914dbf19912c34add5f30d486ddaef5d4a72122ecc42bb
 SHA512:
-  metadata.gz: 48b237f8d606fff3d8db2aecac46633d6bebbae3c403ce2f68d9d87ecac0fe7beb101ada9be12d15e2d1bf734ef86dab92ff7cbf56298311634e44584b9b7cce
-  data.tar.gz: 4627a44685b895c4b2616de3a88ba8b4bb63b038efc7f0536aacc7b9108e373f78d690acdc5adc99635dc9c8e10c6b1e59161643fdf7c3db283a012f1166a9bb
+  metadata.gz: ecea745e019e298450b06485dc8283d66e2a3bb0e0562a54ee6c55c358b1e687afb1c7f9f34e9b45a495189ca282651183fdd47983492f554ce68a6125277529
+  data.tar.gz: e1834ffed43d4db32b430bdf7150af21250d7757adf87c5dbc5912162598038f661ba24b24aaa6ac4cf078c9db7d32e7ec1d0a1c79c79e52dac94d2f27f74991

data/README.md

@@ -70,21 +70,10 @@ completion.choice.message.content # 'Why did the chicken cross the road? To get
 ```
 
 ```ruby
-completion = client.chat({
-  role: OmniAI::Chat::Role::USER,
-  content: 'Is it wise to jump off a bridge?'
-})
-completion.choice.message.content # 'No.'
-```
-
-```ruby
-completion = client.chat([
-  {
-    role: OmniAI::Chat::Role::SYSTEM,
-    content: 'You are a helpful assistant.'
-  },
-  'What is the capital of Canada?',
-])
+completion = client.chat do |prompt|
+  prompt.system('Your are an expert in geography.')
+  prompt.user('What is the capital of Canada?')
+end
 completion.choice.message.content # 'The capital of Canada is Ottawa.'
 ```
 
@@ -128,10 +117,10 @@ client.chat('Be poetic.', stream:)
 `format` takes an optional symbol (`:json`) and that setes the `response_format` to `json_object`:
 
 ```ruby
-completion = client.chat([
-  { role: OmniAI::Chat::Role::SYSTEM, content: OmniAI::Chat::JSON_PROMPT },
-  { role: OmniAI::Chat::Role::USER, content: 'What is the name of the drummer for the Beatles?' }
-], format: :json)
+completion = client.chat(format: :json) do |prompt|
+  prompt.system(OmniAI::Chat::JSON_PROMPT)
+  prompt.user('What is the name of the drummer for the Beatles?')
+end
 JSON.parse(completion.choice.message.content) # { "name": "Ringo" }
 ```
 

data/lib/omniai/openai/chat.rb

@@ -3,6 +3,14 @@
 module OmniAI
   module OpenAI
     # An OpenAI chat implementation.
+    #
+    # Usage:
+    #
+    #   completion = OmniAI::OpenAI::Chat.process!(client: client) do |prompt|
+    #     prompt.system('You are an expert in the field of AI.')
+    #     prompt.user('What are the biggest risks of AI?')
+    #   end
+    #   completion.choice.message.content # '...'
     class Chat < OmniAI::Chat
       JSON_RESPONSE_FORMAT = { type: 'json_object' }.freeze
 
@@ -20,7 +28,7 @@ module OmniAI
       # @return [Hash]
       def payload
         OmniAI::OpenAI.config.chat_options.merge({
-          messages:,
+          messages: @prompt.serialize,
           model: @model,
           stream: @stream.nil? ? nil : !@stream.nil?,
           temperature: @temperature,

data/lib/omniai/openai/client.rb

@@ -69,9 +69,12 @@ module OmniAI
       # @param stream [Proc, nil] optional
       # @param tools [Array<OmniAI::Tool>, nil] optional
       #
+      # @yield [prompt]
+      # @yieldparam prompt [OmniAI::Chat::Prompt]
+      #
       # @return [OmniAI::Chat::Completion]
-      def chat(messages, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil)
-        Chat.process!(messages, model:, temperature:, format:, stream:, tools:, client: self)
+      def chat(messages, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil, &)
+        Chat.process!(messages, model:, temperature:, format:, stream:, tools:, client: self, &)
       end
 
       # @raise [OmniAI::Error]

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '1.5.0'
+    VERSION = '1.6.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser