omniai-openai 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41461329b48f40e24c8d2f69a58ece1a8e07726c7d45deda20c83fc58d6a1a54
-  data.tar.gz: 6699b15afe94e512ddec9c1919d74b121a2044f5d50c390fd7899f4498b7cf19
+  metadata.gz: 0bc756e1ccefb9777b3103759fd819b73d39ee71fccf8eacb01d53c93b80b5cd
+  data.tar.gz: 752e9be7a594471210e6f85aeefb0443a917ebe2bc1eea776aa8cdcd34c5fe12
 SHA512:
-  metadata.gz: c30e7ded2ee30804f3cc6b9d1dcb2ca62c52d7454fe722caedf518d96f019183a73265d81803a526453b3b6044c210260b6c0ef4c8e0909fead982ebe59ae3bb
-  data.tar.gz: f99a44a88ad1c564101cb9caff9d57e33214d93c5716cad13ab0fabc3792bf3196f693ec3783eaeadfef121db785ff5d38d1c7ebd6b32d5b2f1150c10ec2687f
+  metadata.gz: 4c821761f9616bfda0a2f4ccd8abd203a25a44310a2d4820a6f2f5858bb3d47772b117b0dd1906b01b1e949618673aaf9db6e47e746713cf50a435864f90b6e2
+  data.tar.gz: 91091db68f9030aa628cfa1669603627c736410c4a449da015d438f2d5b3f9141bb64227679b7b40f8cf67d4960acc4388e92602742bdfda6c9dce88fc5bbf57

data/README.md

@@ -62,19 +62,21 @@ _For details on installation or running Ollama checkout [the project README](htt
 
 ### Chat
 
-A chat completion is generated by passing in prompts using any a variety of formats:
+A chat completion is generated by passing in a simple text prompt:
 
 ```ruby
 completion = client.chat('Tell me a joke!')
-completion.choice.message.content # 'Why did the chicken cross the road? To get to the other side.'
+completion.content # 'Why did the chicken cross the road? To get to the other side.'
 ```
 
+A chat completion may also be generated by using a prompt builder:
+
 ```ruby
 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.'
+completion.content # 'The capital of Canada is Ottawa.'
 ```
 
 #### Model
@@ -83,7 +85,7 @@ completion.choice.message.content # 'The capital of Canada is Ottawa.'
 
 ```ruby
 completion = client.chat('How fast is a cheetah?', model: OmniAI::OpenAI::Chat::Model::GPT_3_5_TURBO)
-completion.choice.message.content # 'A cheetah can reach speeds over 100 km/h.'
+completion.content # 'A cheetah can reach speeds over 100 km/h.'
 ```
 
 [OpenAI API Reference `model`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-model)
@@ -94,7 +96,7 @@ completion.choice.message.content # 'A cheetah can reach speeds over 100 km/h.'
 
 ```ruby
 completion = client.chat('Pick a number between 1 and 5', temperature: 2.0)
-completion.choice.message.content # '3'
+completion.content # '3'
 ```
 
 [OpenAI API Reference `temperature`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-temperature)
@@ -105,7 +107,7 @@ completion.choice.message.content # '3'
 
 ```ruby
 stream = proc do |chunk|
-  print(chunk.choice.delta.content) # 'Better', 'three', 'hours', ...
+  print(chunk.content) # 'Better', 'three', 'hours', ...
 end
 client.chat('Be poetic.', stream:)
 ```
@@ -121,7 +123,7 @@ 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" }
+JSON.parse(completion.content) # { "name": "Ringo" }
 ```
 
 [OpenAI API Reference `response_format`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream)

data/lib/omniai/openai/chat.rb

@@ -34,7 +34,7 @@ module OmniAI
           stream: @stream.nil? ? nil : !@stream.nil?,
           temperature: @temperature,
           response_format: (JSON_RESPONSE_FORMAT if @format.eql?(:json)),
-          tools: @tools&.map(&:prepare),
+          tools: @tools&.map(&:serialize),
         }).compact
       end
 

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '1.7.0'
+    VERSION = '1.8.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser