Class: OmniAI::Mistral::Client

Inherits:
Client
  • Object
show all
Defined in:
lib/omniai/mistral/client.rb

Overview

An Mistral client implementation. Usage:

w/ ‘api_key“:

client = OmniAI::Mistral::Client.new(api_key: '...')

w/ ENV:

ENV['MISTRAL_API_KEY'] = '...'
client = OmniAI::Mistral::Client.new

w/ config:

OmniAI::Mistral.configure do |config|
  config.api_key = '...'
end

client = OmniAI::Mistral::Client.new

Constant Summary collapse

VERSION = 
'v1'

Instance Method Summary collapse

Constructor Details

#initialize(api_key: OmniAI::Mistral.config.api_key, host: OmniAI::Mistral.config.host, logger: OmniAI::Mistral.config.logger, timeout: OmniAI::Mistral.config.timeout) ⇒ Client

Returns a new instance of Client.

Parameters:

  • api_key (String) (defaults to: OmniAI::Mistral.config.api_key) —

    optional - defaults to ‘OmniAI::Mistral.config.api_key`

  • host (String) (defaults to: OmniAI::Mistral.config.host) —

    optional - defaults to ‘OmniAI::Mistral.config.host`

  • logger (Logger) (defaults to: OmniAI::Mistral.config.logger) —

    optional - defaults to ‘OmniAI::Mistral.config.logger`

  • timeout (Integer) (defaults to: OmniAI::Mistral.config.timeout) —

    optional - defaults to ‘OmniAI::Mistral.config.timeout`

Raises:

  • (ArgumentError) 


29
30
31
32
33
34
35
36
37
38
 
# File 'lib/omniai/mistral/client.rb', line 29

def initialize(
  api_key: OmniAI::Mistral.config.api_key,
  host: OmniAI::Mistral.config.host,
  logger: OmniAI::Mistral.config.logger,
  timeout: OmniAI::Mistral.config.timeout
)
  raise(ArgumentError, %(ENV['MISTRAL_API_KEY'] must be defined or `api_key` must be passed)) if api_key.nil?

  super
end

Instance Method Details

#chat(messages = nil, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil) {|prompt| ... } ⇒ OmniAI::Chat::Completion

Parameters:

  • messages (String) (defaults to: nil) —

    optional

  • model (String) (defaults to: Chat::DEFAULT_MODEL) —

    optional

  • format (Symbol) (defaults to: nil) —

    optional :text or :json

  • temperature (Float, nil) (defaults to: nil) —

    optional

  • stream (Proc, nil) (defaults to: nil) —

    optional

  • tools (Array<OmniAI::Tool>, nil) (defaults to: nil) —

    optional

Yields:

  • (prompt) —

    optional

Yield Parameters:

  • prompt (OmniAI::Chat::Prompt)

Returns:

  • (OmniAI::Chat::Completion)

Raises:

  • (OmniAI::Error) 


58
59
60
 
# File 'lib/omniai/mistral/client.rb', line 58

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

#connection ⇒ HTTP::Client

Returns:

  • (HTTP::Client) 


41
42
43
 
# File 'lib/omniai/mistral/client.rb', line 41

def connection
  @connection ||= super.auth("Bearer #{api_key}")
end

#embed(input, model: Embed::DEFAULT_MODEL) ⇒ Object

Parameters:

  • input (String, Array<String>, Array<Integer>) —

    required

  • model (String) (defaults to: Embed::DEFAULT_MODEL) —

    optional

Raises:

  • (OmniAI::Error) 


66
67
68
 
# File 'lib/omniai/mistral/client.rb', line 66

def embed(input, model: Embed::DEFAULT_MODEL)
  Embed.process!(input, model:, client: self)
end