1452: Added message classes

src/Client/Ollama.php

@@ -7,7 +7,7 @@
 /**
  * Client to communicate with Ollama.
  */
-class Ollama {
+readonly class Ollama {
 
   /**
    * Default constructor.
@@ -18,8 +18,8 @@ class Ollama {
    *   The port that Ollama is listing on.
    */
   public function __construct(
-    private readonly string $url,
-    private readonly int $port,
+    private string $url,
+    private int $port,
   ) {
   }
 
@@ -49,6 +49,19 @@ public function listLocalModels(): array {
     return $models;
   }
 
+  /**
+   * Install/update model in Ollama.
+   *
+   * @param string $modelName
+   *   Name of the model
+   *
+   * @return string
+   *
+   * @see https://ollama.com/library
+   *
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   * @throws \JsonException
+   */
   public function install(string $modelName): string {
     $this->call(method: 'post', uri: '/api/pull', options: [
       'json' => [
@@ -62,7 +75,8 @@ public function install(string $modelName): string {
       RequestOptions::TIMEOUT => 300,
     ]);
 
-    return 'dfs';
+    // @todo: change to stream and return status.
+    return '';
   }
 
   /**

src/Model/ChatMessage.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Drupal\llm_services\Model;
+
+class ChatMessage {
+
+  /**
+   * The role of this message.
+   *
+   * @var \Drupal\llm_services\Model\MessageRoles
+   */
+  public MessageRoles $role;
+
+  /**
+   * The message content.
+   *
+   * @var string
+   */
+  public string $content;
+
+  /**
+   * Images base64 encoded.
+   *
+   * Used for multimodal models such as llava. Which can describe the content of
+   * the image.
+   *
+   * @var array<string>
+   */
+  public array $images;
+}

src/Model/Message.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Drupal\llm_services\Model;
+
+class Message {
+
+  /**
+   * Name of the model to use.
+   *
+   * @var string
+   */
+  public string $model;
+
+  /**
+   * Message(s) to send
+   *
+   * @see https://github.com/ollama/ollama/blob/main/docs/api.md#parameters-1
+   *
+   * @var array<\Drupal\llm_services\Model\ChatMessage>
+   */
+  public array $messages;
+
+  /**
+   * Additional model parameters.
+   *
+   * @see https://github.com/ollama/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values
+   *
+   * @var array<string, string>
+   */
+  public array $options;
+}

src/Model/MessageRoles.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Drupal\llm_services\Model;
+
+enum MessageRoles: string {
+    case Assistant = 'assistant';
+    case System = "system";
+    case User = 'user';
+}