From 65f00defcf61b4234c19891fce1a10f4026346ec Mon Sep 17 00:00:00 2001
From: Amith Koujalgi <amith.koujalgi@razorthink.com>
Date: Mon, 12 Feb 2024 22:03:01 +0530
Subject: [PATCH] Updates to javadoc

---
 .../ollama4j/core/OllamaAPI.java              |  4 +--
 .../core/models/chat/OllamaChatMessage.java   |  7 ++---
 .../models/chat/OllamaChatRequestModel.java   | 29 +++++++++----------
 3 files changed, 19 insertions(+), 21 deletions(-)

diff --git a/src/main/java/io/github/amithkoujalgi/ollama4j/core/OllamaAPI.java b/src/main/java/io/github/amithkoujalgi/ollama4j/core/OllamaAPI.java
index a0212d7..4661653 100644
--- a/src/main/java/io/github/amithkoujalgi/ollama4j/core/OllamaAPI.java
+++ b/src/main/java/io/github/amithkoujalgi/ollama4j/core/OllamaAPI.java
@@ -3,9 +3,9 @@ package io.github.amithkoujalgi.ollama4j.core;
 import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
 import io.github.amithkoujalgi.ollama4j.core.models.*;
 import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatMessage;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestBuilder;
 import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestModel;
 import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatResult;
-import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestBuilder;
 import io.github.amithkoujalgi.ollama4j.core.models.request.CustomModelFileContentsRequest;
 import io.github.amithkoujalgi.ollama4j.core.models.request.CustomModelFilePathRequest;
 import io.github.amithkoujalgi.ollama4j.core.models.request.ModelEmbeddingsRequest;
@@ -441,7 +441,7 @@ public class OllamaAPI {
   /**
    * Ask a question to a model using an {@link OllamaChatRequestModel}. This can be constructed using an {@link OllamaChatRequestBuilder}. 
    * 
-   * Hint: the {@link OllamaChatRequestModel#getStream()} property is not implemented
+   * Hint: the OllamaChatRequestModel#getStream() property is not implemented.
    * 
    * @param request request object to be sent to the server
    * @return 
diff --git a/src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatMessage.java b/src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatMessage.java
index b877ddf..f8cca73 100644
--- a/src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatMessage.java
+++ b/src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatMessage.java
@@ -1,11 +1,10 @@
 package io.github.amithkoujalgi.ollama4j.core.models.chat;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
 import static io.github.amithkoujalgi.ollama4j.core.utils.Utils.getObjectMapper;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
 import java.io.File;
 import java.util.List;
-
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -14,8 +13,8 @@ import lombok.RequiredArgsConstructor;
 
 /**
  * Defines a single Message to be used inside a chat request against the ollama /api/chat endpoint.
- * 
- * @see https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion
+ *
+ * @see <a href="https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion">Generate chat completion</a>
  */
 @Data
 @AllArgsConstructor
diff --git a/src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatRequestModel.java b/src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatRequestModel.java
index 516e00b..2f947a2 100644
--- a/src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatRequestModel.java
+++ b/src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatRequestModel.java
@@ -16,27 +16,27 @@ import lombok.RequiredArgsConstructor;
 
 /**
  * Defines a Request to use against the ollama /api/chat endpoint.
- * 
- * @see https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion
+ *
+ * @see <a
+ *     href="https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion">Generate
+ *     Chat Completion</a>
  */
 @Data
 @AllArgsConstructor
 @RequiredArgsConstructor
-public class OllamaChatRequestModel implements OllamaRequestBody{
+public class OllamaChatRequestModel implements OllamaRequestBody {
 
-    @NonNull
-    private String model;
+  @NonNull private String model;
 
-    @NonNull
-    private List<OllamaChatMessage> messages;
+  @NonNull private List<OllamaChatMessage> messages;
 
-    private String format;
-    private Options options;
-    private String template;
-    private boolean stream;
-    private String keepAlive;
+  private String format;
+  private Options options;
+  private String template;
+  private boolean stream;
+  private String keepAlive;
 
-      @Override
+  @Override
   public String toString() {
     try {
       return getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
@@ -44,5 +44,4 @@ public class OllamaChatRequestModel implements OllamaRequestBody{
       throw new RuntimeException(e);
     }
   }
-
-}
\ No newline at end of file
+}