Skip to content

[experimental] (Abstract+Demo)VectorToTextStream #2109

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.

Sign up for GitHub

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

Draft
cpoerschke wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

[experimental] (Abstract+Demo)VectorToTextStream #2109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8e0ee7d
add SOLR-16952-demo.sh script
cpoerschke Nov 29, 2023
8855a18
SOLR-16952: add DenseVectorField to DocsStreamer.KNOWN_TYPES
cpoerschke Nov 29, 2023
6b35fa0
remove SOLR-16952-demo.sh script
cpoerschke Nov 29, 2023
1084c29
SOLR-16952: add DocsStreamerTest.testDenseVectorField test
cpoerschke Nov 30, 2023
624af9f
SOLR-16952: adjust DocsStreamerTest.testDenseVectorField test
cpoerschke Nov 30, 2023
29ee1f1
add solr/CHANGES.txt entry
cpoerschke Nov 30, 2023
79cac55
Merge branch 'main' into SOLR-16952-with-demo
cpoerschke Dec 1, 2023
439bf57
[experimental] (Abstract+Demo)VectorToTextStream
cpoerschke Dec 1, 2023
006d4f5
Merge remote-tracking branch 'origin/main' into vector-to-text-stream
cpoerschke Dec 4, 2023
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
71 changes: 71 additions & 0 deletions demo.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@

# ./gradlew dev

# following the https://github.com/apache/solr/blob/main/solr/example/films/README.md steps except for
# starting with `-cloud -noprompt` arguments to get cloud mode
# creating with `-s 2` argument to get two shards

solr/packaging/build/dev/bin/solr start -cloud -noprompt

solr/packaging/build/dev/bin/solr create -c films -s 2

curl --silent http://localhost:8983/solr/films/schema -X POST -H 'Content-type:application/json' --data-binary '{
"add-field-type" : {
"name":"knn_vector_10",
"class":"solr.DenseVectorField",
"vectorDimension":10,
"similarityFunction":"cosine",
"knnAlgorithm":"hnsw"
},
"add-field" : [
{
"name":"name",
"type":"text_general",
"multiValued":false,
"stored":true
},
{
"name":"initial_release_date",
"type":"pdate",
"stored":true
},
{
"name":"film_vector",
"type":"knn_vector_10",
"indexed":true,
"stored":true
}
]
}'

solr/packaging/build/dev/bin/post -c films solr/packaging/build/dev/example/films/films.json

curl --silent "http://localhost:8983/solr/films/select?q=name:batman&rows=10"

curl --silent --data-urlencode 'expr=
search(films,
q="name:batman",
fl="id,name,genre,film_vector",
sort="id asc",
rows="10")
' "http://localhost:8983/solr/films/stream"

curl --data-urlencode 'expr=
demoVectorToText(
search(films,
q="name:batman",
fl="id,name,genre,film_vector",
sort="id asc",
rows="10"),
vectorField="film_vector",
outputKey="answer",
demoParam="externalComputation"
)
' "http://localhost:8983/solr/films/stream"

echo
echo
echo "TODO: solr/packaging/build/dev/bin/solr stop -all"
echo
echo

