SOLR-18187: Document enrichment with LLMs

changelog/unreleased/PR#4419-lenguage-model-test-refactoring.yml

@@ -0,0 +1,9 @@
+title: Refactor the tests of the language-model module to accomodate new upcoming LLM oriented features avoiding code duplication.
+type: fixed
+authors:
+  - name: Nicolò Rinaldi
+  - name: Anna Ruggero
+  - name: Alessandro benedetti
+links:
+  - name: PR#4419
+    url: https://github.com/apache/solr/pull/4419

changelog/unreleased/SOLR-18187-llm-document-enrichment.yml

@@ -0,0 +1,7 @@
+title: Add DocumentEnrichmentUpdateProcessorFactory for LLM-based document enrichment at index time
+type: added # added, changed, fixed, deprecated, removed, dependency_update, security, other
+authors:
+- name: Nicolò Rinaldi, Anna Ruggero, Alessandro Benedetti
+links:
+  - name: SOLR-18187
+    url: https://issues.apache.org/jira/browse/SOLR-18187

gradle/libs.versions.toml

@@ -240,8 +240,8 @@ amazon-awssdk-s3 = { module = "software.amazon.awssdk:s3", version.ref = "amazon
 amazon-awssdk-sdkcore = { module = "software.amazon.awssdk:sdk-core", version.ref = "amazon-awssdk" }
 amazon-awssdk-sts = { module = "software.amazon.awssdk:sts", version.ref = "amazon-awssdk" }
 androidx-lifecycle-runtimeCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-runtime-compose", version.ref = "androidx-lifecycle" }
-androidx-lifecycle-viewmodelCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "androidx-lifecycle" }
 androidx-lifecycle-viewModelNav3 = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-navigation3", version.ref = "androidx-lifecycle" }
+androidx-lifecycle-viewmodelCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "androidx-lifecycle" }
 androidx-material3-adaptive = { module = "org.jetbrains.compose.material3.adaptive:adaptive", version.ref = "androidx-adaptive" }
 androidx-material3-adaptive-nav3 = { module = "org.jetbrains.compose.material3.adaptive:adaptive-navigation3", version.ref = "androidx-adaptive" }
 androidx-navigation3-ui = { module = "org.jetbrains.androidx.navigation3:navigation3-ui", version.ref = "androidx-navigation3" }
