Merge pull request #578 from alexrudall/docs/deepseek

Add Deepseek to docs

Author: alexrudall

README.md

@@ -29,6 +29,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
         - [Errors](#errors)
         - [Faraday middleware](#faraday-middleware)
       - [Azure](#azure)
+      - [Deepseek](#deepseek)
       - [Ollama](#ollama)
       - [Groq](#groq)
     - [Counting Tokens](#counting-tokens)
@@ -228,6 +229,28 @@ end
 
 where `AZURE_OPENAI_URI` is e.g. `https://custom-domain.openai.azure.com/openai/deployments/gpt-35-turbo`
 
+#### Deepseek
+
+[Deepseek](https://api-docs.deepseek.com/) is compatible with the OpenAI chat API. Get an access token from [here](https://platform.deepseek.com/api_keys), then:
+
+```ruby
+client = OpenAI::Client.new(
+  access_token: "deepseek_access_token_goes_here",
+  uri_base: "https://api.deepseek.com/"
+)
+
+client.chat(
+  parameters: {
+    model: "deepseek-chat", # Required.
+    messages: [{ role: "user", content: "Hello!"}], # Required.
+    temperature: 0.7,
+    stream: proc do |chunk, _bytesize|
+     print chunk.dig("choices", 0, "delta", "content")
+    end
+  }
+)
+```
+
 #### Ollama
 
 Ollama allows you to run open-source LLMs, such as Llama 3, locally. It [offers chat compatibility](https://github.com/ollama/ollama/blob/main/docs/openai.md) with the OpenAI API.

spec/fixtures/cassettes/deepseek_deepseek-chat_streamed_chat.yml

@@ -185,6 +185,34 @@ def call(chunk)
         end
       end
 
+      context "with Deepseek + model: deepseek-chat" do
+        let(:uri_base) { "https://api.deepseek.com/" }
+        let(:provider) { "deepseek" }
+        let(:model) { "deepseek-chat" }
+        let(:response) do
+          OpenAI::Client.new({ uri_base: uri_base }).chat(
+            parameters: parameters
+          )
+        end
+        let(:chunks) { [] }
+        let(:stream) do
+          proc do |chunk, _bytesize|
+            chunks << chunk
+          end
+        end
+
+        it "succeeds" do
+          VCR.use_cassette(cassette) do
+            tap do
+              response
+            rescue Faraday::UnauthorizedError
+              pending "This test needs the `OPENAI_ACCESS_TOKEN` to be a Deepseek API key"
+            end
+            expect(chunks.dig(0, "choices", 0, "index")).to eq(0)
+          end
+        end
+      end
+
       context "with Groq + model: llama3" do
         let(:uri_base) { "https://api.groq.com/openai" }
         let(:provider) { "groq" }