omniai-deepseek 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b01ec27c812ac1fd9d44619b8bf622b3e2f9f2de08e18ae5b2ecb77f8304146
+  data.tar.gz: 5c64510f011221a229130b58e486e771d10a51aab36f8b80616f38cf1ce4dfa9
+SHA512:
+  metadata.gz: a8c786ce882c8ed8f96227b05cd5def3315f595f73a873f5890224056990a79167ce401bad34d383f25c29953495bbaceb5a06dde137b88c95acaa665a0a9b02
+  data.tar.gz: 894147e0f0b1e0c8aa3c8ad6fb2faece3a9560c04ffa11783182f5b9ff8457eccb37222b6c97c382fe2110f20ed47799e433fc8c863306c7c99c62b9152269dd

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "irb"
+gem "logger"
+gem "rake"
+gem "rspec"
+gem "rspec_junit_formatter"
+gem "rubocop"
+gem "rubocop-basic"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "webmock"
+gem "yard"

data/README.md

@@ -0,0 +1,111 @@
+# OmniAI::DeepSeek
+
+[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/omniai-deepseek/blob/main/LICENSE)
+[![RubyGems](https://img.shields.io/gem/v/omniai-deepseek)](https://rubygems.org/gems/omniai-deepseek)
+[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/omniai-deepseek)
+[![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://omniai-deepseek.ksylvest.com)
+[![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/omniai-deepseek)](https://circleci.com/gh/ksylvest/omniai-deepseek)
+
+An DeepSeek implementation of the [OmniAI](https://github.com/ksylvest/omniai) interface for [deepseek](https://www.deepseek.com/).
+
+## Installation
+
+```sh
+gem install omniai-deepseek
+```
+
+## Usage
+
+### Client
+
+A client is setup as follows if `ENV['DEEPSEEK_API_KEY']` exists:
+
+```ruby
+client = OmniAI::DeepSeek::Client.new
+```
+
+A client may also be passed the following options:
+
+- `api_key` (required - default is `ENV['DEEPSEEK_API_KEY']`)
+- `host` (optional)
+
+### Configuration
+
+Global configuration is supported for the following options:
+
+```ruby
+OmniAI::DeepSeek.configure do |config|
+  config.api_key = 'sk-...' # default: ENV['DEEPSEEK_API_KEY']
+  config.host = '...' # default: 'https://api.deepseek.com'
+end
+```
+
+### Chat
+
+A chat completion is generated by passing in a simple text prompt:
+
+```ruby
+completion = client.chat('Tell me a joke!')
+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.content # 'The capital of Canada is Ottawa.'
+```
+
+#### Model
+
+`model` takes an optional string (default is `gpt-4o`):
+
+```ruby
+completion = client.chat('How fast is a cheetah?', model: OmniAI::DeepSeek::Chat::Model::REASONER)
+completion.content # 'A cheetah can reach speeds over 100 km/h.'
+```
+
+[DeepSeek API Reference `model`](https://api-docs.deepseek.com/quick_start/pricing)
+
+#### Temperature
+
+`temperature` takes an optional float between `0.0` and `2.0` (defaults is `0.7`):
+
+```ruby
+completion = client.chat('Pick a number between 1 and 5', temperature: 2.0)
+completion.content # '3'
+```
+
+[DeepSeek API Reference `temperature`](https://api-docs.deepseek.com/quick_start/parameter_settings)
+
+#### Stream
+
+`stream` takes an optional a proc to stream responses in real-time chunks instead of waiting for a complete response:
+
+```ruby
+stream = proc do |chunk|
+  print(chunk.content) # 'Better', 'three', 'hours', ...
+end
+client.chat('Be poetic.', stream:)
+```
+
+[DeepSeek API Reference `stream`](https://platform.deepseek.com/docs/api-reference/chat/create#chat-create-stream)
+
+#### Format
+
+`format` takes an optional symbol (`:json`) and that setes the `response_format` to `json_object`:
+
+```ruby
+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.content) # { "name": "Ringo" }
+```
+
+[DeepSeek API Reference `response_format`](https://platform.deepseek.com/docs/api-reference/chat/create#chat-create-stream)
+
+> When using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message.

data/lib/omniai/deepseek/chat.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module DeepSeek
+    # An DeepSeek chat implementation.
+    #
+    # Usage:
+    #
+    #   completion = OmniAI::DeepSeek::Chat.process!(client: client) do |prompt|
+    #     prompt.system('You are an expert in the field of AI.')
+    #     prompt.user('What are the biggest risks of AI?')
+    #   end
+    #   completion.choice.message.content # '...'
+    class Chat < OmniAI::Chat
+      JSON_RESPONSE_FORMAT = { type: "json_object" }.freeze
+
+      module Model
+        CHAT = "deepseek-chat"
+        REASONER = "deepseek-reasoner"
+      end
+
+      DEFAULT_MODEL = Model::CHAT
+
+    protected
+
+      # @return [Hash]
+      def payload
+        OmniAI::DeepSeek.config.chat_options.merge({
+          messages: @prompt.serialize,
+          model: @model,
+          stream: @stream.nil? ? nil : !@stream.nil?,
+          temperature: @temperature,
+          response_format: (JSON_RESPONSE_FORMAT if @format.eql?(:json)),
+          tools: (@tools.map(&:serialize) if @tools&.any?),
+        }).compact
+      end
+
+      # @return [String]
+      def path
+        "/chat/completions"
+      end
+    end
+  end
+end

data/lib/omniai/deepseek/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module DeepSeek
+    # An DeepSeek client implementation. Usage:
+    #
+    # w/ `api_key``:
+    #   client = OmniAI::DeepSeek::Client.new(api_key: '...')
+    #
+    # w/ ENV['DEEPSEEK_API_KEY']:
+    #
+    #   ENV['DEEPSEEK_API_KEY'] = '...'
+    #   client = OmniAI::DeepSeek::Client.new
+    #
+    # w/ config:
+    #
+    #   OmniAI::DeepSeek.configure do |config|
+    #     config.api_key = '...'
+    #   end
+    #
+    #   client = OmniAI::DeepSeek::Client.new
+    class Client < OmniAI::Client
+      # @param api_key [String, nil] optional - defaults to `OmniAI::DeepSeek.config.api_key`
+      # @param host [String] optional - defaults to `OmniAI::DeepSeek.config.host`
+      # @param logger [Logger, nil] optional - defaults to `OmniAI::DeepSeek.config.logger`
+      # @param timeout [Integer, nil] optional - defaults to `OmniAI::DeepSeek.config.timeout`
+      def initialize(
+        api_key: OmniAI::DeepSeek.config.api_key,
+        host: OmniAI::DeepSeek.config.host,
+        logger: OmniAI::DeepSeek.config.logger,
+        timeout: OmniAI::DeepSeek.config.timeout
+      )
+        super
+      end
+
+      # @return [HTTP::Client]
+      def connection
+        @connection ||= begin
+          http = super
+          http = http.auth("Bearer #{@api_key}") if @api_key
+          http
+        end
+      end
+
+      # @raise [OmniAI::Error]
+      #
+      # @param messages [String] optional
+      # @param model [String] optional
+      # @param format [Symbol] optional :text or :json
+      # @param temperature [Float, nil] optional
+      # @param stream [Proc, nil] optional
+      # @param tools [Array<OmniAI::Tool>, nil] optional
+      #
+      # @yield [prompt]
+      # @yieldparam prompt [OmniAI::Chat::Prompt]
+      #
+      # @return [OmniAI::Chat::Completion]
+      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
+    end
+  end
+end

data/lib/omniai/deepseek/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module DeepSeek
+    # Configuration for DeepSeek.
+    class Config < OmniAI::Config
+      DEFAULT_HOST = "https://api.deepseek.com"
+
+      # @param api_key [String, nil] optional - defaults to `ENV['DEEPSEEK_API_KEY']`
+      # @param host [String, nil] optional - defaults to ENV['DEEPSEEK_HOST'] w/ fallback to `DEFAULT_HOST`
+      # @param logger [Logger, nil] optional
+      # @param timeout [Integer, Hash, nil] optional
+      def initialize(
+        api_key: ENV.fetch("DEEPSEEK_API_KEY", nil),
+        host: ENV.fetch("DEEPSEEK_HOST", DEFAULT_HOST),
+        logger: nil,
+        timeout: nil
+      )
+        super
+      end
+    end
+  end
+end

data/lib/omniai/deepseek/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module DeepSeek
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniai/deepseek.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "event_stream_parser"
+require "omniai"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.push_dir(__dir__, namespace: OmniAI)
+loader.inflector.inflect "deepseek" => "DeepSeek"
+loader.setup
+
+module OmniAI
+  # A namespace for everything DeepSeek.
+  module DeepSeek
+    # @return [OmniAI::DeepSeek::Config]
+    def self.config
+      @config ||= Config.new
+    end
+
+    # @yield [OmniAI::DeepSeek::Config]
+    def self.configure
+      yield config
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: omniai-deepseek
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Sylvestre
+bindir: exe
+cert_chain: []
+date: 2025-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: event_stream_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An implementation of OmniAI for DeepSeek
+email:
+- kevin@ksylvest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/omniai/deepseek.rb
+- lib/omniai/deepseek/chat.rb
+- lib/omniai/deepseek/client.rb
+- lib/omniai/deepseek/config.rb
+- lib/omniai/deepseek/version.rb
+homepage: https://github.com/ksylvest/omniai-deepseek
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ksylvest/omniai-deepseek
+  changelog_uri: https://github.com/ksylvest/omniai-deepseek/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A generalized framework for interacting with DeepSeek
+test_files: []