Reformat and cleanup some code

Author: Martin7-1

content-retrievers/langchain4j-community-neo4j-retriever/src/main/java/dev/langchain4j/community/rag/content/retriever/neo4j/Neo4jGraph.java

@@ -15,6 +15,7 @@
 import org.neo4j.driver.summary.ResultSummary;
 
 public class Neo4jGraph implements AutoCloseable {
+
     public record StructuredSchema(
             List<String> nodesProperties, List<String> relationshipsProperties, List<String> patterns) {}
 
@@ -24,7 +25,7 @@ public record StructuredSchema(
 
     private StructuredSchema structuredSchema;
 
-    public Neo4jGraph(final Driver driver, Long sample, Long maxRels) {
+    public Neo4jGraph(Driver driver, Long sample, Long maxRels) {
 
         this.sample = getOrDefault(sample, 1000L);
         this.maxRels = getOrDefault(maxRels, 100L);

content-retrievers/langchain4j-community-neo4j-retriever/src/main/java/dev/langchain4j/community/rag/content/retriever/neo4j/Neo4jGraphSchemaUtils.java

@@ -11,18 +11,18 @@ class Neo4jGraphSchemaUtils {
 
     static final String SCHEMA_FROM_META_DATA =
             """
-            CALL apoc.meta.data({maxRels: $maxRels, sample: $sample})
-            YIELD label, other, elementType, type, property
-            WITH label, elementType,
-                 apoc.text.join(collect(case when NOT type = "RELATIONSHIP" then property+": "+type else null end),", ") AS properties,
-                 collect(case when type = "RELATIONSHIP" AND elementType = "node" then "(:" + label + ")-[:" + property + "]->(:" + toString(other[0]) + ")" else null end) AS patterns
-            WITH elementType AS type,
-                collect(":"+label+" {"+properties+"}") AS entities,
-                apoc.coll.flatten(collect(coalesce(patterns,[]))) AS patterns
-            RETURN collect(case type when "relationship" then entities end)[0] AS relationships,
-                collect(case type when "node" then entities end)[0] AS nodes,
-                collect(case type when "node" then patterns end)[0] as patterns
-            """;
+                    CALL apoc.meta.data({maxRels: $maxRels, sample: $sample})
+                    YIELD label, other, elementType, type, property
+                    WITH label, elementType,
+                         apoc.text.join(collect(case when NOT type = "RELATIONSHIP" then property+": "+type else null end),", ") AS properties,
+                         collect(case when type = "RELATIONSHIP" AND elementType = "node" then "(:" + label + ")-[:" + property + "]->(:" + toString(other[0]) + ")" else null end) AS patterns
+                    WITH elementType AS type,
+                        collect(":"+label+" {"+properties+"}") AS entities,
+                        apoc.coll.flatten(collect(coalesce(patterns,[]))) AS patterns
+                    RETURN collect(case type when "relationship" then entities end)[0] AS relationships,
+                        collect(case type when "node" then entities end)[0] AS nodes,
+                        collect(case type when "node" then patterns end)[0] as patterns
+                    """;
 
     static Neo4jGraph.StructuredSchema getSchemaFromMetadata(Neo4jGraph graph, Long sample, Long maxRels) {
         final Record record = graph.executeRead(SCHEMA_FROM_META_DATA, Map.of("sample", sample, "maxRels", maxRels))

content-retrievers/langchain4j-community-neo4j-retriever/src/main/java/dev/langchain4j/community/rag/content/retriever/neo4j/Neo4jText2CypherRetriever.java

@@ -179,7 +179,7 @@ private RetrieveResult getRetrieveResult(Query query) {
     public String fromLLM(Query query) {
         RetrieveResult result = getRetrieveResult(query);
 
-        final Prompt prompt = FROM_LLM_PROMPT_TEMPLATE.apply(
+        Prompt prompt = FROM_LLM_PROMPT_TEMPLATE.apply(
                 Map.of("context", result.contents(), "cypher", result.cypherQuery(), "question", query.text()));
         String cypherQuery = chatModel.chat(prompt.text());
         return getBacktickText(cypherQuery);

embedding-stores/langchain4j-community-neo4j/src/main/java/dev/langchain4j/community/store/embedding/neo4j/HypotheticalQuestionGraphIngestor.java

@@ -3,7 +3,7 @@
 import static dev.langchain4j.internal.Utils.getOrDefault;
 
 /**
- *  A specialized ingestor for generating and storing hypothetical questions in a Neo4j graph database.
+ * A specialized ingestor for generating and storing hypothetical questions in a Neo4j graph database.
  * It implements the <a href="https://graphrag.com/reference/graphrag/hypothetical-question-retriever/">Hypothetical Question Retriever concept</a>
  *
  * <p>This ingestor is built on top of {@link Neo4jEmbeddingStoreIngestor} and is designed to process
@@ -31,11 +31,11 @@ public static class Builder extends Neo4jEmbeddingStoreIngestor.Builder {
 
         private static final String DEFAULT_RETRIEVAL_QUERY =
                 """
-            MATCH (node)<-[:HAS_QUESTION]-(parent)
-            WITH parent, max(score) AS score, node // deduplicate parents
-            RETURN parent.text AS text, score, properties(node) AS metadata
-             ORDER BY score DESC
-            LIMIT $maxResults""";
+                        MATCH (node)<-[:HAS_QUESTION]-(parent)
+                        WITH parent, max(score) AS score, node // deduplicate parents
+                        RETURN parent.text AS text, score, properties(node) AS metadata
+                         ORDER BY score DESC
+                        LIMIT $maxResults""";
 
         private static final String DEFAULT_PARENT_QUERY =
                 """
@@ -52,17 +52,17 @@ RETURN count(*)
 
         private static final String DEFAULT_SYSTEM_PROMPT =
                 """
-            You are generating hypothetical questions based on the information found in the text.
-            Make sure to provide full context in the generated questions.
-            """;
+                        You are generating hypothetical questions based on the information found in the text.
+                        Make sure to provide full context in the generated questions.
+                        """;
 
         private static final String DEFAULT_USER_PROMPT =
                 """
-            Use the given format to generate hypothetical questions from the following input:
-            {{input}}
+                        Use the given format to generate hypothetical questions from the following input:
+                        {{input}}
 
-            Hypothetical questions:
-            """;
+                        Hypothetical questions:
+                        """;
         public static final String DEFAULT_CHUNK_CREATION_QUERY = "CREATE (:QuestionChunk $metadata)";
 
         private Neo4jEmbeddingStore defaultEmbeddingStore() {

embedding-stores/langchain4j-community-neo4j/src/main/java/dev/langchain4j/community/store/embedding/neo4j/Neo4jEmbeddingStore.java

@@ -398,7 +398,7 @@ public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)
     /*
     Private methods
     */
-    private EmbeddingSearchResult getSearchResUsingVectorSimilarity(
+    private EmbeddingSearchResult<TextSegment> getSearchResUsingVectorSimilarity(
             EmbeddingSearchRequest request, Filter filter, Value embeddingValue, Session session) {
         /* Build an
             CYPHER runtime = parallel parallelRuntimeSupport=all
@@ -635,9 +635,9 @@ private boolean indexExists() {
             if (!resIndex.hasNext()) {
                 return false;
             }
-            Record record = resIndex.single();
-            List<String> idxLabels = record.get("labelsOrTypes").asList(Value::asString);
-            List<Object> idxProps = record.get("properties").asList();
+            Record singleRecord = resIndex.single();
+            List<String> idxLabels = singleRecord.get("labelsOrTypes").asList(Value::asString);
+            List<Object> idxProps = singleRecord.get("properties").asList();
 
             boolean isIndexDifferent = !idxLabels.equals(singletonList(this.label))
                     || !idxProps.equals(singletonList(this.embeddingProperty));
@@ -781,8 +781,7 @@ public Builder retrievalQuery(String retrievalQuery) {
         }
 
         /**
-         * @param entityCreationQuery    the optional entity creation query (default: {@link Neo4jEmbeddingStore#ENTITIES_CREATION})
-         *
+         * @param entityCreationQuery the optional entity creation query (default: {@link Neo4jEmbeddingStore#ENTITIES_CREATION})
          */
         public Builder entityCreationQuery(String entityCreationQuery) {
             this.entityCreationQuery = entityCreationQuery;

embedding-stores/langchain4j-community-neo4j/src/main/java/dev/langchain4j/community/store/embedding/neo4j/Neo4jEmbeddingStoreIngestor.java

@@ -96,29 +96,29 @@ public Neo4jEmbeddingStoreIngestor(Builder builder) {
      *   <li>Embedding generation and storage of segments into Neo4j</li>
      * </ul>
      *
-     * @param documentTransformer The {@link DocumentTransformer} applied to the original documents.
-     * @param documentSplitter The {@link DocumentSplitter} used to split documents into parent segments.
-     * @param textSegmentTransformer The {@link TextSegmentTransformer} applied to parent segments.
+     * @param documentTransformer         The {@link DocumentTransformer} applied to the original documents.
+     * @param documentSplitter            The {@link DocumentSplitter} used to split documents into parent segments.
+     * @param textSegmentTransformer      The {@link TextSegmentTransformer} applied to parent segments.
      * @param childTextSegmentTransformer The {@link TextSegmentTransformer} applied to child segments.
-     * @param embeddingModel The {@link EmbeddingModel} used to generate embeddings from text segments.
-     * @param embeddingStore The {@link EmbeddingStore} (specifically {@link Neo4jEmbeddingStore}) used to persist embeddings.
-     * @param documentChildSplitter The {@link DocumentSplitter} used to generate child segments from parent segments.
-     * @param driver The {@link Driver} used to execute Cypher queries against the Neo4j database.
-     * @param query The Cypher query used to insert processed segments and metadata into Neo4j.
-     * @param parentIdKey The metadata key used to extract the parent segment ID; if absent, a UUID will be generated.
-     * @param params Additional query parameters to include in the Cypher execution, beyond segment metadata and text.
-     * @param systemPrompt A system prompt for manipulating parent segment text via a {@link ChatModel}. Ignored if {@code questionModel} is {@code null}.
-     * @param userPrompt A user prompt for manipulating parent segment text via a {@link ChatModel}. Ignored if {@code questionModel} is {@code null}.
-     * @param questionModel A {@link ChatModel} used to further transform parent segment text based on provided prompts. If {@code null}, no chat-based manipulation occurs.
+     * @param embeddingModel              The {@link EmbeddingModel} used to generate embeddings from text segments.
+     * @param embeddingStore              The {@link EmbeddingStore} (specifically {@link Neo4jEmbeddingStore}) used to persist embeddings.
+     * @param documentChildSplitter       The {@link DocumentSplitter} used to generate child segments from parent segments.
+     * @param driver                      The {@link Driver} used to execute Cypher queries against the Neo4j database.
+     * @param query                       The Cypher query used to insert processed segments and metadata into Neo4j.
+     * @param parentIdKey                 The metadata key used to extract the parent segment ID; if absent, a UUID will be generated.
+     * @param params                      Additional query parameters to include in the Cypher execution, beyond segment metadata and text.
+     * @param systemPrompt                A system prompt for manipulating parent segment text via a {@link ChatModel}. Ignored if {@code questionModel} is {@code null}.
+     * @param userPrompt                  A user prompt for manipulating parent segment text via a {@link ChatModel}. Ignored if {@code questionModel} is {@code null}.
+     * @param questionModel               A {@link ChatModel} used to further transform parent segment text based on provided prompts. If {@code null}, no chat-based manipulation occurs.
      */
     public Neo4jEmbeddingStoreIngestor(
-            final DocumentTransformer documentTransformer,
-            final DocumentSplitter documentSplitter,
+            DocumentTransformer documentTransformer,
+            DocumentSplitter documentSplitter,
             TextSegmentTransformer textSegmentTransformer,
             TextSegmentTransformer childTextSegmentTransformer,
-            final EmbeddingModel embeddingModel,
-            final Neo4jEmbeddingStore embeddingStore,
-            final DocumentSplitter documentChildSplitter,
+            EmbeddingModel embeddingModel,
+            Neo4jEmbeddingStore embeddingStore,
+            DocumentSplitter documentChildSplitter,
             Driver driver,
             String query,
             String parentIdKey,
@@ -152,7 +152,7 @@ private TextSegmentTransformer getTextSegmentTransformer() {
         return segment -> {
             TextSegment parentSegment = getTextSegmentWithUniqueId(segment, neo4jEmbeddingStore.getIdProperty(), null);
             String textInput = parentSegment.text();
-            final Map<String, Object> metadataMap = segment.metadata().toMap();
+            Map<String, Object> metadataMap = segment.metadata().toMap();
             String parentId = "parent_" + UUID.randomUUID();
             metadataMap.put(parentIdKey, parentId);
             String text;
@@ -161,22 +161,19 @@ private TextSegmentTransformer getTextSegmentTransformer() {
                     throw new RuntimeException(
                             "Prompts cannot be null: systemPrompt=" + systemPrompt + ", userPrompt=" + userPrompt);
                 }
-                final SystemMessage systemMessage = Prompt.from(systemPrompt).toSystemMessage();
-
-                final PromptTemplate userTemplate = PromptTemplate.from(userPrompt);
-
-                final UserMessage userMessage =
+                SystemMessage systemMessage = Prompt.from(systemPrompt).toSystemMessage();
+                PromptTemplate userTemplate = PromptTemplate.from(userPrompt);
+                UserMessage userMessage =
                         userTemplate.apply(Map.of("input", textInput)).toUserMessage();
-
-                final List<ChatMessage> chatMessages = List.of(systemMessage, userMessage);
+                List<ChatMessage> chatMessages = List.of(systemMessage, userMessage);
 
                 text = this.questionModel.chat(chatMessages).aiMessage().text();
             } else {
                 text = textInput;
             }
             metadataMap.putIfAbsent("text", text);
 
-            final Map<String, Object> params = new HashMap<>(Map.of("metadata", metadataMap));
+            Map<String, Object> params = new HashMap<>(Map.of("metadata", metadataMap));
             params.put(parentIdKey, parentId);
             getAdditionalParams(parentId);
             metadataMap.putAll(this.params);
@@ -193,14 +190,14 @@ private TextSegmentTransformer getDefaultChildTextSegmentTransformer() {
     }
 
     private void getAdditionalParams(String parentId) {
-        final Map<String, Object> params = new HashMap<>(this.params);
+        Map<String, Object> params = new HashMap<>(this.params);
         params.put(parentIdKey, parentId);
         neo4jEmbeddingStore.setAdditionalParams(params);
     }
 
     public static TextSegment getTextSegmentWithUniqueId(TextSegment segment, String idProperty, String parentId) {
-        final Metadata metadata1 = segment.metadata();
-        final Object idMeta = metadata1.toMap().get(idProperty);
+        Metadata metadata1 = segment.metadata();
+        Object idMeta = metadata1.toMap().get(idProperty);
         String value = parentId == null ? randomUUID() : parentId + "_" + randomUUID();
         if (idMeta != null) {
             value = idMeta + "_" + value;
@@ -219,6 +216,7 @@ public static Neo4jEmbeddingStoreIngestor.Builder builder() {
     }
 
     public static class Builder extends ParentChildEmbeddingStoreIngestor.Builder<Builder> {
+
         protected Driver driver;
         protected String query;
         protected String parentIdKey;

embedding-stores/langchain4j-community-neo4j/src/main/java/dev/langchain4j/community/store/embedding/neo4j/Neo4jEmbeddingUtils.java

@@ -2,6 +2,7 @@
 
 import static org.neo4j.cypherdsl.support.schema_name.SchemaNames.sanitize;
 
+import dev.langchain4j.Internal;
 import dev.langchain4j.data.document.Metadata;
 import dev.langchain4j.data.embedding.Embedding;
 import dev.langchain4j.data.segment.TextSegment;
@@ -16,6 +17,7 @@
 import org.neo4j.driver.Value;
 import org.neo4j.driver.Values;
 
+@Internal
 class Neo4jEmbeddingUtils {
 
     private Neo4jEmbeddingUtils() throws InstantiationException {

embedding-stores/langchain4j-community-neo4j/src/main/java/dev/langchain4j/community/store/embedding/neo4j/Neo4jFilterMapper.java

@@ -7,6 +7,7 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.json.JsonMapper;
+import dev.langchain4j.Internal;
 import dev.langchain4j.store.embedding.filter.Filter;
 import dev.langchain4j.store.embedding.filter.comparison.IsEqualTo;
 import dev.langchain4j.store.embedding.filter.comparison.IsGreaterThan;
@@ -29,9 +30,12 @@
 import org.neo4j.driver.internal.value.ListValue;
 import org.neo4j.driver.internal.value.PointValue;
 
-public class Neo4jFilterMapper {
+@Internal
+class Neo4jFilterMapper {
 
-    public static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
+    static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
+
+    static final String UNSUPPORTED_FILTER_TYPE_ERROR = "Unsupported filter type: ";
 
     private static FunctionInvocation convertToPoint(PointValue value1) {
         try {
@@ -47,7 +51,7 @@ private static FunctionInvocation convertToPoint(PointValue value1) {
      * The {@link Cypher#literalOf(Object)} doesn't handle all data types,
      * so we use this method to transform non-managed data
      */
-    public static Expression toCypherLiteral(Object value) {
+    static Expression toCypherLiteral(Object value) {
         if (value instanceof OffsetDateTime) {
             return Cypher.datetime(literalOf(value.toString()));
         }
@@ -65,15 +69,13 @@ public static Expression toCypherLiteral(Object value) {
         return literalOf(value);
     }
 
-    public static String UNSUPPORTED_FILTER_TYPE_ERROR = "Unsupported filter type: ";
-
-    private Node node;
+    private final Node node;
 
-    public Neo4jFilterMapper(Node node) {
+    Neo4jFilterMapper(Node node) {
         this.node = node;
     }
 
-    public Condition getCondition(Filter filter) {
+    Condition getCondition(Filter filter) {
         if (filter instanceof IsEqualTo item) {
             Expression cypherLiteral = toCypherLiteral(item.key());
             Expression cypherLiteral1 = toCypherLiteral(item.comparisonValue());
@@ -114,13 +116,13 @@ public Condition getCondition(Filter filter) {
         }
     }
 
-    public Condition mapIn(IsIn filter) {
+    Condition mapIn(IsIn filter) {
         Expression cypherLiteral = toCypherLiteral(filter.key());
         Expression cypherLiteral1 = toCypherLiteral(filter.comparisonValues());
         return Cypher.includesAny(node.property(cypherLiteral), cypherLiteral1);
     }
 
-    public Condition mapNotIn(IsNotIn filter) {
+    Condition mapNotIn(IsNotIn filter) {
         Expression cypherLiteral = toCypherLiteral(filter.key());
         Expression cypherLiteral1 = toCypherLiteral(filter.comparisonValues());
         Condition condition1 = Cypher.includesAny(node.property(cypherLiteral), cypherLiteral1);

embedding-stores/langchain4j-community-neo4j/src/main/java/dev/langchain4j/community/store/embedding/neo4j/Neo4jUtils.java

@@ -6,6 +6,10 @@
 @Internal
 class Neo4jUtils {
 
+    private Neo4jUtils() throws InstantiationException {
+        throw new InstantiationException("Cannot instantiate utility class.");
+    }
+
     static FunctionInvocation.FunctionDefinition functionDef(String functionName) {
         return new FunctionInvocation.FunctionDefinition() {