ollama-ai 1.0.0 → 1.2.0

data/README.md

@@ -1,6 +1,6 @@
 # Ollama AI
 
-A Ruby gem for interacting with [Ollama](https://github.com/jmorganca/ollama)'s API that allows you to run open source AI LLMs (Large Language Models) locally.
+A Ruby gem for interacting with [Ollama](https://ollama.ai)'s API that allows you to run open source AI LLMs (Large Language Models) locally.
 
 ![The image presents a llama's head merged with a red ruby gemstone against a light beige background. The red facets form both the ruby and the contours of the llama, creating a clever visual fusion.](https://raw.githubusercontent.com/gbaptista/assets/main/ollama-ai/ollama-ai-canvas.png)
 
@@ -9,7 +9,7 @@ A Ruby gem for interacting with [Ollama](https://github.com/jmorganca/ollama)'s
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'ollama-ai', '~> 1.0.0'
+gem 'ollama-ai', '~> 1.2.0'
 ```
 
 ```ruby
@@ -21,40 +21,40 @@ client = Ollama.new(
 )
 
 result = client.generate(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     prompt: 'Hi!' }
 )
 ```
 
 Result:
 ```ruby
-[{ 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T16:53:21.357816652Z',
+[{ 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:34:02.088810408Z',
    'response' => 'Hello',
    'done' => false },
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T16:53:21.490053654Z',
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:34:02.419045606Z',
    'response' => '!',
    'done' => false },
- # ...
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T16:53:24.82505599Z',
-   'response' => '.',
+ # ..
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:34:07.680049831Z',
+   'response' => '?',
    'done' => false },
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T16:53:24.956774721Z',
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:34:07.872170352Z',
    'response' => '',
    'done' => true,
    'context' =>
-     [50_296, 10_057,
+     [518, 25_580,
       # ...
-      1037, 13],
-   'total_duration' => 5_702_027_026,
-   'load_duration' => 649_711,
-   'prompt_eval_count' => 25,
-   'prompt_eval_duration' => 2_227_159_000,
-   'eval_count' => 39,
-   'eval_duration' => 3_466_593_000 }]
+      13_563, 29_973],
+   'total_duration' => 11_653_781_127,
+   'load_duration' => 1_186_200_439,
+   'prompt_eval_count' => 22,
+   'prompt_eval_duration' => 5_006_751_000,
+   'eval_count' => 25,
+   'eval_duration' => 5_453_058_000 }]
 ```
 
 ## Index
@@ -62,37 +62,41 @@ Result:
 - [TL;DR and Quick Start](#tldr-and-quick-start)
 - [Index](#index)
 - [Setup](#setup)
-    - [Installing](#installing)
+  - [Installing](#installing)
 - [Usage](#usage)
-    - [Client](#client)
-    - [Methods](#methods)
-        - [generate: Generate a completion](#generate-generate-a-completion)
-            - [Without Streaming Events](#without-streaming-events)
-            - [Receiving Stream Events](#receiving-stream-events)
-        - [chat: Generate a chat completion](#chat-generate-a-chat-completion)
-            - [Back-and-Forth Conversations](#back-and-forth-conversations)
-        - [embeddings: Generate Embeddings](#embeddings-generate-embeddings)
-        - [Models](#models)
-            - [create: Create a Model](#create-create-a-model)
-            - [tags: List Local Models](#tags-list-local-models)
-            - [show: Show Model Information](#show-show-model-information)
-            - [copy: Copy a Model](#copy-copy-a-model)
-            - [delete: Delete a Model](#delete-delete-a-model)
-            - [pull: Pull a Model](#pull-pull-a-model)
-            - [push: Push a Model](#push-push-a-model)
-    - [Streaming and Server-Sent Events (SSE)](#streaming-and-server-sent-events-sse)
-        - [Server-Sent Events (SSE) Hang](#server-sent-events-sse-hang)
-    - [New Functionalities and APIs](#new-functionalities-and-apis)
-    - [Request Options](#request-options)
-        - [Timeout](#timeout)
-    - [Error Handling](#error-handling)
-        - [Rescuing](#rescuing)
-        - [For Short](#for-short)
-        - [Errors](#errors)
+  - [Client](#client)
+  - [Methods](#methods)
+    - [generate: Generate a completion](#generate-generate-a-completion)
+      - [Without Streaming Events](#without-streaming-events)
+      - [Receiving Stream Events](#receiving-stream-events)
+    - [chat: Generate a chat completion](#chat-generate-a-chat-completion)
+      - [Back-and-Forth Conversations](#back-and-forth-conversations)
+    - [embeddings: Generate Embeddings](#embeddings-generate-embeddings)
+    - [Models](#models)
+      - [create: Create a Model](#create-create-a-model)
+      - [tags: List Local Models](#tags-list-local-models)
+      - [show: Show Model Information](#show-show-model-information)
+      - [copy: Copy a Model](#copy-copy-a-model)
+      - [delete: Delete a Model](#delete-delete-a-model)
+      - [pull: Pull a Model](#pull-pull-a-model)
+      - [push: Push a Model](#push-push-a-model)
+  - [Modes](#modes)
+    - [Text](#text)
+    - [Image](#image)
+  - [Streaming and Server-Sent Events (SSE)](#streaming-and-server-sent-events-sse)
+    - [Server-Sent Events (SSE) Hang](#server-sent-events-sse-hang)
+  - [New Functionalities and APIs](#new-functionalities-and-apis)
+  - [Request Options](#request-options)
+    - [Adapter](#adapter)
+    - [Timeout](#timeout)
+  - [Error Handling](#error-handling)
+    - [Rescuing](#rescuing)
+    - [For Short](#for-short)
+    - [Errors](#errors)
 - [Development](#development)
-    - [Purpose](#purpose)
-    - [Publish to RubyGems](#publish-to-rubygems)
-    - [Updating the README](#updating-the-readme)
+  - [Purpose](#purpose)
+  - [Publish to RubyGems](#publish-to-rubygems)
+  - [Updating the README](#updating-the-readme)
 - [Resources and References](#resources-and-references)
 - [Disclaimer](#disclaimer)
 
@@ -101,11 +105,11 @@ Result:
 ### Installing
 
 ```sh
-gem install ollama-ai -v 1.0.0
+gem install ollama-ai -v 1.2.0
 ```
 
 ```sh
-gem 'ollama-ai', '~> 1.0.0'
+gem 'ollama-ai', '~> 1.2.0'
 ```
 
 ## Usage
@@ -148,7 +152,7 @@ API Documentation: https://github.com/jmorganca/ollama/blob/main/docs/api.md#gen
 
 ```ruby
 result = client.generate(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     prompt: 'Hi!',
     stream: false }
 )
@@ -156,21 +160,20 @@ result = client.generate(
 
 Result:
 ```ruby
-[{ 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T17:47:26.443128626Z',
-   'response' =>
-     "Hello! How can I assist you today? Do you have any questions or problems that you'd like help with?",
+[{ 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:35:41.951371247Z',
+   'response' => "Hi there! It's nice to meet you. How are you today?",
    'done' => true,
    'context' =>
-     [50_296, 10_057,
+     [518, 25_580,
       # ...
-      351, 30],
-   'total_duration' => 6_495_278_960,
-   'load_duration' => 1_434_052_851,
-   'prompt_eval_count' => 25,
-   'prompt_eval_duration' => 1_938_861_000,
-   'eval_count' => 23,
-   'eval_duration' => 3_119_030_000 }]
+      9826, 29_973],
+   'total_duration' => 6_981_097_576,
+   'load_duration' => 625_053,
+   'prompt_eval_count' => 22,
+   'prompt_eval_duration' => 4_075_171_000,
+   'eval_count' => 16,
+   'eval_duration' => 2_900_325_000 }]
 ```
 
 ##### Receiving Stream Events
@@ -181,7 +184,7 @@ Ensure that you have enabled [Server-Sent Events](#streaming-and-server-sent-eve
 
 ```ruby
 client.generate(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     prompt: 'Hi!' }
 ) do |event, raw|
   puts event
@@ -190,8 +193,8 @@ end
 
 Event:
 ```ruby
-{ 'model' => 'dolphin-phi',
-  'created_at' => '2024-01-06T17:27:29.366879586Z',
+{ 'model' => 'llama2',
+  'created_at' => '2024-01-07T01:36:30.665245712Z',
   'response' => 'Hello',
   'done' => false }
 ```
@@ -199,46 +202,46 @@ Event:
 You can get all the receive events at once as an array:
 ```ruby
 result = client.generate(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     prompt: 'Hi!' }
 )
 ```
 
 Result:
 ```ruby
-[{ 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T16:53:21.357816652Z',
+[{ 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:36:30.665245712Z',
    'response' => 'Hello',
    'done' => false },
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T16:53:21.490053654Z',
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:36:30.927337136Z',
    'response' => '!',
    'done' => false },
  # ...
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T16:53:24.82505599Z',
-   'response' => '.',
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:36:37.249416767Z',
+   'response' => '?',
    'done' => false },
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T16:53:24.956774721Z',
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:36:37.44041283Z',
    'response' => '',
    'done' => true,
    'context' =>
-     [50_296, 10_057,
+     [518, 25_580,
       # ...
-      1037, 13],
-   'total_duration' => 5_702_027_026,
-   'load_duration' => 649_711,
-   'prompt_eval_count' => 25,
-   'prompt_eval_duration' => 2_227_159_000,
-   'eval_count' => 39,
-   'eval_duration' => 3_466_593_000 }]
+      13_563, 29_973],
+   'total_duration' => 10_551_395_645,
+   'load_duration' => 966_631,
+   'prompt_eval_count' => 22,
+   'prompt_eval_duration' => 4_034_990_000,
+   'eval_count' => 25,
+   'eval_duration' => 6_512_954_000 }]
 ```
 
 You can mix both as well:
 ```ruby
 result = client.generate(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     prompt: 'Hi!' }
 ) do |event, raw|
   puts event
