Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SOLR-17525: Text Embedder Query Parser #2809

Merged
merged 77 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
becec74
first skeleton + draft tests
alessandrobenedetti Sep 18, 2024
cc9e836
first skeleton + first tests working
alessandrobenedetti Oct 5, 2024
79aad31
added openAI support
alessandrobenedetti Oct 5, 2024
ce4e13c
added mistralAI support
alessandrobenedetti Oct 5, 2024
b47e90e
consolidated support for core set of parameters
alessandrobenedetti Oct 5, 2024
971dea4
introduced support for huggingface
alessandrobenedetti Oct 7, 2024
44cfe80
fixed persistence + tests
alessandrobenedetti Oct 9, 2024
e59052c
added embedded query parser + tests
alessandrobenedetti Oct 10, 2024
5d3ec25
package description fixed
alessandrobenedetti Oct 10, 2024
35c7a0a
first documentation draft
alessandrobenedetti Oct 27, 2024
ed7d3e0
second documentation draft
alessandrobenedetti Oct 27, 2024
aa24c35
remove update request processor
alessandrobenedetti Oct 27, 2024
5d617aa
first polishing, next step is to clean up a bit the documentation lin…
alessandrobenedetti Oct 27, 2024
ca20058
licenses and deps after check
alessandrobenedetti Oct 29, 2024
18bbffd
licenses after check
alessandrobenedetti Oct 29, 2024
05eaa38
cleaned solr-tests.policy based on review
alessandrobenedetti Oct 30, 2024
30bb45b
removed synonyms and stopwors, not necessary for tests
alessandrobenedetti Oct 31, 2024
2f7149e
clean up of tests (not finished)
alessandrobenedetti Oct 31, 2024
5af0a9d
clean up of tests after review
alessandrobenedetti Nov 6, 2024
874ac20
Update settings.gradle
alessandrobenedetti Nov 6, 2024
bb5e8ee
Update solr/core/src/java/org/apache/solr/schema/DenseVectorField.java
alessandrobenedetti Nov 6, 2024
c46f1de
Update solr/core/src/java/org/apache/solr/schema/DenseVectorField.java
alessandrobenedetti Nov 6, 2024
6bb6cb0
Update solr/modules/llm/src/java/org/apache/solr/llm/store/package-in…
alessandrobenedetti Nov 6, 2024
39f04ae
Update solr/modules/llm/src/java/org/apache/solr/llm/store/rest/packa…
alessandrobenedetti Nov 6, 2024
5707b9d
Update solr/modules/llm/build.gradle
alessandrobenedetti Nov 6, 2024
ea3b6b1
added 'which one to use' section after review comments
alessandrobenedetti Nov 7, 2024
11ad4d5
removed documentation errata
alessandrobenedetti Nov 7, 2024
54a9a8a
added links to documentation
alessandrobenedetti Nov 7, 2024
2249235
Update solr/modules/llm/src/java/org/apache/solr/llm/search/TextEmbed…
alessandrobenedetti Nov 7, 2024
994f6d3
review comment addressed
alessandrobenedetti Nov 7, 2024
052dae8
gradle tidy
alessandrobenedetti Nov 7, 2024
c68ad43
followed Christine suggestion to simplify instantiation of embedder m…
alessandrobenedetti Nov 7, 2024
b866bd1
Update solr/modules/llm/src/java/org/apache/solr/llm/embedding/SolrEm…
alessandrobenedetti Nov 7, 2024
428974f
followed Christine suggestion to simplify it
alessandrobenedetti Nov 7, 2024
f67c201
Update solr/modules/llm/src/java/org/apache/solr/llm/embedding/SolrEm…
alessandrobenedetti Nov 12, 2024
082f4ea
Update solr/modules/llm/src/java/org/apache/solr/llm/embedding/SolrEm…
alessandrobenedetti Nov 12, 2024
4aa093c
Update solr/modules/llm/src/java/org/apache/solr/llm/embedding/SolrEm…
alessandrobenedetti Nov 12, 2024
4cb8b2e
Update solr/modules/llm/src/java/org/apache/solr/llm/embedding/SolrEm…
alessandrobenedetti Nov 12, 2024
a4a1622
Update solr/modules/llm/src/java/org/apache/solr/llm/embedding/SolrEm…
alessandrobenedetti Nov 12, 2024
ba55315
Update solr/modules/llm/src/java/org/apache/solr/llm/embedding/SolrEm…
alessandrobenedetti Nov 12, 2024
2cb7952
review comments
alessandrobenedetti Nov 12, 2024
6aeca10
query parser rename
alessandrobenedetti Nov 12, 2024
d87ec8b
added comments to make cleare the inversion of control part + gradle …
alessandrobenedetti Nov 18, 2024
f7809d6
renaming around to make it clearer
alessandrobenedetti Nov 18, 2024
78eaa33
sync map based on review comments
alessandrobenedetti Nov 18, 2024
8035a91
minor clean up
alessandrobenedetti Nov 18, 2024
23ab0ea
static fields clean up
alessandrobenedetti Nov 18, 2024
ecac671
moving to java streams
alessandrobenedetti Nov 18, 2024
b3a7824
additional documentation
alessandrobenedetti Nov 19, 2024
eb24d1d
solr resource loader + cleanup
alessandrobenedetti Nov 19, 2024
05448f9
attempted new dependency approach
alessandrobenedetti Nov 19, 2024
9ba06e3
Remove invalid license file
malliaridis Nov 19, 2024
124da7b
Update references to dependencies
malliaridis Nov 19, 2024
871fc71
Write locks and update checksums
malliaridis Nov 19, 2024
a017e44
Merge langchain4j license and notice files
malliaridis Nov 19, 2024
1d8076f
fixing tests
alessandrobenedetti Nov 21, 2024
da6b5c4
Update solr/solr-ref-guide/modules/query-guide/pages/embedding-text.adoc
alessandrobenedetti Nov 29, 2024
a95a93e
Update solr/solr-ref-guide/modules/query-guide/pages/embedding-text.adoc
alessandrobenedetti Nov 29, 2024
2a4d4ed
Update solr/solr-ref-guide/modules/query-guide/pages/embedding-text.adoc
alessandrobenedetti Nov 29, 2024
04a3031
fixing tests
alessandrobenedetti Nov 29, 2024
e0fdaed
thread safety
alessandrobenedetti Nov 29, 2024
8fd0618
test cleanup
alessandrobenedetti Nov 29, 2024
9f7c15d
schema version
alessandrobenedetti Nov 29, 2024
caaa4da
massive 'embedding' to text-to-vector refactor
alessandrobenedetti Nov 29, 2024
4f4e86f
sync read
alessandrobenedetti Nov 29, 2024
4636f01
query parser rename
alessandrobenedetti Dec 5, 2024
84eb101
Update solr/solr-ref-guide/modules/query-guide/pages/text-to-vector.adoc
alessandrobenedetti Dec 5, 2024
ab73c2b
minor
alessandrobenedetti Dec 5, 2024
7648643
changes
alessandrobenedetti Dec 5, 2024
9c4dcfc
automatic version changes
alessandrobenedetti Dec 16, 2024
f13fb64
gradle dependencies
alessandrobenedetti Dec 16, 2024
38b569c
gradle dependencies fix
alessandrobenedetti Dec 16, 2024
b4a78bb
gradle dependencies fix
alessandrobenedetti Dec 16, 2024
c833148
gradle dependencies fix
alessandrobenedetti Dec 16, 2024
7f8b9c4
gradle dependencies fix
alessandrobenedetti Dec 16, 2024
062f3bf
gradle dependencies fix
alessandrobenedetti Dec 16, 2024
5148c68
target version 9.8
alessandrobenedetti Dec 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ jersey-containers = "2.39.1"
# @keep for version alignment
joda-time = "2.8.1"
junit = "4.13.2"
langchain4j = "0.35.0"
# @keep Link checker version used in ref-guide
link-checker = "1.4.2"
littlerobots-versioncatalogupdate = "0.8.4"
Expand Down Expand Up @@ -400,6 +401,11 @@ jersey-media-jsonjackson = { module = "org.glassfish.jersey.media:jersey-media-j
# @keep transitive dependency for version alignment
jodatime-jodatime = { module = "joda-time:joda-time", version.ref = "joda-time" }
junit-junit = { module = "junit:junit", version.ref = "junit" }
langchain4j-cohere = { module = "dev.langchain4j:langchain4j-cohere", version.ref = "langchain4j" }
langchain4j-core = { module = "dev.langchain4j:langchain4j-core", version.ref = "langchain4j" }
langchain4j-hugging-face = { module = "dev.langchain4j:langchain4j-hugging-face", version.ref = "langchain4j" }
langchain4j-mistral-ai = { module = "dev.langchain4j:langchain4j-mistral-ai", version.ref = "langchain4j" }
langchain4j-open-ai = { module = "dev.langchain4j:langchain4j-open-ai", version.ref = "langchain4j" }
lmax-disruptor = { module = "com.lmax:disruptor", version.ref = "lmax-disruptor" }
locationtech-spatial4j = { module = "org.locationtech.spatial4j:spatial4j", version.ref = "spatial4j" }
mockito-core = { module = "org.mockito:mockito-core", version.ref = "mockito" }
Expand Down
3 changes: 3 additions & 0 deletions gradle/testing/randomization/policies/solr-tests.policy
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ grant {

// needed by randomizedtesting runner to identify test methods.
permission java.lang.reflect.ReflectPermission "suppressAccessChecks";
permission java.lang.reflect.ReflectPermission "newProxyInPackage.dev.langchain4j.model.cohere";
permission java.lang.reflect.ReflectPermission "newProxyInPackage.dev.ai4j.openai4j";
permission java.lang.reflect.ReflectPermission "newProxyInPackage.dev.langchain4j.model.huggingface";
permission java.lang.RuntimePermission "accessDeclaredMembers";
// needed by certain tests to redirect sysout/syserr:
permission java.lang.RuntimePermission "setIO";
Expand Down
1 change: 1 addition & 0 deletions settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ include "solr:modules:gcs-repository"
include "solr:modules:hdfs"
include "solr:modules:jwt-auth"
include "solr:modules:langid"
include "solr:modules:llm"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is LLM the best name for this package? Will it expand to other LLM stuff?

Copy link
Contributor Author

@alessandrobenedetti alessandrobenedetti Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the idea is to add in there all future integrations with LLM (RAG, from natural language to structured queries, etc), using LangChain4j capabilities (or other appropriate future libraries if necessary

include "solr:modules:ltr"
include "solr:modules:s3-repository"
include "solr:modules:scripting"
Expand Down
2 changes: 2 additions & 0 deletions solr/CHANGES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ New Features

* SOLR-17150: Implement `memAllowed` parameter to limit per-thread memory allocations during request processing. (Andrzej Bialecki, Gus Heck)

* SOLR-17525: Added knn_text_to_vector query parser to encode text to vector at query time through external LLM services. (Alessandro Benedetti)

Improvements
---------------------
* SOLR-17158: Users using query limits (timeAllowed, cpuTimeAllowed) for whom partial results are uninteresting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
public class KnnQParser extends AbstractVectorQParserBase {

// retrieve the top K results based on the distance similarity function
static final String TOP_K = "topK";
static final int DEFAULT_TOP_K = 10;
protected static final String TOP_K = "topK";
protected static final int DEFAULT_TOP_K = 10;

public KnnQParser(String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req) {
super(qstr, localParams, params, req);
Expand Down
1 change: 1 addition & 0 deletions solr/licenses/converter-jackson-2.9.0.jar.sha1
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
19b4010914e747601e26f46c6a403044bbe0b2bf
202 changes: 202 additions & 0 deletions solr/licenses/converter-jackson-LICENSE-ASL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed 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.
13 changes: 13 additions & 0 deletions solr/licenses/converter-jackson-NOTICE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2013 Square, Inc.

Licensed 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.
1 change: 1 addition & 0 deletions solr/licenses/jtokkit-1.1.0.jar.sha1
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
b7370f801db3eb8c7c6a2c2c06231909ac6de0b0
21 changes: 21 additions & 0 deletions solr/licenses/jtokkit-LICENSE-MIT.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Knuddels, Philip Müller

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
1 change: 1 addition & 0 deletions solr/licenses/langchain4j-0.35.0.jar.sha1
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
f739eae706dcfd090c56c2a470e1b6bd8d60e175
Loading
Loading