SOLR-18187: Document enrichment with LLMs by nicolo-rinaldi · Pull Request #4259 · apache/solr

nicolo-rinaldi · 2026-04-01T16:11:45Z

https://issues.apache.org/jira/browse/SOLR-18187

Description

The goal of this PR is to add a way to integrate LLMs directly into Solr at index time to fill fields that might be useful (e.g., categories, tags, etc.)

Solution

This PR adds LLM-based document enrichment capabilities to Solr's indexing pipeline via a new DocumentEnrichmentUpdateProcessorFactory in the language-models module. The processor allows users to enrich documents at index time by calling an LLM (via https://github.com/langchain4j/langchain4j) with a configurable prompt built from one or more existing document fields (inputFields), and storing the model's response into an output field. The output field can be of different types (i.e., string, text, int, long, float, double, boolean, and date) and can be single-valued or multi-valued. The structured output has been used to adapt to the output field type.

The implementation has taken inspiration from the text-to-vector feature in the same module. This has been done to keep the implementation consistent with conventions already in the language-models module.

Note: this PR was developed with assistance from Claude Code (Anthropic).

Tests

Tests covering configuration validation (missing required params, conflicting params, invalid field types, placeholder mismatches), and processor initialization.

Tests covering single-valued and multi-valued output fields of all supported types, multi-input-field prompts, prompt file loading, error handling (model exceptions, ambiguous/malformed JSON responses, unsupported model types), and skipNullOrMissingFieldValues behaviour. All the supported models have been tested.

Checklist

Please review the following and check all that apply:

I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
I have created a Jira issue and added the issue ID to my pull request title.
I have given Solr maintainers access to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation)
I have developed this patch against the main branch.
I have run ./gradlew check.
I have added tests for my changes.
I have added documentation for the Reference Guide
I have added a changelog entry for my change

…tUpdateProcessorFactory

- multivalued outputField - outputField different from Str/Text, with numeric, boolean and date

…or documentation

…t with LLMs' module

…rFactory

aruggero

Left some comments

aruggero · 2026-04-13T08:17:31Z

+    restTestHarness.delete(ManagedChatModelStore.REST_END_POINT + "/model1");
+  }
+
+  private UpdateRequestProcessor createUpdateProcessor(


Can't this always be generalised and used for all the tests? In some of them, you are now repeating this code with small changes...

this is the same as createUpdateProcessor a part from the creation of the request and getInstance()
maybe we can exclude the solr request + getInstance() and use that method also here? calling it like "initializeUpdateProcessorFactory"?
what do you think?

I created a function initializeUpdateProcessorFactory that is used inside createUpdateProcessor. In this way, the code inside the first one can be reused

Fixed tests

why some test could not use these new functions?
e.g. init_multipleInputFields_shouldInitAllFields

I kept them unrelated to the model creation, just to see the proper initialization of the Factory. I can see if this can be changed if you want

aruggero · 2026-04-13T13:57:46Z

+    restTestHarness.delete(ManagedChatModelStore.REST_END_POINT + "/model1");
+  }
+
+  private UpdateRequestProcessor createUpdateProcessor(


this is the same as createUpdateProcessor a part from the creation of the request and getInstance()
maybe we can exclude the solr request + getInstance() and use that method also here? calling it like "initializeUpdateProcessorFactory"?
what do you think?

…fields and updated documentation

nicolo-rinaldi · 2026-04-15T13:27:05Z

+
+=== Models
+
+* A model in this module is a chat model, that answers with text given a prompt.


nicolo-rinaldi · 2026-04-15T13:27:12Z

+=== Models
+
+* A model in this module is a chat model, that answers with text given a prompt.
+* A model in this Solr module is a reference to an external API that runs the Large Language Model responsible for chat


nicolo-rinaldi · 2026-04-15T13:30:38Z

+
+Exactly one of the following parameters is required: `prompt` or `promptFile`.
+
+Another important feature of this module is that one (or more) `inputField` needs to be injected in the prompt. This is


…orks

alessandrobenedetti · 2026-04-17T14:47:58Z

+            .messages(UserMessage.from(prompt))
+            .build();
+    String rawJson = chatModel.chat(chatRequest).aiMessage().text();
+    Object parsed = Utils.fromJSONString(rawJson);


Is parsing an 'Object' necessary?

alessandrobenedetti · 2026-04-17T14:51:04Z

+  public SolrChatModel getModel(String modelName) {
+    return store.getModel(modelName);
+  }
+


this entire class feels like exactly the same of the one I implemented for embedding models.
Can't we use the same class but for multiple storage solutions?
So you instantiate different endpoints but same class.
It feels a lot of duplicate code

alessandrobenedetti · 2026-04-17T14:51:37Z

+          "model '" + name + "' already exists. Please use a different name");
+    }
+  }
+}


