Rename chatjpt to jvm-openai

README.md

@@ -1,11 +1,11 @@
-# ChatJPT
+# jvm-openai
 
-[![build](https://github.com/StefanBratanov/chatjpt/actions/workflows/build.yml/badge.svg)](https://github.com/StefanBratanov/chatjpt/actions/workflows/build.yml)
-[![Maven Central](https://img.shields.io/maven-central/v/io.github.stefanbratanov/chatjpt)](https://central.sonatype.com/artifact/io.github.stefanbratanov/chatjpt)
-[![javadoc](https://javadoc.io/badge2/io.github.stefanbratanov/chatjpt/javadoc.svg)](https://javadoc.io/doc/io.github.stefanbratanov/chatjpt)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=StefanBratanov_chatjpt&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=StefanBratanov_chatjpt)
+[![build](https://github.com/StefanBratanov/jvm-openai/actions/workflows/build.yml/badge.svg)](https://github.com/StefanBratanov/jvm-openai/actions/workflows/build.yml)
+[![Maven Central](https://img.shields.io/maven-central/v/io.github.stefanbratanov/jvm-openai)](https://central.sonatype.com/artifact/io.github.stefanbratanov/jvm-openai)
+[![javadoc](https://javadoc.io/badge2/io.github.stefanbratanov/jvm-openai/javadoc.svg)](https://javadoc.io/doc/io.github.stefanbratanov/jvm-openai)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=StefanBratanov_jvm-openai&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=StefanBratanov_jvm-openai)
 
-A minimalistic unofficial Java client for the [OpenAI API](https://platform.openai.com/docs/api-reference)
+A minimalistic unofficial JVM client for the [OpenAI API](https://platform.openai.com/docs/api-reference) written in Java
 
 ## Add dependency
 
@@ -14,34 +14,34 @@ Java 17+ is a prerequisite
 #### Gradle
 
 ```groovy
-implementation("io.github.stefanbratanov:chatjpt:${version}")
+implementation("io.github.stefanbratanov:jvm-openai:${version}")
 ```
 
 #### Maven
-
+F
 ```xml
 
 <dependency>
     <groupId>io.github.stefanbratanov</groupId>
-    <artifactId>chatjpt</artifactId>
+    <artifactId>jvm-openai</artifactId>
     <version>${version}</version>
 </dependency>
 ```
 
 ## Minimal sample
 
 ```java
-ChatJPT chatJPT = ChatJPT.newBuilder(System.getenv("OPENAI_API_KEY")).build();
+OpenAI openAI = OpenAI.newBuilder(System.getenv("OPENAI_API_KEY")).build();
 
-ChatClient chatClient = chatJPT.chatClient();
+ChatClient chatClient = openAI.chatClient();
 ChatRequest chatRequest = ChatRequest.newBuilder()
         .model("gpt-3.5-turbo")
         .message(ChatMessage.userMessage("Who won the world series in 2020?"))
         .build();
 ChatResponse response = chatClient.sendRequest(chatRequest);
 // ChatResponse[id=chatcmpl-123, created=1703506594, model=gpt-3.5-turbo-0613, systemFingerprint=fp_44709d6fcb, choices=[Choice[index=0, message=Message[content=The Los Angeles Dodgers won the World Series in 2020., toolCalls=null, role=assistant], logProbs=null, finishReason=stop]], usage=Usage[promptTokens=17, completionTokens=13, totalTokens=30]]
 
-ImagesClient imagesClient = chatJPT.imagesClient();
+ImagesClient imagesClient = openAI.imagesClient();
 CreateImageRequest createImageRequest = CreateImageRequest.newBuilder()
         .model("dall-e-3")
         .prompt("A cute baby sea otter")

build.gradle

@@ -49,9 +49,9 @@ publishing {
             from components.java
 
             pom {
-                name = "ChatJPT"
-                description = "A minimalistic Java client for the OpenAI API"
-                url = "https://github.com/StefanBratanov/chatjpt"
+                name = "jvm-openai"
+                description = "A minimalistic JVM client for the OpenAI API written in Java"
+                url = "https://github.com/StefanBratanov/jvm-openai"
                 licenses {
                     license {
                         name = "The Apache License, Version 2.0"
@@ -66,9 +66,9 @@ publishing {
                     }
                 }
                 scm {
-                    connection = "scm:git:git://github.com/StefanBratanov/chatjpt.git"
-                    developerConnection = "scm:git:ssh://github.com/StefanBratanov/chatjpt.git"
-                    url = "https://github.com/StefanBratanov/chatjpt"
+                    connection = "scm:git:git://github.com/StefanBratanov/jvm-openai.git"
+                    developerConnection = "scm:git:ssh://github.com/StefanBratanov/jvm-openai.git"
+                    url = "https://github.com/StefanBratanov/jvm-openai"
                 }
             }
         }

settings.gradle

@@ -1,2 +1,2 @@
-rootProject.name = "chatjpt"
+rootProject.name = "jvm-openai"
 

src/main/java/io/github/stefanbratanov/chatjpt/Assistant.java → src/main/java/io/github/stefanbratanov/jvm/openai/Assistant.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 import java.util.Map;

src/main/java/io/github/stefanbratanov/chatjpt/AssistantFile.java → src/main/java/io/github/stefanbratanov/jvm/openai/AssistantFile.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 /** A list of Files attached to an assistant. */
 public record AssistantFile(String id, long createdAt, String assistantId) {}

src/main/java/io/github/stefanbratanov/chatjpt/AssistantsClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/AssistantsClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/AudioClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/AudioClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.IOException;

src/main/java/io/github/stefanbratanov/chatjpt/ChatChunkResponse.java → src/main/java/io/github/stefanbratanov/jvm/openai/ChatChunkResponse.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 

src/main/java/io/github/stefanbratanov/chatjpt/ChatClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/ChatClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/ChatMessage.java → src/main/java/io/github/stefanbratanov/jvm/openai/ChatMessage.java

@@ -1,9 +1,9 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
-import io.github.stefanbratanov.chatjpt.ChatMessage.UserMessage.UserMessageWithContentParts;
-import io.github.stefanbratanov.chatjpt.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart;
-import io.github.stefanbratanov.chatjpt.ChatMessage.UserMessage.UserMessageWithTextContent;
+import io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts;
+import io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart;
+import io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithTextContent;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;

src/main/java/io/github/stefanbratanov/chatjpt/ChatRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/ChatRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.*;
 

src/main/java/io/github/stefanbratanov/chatjpt/ChatResponse.java → src/main/java/io/github/stefanbratanov/jvm/openai/ChatResponse.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 

src/main/java/io/github/stefanbratanov/chatjpt/Constants.java → src/main/java/io/github/stefanbratanov/jvm/openai/Constants.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 class Constants {
 

src/main/java/io/github/stefanbratanov/chatjpt/CreateAssistantRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/CreateAssistantRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.LinkedList;
 import java.util.List;

src/main/java/io/github/stefanbratanov/chatjpt/CreateFineTuningJobRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/CreateFineTuningJobRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.Optional;
 

src/main/java/io/github/stefanbratanov/chatjpt/CreateImageRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/CreateImageRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.Optional;
 

src/main/java/io/github/stefanbratanov/chatjpt/CreateImageVariationRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/CreateImageVariationRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.nio.file.Path;
 import java.util.Optional;

src/main/java/io/github/stefanbratanov/chatjpt/CreateMessageRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/CreateMessageRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 import java.util.Map;

src/main/java/io/github/stefanbratanov/chatjpt/CreateRunRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/CreateRunRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 import java.util.Map;

src/main/java/io/github/stefanbratanov/chatjpt/CreateThreadAndRunRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/CreateThreadAndRunRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 import java.util.Map;

src/main/java/io/github/stefanbratanov/chatjpt/CreateThreadRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/CreateThreadRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.LinkedList;
 import java.util.List;

src/main/java/io/github/stefanbratanov/chatjpt/DeletionStatus.java → src/main/java/io/github/stefanbratanov/jvm/openai/DeletionStatus.java

@@ -1,3 +1,3 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 public record DeletionStatus(String id, boolean deleted) {}

src/main/java/io/github/stefanbratanov/chatjpt/EditImageRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/EditImageRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.nio.file.Path;
 import java.util.Optional;

src/main/java/io/github/stefanbratanov/chatjpt/Embeddings.java → src/main/java/io/github/stefanbratanov/jvm/openai/Embeddings.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 

src/main/java/io/github/stefanbratanov/chatjpt/EmbeddingsClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/EmbeddingsClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/EmbeddingsRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/EmbeddingsRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.Arrays;
 import java.util.List;

src/main/java/io/github/stefanbratanov/chatjpt/Endpoint.java → src/main/java/io/github/stefanbratanov/jvm/openai/Endpoint.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 enum Endpoint {
   CHAT("chat/completions"),

src/main/java/io/github/stefanbratanov/chatjpt/File.java → src/main/java/io/github/stefanbratanov/jvm/openai/File.java

@@ -1,3 +1,3 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 public record File(String id, int bytes, long createdAt, String filename, String purpose) {}

src/main/java/io/github/stefanbratanov/chatjpt/FilesClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/FilesClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/FineTuningClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/FineTuningClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/FineTuningJob.java → src/main/java/io/github/stefanbratanov/jvm/openai/FineTuningJob.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 

src/main/java/io/github/stefanbratanov/chatjpt/FineTuningJobEvent.java → src/main/java/io/github/stefanbratanov/jvm/openai/FineTuningJobEvent.java

@@ -1,3 +1,3 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 public record FineTuningJobEvent(String id, long createdAt, String level, String message) {}

src/main/java/io/github/stefanbratanov/chatjpt/Images.java → src/main/java/io/github/stefanbratanov/jvm/openai/Images.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.net.URL;
 import java.util.List;

src/main/java/io/github/stefanbratanov/chatjpt/ImagesClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/ImagesClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/Logprobs.java → src/main/java/io/github/stefanbratanov/jvm/openai/Logprobs.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.List;
 

src/main/java/io/github/stefanbratanov/chatjpt/MessagesClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/MessagesClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/Model.java → src/main/java/io/github/stefanbratanov/jvm/openai/Model.java

@@ -1,3 +1,3 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 public record Model(String id, long created, String ownedBy) {}

src/main/java/io/github/stefanbratanov/chatjpt/ModelsClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/ModelsClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/Moderation.java → src/main/java/io/github/stefanbratanov/jvm/openai/Moderation.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import java.util.List;

src/main/java/io/github/stefanbratanov/chatjpt/ModerationRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/ModerationRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.LinkedList;
 import java.util.List;

src/main/java/io/github/stefanbratanov/chatjpt/ModerationsClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/ModerationsClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.URI;

src/main/java/io/github/stefanbratanov/chatjpt/ModifyAssistantRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/ModifyAssistantRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.LinkedList;
 import java.util.List;

src/main/java/io/github/stefanbratanov/chatjpt/ModifyMessageRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/ModifyMessageRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.Map;
 import java.util.Optional;

src/main/java/io/github/stefanbratanov/chatjpt/ModifyRunRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/ModifyRunRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.Map;
 import java.util.Optional;

src/main/java/io/github/stefanbratanov/chatjpt/ModifyThreadRequest.java → src/main/java/io/github/stefanbratanov/jvm/openai/ModifyThreadRequest.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.util.Map;
 import java.util.Optional;

src/main/java/io/github/stefanbratanov/chatjpt/MultipartBodyPublisher.java → src/main/java/io/github/stefanbratanov/jvm/openai/MultipartBodyPublisher.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import java.io.IOException;
 import java.io.UncheckedIOException;

src/main/java/io/github/stefanbratanov/chatjpt/ChatJPT.java → src/main/java/io/github/stefanbratanov/jvm/openai/OpenAI.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.DeserializationFeature;
@@ -14,7 +14,7 @@
  * based on the endpoints defined at <a href="https://platform.openai.com/docs/api-reference">API
  * Reference - OpenAI API</a>
  */
-public final class ChatJPT {
+public final class OpenAI {
 
   private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
 
@@ -38,8 +38,7 @@ public final class ChatJPT {
   private final MessagesClient messagesClient;
   private final RunsClient runsClient;
 
-  private ChatJPT(
-      URI baseUrl, String apiKey, Optional<String> organization, HttpClient httpClient) {
+  private OpenAI(URI baseUrl, String apiKey, Optional<String> organization, HttpClient httpClient) {
     audioClient = new AudioClient(baseUrl, apiKey, organization, httpClient, OBJECT_MAPPER);
     chatClient = new ChatClient(baseUrl, apiKey, organization, httpClient, OBJECT_MAPPER);
     embeddingsClient =
@@ -201,11 +200,11 @@ public Builder httpClient(HttpClient httpClient) {
       return this;
     }
 
-    public ChatJPT build() {
+    public OpenAI build() {
       if (!baseUrl.endsWith("/")) {
         baseUrl += "/";
       }
-      return new ChatJPT(
+      return new OpenAI(
           URI.create(baseUrl),
           apiKey,
           organization,

src/main/java/io/github/stefanbratanov/chatjpt/OpenAIAssistantsClient.java → src/main/java/io/github/stefanbratanov/jvm/openai/OpenAIAssistantsClient.java

@@ -1,4 +1,4 @@
-package io.github.stefanbratanov.chatjpt;
+package io.github.stefanbratanov.jvm.openai;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.net.http.HttpClient;