@@ -251,7 +254,7 @@ API Documentation: https://github.com/jmorganca/ollama/blob/main/docs/api.md#gen
 
 ```ruby
 result = client.chat(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     messages: [
       { role: 'user', content: 'Hi! My name is Purple.' }
     ] }
@@ -262,37 +265,37 @@ end
 
 Event:
 ```ruby
-{ 'model' => 'dolphin-phi',
-  'created_at' => '2024-01-06T18:17:22.468231988Z',
-  'message' => { 'role' => 'assistant', 'content' => 'Hello' },
+{ 'model' => 'llama2',
+  'created_at' => '2024-01-07T01:38:01.729897311Z',
+  'message' => { 'role' => 'assistant', 'content' => "\n" },
   'done' => false }
 ```
 
 Result:
 ```ruby
-[{ 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T18:17:22.468231988Z',
-   'message' => { 'role' => 'assistant', 'content' => 'Hello' },
+[{ 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:38:01.729897311Z',
+   'message' => { 'role' => 'assistant', 'content' => "\n" },
    'done' => false },
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T18:17:22.594414415Z',
-   'message' => { 'role' => 'assistant', 'content' => ' Purple' },
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:38:02.081494506Z',
+   'message' => { 'role' => 'assistant', 'content' => '*' },
    'done' => false },
  # ...
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T18:17:25.491597233Z',
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:38:17.855905499Z',
    'message' => { 'role' => 'assistant', 'content' => '?' },
    'done' => false },
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T18:17:25.578463723Z',
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:38:18.07331245Z',
    'message' => { 'role' => 'assistant', 'content' => '' },
    'done' => true,
-   'total_duration' => 5_274_177_696,
-   'load_duration' => 1_565_325,
-   'prompt_eval_count' => 30,
-   'prompt_eval_duration' => 2_284_638_000,
-   'eval_count' => 29,
-   'eval_duration' => 2_983_962_000 }]
+   'total_duration' => 22_494_544_502,
+   'load_duration' => 4_224_600,
+   'prompt_eval_count' => 28,
+   'prompt_eval_duration' => 6_496_583_000,
+   'eval_count' => 61,
+   'eval_duration' => 15_991_728_000 }]
 ```
 
 ##### Back-and-Forth Conversations
@@ -303,11 +306,11 @@ To maintain a back-and-forth conversation, you need to append the received respo
 
 ```ruby
 result = client.chat(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     messages: [
       { role: 'user', content: 'Hi! My name is Purple.' },
       { role: 'assistant',
-        content: "Hi, Purple! It's nice to meet you. I am Dolphin. How can I help you today?" },
+        content: 'Hi, Purple!' },
       { role: 'user', content: "What's my name?" }
     ] }
 ) do |event, raw|