see above in regards of duplicated code

alessandrobenedetti · 2026-04-17T14:53:42Z

+      // as for now, only a plain text as prompt is sent to the model (no support for
+      // tools/skills/agents)
+      // chatModel.chat returns the parsed value from the structured JSON response
+      Object value = chatModel.chat(injectedPrompt, responseFormat);


value? isn't it the output? Also, langchain4j returns an 'Object'? is that a weak typing?

alessandrobenedetti

Good work, but there's a lot to discuss and change!

Reasonable first draft though!

alessandrobenedetti · 2026-04-22T09:02:08Z

+          SolrException.ErrorCode.SERVER_ERROR,
+          "field type is not supported by Document Enrichment: "
+              + fieldType.getClass().getSimpleName());
+    }


I think with switch-case java construct this part will be more readable

alessandrobenedetti · 2026-04-22T09:22:43Z

+Monitor your indexing logs to detect documents that were not enriched as expected.
+====
+
+== Chat Model Setup


Chat Model is a LangChain4j naming, please remove it entirely from the doc and Solr where possible.
Furthermore we don't offer any chat style interaction so it can be misleading.

let's just use 'general purpose LLM'

…y reference to ChatModel when is not needed.

# Conflicts: # gradle/libs.versions.toml # solr/modules/language-models/gradle.lockfile

aruggero · 2026-04-24T12:24:04Z

+            .build();
+    String rawJson = chatModel.chat(chatRequest).aiMessage().text();
+    Object parsed = Utils.fromJSONString(rawJson);
+    // It makes sense to keep this due to Ollama support


I would change the comment
"Ollama support" is not clear to me

aruggero · 2026-04-24T12:46:40Z

+
+      // fall-back to SolrException
+      default -> throw unsupportedFieldTypeException;
+    };


Can't we use

return switch (fieldType) { case StrField _, TextField _, DatePointField _ -> new JsonStringSchema(); case IntPointField _, LongPointField _ -> new JsonIntegerSchema(); case FloatPointField _, DoublePointField _ -> new JsonNumberSchema(); case BoolField _ -> new JsonBooleanSchema(); default -> throw unsupportedFieldTypeException; };

with Java 22+?

aruggero · 2026-04-24T12:48:21Z

@@ -0,0 +1,85 @@
+/*


Didn't we remove any "chatModel" reference from the contribution?

Yes, but this is a mock for the actual langchain4j ChatModel class, indeed it implements the ChatModel interface, so I thought the name must contain some reference to the langchain4j library.

aruggero · 2026-04-24T13:00:11Z

+  <field name="output_binary"        type="binary"           indexed="false" stored="true"  multiValued="false"/>
+
+  <!-- output fields for unsupported types -->
+  <field name="output_bynary"     type="binary"   indexed="true"  stored="true"  multiValued="false"/>


Why do we have both binary and bynary?

I didn't even noticed this. "output_bynary" is never used. Removed

aruggero · 2026-04-24T13:01:26Z

+  <!-- output fields for unsupported types -->
+  <field name="output_bynary"     type="binary"   indexed="true"  stored="true"  multiValued="false"/>
+
+  <!-- output fields for types explicitly unsupported (without they are supported via inheritance) -->


What does this comment mean?

Changed, see if now is clear

aruggero · 2026-04-24T13:04:32Z

  }

-  /* buildResponseFormat tests for field types from the Solr documentation */
+  /* buildResponseFormat tests for unsupported field types from the Solr documentation: 1 general (Binary) + 3 via inheritance */


What does this comment mean?

Changed, see if now is clear

aruggero · 2026-04-24T13:09:47Z

