Mirror/ollama4j
1
0
Fork 1
mirror of https://github.com/amithkoujalgi/ollama4j.git synced 2025-11-04 02:20:50 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add Javadoc generation to Makefile and refactor model classes

Browse Source 
- Introduced a new `javadoc` target in the Makefile to generate Javadocs.
- Refactored model classes: renamed `ModelsProcessResponse` to `ModelProcessesResponse` and updated related references.
- Updated `OllamaEmbedRequestModel` and `OllamaEmbedResponseModel` to `OllamaEmbedRequest` and `OllamaEmbedResponse`, respectively, across the codebase.
- Added new classes for `OllamaEmbedRequest` and `OllamaEmbedResponse` to improve clarity and maintainability.
This commit is contained in:
amithkoujalgi
2025-09-28 22:46:37 +05:30
parent 36f7d14c68
commit dd1022a990
11 changed files with 52 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/main/java/io/github/ollama4j/OllamaAPI.java
View File

@@ -15,12 +15,12 @@ import io.github.ollama4j.exceptions.ToolInvocationException;
import io.github.ollama4j.metrics.MetricsRecorder;
import io.github.ollama4j.models.chat.*;
import io.github.ollama4j.models.chat.OllamaChatTokenHandler;
import io.github.ollama4j.models.embed.OllamaEmbedRequestModel;
import io.github.ollama4j.models.embed.OllamaEmbedResponseModel;
import io.github.ollama4j.models.embed.OllamaEmbedRequest;
import io.github.ollama4j.models.embed.OllamaEmbedResponse;
import io.github.ollama4j.models.generate.OllamaGenerateRequest;
import io.github.ollama4j.models.generate.OllamaGenerateStreamObserver;
import io.github.ollama4j.models.generate.OllamaGenerateTokenHandler;
import io.github.ollama4j.models.ps.ModelsProcessResponse;
import io.github.ollama4j.models.ps.ModelProcessesResponse;
import io.github.ollama4j.models.request.*;
import io.github.ollama4j.models.response.*;
import io.github.ollama4j.tools.*;
@@ -189,7 +189,7 @@ public class OllamaAPI {
* @return ModelsProcessResponse containing details about the running models
* @throws OllamaException if the response indicates an error status
*/
public ModelsProcessResponse ps() throws OllamaException {
public ModelProcessesResponse ps() throws OllamaException {
long startTime = System.currentTimeMillis();
String url = "/api/ps";
int statusCode = -1;
@@ -217,7 +217,7 @@ public class OllamaAPI {
String responseString = response.body();
if (statusCode == 200) {
return Utils.getObjectMapper()
.readValue(responseString, ModelsProcessResponse.class);
.readValue(responseString, ModelProcessesResponse.class);
} else {
throw new OllamaException(statusCode + " - " + responseString);
}
@@ -713,14 +713,13 @@ public class OllamaAPI {
}
/**
* Generate embeddings using a {@link OllamaEmbedRequestModel}.
* Generate embeddings using a {@link OllamaEmbedRequest}.
*
* @param modelRequest request for '/api/embed' endpoint
* @return embeddings
* @throws OllamaException if the response indicates an error status
*/
public OllamaEmbedResponseModel embed(OllamaEmbedRequestModel modelRequest)
throws OllamaException {
public OllamaEmbedResponse embed(OllamaEmbedRequest modelRequest) throws OllamaException {
long startTime = System.currentTimeMillis();
String url = "/api/embed";
int statusCode = -1;
@@ -740,8 +739,7 @@ public class OllamaAPI {
statusCode = response.statusCode();
String responseBody = response.body();
if (statusCode == 200) {
return Utils.getObjectMapper()
.readValue(responseBody, OllamaEmbedResponseModel.class);
return Utils.getObjectMapper().readValue(responseBody, OllamaEmbedResponse.class);
} else {
throw new OllamaException(statusCode + " - " + responseBody);
}

2
src/main/java/io/github/ollama4j/models/embed/OllamaEmbedRequestModel.java → src/main/java/io/github/ollama4j/models/embed/OllamaEmbedRequest.java
View File

@@ -20,7 +20,7 @@ import lombok.*;
@Data
@RequiredArgsConstructor
@NoArgsConstructor
public class OllamaEmbedRequestModel {
public class OllamaEmbedRequest {
@NonNull private String model;
@NonNull private List<String> input;

6
src/main/java/io/github/ollama4j/models/embed/OllamaEmbedRequestBuilder.java
View File

@@ -16,10 +16,10 @@ import java.util.List;
*/
public class OllamaEmbedRequestBuilder {
private final OllamaEmbedRequestModel request;
private final OllamaEmbedRequest request;
private OllamaEmbedRequestBuilder(String model, List<String> input) {
this.request = new OllamaEmbedRequestModel(model, input);
this.request = new OllamaEmbedRequest(model, input);
}
public static OllamaEmbedRequestBuilder getInstance(String model, String... input) {
@@ -41,7 +41,7 @@ public class OllamaEmbedRequestBuilder {
return this;
}
public OllamaEmbedRequestModel build() {
public OllamaEmbedRequest build() {
return this.request;
}
}

2
src/main/java/io/github/ollama4j/models/embed/OllamaEmbedResponseModel.java → src/main/java/io/github/ollama4j/models/embed/OllamaEmbedResponse.java
View File

@@ -14,7 +14,7 @@ import lombok.Data;
@SuppressWarnings("unused")
@Data
public class OllamaEmbedResponseModel {
public class OllamaEmbedResponse {
@JsonProperty("model")
private String model;

2
src/main/java/io/github/ollama4j/models/ps/ModelsProcessResponse.java → src/main/java/io/github/ollama4j/models/ps/ModelProcessesResponse.java
View File

@@ -17,7 +17,7 @@ import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@JsonIgnoreProperties(ignoreUnknown = true)
public class ModelsProcessResponse {
public class ModelProcessesResponse {
@JsonProperty("models")
private List<ModelProcess> models;

12
src/test/java/io/github/ollama4j/integrationtests/OllamaAPIIntegrationTest.java
View File

@@ -15,8 +15,8 @@ import io.github.ollama4j.exceptions.OllamaException;
import io.github.ollama4j.impl.ConsoleOutputChatTokenHandler;
import io.github.ollama4j.impl.ConsoleOutputGenerateTokenHandler;
import io.github.ollama4j.models.chat.*;
import io.github.ollama4j.models.embed.OllamaEmbedRequestModel;
import io.github.ollama4j.models.embed.OllamaEmbedResponseModel;
import io.github.ollama4j.models.embed.OllamaEmbedRequest;
import io.github.ollama4j.models.embed.OllamaEmbedResponse;
import io.github.ollama4j.models.generate.OllamaGenerateRequest;
import io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder;
import io.github.ollama4j.models.generate.OllamaGenerateStreamObserver;
@@ -231,10 +231,10 @@ class OllamaAPIIntegrationTest {
@Order(5)
void shouldReturnEmbeddings() throws Exception {
api.pullModel(EMBEDDING_MODEL);
OllamaEmbedRequestModel m = new OllamaEmbedRequestModel();
OllamaEmbedRequest m = new OllamaEmbedRequest();
m.setModel(EMBEDDING_MODEL);
m.setInput(Arrays.asList("Why is the sky blue?", "Why is the grass green?"));
OllamaEmbedResponseModel embeddings = api.embed(m);
OllamaEmbedResponse embeddings = api.embed(m);
assertNotNull(embeddings, "Embeddings should not be null");
assertFalse(embeddings.getEmbeddings().isEmpty(), "Embeddings should not be empty");
}
@@ -1328,12 +1328,12 @@ class OllamaAPIIntegrationTest {
void shouldReturnEmbeddingsForSingleInput() throws Exception {
api.pullModel(EMBEDDING_MODEL);
OllamaEmbedRequestModel requestModel = new OllamaEmbedRequestModel();
OllamaEmbedRequest requestModel = new OllamaEmbedRequest();
requestModel.setModel(EMBEDDING_MODEL);
requestModel.setInput(
Collections.singletonList("This is a single test sentence for embedding."));
OllamaEmbedResponseModel embeddings = api.embed(requestModel);
OllamaEmbedResponse embeddings = api.embed(requestModel);
assertNotNull(embeddings);
assertFalse(embeddings.getEmbeddings().isEmpty());

20
src/test/java/io/github/ollama4j/unittests/TestMockedAPIs.java
View File

@@ -16,8 +16,8 @@ import io.github.ollama4j.OllamaAPI;
import io.github.ollama4j.exceptions.OllamaException;
import io.github.ollama4j.exceptions.RoleNotFoundException;
import io.github.ollama4j.models.chat.OllamaChatMessageRole;
import io.github.ollama4j.models.embed.OllamaEmbedRequestModel;
import io.github.ollama4j.models.embed.OllamaEmbedResponseModel;
import io.github.ollama4j.models.embed.OllamaEmbedRequest;
import io.github.ollama4j.models.embed.OllamaEmbedResponse;
import io.github.ollama4j.models.generate.OllamaGenerateRequest;
import io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder;
import io.github.ollama4j.models.generate.OllamaGenerateStreamObserver;
@@ -109,10 +109,10 @@ class TestMockedAPIs {
String model = "llama2";
String prompt = "some prompt text";
try {
OllamaEmbedRequestModel m = new OllamaEmbedRequestModel();
OllamaEmbedRequest m = new OllamaEmbedRequest();
m.setModel(model);
m.setInput(List.of(prompt));
when(ollamaAPI.embed(m)).thenReturn(new OllamaEmbedResponseModel());
when(ollamaAPI.embed(m)).thenReturn(new OllamaEmbedResponse());
ollamaAPI.embed(m);
verify(ollamaAPI, times(1)).embed(m);
} catch (OllamaException e) {
@@ -126,8 +126,8 @@ class TestMockedAPIs {
String model = "llama2";
List<String> inputs = List.of("some prompt text");
try {
OllamaEmbedRequestModel m = new OllamaEmbedRequestModel(model, inputs);
when(ollamaAPI.embed(m)).thenReturn(new OllamaEmbedResponseModel());
OllamaEmbedRequest m = new OllamaEmbedRequest(model, inputs);
when(ollamaAPI.embed(m)).thenReturn(new OllamaEmbedResponse());
ollamaAPI.embed(m);
verify(ollamaAPI, times(1)).embed(m);
} catch (OllamaException e) {
@@ -141,10 +141,10 @@ class TestMockedAPIs {
String model = "llama2";
List<String> inputs = List.of("some prompt text");
try {
when(ollamaAPI.embed(new OllamaEmbedRequestModel(model, inputs)))
.thenReturn(new OllamaEmbedResponseModel());
ollamaAPI.embed(new OllamaEmbedRequestModel(model, inputs));
verify(ollamaAPI, times(1)).embed(new OllamaEmbedRequestModel(model, inputs));
when(ollamaAPI.embed(new OllamaEmbedRequest(model, inputs)))
.thenReturn(new OllamaEmbedResponse());
ollamaAPI.embed(new OllamaEmbedRequest(model, inputs));
verify(ollamaAPI, times(1)).embed(new OllamaEmbedRequest(model, inputs));
} catch (OllamaException e) {
throw new RuntimeException(e);
}

5
src/test/java/io/github/ollama4j/unittests/TestOptionsAndUtils.java
View File

@@ -69,7 +69,10 @@ class TestOptionsAndUtils {
void testOptionsBuilderRejectsUnsupportedCustomType() {
assertThrows(
IllegalArgumentException.class,
() -> new OptionsBuilder().setCustomOption("bad", new Object()));
() -> {
OptionsBuilder builder = new OptionsBuilder();
builder.setCustomOption("bad", new Object());
});
}
@Test

14
src/test/java/io/github/ollama4j/unittests/jackson/TestEmbedRequestSerialization.java
View File

@@ -10,13 +10,13 @@ package io.github.ollama4j.unittests.jackson;
import static org.junit.jupiter.api.Assertions.assertEquals;
import io.github.ollama4j.models.embed.OllamaEmbedRequest;
import io.github.ollama4j.models.embed.OllamaEmbedRequestBuilder;
import io.github.ollama4j.models.embed.OllamaEmbedRequestModel;
import io.github.ollama4j.utils.OptionsBuilder;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
class TestEmbedRequestSerialization extends AbstractSerializationTest<OllamaEmbedRequestModel> {
class TestEmbedRequestSerialization extends AbstractSerializationTest<OllamaEmbedRequest> {
private OllamaEmbedRequestBuilder builder;
@@ -27,20 +27,18 @@ class TestEmbedRequestSerialization extends AbstractSerializationTest<OllamaEmbe
@Test
public void testRequestOnlyMandatoryFields() {
OllamaEmbedRequestModel req = builder.build();
OllamaEmbedRequest req = builder.build();
String jsonRequest = serialize(req);
assertEqualsAfterUnmarshalling(
deserialize(jsonRequest, OllamaEmbedRequestModel.class), req);
assertEqualsAfterUnmarshalling(deserialize(jsonRequest, OllamaEmbedRequest.class), req);
}
@Test
public void testRequestWithOptions() {
OptionsBuilder b = new OptionsBuilder();
OllamaEmbedRequestModel req = builder.withOptions(b.setMirostat(1).build()).build();
OllamaEmbedRequest req = builder.withOptions(b.setMirostat(1).build()).build();
String jsonRequest = serialize(req);
OllamaEmbedRequestModel deserializeRequest =
deserialize(jsonRequest, OllamaEmbedRequestModel.class);
OllamaEmbedRequest deserializeRequest = deserialize(jsonRequest, OllamaEmbedRequest.class);
assertEqualsAfterUnmarshalling(deserializeRequest, req);
assertEquals(1, deserializeRequest.getOptions().get("mirostat"));
}