omniai-mistral 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecfcd380d66660c2b8cb71d7cec580dd10c9df8030b25c9ee60e78de5181c173
-  data.tar.gz: a2230cb09db232a7024acd6677e206e47e345e3daa07081b0c0e2acde3622d96
+  metadata.gz: 34f5225c5523b037112416e04de0ff1861568756d306506b547c981646742210
+  data.tar.gz: dfc5114348aa17a5f2f32c60e6cdefb8207d42c9f339de53c360fd132b1dc46b
 SHA512:
-  metadata.gz: 34442af7ff4d2c376e6959d86d5f43b7a02bb57397882f1ec834b2f1c40448458573560abec4e21ac8c79b1c42646d073aac058f5be7ad39332cf74db96c1855
-  data.tar.gz: 446b60f9e02e37c822bf5d9728db0059a9926485afb961cafc6ff4ae79938baf5e6a10de6e371a4c687ee89956258e78a0f679220e68cafc5e110e6d0fb163b3
+  metadata.gz: 7c31d0f5d1a26c72c717f69872ca9c1adcbf12ea1409aee7c3684ad1fdd4d809d84a6f34030f6fb562b3f7d66718da96da732c0eda9d5e4ea3ac791882b7de4f
+  data.tar.gz: 3abb924937c1a3d5fc065e06811d41c1db49a24ca2a3617834b9da1bb2abb7cbcdef4d70c7124f8d4624381b1cba782732f5a02d06acfc71272760cdf4d80164

data/Gemfile

@@ -11,5 +11,4 @@ gem 'rspec_junit_formatter'
 gem 'rubocop'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
-gem 'vcr'
 gem 'webmock'

data/README.md

@@ -39,22 +39,22 @@ end
 A chat completion is generated by passing in prompts using any a variety of formats:
 
 ```ruby
-completion = client.chat.completion('Tell me a joke!')
+completion = client.chat('Tell me a joke!')
 completion.choice.message.content # 'Why did the chicken cross the road? To get to the other side.'
 ```
 
 ```ruby
-completion = client.chat.completion({
-  role: OmniAI::Mistral::Chat::Role::USER,
+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.completion([
+completion = client.chat([
   {
-    role: OmniAI::Mistral::Chat::Role::SYSTEM,
+    role: OmniAI::Chat::Role::SYSTEM,
     content: 'You are a helpful assistant.'
   },
   'What is the capital of Canada?',
@@ -67,19 +67,23 @@ completion.choice.message.content # 'The capital of Canada is Ottawa.'
 `model` takes an optional string (default is `mistral-medium-latest`):
 
 ```ruby
-completion = client.chat.completion('Provide code for fibonacci', model: OmniAI::Mistral::Chat::Model::CODESTRAL)
+completion = client.chat('Provide code for fibonacci', model: OmniAI::Mistral::Chat::Model::CODESTRAL)
 completion.choice.message.content # 'def fibonacci(n)...end'
 ```
 
+[Mistral API Reference `model`](https://docs.mistral.ai/getting-started/models/)
+
 #### Temperature
 
 `temperature` takes an optional float between `0.0` and `1.0` (defaults is `0.7`):
 
 ```ruby
-completion = client.chat.completion('Pick a number between 1 and 5', temperature: 1.0)
+completion = client.chat('Pick a number between 1 and 5', temperature: 1.0)
 completion.choice.message.content # '3'
 ```
 
+[Mistral API Reference `temperature`](https://docs.mistral.ai/api/)
+
 #### Stream
 
 `stream` takes an optional a proc to stream responses in real-time chunks instead of waiting for a complete response:
@@ -88,14 +92,23 @@ completion.choice.message.content # '3'
 stream = proc do |chunk|
   print(chunk.choice.delta.content) # 'Better', 'three', 'hours', ...
 end
-client.chat.completion('Be poetic.', stream:)
+client.chat('Be poetic.', stream:)
 ```
 
+[Mistral API Reference `stream`](https://docs.mistral.ai/api/)
+
 #### Format
 
-`format` takes an optional symbol (i.e. `:json`) and switches the client to parsing message content as `json`:
+`format` takes an optional symbol (`:json`) and that sets the `response_format` to `json_object`:
 
 ```ruby
-completion = client.chat.completion('Please provide a color name / hex / hsl as JSON.', format: :json)
-completion.choice.message.content # { "name": "Black", "hex": "#000", "hsl": { "h": 0, "s": 0, "l": 0 } }
+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)
+JSON.parse(completion.choice.message.content) # { "name": "Ringo" }
 ```
+
+[Mistral API Reference `response_format`](https://docs.mistral.ai/api/)
+
+> When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message.

data/lib/omniai/mistral/chat.rb

@@ -25,18 +25,24 @@ module OmniAI
         SYSTEM = 'system'
       end
 
-      # @raise [OmniAI::Error]
-      #
-      # @param prompt [String]
-      # @param model [String] optional
-      # @param format [Symbol] optional :text or :json
-      # @param temperature [Float, nil] optional
-      # @param stream [Proc, nil] optional
-      #
-      # @return [OmniAI::Mistral::Chat::Response]
-      def completion(messages, model: Model::MEDIUM, temperature: nil, format: nil, stream: nil)
-        request = OmniAI::Mistral::Chat::Request.new(client: @client, messages:, model:, temperature:, format:, stream:)
-        request.process!
+      JSON_RESPONSE_FORMAT = { type: 'json_object' }.freeze
+
+      protected
+
+      # @return [Hash]
+      def payload
+        OmniAI::Mistral.config.chat_options.merge({
+          messages:,
+          model: @model,
+          stream: @stream.nil? ? nil : !@stream.nil?,
+          temperature: @temperature,
+          response_format: (JSON_RESPONSE_FORMAT if @format.eql?(:json)),
+        }).compact
+      end
+
+      # @return [String]
+      def path
+        "/#{OmniAI::Mistral::Client::VERSION}/chat/completions"
       end
     end
   end

data/lib/omniai/mistral/client.rb

@@ -41,9 +41,17 @@ module OmniAI
         @connection ||= HTTP.auth("Bearer #{api_key}").persistent(@host)
       end
 
-      # @return [OmniAI::Mistral::Chat]
-      def chat
-        Chat.new(client: self)
+      # @raise [OmniAI::Error]
+      #
+      # @param messages [String, Array, Hash]
+      # @param model [String] optional
+      # @param format [Symbol] optional :text or :json
+      # @param temperature [Float, nil] optional
+      # @param stream [Proc, nil] optional
+      #
+      # @return [OmniAI::Chat::Completion]
+      def chat(messages, model: Chat::Model::MEDIUM, temperature: nil, format: nil, stream: nil)
+        Chat.process!(messages, model:, temperature:, format:, stream:, client: self)
       end
     end
   end

data/lib/omniai/mistral/config.rb

@@ -2,12 +2,15 @@
 
 module OmniAI
   module Mistral
-    # Config for the Mistral `api_key` / `host` / `logger`.
+    # Config for the Mistral `api_key` / `host` / `logger`, `chat_options`.
     class Config < OmniAI::Config
+      attr_accessor :chat_options
+
       def initialize
         super
         @api_key = ENV.fetch('MISTRAL_API_KEY', nil)
         @host = ENV.fetch('MISTRAL_HOST', 'https://api.mistral.ai')
+        @chat_options = {}
       end
     end
   end

data/lib/omniai/mistral/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module Mistral
-    VERSION = '0.2.0'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai-mistral
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -63,7 +63,6 @@ files:
 - README.md
 - lib/omniai/mistral.rb
 - lib/omniai/mistral/chat.rb
-- lib/omniai/mistral/chat/request.rb
 - lib/omniai/mistral/client.rb
 - lib/omniai/mistral/config.rb
 - lib/omniai/mistral/version.rb

data/lib/omniai/mistral/chat/request.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  module Mistral
-    class Chat
-      # An implementation of OmniAI::Chat::Request for Mistral.
-      class Request < OmniAI::Chat::Request
-        protected
-
-        # @return [Hash]
-        def payload
-          { messages: }.tap do |payload|
-            payload[:model] = @model
-            payload[:stream] = !@stream.nil? unless @stream.nil?
-            payload[:temperature] = @temperature if @temperature
-            payload[:response_format] = { type: 'json_object' } if @format.eql?(:json)
-          end
-        end
-
-        # @return [Array<Hash>]
-        def messages
-          arrayify(@messages).map do |content|
-            case content
-            when String then { role: OmniAI::Mistral::Chat::Role::USER, content: }
-            when Hash then content
-            else raise Error, "Unsupported content=#{content.inspect}"
-            end
-          end
-        end
-
-        # @return [String]
-        def path
-          "/#{OmniAI::Mistral::Client::VERSION}/chat/completions"
-        end
-
-        private
-
-        # @param value [Object, Array<Object>]
-        # @return [Array<Object>]
-        def arrayify(value)
-          value.is_a?(Array) ? value : [value]
-        end
-      end
-    end
-  end
-end