@@ -318,37 +321,41 @@ end
 Event:
 
 ```ruby
-{ 'model' => 'dolphin-phi',
-  'created_at' => '2024-01-06T19:07:51.05465997Z',
-  'message' => { 'role' => 'assistant', 'content' => 'Your' },
+{ 'model' => 'llama2',
+  'created_at' => '2024-01-07T01:40:07.352998498Z',
+  'message' => { 'role' => 'assistant', 'content' => ' Pur' },
   'done' => false }
 ```
 
 Result:
 ```ruby
-[{ 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T19:07:51.05465997Z',
+[{ 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:40:06.562939469Z',
    'message' => { 'role' => 'assistant', 'content' => 'Your' },
    'done' => false },
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T19:07:51.184476541Z',
-   'message' => { 'role' => 'assistant', 'content' => ' name' },
-   'done' => false },
  # ...
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T19:07:56.526297223Z',
-   'message' => { 'role' => 'assistant', 'content' => '.' },
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:40:07.352998498Z',
+   'message' => { 'role' => 'assistant', 'content' => ' Pur' },
+   'done' => false },
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:40:07.545323584Z',
+   'message' => { 'role' => 'assistant', 'content' => 'ple' },
+   'done' => false },
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:40:07.77769408Z',
+   'message' => { 'role' => 'assistant', 'content' => '!' },
    'done' => false },
- { 'model' => 'dolphin-phi',
-   'created_at' => '2024-01-06T19:07:56.667809424Z',
+ { 'model' => 'llama2',
+   'created_at' => '2024-01-07T01:40:07.974165849Z',
    'message' => { 'role' => 'assistant', 'content' => '' },
    'done' => true,
-   'total_duration' => 12_169_557_266,
-   'load_duration' => 4_486_689,
-   'prompt_eval_count' => 95,
-   'prompt_eval_duration' => 6_678_566_000,
-   'eval_count' => 40,
-   'eval_duration' => 5_483_133_000 }]
+   'total_duration' => 11_482_012_681,
+   'load_duration' => 4_246_882,
+   'prompt_eval_count' => 57,
+   'prompt_eval_duration' => 10_387_150_000,
+   'eval_count' => 6,
+   'eval_duration' => 1_089_249_000 }]
 ```
 
 #### embeddings: Generate Embeddings
@@ -357,7 +364,7 @@ API Documentation: https://github.com/jmorganca/ollama/blob/main/docs/api.md#gen
 
 ```ruby
 result = client.embeddings(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     prompt: 'Hi!' }
 )
 ```
