Javadoc improvements

StefanBratanov · Jan 5, 2024 · 27ed732 · 27ed732
1 parent 518242d
commit 27ed732
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/src/main/java/io/github/stefanbratanov/chatjpt/ChatResponse.java b/src/main/java/io/github/stefanbratanov/chatjpt/ChatResponse.java
@@ -2,6 +2,7 @@
 
 import java.util.List;
 
+/** Represents a chat completion response returned by model, based on the provided input. */
 public record ChatResponse(
     String id,
     long created,

diff --git a/src/main/java/io/github/stefanbratanov/chatjpt/Embeddings.java b/src/main/java/io/github/stefanbratanov/chatjpt/Embeddings.java
@@ -4,6 +4,7 @@
 
 public record Embeddings(List<Embedding> data, String model, Usage usage) {
 
+  /** Represents an embedding vector returned by embedding endpoint. */
   public record Embedding(int index, List<Double> embedding) {}
 
   public record Usage(int promptTokens, int totalTokens) {}

diff --git a/src/main/java/io/github/stefanbratanov/chatjpt/FineTuningJob.java b/src/main/java/io/github/stefanbratanov/chatjpt/FineTuningJob.java
@@ -2,6 +2,9 @@
 
 import java.util.List;
 
+/**
+ * The fine_tuning.job object represents a fine-tuning job that has been created through the API.
+ */
 public record FineTuningJob(
     String id,
     long createdAt,

diff --git a/src/main/java/io/github/stefanbratanov/chatjpt/Moderation.java b/src/main/java/io/github/stefanbratanov/chatjpt/Moderation.java
@@ -3,6 +3,9 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import java.util.List;
 
+/**
+ * Represents policy compliance report by OpenAI's content moderation model against a given input.
+ */
 public record Moderation(String id, String model, List<Result> results) {
 
   public record Result(boolean flagged, Categories categories, CategoryScores categoryScores) {