4 changes: 4 additions & 0 deletions solr/solrj-streaming/src/java/org/apache/solr/client/solrj/io/Lang.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@
import org.apache.solr.client.solrj.io.stream.CsvStream;
import org.apache.solr.client.solrj.io.stream.DaemonStream;
import org.apache.solr.client.solrj.io.stream.DeleteStream;
import org.apache.solr.client.solrj.io.stream.DemoVectorToTextStream;
import org.apache.solr.client.solrj.io.stream.DrillStream;
import org.apache.solr.client.solrj.io.stream.EchoStream;
import org.apache.solr.client.solrj.io.stream.EvalStream;
Expand Down Expand Up @@ -415,6 +416,9 @@ public static void register(StreamFactory streamFactory) {
.withFunctionName("distinct", DistinctOperation.class)
.withFunctionName("having", HavingStream.class)

// experimental
.withFunctionName("demoVectorToText", DemoVectorToTextStream.class)

// Stream Evaluators
.withFunctionName("val", RawValueEvaluator.class)

Expand Down
160 changes: 160 additions & 0 deletions ...streaming/src/java/org/apache/solr/client/solrj/io/stream/AbstractVectorToTextStream.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
/*
* 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.client.solrj.io.stream;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.apache.solr.client.solrj.io.Tuple;
import org.apache.solr.client.solrj.io.comp.StreamComparator;
import org.apache.solr.client.solrj.io.stream.expr.DefaultStreamFactory;
import org.apache.solr.client.solrj.io.stream.expr.Explanation;
import org.apache.solr.client.solrj.io.stream.expr.Explanation.ExpressionType;
import org.apache.solr.client.solrj.io.stream.expr.Expressible;
import org.apache.solr.client.solrj.io.stream.expr.StreamExplanation;
import org.apache.solr.client.solrj.io.stream.expr.StreamExpression;
import org.apache.solr.client.solrj.io.stream.expr.StreamExpressionNamedParameter;
import org.apache.solr.client.solrj.io.stream.expr.StreamExpressionParameter;
import org.apache.solr.client.solrj.io.stream.expr.StreamExpressionValue;
import org.apache.solr.client.solrj.io.stream.expr.StreamFactory;

public abstract class AbstractVectorToTextStream extends TupleStream implements Expressible {

private static final String VECTOR_FIELD_PARAM = "vectorField";
private static final String OUTPUT_KEY_PARAM = "outputKey";

private final TupleStream tupleStream;

private final String vectorField;
private final String outputKey;

public AbstractVectorToTextStream(StreamExpression streamExpression, StreamFactory streamFactory)
throws IOException {

final List<StreamExpression> streamExpressions =
streamFactory.getExpressionOperandsRepresentingTypes(
streamExpression, Expressible.class, TupleStream.class);
if (streamExpressions.size() == 1) {
this.tupleStream = streamFactory.constructStream(streamExpressions.get(0));
} else {
throw new IOException("Expected exactly one stream in expression: " + streamExpression);
}

this.vectorField = getOperandValue(streamExpression, streamFactory, VECTOR_FIELD_PARAM);
this.outputKey = getOperandValue(streamExpression, streamFactory, OUTPUT_KEY_PARAM);

if (!(streamFactory instanceof DefaultStreamFactory)) {
throw new IOException(
this.getClass().getName()
+ " requires a "
+ DefaultStreamFactory.class.getName()
+ " StreamFactory");
}
}

protected static String getOperandValue(
StreamExpression streamExpression, StreamFactory streamFactory, String operandName)
throws IOException {
final StreamExpressionNamedParameter namedParameter =
streamFactory.getNamedOperand(streamExpression, operandName);
String operandValue = null;
if (namedParameter != null && namedParameter.getParameter() instanceof StreamExpressionValue) {
operandValue = ((StreamExpressionValue) namedParameter.getParameter()).getValue();
}
if (operandValue == null) {
throw new IOException("Expected '" + operandName + "' in expression: " + streamExpression);
} else {
return operandValue;
}
}

public void setStreamContext(StreamContext streamContext) {
tupleStream.setStreamContext(streamContext);
}

public List<TupleStream> children() {
return tupleStream.children();
}

public void open() throws IOException {
tupleStream.open();
}

public void close() throws IOException {
tupleStream.close();
}

public Tuple read() throws IOException {
List<List<Double>> vectors = new ArrayList<>();
Tuple tuple = tupleStream.read();
while (!tuple.EOF) {
vectors.add(tuple.getDoubles(this.vectorField));
tuple = tupleStream.read();
}

final Tuple result = new Tuple();
result.put(this.outputKey, vectorToText(vectors));
result.EOF = true;
return result;
}

protected abstract String vectorToText(List<List<Double>> vectors);

public StreamComparator getStreamSort() {
return tupleStream.getStreamSort();
}

public Explanation toExplanation(StreamFactory streamFactory) throws IOException {
return new StreamExplanation(getStreamNodeId().toString())
.withChildren(new Explanation[] {tupleStream.toExplanation(streamFactory)})
.withExpressionType(ExpressionType.STREAM_DECORATOR)
.withFunctionName(streamFactory.getFunctionName(this.getClass()))
.withImplementingClass(this.getClass().getName())
.withExpression(toExpression(streamFactory, false).toString());
}

public StreamExpressionParameter toExpression(StreamFactory streamFactory) throws IOException {
return toExpression(streamFactory, true /* includeStreams */);
}

protected StreamExpression toExpression(StreamFactory streamFactory, boolean includeStreams)
throws IOException {
final String functionName = streamFactory.getFunctionName(this.getClass());
final StreamExpression streamExpression = new StreamExpression(functionName);

if (includeStreams) {
if (this.tupleStream instanceof Expressible) {
streamExpression.addParameter(((Expressible) this.tupleStream).toExpression(streamFactory));
} else {
throw new IOException(
"This "
+ this.getClass().getName()
+ " contains a non-Expressible TupleStream "
+ this.tupleStream.getClass().getName());
}
} else {
streamExpression.addParameter("<stream>");
}

streamExpression.addParameter(
new StreamExpressionNamedParameter(VECTOR_FIELD_PARAM, this.vectorField));
streamExpression.addParameter(
new StreamExpressionNamedParameter(OUTPUT_KEY_PARAM, this.outputKey));

return streamExpression;
}
}
72 changes: 72 additions & 0 deletions ...lrj-streaming/src/java/org/apache/solr/client/solrj/io/stream/DemoVectorToTextStream.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
/*
* 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.client.solrj.io.stream;

import java.io.IOException;
import java.util.List;
import java.util.Locale;
import org.apache.solr.client.solrj.io.stream.expr.StreamExpression;
import org.apache.solr.client.solrj.io.stream.expr.StreamExpressionNamedParameter;
import org.apache.solr.client.solrj.io.stream.expr.StreamFactory;

/**
* Illustrative expression snippet:
*
* <pre>
* demoVectorToText(search(myCollection,
* q="*:*",
* fl="id,fieldX",
* sort="id asc",
* qt="/export"),
* vectorField="fieldX",
* outputKey="answer",
* demoParam="foobar")
* </pre>
*/
public class DemoVectorToTextStream extends AbstractVectorToTextStream {

private static final String DEMO_PARAM = "demoParam";

private final String demoParam;

public DemoVectorToTextStream(StreamExpression streamExpression, StreamFactory streamFactory)
throws IOException {
super(streamExpression, streamFactory);
this.demoParam = getOperandValue(streamExpression, streamFactory, DEMO_PARAM);
}

/** TODO: replace this dummy text with something model based */
protected String vectorToText(List<List<Double>> vectors) {
final StringBuilder sb = new StringBuilder();
sb.append(this.demoParam);
sb.append("([\n");
for (List<Double> vector : vectors) {
sb.append(String.format(Locale.ROOT, "%s\n", vector));
}
sb.append("])");
return sb.toString();
}

protected StreamExpression toExpression(StreamFactory streamFactory, boolean includeStreams)
throws IOException {
final StreamExpression streamExpression = super.toExpression(streamFactory, includeStreams);

streamExpression.addParameter(new StreamExpressionNamedParameter(DEMO_PARAM, this.demoParam));

return streamExpression;
}
}