@@ -0,0 +1,48 @@
+/*


Didn't we remove any "chatModel" reference from the contribution?

same as DummyChatModel

aruggero · 2026-04-24T13:09:51Z

@@ -0,0 +1,48 @@
+/*


Didn't we remove any "chatModel" reference from the contribution?

same as DummyChatModel

…y reference to ChatModel when is not needed.

nicolo-rinaldi added 11 commits March 25, 2026 13:06

[llm-document-erichment] Add first revision of the feature

b11d049

[llm-document-enrichment] First working version

dfb27ab

[llm-document-enrichment] Add promptFile feature to DocumentEnrichmen…

827548a

…tUpdateProcessorFactory

[llm-document-enrichment] Add multiple inputField support + tests

cc94317

[llm-document-enrchment] Add supprot for:

c723362

- multivalued outputField - outputField different from Str/Text, with numeric, boolean and date

[llm-document-enrichment] polished code, added tests and added file f…

cf0d6bb

…or documentation

[llm-document-enrichment] updated supported models + added tests

570c2aa

[llm-document-enrichment] added documentation for 'Document Enrichmen…

184f579

…t with LLMs' module

[llm-document-enrichment] cleanup of DocumentEnrichmentUpdateProcesso…

1b7c972

…rFactory

Merge branch 'main' into llm-document-enrichment

9cf0315

Merge branch 'main' into llm-document-enrichment

36208af

github-actions Bot added documentation Improvements or additions to documentation dependencies Dependency upgrades tool:build tests labels Apr 1, 2026

aruggero suggested changes Apr 3, 2026

View reviewed changes

aruggero suggested changes Apr 13, 2026

View reviewed changes

[llm-document-enrichment] Addressed comments in Anna's review

3d29d16

aruggero suggested changes Apr 13, 2026

View reviewed changes

nicolo-rinaldi added 2 commits April 13, 2026 17:55

[llm-document-enrichment] Addressed comments in Anna's review

55ff9ab

[llm-document-enrichment] Fixed broken tests and updated documentation

ed40008

aruggero suggested changes Apr 15, 2026

View reviewed changes

[llm-document-enrichment] Added tests, Exception for multiple output …

ba27be1

…fields and updated documentation

nicolo-rinaldi commented Apr 15, 2026

View reviewed changes

aruggero suggested changes Apr 15, 2026

View reviewed changes

nicolo-rinaldi added 2 commits April 15, 2026 17:22

[llm-document-enrichment] Updated documentation

b092f22

Merge branch 'main' into llm-document-enrichment

6e9525d

nicolo-rinaldi requested a review from aruggero April 17, 2026 08:29

aruggero approved these changes Apr 17, 2026

View reviewed changes

nicolo-rinaldi added 3 commits April 17, 2026 11:18

[llm-document-enrichment] Pre-check changes

4f39e40

Merge branch 'main' into llm-document-enrichment

b2b51a6

[llm-document-enrichment] Post-check changes. Now ./gradlew check w…

af48a10

…orks

alessandrobenedetti reviewed Apr 17, 2026

View reviewed changes

Comment thread ...lr/languagemodels/documentenrichment/update/processor/DocumentEnrichmentUpdateProcessor.java

alessandrobenedetti reviewed Apr 17, 2026

View reviewed changes

Comment thread ...uagemodels/documentenrichment/update/processor/DocumentEnrichmentUpdateProcessorFactory.java Outdated

[llm-document-enrichment] Fix GitHub actions failures

f15285e

alessandrobenedetti reviewed Apr 22, 2026

View reviewed changes

Comment thread changelog/unreleased/SOLR-18187-llm-document-enrichment.yml Outdated

alessandrobenedetti requested changes Apr 22, 2026

View reviewed changes

nicolo-rinaldi added 2 commits April 24, 2026 10:55

[llm-document-enrichment] Addressed Alessandro's comments. Removed an…

2cb28e4

…y reference to ChatModel when is not needed.

Merge branch 'main' into llm-document-enrichment

157787d

# Conflicts: # gradle/libs.versions.toml # solr/modules/language-models/gradle.lockfile

aruggero suggested changes Apr 24, 2026

View reviewed changes

[llm-document-enrichment] Addressed Alessandro's comments. Removed an…

3ae92f6

…y reference to ChatModel when is not needed.


		=== Models

		* A model in this module is a chat model, that answers with text given a prompt.


		Exactly one of the following parameters is required: `prompt` or `promptFile`.

		Another important feature of this module is that one (or more) `inputField` needs to be injected in the prompt. This is

Conversation

nicolo-rinaldi commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Solution

Tests

Checklist

Uh oh!

aruggero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicolo-rinaldi commented Apr 1, 2026 •

edited

Loading

alessandrobenedetti Apr 17, 2026 •

edited

Loading