@@ -365,11 +372,9 @@ result = client.embeddings(
 Result:
 ```ruby
 [{ 'embedding' =>
-   [1.0372048616409302,
-    1.0635842084884644,
+   [0.6970467567443848, -2.248202085494995,
     # ...
-    -0.5416496396064758,
-    0.051569778472185135] }]
+    -1.5994540452957153, -0.3464218080043793] }]
 ```
 
 #### Models
@@ -381,7 +386,7 @@ API Documentation: https://github.com/jmorganca/ollama/blob/main/docs/api.md#cre
 ```ruby
 result = client.create(
   { name: 'mario',
-    modelfile: "FROM dolphin-phi\nSYSTEM You are mario from Super Mario Bros." }
+    modelfile: "FROM llama2\nSYSTEM You are mario from Super Mario Bros." }
 ) do |event, raw|
   puts event
 end
@@ -422,9 +427,7 @@ client.generate(
 end
 ```
 
-> _Hello! I'm Mario, a character from the popular video game series Super Mario Bros. My goal is to rescue Princess Peach from the evil Bowser and his minions, so we can live happily ever after in the Mushroom Kingdom! 🍄🐥_
-> 
-> _What brings you here? How can I help you on your journey?_
+> _Woah! *adjusts sunglasses* It's-a me, Mario! *winks* You must be a new friend I've-a met here in the Mushroom Kingdom. *tips top hat* What brings you to this neck of the woods? Maybe you're looking for-a some help on your adventure? *nods* Just let me know, and I'll do my best to-a assist ya! 😃_
 
 ##### tags: List Local Models
 
@@ -437,28 +440,28 @@ result = client.tags
 Result:
 ```ruby
 [{ 'models' =>
-   [{ 'name' => 'dolphin-phi:latest',
-      'modified_at' => '2024-01-06T12:20:42.778120982-03:00',
-      'size' => 1_602_473_850,
+   [{ 'name' => 'llama2:latest',
+      'modified_at' => '2024-01-06T15:06:23.6349195-03:00',
+      'size' => 3_826_793_677,
       'digest' =>
-       'c5761fc772409945787240af89a5cce01dd39dc52f1b7b80d080a1163e8dbe10',
+      '78e26419b4469263f75331927a00a0284ef6544c1975b826b15abdaef17bb962',
       'details' =>
-        { 'format' => 'gguf',
-          'family' => 'phi2',
-          'families' => ['phi2'],
-          'parameter_size' => '3B',
-          'quantization_level' => 'Q4_0' } },
+      { 'format' => 'gguf',
+        'family' => 'llama',
+        'families' => ['llama'],
+        'parameter_size' => '7B',
+        'quantization_level' => 'Q4_0' } },
     { 'name' => 'mario:latest',
-      'modified_at' => '2024-01-06T16:19:11.340234644-03:00',
-      'size' => 1_602_473_846,
+      'modified_at' => '2024-01-06T22:41:59.495298101-03:00',
+      'size' => 3_826_793_787,
       'digest' =>
-        '582e668feaba3fcb6add3cee26046a1d6a0c940b86a692ea30d5100aec90135f',
+      '291f46d2fa687dfaff45de96a8cb6e32707bc16ec1e1dfe8d65e9634c34c660c',
       'details' =>
-        { 'format' => 'gguf',
-          'family' => 'phi2',
-          'families' => ['phi2'],
-          'parameter_size' => '3B',
-          'quantization_level' => 'Q4_0' } }] }]
+      { 'format' => 'gguf',
+        'family' => 'llama',
+        'families' => ['llama'],
+        'parameter_size' => '7B',
+        'quantization_level' => 'Q4_0' } }] }]
 ```
 
 ##### show: Show Model Information
@@ -467,35 +470,33 @@ API Documentation: https://github.com/jmorganca/ollama/blob/main/docs/api.md#sho
 
 ```ruby
 result = client.show(
-  { name: 'dolphin-phi' }
+  { name: 'llama2' }
 )
 ```
 
 Result:
 ```ruby
 [{ 'license' =>
-     "MICROSOFT RESEARCH LICENSE TERMS\n" \
+     "LLAMA 2 COMMUNITY LICENSE AGREEMENT\t\n" \
      # ...
-     'It also applies even if Microsoft knew or should have known about the possibility...',
+     "* Reporting violations of the Acceptable Use Policy or unlicensed uses of Llama..." \
+     "\n",
    'modelfile' =>
      "# Modelfile generated by \"ollama show\"\n" \
      # ...
-     'PARAMETER stop "<|im_end|>"',
+     'PARAMETER stop "<</SYS>>"',
    'parameters' =>
-     "stop                           <|im_start|>\n" \
-     'stop                           <|im_end|>',
-   'template' =>
-     "<|im_start|>system\n" \
-     "{{ .System }}<|im_end|>\n" \
-     "<|im_start|>user\n" \
-     "{{ .Prompt }}<|im_end|>\n" \
-     "<|im_start|>assistant\n",
-   'system' => 'You are Dolphin, a helpful AI assistant.',
+     "stop                           [INST]\n" \
+     "stop                           [/INST]\n" \
+     "stop                           <<SYS>>\n" \
+     'stop                           <</SYS>>',
+     'template' =>
+     "[INST] <<SYS>>{{ .System }}<</SYS>>\n\n{{ .Prompt }} [/INST]\n",
    'details' =>
      { 'format' => 'gguf',
-       'family' => 'phi2',
-       'families' => ['phi2'],
-       'parameter_size' => '3B',
+       'family' => 'llama',
+       'families' => ['llama'],
+       'parameter_size' => '7B',
        'quantization_level' => 'Q4_0' } }]
 ```
 
@@ -505,8 +506,8 @@ API Documentation: https://github.com/jmorganca/ollama/blob/main/docs/api.md#cop
 
 ```ruby
 result = client.copy(
-  { source: 'dolphin-phi',
-    destination: 'dolphin-phi-backup' }
+  { source: 'llama2',
+    destination: 'llama2-backup' }
 )
 ```
 
@@ -543,7 +544,7 @@ API Documentation: https://github.com/jmorganca/ollama/blob/main/docs/api.md#del
 
 ```ruby
 result = client.delete(
-  { name: 'dolphin-phi' }
+  { name: 'llama2' }
 )
 ```
 
@@ -556,14 +557,14 @@ If the model does not exist:
 ```ruby
 begin
   result = client.delete(
-    { name: 'dolphin-phi' }
+    { name: 'llama2' }
   )
 rescue Ollama::Errors::OllamaError => error
   puts error.class # Ollama::Errors::RequestError
   puts error.message # 'the server responded with status 404'
 
   puts error.payload
-  # { name: 'dolphin-phi',
+  # { name: 'llama2',
   #   ...
   # }
 
@@ -578,7 +579,7 @@ API Documentation: https://github.com/jmorganca/ollama/blob/main/docs/api.md#pul
 
 ```ruby
 result = client.pull(
-  { name: 'dolphin-phi' }
+  { name: 'llama2' }
 ) do |event, raw|
   puts event
 end
@@ -660,6 +661,69 @@ Result:
  { 'status' => 'success' }]
 ```
 
+### Modes
+
+#### Text
+
+You can use the [generate](#generate-generate-a-completion) or [chat](#chat-generate-a-chat-completion) methods for text.
+
+#### Image
+
+![A black and white image of an old piano. The piano is an upright model, with the keys on the right side of the image. The piano is sitting on a tiled floor. There is a small round object on the top of the piano.](https://raw.githubusercontent.com/gbaptista/assets/main/gemini-ai/piano.jpg)
+
+> _Courtesy of [Unsplash](https://unsplash.com/photos/greyscale-photo-of-grand-piano-czPs0z3-Ggg)_
+
+You need to choose a model that supports images, like [LLaVA](https://ollama.ai/library/llava) or [bakllava](https://ollama.ai/library/bakllava), and encode the image as [Base64](https://en.wikipedia.org/wiki/Base64).
+
+Depending on your hardware, some models that support images can be slow, so you may want to increase the client [timeout](#timeout):
+
+```ruby
+client = Ollama.new(
+  credentials: { address: 'http://localhost:11434' },
+  options: {
+    server_sent_events: true,
+    connection: { request: { timeout: 120, read_timeout: 120 } } }
+)
+```
+
+Using the `generate` method:
+
+```ruby
+require 'base64'
+
+client.generate(
+  { model: 'llava',
+    prompt: 'Please describe this image.',
+    images: [Base64.strict_encode64(File.read('piano.jpg'))] }
+) do |event, raw|
+  print event['response']
+end
+```
+
+Output:
+> _The image is a black and white photo of an old piano, which appears to be in need of maintenance. A chair is situated right next to the piano. Apart from that, there are no other objects or people visible in the scene._
+
+Using the `chat` method:
+```ruby
+require 'base64'
+
+result = client.chat(
+  { model: 'llava',
+    messages: [
+      { role: 'user',
+        content: 'Please describe this image.',
+        images: [Base64.strict_encode64(File.read('piano.jpg'))] }
+    ] }
+) do |event, raw|
+  puts event
+end
+```
+
+Output:
+> _The image displays an old piano, sitting on a wooden floor with black keys. Next to the piano, there is another keyboard in the scene, possibly used for playing music._
+> 
+> _On top of the piano, there are two mice placed in different locations within its frame. These mice might be meant for controlling the music being played or simply as decorative items. The overall atmosphere seems to be focused on artistic expression through this unique instrument._
+
 ### Streaming and Server-Sent Events (SSE)
 
 [Server-Sent Events (SSE)](https://en.wikipedia.org/wiki/Server-sent_events) is a technology that allows certain endpoints to offer streaming capabilities, such as creating the impression that "the model is typing along with you," rather than delivering the entire answer all at once.
@@ -675,7 +739,7 @@ client = Ollama.new(
 Or, you can decide on a request basis:
 ```ruby
 result = client.generate(
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     prompt: 'Hi!' },
   server_sent_events: true
 ) do |event, raw|
@@ -696,7 +760,7 @@ Ollama may launch a new endpoint that we haven't covered in the Gem yet. If that
 ```ruby
 result = client.request(
   'api/generate',
-  { model: 'dolphin-phi',
+  { model: 'llama2',
     prompt: 'Hi!' },
   request_method: 'POST', server_sent_events: true
 )
@@ -704,6 +768,21 @@ result = client.request(
 
 ### Request Options
 
+#### Adapter
+
+The gem uses [Faraday](https://github.com/lostisland/faraday) with the [Typhoeus](https://github.com/typhoeus/typhoeus) adapter by default.
+
+You can use a different adapter if you want:
+
+```ruby
+require 'faraday/net_http'
+
+client = Ollama.new(
+  credentials: { address: 'http://localhost:11434' },
+  options: { connection: { adapter: :net_http } }
+)
+```
+
 #### Timeout
 
 You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
@@ -742,7 +821,7 @@ require 'ollama-ai'
 
 begin
   client.chat_completions(
-    { model: 'dolphin-phi',
+    { model: 'llama2',
       prompt: 'Hi!' }
   )
 rescue Ollama::Errors::OllamaError => error
@@ -750,7 +829,7 @@ rescue Ollama::Errors::OllamaError => error
   puts error.message # 'the server responded with status 500'
 
   puts error.payload
-  # { model: 'dolphin-phi',
+  # { model: 'llama2',
   #   prompt: 'Hi!',
   #   ...
   # }
@@ -767,7 +846,7 @@ require 'ollama-ai/errors'
 
 begin
   client.chat_completions(
-    { model: 'dolphin-phi',
+    { model: 'llama2',
       prompt: 'Hi!' }
   )
 rescue OllamaError => error
@@ -790,6 +869,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -803,7 +884,7 @@ gem build ollama-ai.gemspec
 
 gem signin
 
-gem push ollama-ai-1.0.0.gem
+gem push ollama-ai-1.2.0.gem
 ```
 
 ### Updating the README