@@ -459,11 +459,14 @@ ktor-client-serialization-json = { module = "io.ktor:ktor-serialization-kotlinx-
 ktor-server-cio = { module = "io.ktor:ktor-server-cio" }
 ktor-server-core = { module = "io.ktor:ktor-server-core" }
 ktor-server-htmlBuilder = { module = "io.ktor:ktor-server-html-builder" }
+langchain4j-anthropic = { module = "dev.langchain4j:langchain4j-anthropic" }
 langchain4j-bom = { module = "dev.langchain4j:langchain4j-bom", version.ref = "langchain4j-bom" }
 langchain4j-cohere = { module = "dev.langchain4j:langchain4j-cohere" }
 langchain4j-core = { module = "dev.langchain4j:langchain4j-core" }
+langchain4j-google-ai-gemini = { module = "dev.langchain4j:langchain4j-google-ai-gemini" }
 langchain4j-hugging-face = { module = "dev.langchain4j:langchain4j-hugging-face" }
 langchain4j-mistral-ai = { module = "dev.langchain4j:langchain4j-mistral-ai" }
+langchain4j-ollama = { module = "dev.langchain4j:langchain4j-ollama" }
 langchain4j-open-ai = { module = "dev.langchain4j:langchain4j-open-ai" }
 lmax-disruptor = { module = "com.lmax:disruptor", version.ref = "lmax-disruptor" }
 locationtech-spatial4j = { module = "org.locationtech.spatial4j:spatial4j", version.ref = "spatial4j" }

solr/licenses/langchain4j-anthropic-1.9.1.jar.sha1

@@ -0,0 +1 @@
+905f570cd38c2ebd94fa159f2e88bca06bbf71c8

solr/licenses/langchain4j-google-ai-gemini-1.9.1.jar.sha1

@@ -0,0 +1 @@
+49973974543318de23f3f09b21c79d5e45815d8c

solr/licenses/langchain4j-ollama-1.9.1.jar.sha1

@@ -0,0 +1 @@
+e3c631fa2fce6e79ad50fc86adb724656992263a

solr/modules/language-models/build.gradle

@@ -29,9 +29,12 @@ dependencies {
   implementation libs.apache.lucene.core
 
   implementation libs.langchain4j.core
+  runtimeOnly libs.langchain4j.anthropic
   runtimeOnly libs.langchain4j.cohere
+  runtimeOnly libs.langchain4j.google.ai.gemini
   runtimeOnly libs.langchain4j.hugging.face
   runtimeOnly libs.langchain4j.mistral.ai
+  runtimeOnly libs.langchain4j.ollama
   runtimeOnly libs.langchain4j.open.ai
 
   implementation libs.slf4j.api

solr/modules/language-models/gradle.lockfile

@@ -41,13 +41,16 @@ com.tdunning:t-digest:3.3=jarValidation,runtimeClasspath,runtimeLibs,solrPlatfor
 commons-cli:commons-cli:1.11.0=jarValidation,runtimeClasspath,runtimeLibs,solrPlatformLibs,testRuntimeClasspath
 commons-codec:commons-codec:1.21.0=jarValidation,runtimeClasspath,runtimeLibs,solrPlatformLibs,testRuntimeClasspath
 commons-io:commons-io:2.21.0=compileClasspath,jarValidation,runtimeClasspath,runtimeLibs,solrPlatformLibs,testCompileClasspath,testRuntimeClasspath
+dev.langchain4j:langchain4j-anthropic:1.9.1=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 dev.langchain4j:langchain4j-bom:1.9.1=compileClasspath,jarValidation,runtimeClasspath,runtimeLibs,testCompileClasspath,testRuntimeClasspath
 dev.langchain4j:langchain4j-cohere:1.9.1-beta17=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 dev.langchain4j:langchain4j-core:1.9.1=compileClasspath,jarValidation,runtimeClasspath,runtimeLibs,testCompileClasspath,testRuntimeClasspath
+dev.langchain4j:langchain4j-google-ai-gemini:1.9.1=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 dev.langchain4j:langchain4j-http-client-jdk:1.9.1=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 dev.langchain4j:langchain4j-http-client:1.9.1=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 dev.langchain4j:langchain4j-hugging-face:1.9.1-beta17=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 dev.langchain4j:langchain4j-mistral-ai:1.9.1=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
+dev.langchain4j:langchain4j-ollama:1.9.1=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 dev.langchain4j:langchain4j-open-ai:1.9.1=jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 io.dropwizard.metrics:metrics-annotation:4.2.33=jarValidation,testRuntimeClasspath
 io.dropwizard.metrics:metrics-core:4.2.33=jarValidation,runtimeClasspath,runtimeLibs,solrPlatformLibs,testRuntimeClasspath

solr/modules/language-models/src/java/org/apache/solr/languagemodels/model/SolrLargeLanguageModel.java

@@ -0,0 +1,206 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.solr.languagemodels.model;
+
+import dev.langchain4j.data.message.UserMessage;
+import dev.langchain4j.model.chat.ChatModel;
+import dev.langchain4j.model.chat.request.ChatRequest;
+import dev.langchain4j.model.chat.request.ResponseFormat;
+import java.lang.invoke.MethodHandles;
+import java.lang.reflect.Method;
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.Map;
+import java.util.Objects;
+import org.apache.lucene.util.Accountable;
+import org.apache.lucene.util.RamUsageEstimator;
+import org.apache.solr.common.SolrException;
+import org.apache.solr.core.SolrResourceLoader;
+import org.apache.solr.languagemodels.LanguageModelException;
+import org.apache.solr.languagemodels.store.rest.LargeLanguageModelStore;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * This object wraps a {@link dev.langchain4j.model.chat.ChatModel} to some content given a prompt
+ * and a {@link ResponseFormat}. It's meant to be used as a managed resource with the {@link
+ * LargeLanguageModelStore}
+ */
+public class SolrLargeLanguageModel extends SolrLanguageModel implements Accountable {
+  private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+  private static final long BASE_RAM_BYTES =
+      RamUsageEstimator.shallowSizeOfInstance(SolrLargeLanguageModel.class);
+
+  private static final String THINKING_BUDGET_TOKENS = "thinkingBudgetTokens";
+  private static final String RANDOM_SEED = "randomSeed";
+
+  private final ChatModel chatModel;
+  private final int hashCode;
+
+  public static SolrLargeLanguageModel getInstance(
+      SolrResourceLoader solrResourceLoader,
+      String className,
+      String name,
+      Map<String, Object> params)
+      throws LanguageModelException {
+    try {
+      /*
+       * The idea here is to build a {@link dev.langchain4j.model.chat.ChatModel} using inversion
+       * of control.
+       * Each model has its own list of parameters we don't know beforehand, but each {@link dev.langchain4j.model.chat.ChatModel} class
+       * has its own builder that uses setters with the same name of the parameter in input.
+       * */
+      ChatModel chatModel;
+      Class<?> modelClass = solrResourceLoader.findClass(className, ChatModel.class);
+      var builder = modelClass.getMethod("builder").invoke(null);
+      if (params != null) {
+        /*
+         * This block of code has the responsibility of instantiate a {@link
+         * dev.langchain4j.model.chat.ChatModel} using the params provided. Classes have
+         * params of the specific implementation of {@link
+         * dev.langchain4j.model.chat.ChatModel}, which is not known beforehand. So we benefit of
+         * the design choice in langchain4j that each subclass implementing {@link
+         * dev.langchain4j.model.chat.ChatModel} uses setters with the same name of the
+         * param.
+         */
+        for (String paramName : params.keySet()) {
+          /*
+           * When a param is not primitive, we need to instantiate the object explicitly and then call the
+           * setter method.
+           * N.B. when adding support to new models, pay attention to all the parameters they
+           * support, some of them may require to be handled in here as separate switch cases
+           */
+          switch (paramName) {
+            case TIMEOUT_PARAM -> builder
+                .getClass()
+                .getMethod(paramName, Duration.class)
+                .invoke(builder, Duration.ofSeconds((Long) params.get(paramName)));
+
+            case MAX_RETRIES_PARAM, THINKING_BUDGET_TOKENS, RANDOM_SEED -> builder
+                .getClass()
+                .getMethod(paramName, Integer.class)
+                .invoke(builder, ((Long) params.get(paramName)).intValue());
+
+              /*
+               * For primitive params if there's only one setter available, we call it.
+               * If there's choice we default to the string one
+               */
+            default -> {
+              ArrayList<Method> paramNameMatches = new ArrayList<>();
+              for (var method : builder.getClass().getMethods()) {
+                if (paramName.equals(method.getName()) && method.getParameterCount() == 1) {
+                  paramNameMatches.add(method);
+                }
+              }
+              if (paramNameMatches.size() == 1) {
+                paramNameMatches.getFirst().invoke(builder, params.get(paramName));
+              } else {
+                try {
+                  builder
+                      .getClass()
+                      .getMethod(paramName, String.class)
+                      .invoke(builder, params.get(paramName).toString());
+                } catch (NoSuchMethodException e) {
+                  log.error("Parameter {} not supported by model {}", paramName, className);
+                  throw new SolrException(SolrException.ErrorCode.BAD_REQUEST, e.getMessage(), e);
+                }
+              }
+            }
+          }
+        }
+      }
+
+      // Always enforce strict schema adherence where supported. For Anthropic and Google it's
+      // enabled by default
+      if (!"dev.langchain4j.model.anthropic.AnthropicChatModel".equals(className)
+          && !"dev.langchain4j.model.googleai.GoogleAiGeminiChatModel".equals(className)) {
+        try {
+          builder.getClass().getMethod("strictJsonSchema", Boolean.class).invoke(builder, true);
+        } catch (NoSuchMethodException ignored) {
+          log.debug(
+              "Model {} does not have strictJsonSchema param, structured output is not enforced",
+              className);
+        }
+      }
+      chatModel = (ChatModel) builder.getClass().getMethod("build").invoke(builder);
+      return new SolrLargeLanguageModel(name, chatModel, params);
+    } catch (final Exception e) {
+      throw new LanguageModelException("Model loading failed for " + className, e);
+    }
+  }
+
+  public SolrLargeLanguageModel(String name, ChatModel chatModel, Map<String, Object> params) {
+    super(name, params);
+    this.chatModel = chatModel;
+    this.hashCode = calculateHashCode();
+  }
+
+  /**
+   * Sends a structured chat request to the language model and returns the raw text response.
+   *
+   * @param prompt the user prompt to send to the language model
+   * @param responseFormat the format specification that instructs the model to produce structured
+   *     JSON output
+   * @return the raw text response from the language model
+   */
+  public String generate(String prompt, ResponseFormat responseFormat) {
+    ChatRequest chatRequest =
+        ChatRequest.builder()
+            .responseFormat(responseFormat)
+            .messages(UserMessage.from(prompt))
+            .build();
+    return chatModel.chat(chatRequest).aiMessage().text();
+  }
+
+  @Override
+  public String toString() {
+    return getClass().getSimpleName() + "(name=" + getName() + ")";
+  }
+
+  @Override
+  public long ramBytesUsed() {
+    return BASE_RAM_BYTES
+        + RamUsageEstimator.sizeOfObject(name)
+        + RamUsageEstimator.sizeOfObject(chatModel);
+  }
+
+  @Override
+  public int hashCode() {
+    return hashCode;
+  }
+
+  private int calculateHashCode() {
+    final int prime = 31;
+    int result = 1;
+    result = (prime * result) + Objects.hashCode(name);
+    result = (prime * result) + Objects.hashCode(chatModel);
+    return result;
+  }
+
+  @Override
+  public boolean equals(Object obj) {
+    if (this == obj) return true;
+    if (!(obj instanceof SolrLargeLanguageModel)) return false;
+    final SolrLargeLanguageModel other = (SolrLargeLanguageModel) obj;
+    return Objects.equals(chatModel, other.chatModel) && Objects.equals(name, other.name);
+  }
+
+  @Override
+  public String getModelClassName() {
+    return chatModel.getClass().getName();
+  }
+}

solr/modules/language-models/src/java/org/apache/solr/languagemodels/model/SolrTextToVectorModel.java

@@ -29,13 +29,13 @@
 import org.apache.solr.common.SolrException;
 import org.apache.solr.core.SolrResourceLoader;
 import org.apache.solr.languagemodels.LanguageModelException;
-import org.apache.solr.languagemodels.store.rest.ManagedTextToVectorModelStore;
+import org.apache.solr.languagemodels.store.rest.TextToVectorModelStore;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
  * This object wraps a {@link EmbeddingModel} to encode text to vector. It's meant to be used as a
- * managed resource with the {@link ManagedTextToVectorModelStore}
+ * managed resource with the {@link TextToVectorModelStore}
  */
 public class SolrTextToVectorModel extends SolrLanguageModel implements Accountable {
   private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

solr/modules/language-models/src/java/org/apache/solr/languagemodels/search/TextToVectorQParserPlugin.java

@@ -27,7 +27,7 @@
 import org.apache.solr.common.util.NamedList;
 import org.apache.solr.core.SolrResourceLoader;
 import org.apache.solr.languagemodels.model.SolrTextToVectorModel;
-import org.apache.solr.languagemodels.store.rest.ManagedTextToVectorModelStore;
+import org.apache.solr.languagemodels.store.rest.TextToVectorModelStore;
 import org.apache.solr.request.SolrQueryRequest;
 import org.apache.solr.rest.ManagedResource;
 import org.apache.solr.rest.ManagedResourceObserver;
@@ -44,7 +44,7 @@
 public class TextToVectorQParserPlugin extends QParserPlugin
     implements ResourceLoaderAware, ManagedResourceObserver {
   public static final String EMBEDDING_MODEL_PARAM = "model";
-  private ManagedTextToVectorModelStore modelStore = null;
+  private TextToVectorModelStore modelStore = null;
 
   @Override
   public QParser createParser(
@@ -55,14 +55,14 @@ public QParser createParser(
   @Override
   public void inform(ResourceLoader loader) throws IOException {
     final SolrResourceLoader solrResourceLoader = (SolrResourceLoader) loader;
-    ManagedTextToVectorModelStore.registerManagedTextToVectorModelStore(solrResourceLoader, this);
+    TextToVectorModelStore.registerManagedTextToVectorModelStore(solrResourceLoader, this);
   }
 
   @Override
   public void onManagedResourceInitialized(NamedList<?> args, ManagedResource res)
       throws SolrException {
-    if (res instanceof ManagedTextToVectorModelStore) {
-      modelStore = (ManagedTextToVectorModelStore) res;
+    if (res instanceof TextToVectorModelStore) {
+      modelStore = (TextToVectorModelStore) res;
     }
     if (modelStore != null) {
       modelStore.loadStoredModels();
@@ -105,7 +105,7 @@ public Query parse() throws SyntaxError {
             "The model requested '"
                 + embeddingModelName
                 + "' can't be found in the store: "
-                + ManagedTextToVectorModelStore.REST_END_POINT);
+                + TextToVectorModelStore.REST_END_POINT);
       }
     }
   }