omniai-mistral 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ab0ad2db899898af639d14d319f8de978b4056cddc0b4015fd65663d50e343f
-  data.tar.gz: 8a3843dbb174c054b26a98a657b0dba537cd77f4dba1dca1baac8d3080b756e7
+  metadata.gz: d6fdad55d7cfc5b9d1845a8ec2d64772e2af5cc3d74d31b3d746732bc7509b15
+  data.tar.gz: d31338fb81948d32cb0937a5d206bd9393a92c4fb43523477a1508941e7f2c09
 SHA512:
-  metadata.gz: 2051bf93aac8437af6805882eb9f9d514ba4af1826b8a09234b1b1e67747ba86ae477600e646dd4d63472d464c6b430ee574d95d664c3b11fce891e3848cb33d
-  data.tar.gz: ca1433a9f56e7b859f90e37649d4c1096d790cfe40a112061b26e5ae4d6d532a15395c7f1b93fd60745db95ecd68ca0aaf449b75d154bc597082788e6cd7f078
+  metadata.gz: 2282359b0e6fcd610c1d73b7b9a236371196014458aea74585231de83a3697194879d3917b9f64b8ed5c7fabaab3a9a5f1405b849a5e891e55f7308a8143f2b4
+  data.tar.gz: 5358665adf78efed8c92f9e52f3b2854cd23fe6f82598c2639b25b707252906c798bf46250e6f6ec7d1b2c6d39822439497216063f6e398f22470d16c5c088e9

data/README.md

@@ -103,3 +103,12 @@ 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.
+
+### 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,6 +19,8 @@ module OmniAI
         CODESTRAL = 'codestral-latest'
       end
 
+      DEFAULT_MODEL = Model::MEDIUM
+
       module Role
         ASSISTANT = 'assistant'
         USER = 'user'

data/lib/omniai/mistral/client.rb

@@ -44,7 +44,7 @@ module OmniAI
 
       # @raise [OmniAI::Error]
       #
-      # @param messages [String, Array, Hash]
+      # @param messages [String] optional
       # @param model [String] optional
       # @param format [Symbol] optional :text or :json
       # @param temperature [Float, nil] optional
@@ -55,9 +55,17 @@ module OmniAI
       # @yieldparam prompt [OmniAI::Chat::Prompt]
       #
       # @return [OmniAI::Chat::Completion]
-      def chat(messages, model: Chat::Model::MEDIUM, temperature: nil, format: nil, stream: nil, tools: nil, &)
+      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.1'
+    VERSION = '1.7.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-mistral
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-08-02 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: