omniai-mistral 1.6.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06a0ef7934fc23948925d5c35b75898df7148f162564db8a59fffa9106efa8d8
-  data.tar.gz: 22edea50f3d9a71b3ef659fd731078730adec47cc46190208fe30022a37a9d2e
+  metadata.gz: ed42e145797e63aa3725225494e85cbf842e5ee7720e0b703ae5d129e63d6312
+  data.tar.gz: a1169acf35660a06119ff591704ca6da9f94f25675dc97c2e5d26cb6060ddb71
 SHA512:
-  metadata.gz: 506d07b0b05993c88c540778d3116f608dc3740726e6f0453a72ac444c8b9139c2020476fc3c1627f581a8fcb83e4c11113048b58feda99381f6480b56f1eaed
-  data.tar.gz: 0e8dae928a6d2d64ac459ce48d370bc866516f133fc8e60d14a581deb62ff6761cb3480a294ee8c5afb95a675d9ebc0e4887ec5683f8a80872f9bb8afcfd8447
+  metadata.gz: 04373ce5f992a56861931f2a1d1658d4e2e53b9f26706b1d32a19b25773c0a78659ba2f349723eb5e21bb099652874f84939146a227fe906de953b4014a4bcef
+  data.tar.gz: 06b52cea6dd021cc9c7ffb2cac03eca346f78e81f54eff8d63b059bc9f6c6eba7eea45a3216ec4d7e42ad72dcf1f0b442dfc0cfc91cb3cf2590322acde55196d

data/README.md

@@ -42,7 +42,7 @@ A chat completion is generated by passing in prompts using any a variety of form
 
 ```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.text # 'Why did the chicken cross the road? To get to the other side.'
 ```
 
 ```ruby
@@ -50,7 +50,7 @@ completion = client.chat do |prompt|
   prompt.system('You are a helpful assistant.')
   prompt.user('What is the capital of Canada?')
 end
-completion.choice.message.content # 'The capital of Canada is Ottawa.'
+completion.text # 'The capital of Canada is Ottawa.'
 ```
 
 #### Model
@@ -59,7 +59,7 @@ completion.choice.message.content # 'The capital of Canada is Ottawa.'
 
 ```ruby
 completion = client.chat('Provide code for fibonacci', model: OmniAI::Mistral::Chat::Model::CODESTRAL)
-completion.choice.message.content # 'def fibonacci(n)...end'
+completion.text # 'def fibonacci(n)...end'
 ```
 
 [Mistral API Reference `model`](https://docs.mistral.ai/getting-started/models/)
@@ -70,7 +70,7 @@ completion.choice.message.content # 'def fibonacci(n)...end'
 
 ```ruby
 completion = client.chat('Pick a number between 1 and 5', temperature: 1.0)
-completion.choice.message.content # '3'
+completion.text # '3'
 ```
 
 [Mistral API Reference `temperature`](https://docs.mistral.ai/api/)
@@ -81,7 +81,7 @@ completion.choice.message.content # '3'
 
 ```ruby
 stream = proc do |chunk|
-  print(chunk.choice.delta.content) # 'Better', 'three', 'hours', ...
+  print(chunk.text) # 'Better', 'three', 'hours', ...
 end
 client.chat('Be poetic.', stream:)
 ```
@@ -97,9 +97,18 @@ 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.text) # { "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.
+
+### Embed
+
+Text can be converted into a vector embedding for similarity comparison usage via:
+
+```ruby
+response = client.embed('The quick brown fox jumps over a lazy dog.')
+response.embedding # [0.0, ...]
+```

data/lib/omniai/mistral/chat.rb

@@ -19,7 +19,7 @@ module OmniAI
         CODESTRAL = 'codestral-latest'
       end
 
-      DEFAULT_MODEL = Model::MEDIUM
+      DEFAULT_MODEL = Model::LARGE
 
       module Role
         ASSISTANT = 'assistant'
@@ -39,7 +39,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/mistral/client.rb

@@ -58,6 +58,14 @@ module OmniAI
       def chat(messages = nil, 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]
+      #
+      # @param input [String, Array<String>, Array<Integer>] required
+      # @param model [String] optional
+      def embed(input, model: Embed::DEFAULT_MODEL)
+        Embed.process!(input, model:, client: self)
+      end
     end
   end
 end

data/lib/omniai/mistral/embed.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Mistral
+    # An Mistral embed implementation.
+    #
+    # Usage:
+    #
+    #   input = "..."
+    #   response = OmniAI::Mistral::Embed.process!(input, client: client)
+    #   response.embedding [0.0, ...]
+    class Embed < OmniAI::Embed
+      module Model
+        EMBED = 'mistral-embed'
+      end
+
+      DEFAULT_MODEL = Model::EMBED
+
+      protected
+
+      # @return [Hash]
+      def payload
+        { model: @model, input: arrayify(@input) }
+      end
+
+      # @return [String]
+      def path
+        "/#{OmniAI::Mistral::Client::VERSION}/embeddings"
+      end
+
+      # @param [Object] value
+      # @return [Array]
+      def arrayify(value)
+        value.is_a?(Array) ? value : [value]
+      end
+    end
+  end
+end

data/lib/omniai/mistral/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module Mistral
-    VERSION = '1.6.2'
+    VERSION = '1.8.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-mistral
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -65,6 +65,7 @@ files:
 - lib/omniai/mistral/chat.rb
 - lib/omniai/mistral/client.rb
 - lib/omniai/mistral/config.rb
+- lib/omniai/mistral/embed.rb
 - lib/omniai/mistral/version.rb
 homepage: https://github.com/ksylvest/omniai-mistral
 licenses: