com.aliyun.tair.tairvector.TairVectorPipeline Maven / Gradle / Ivy
Show all versions of alibabacloud-tairjedis-sdk Show documentation
package com.aliyun.tair.tairvector;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import com.aliyun.tair.ModuleCommand;
import com.aliyun.tair.tairhash.factory.HashBuilderFactory;
import com.aliyun.tair.tairvector.factory.VectorBuilderFactory;
import com.aliyun.tair.tairvector.params.DistanceMethod;
import com.aliyun.tair.tairvector.params.HscanParams;
import com.aliyun.tair.tairvector.params.IndexAlgorithm;
import com.aliyun.tair.util.JoinParameters;
import redis.clients.jedis.BuilderFactory;
import redis.clients.jedis.Pipeline;
import redis.clients.jedis.Response;
import redis.clients.jedis.ScanResult;
import redis.clients.jedis.util.SafeEncoder;
import static redis.clients.jedis.Protocol.toByteArray;
public class TairVectorPipeline extends Pipeline {
public void quit() {
getClient("").close();
}
/**
* TVS.CREATEINDEX TVS.CREATEINDEX index_name dims algorithm distance_method [(attribute_key attribute_value) ... ]
*
* create tair-vector index
*
* @param index index name
* @param dims vector dims
* @param algorithm index algorithm
* @param method vector distance method
* @param attrs other columns, optional
* @return Success: +OK; Fail: error
*/
public Response tvscreateindex(final String index, int dims, IndexAlgorithm algorithm, DistanceMethod method, final String... attrs) {
getClient(index).sendCommand(ModuleCommand.TVSCREATEINDEX, JoinParameters.joinParameters(SafeEncoder.encode(index), toByteArray(dims), SafeEncoder.encode(algorithm.name()), SafeEncoder.encode(method.name()), SafeEncoder.encodeMany(attrs)));
return getResponse(BuilderFactory.STRING);
}
public Response tvscreateindex(byte[] index, int dims, IndexAlgorithm algorithm, DistanceMethod method, final byte[]... params) {
getClient(index).sendCommand(ModuleCommand.TVSCREATEINDEX, JoinParameters.joinParameters(index, toByteArray(dims), SafeEncoder.encode(algorithm.name()), SafeEncoder.encode(method.name()), params));
return getResponse(BuilderFactory.BYTE_ARRAY);
}
/**
* TVS.GETINDEX TVS.GETINDEX index_name
*
* get index schema info, including: index_name, algorithm, distance_method, data_count, ...
*
* @param index index name
* @return Success: string_map, Fail: empty
*/
public Response> tvsgetindex(final String index) {
getClient(index).sendCommand(ModuleCommand.TVSGETINDEX, SafeEncoder.encode(index));
return getResponse(BuilderFactory.STRING_MAP);
}
public Response> tvsgetindex(byte[] index) {
getClient(index).sendCommand(ModuleCommand.TVSGETINDEX, index);
return getResponse(BuilderFactory.BYTE_ARRAY_MAP);
}
/**
* TVS.DELINDEX TVS.DELINDEX index_name
*
* delete index
*
* @param index index name
* @return Success: 1; Fail: 0
*/
public Response tvsdelindex(final String index) {
getClient(index).sendCommand(ModuleCommand.TVSDELINDEX, SafeEncoder.encode(index));
return getResponse(BuilderFactory.LONG);
}
public Response tvsdelindex(byte[] index) {
getClient(index).sendCommand(ModuleCommand.TVSDELINDEX, index);
return getResponse(BuilderFactory.LONG);
}
/**
* TVS.SCANINDEX TVS.SCANINDEX index_name
*
* scan index
*
* @param cursor start offset
* @param params the params: [MATCH pattern] [COUNT count]
* `MATCH` - Set the pattern which is used to filter the results
* `COUNT` - Set the number of fields in a single scan (default is 10)
* `NOVAL` - The return result contains no data portion, only cursor information
* @return A ScanResult. {@link HashBuilderFactory#EXHSCAN_RESULT_STRING}
*/
public Response> tvsscanindex(Long cursor, HscanParams params) {
final List args = new ArrayList();
args.add(toByteArray(cursor));
args.addAll(params.getParams());
getClient("").sendCommand(ModuleCommand.TVSSCANINDEX, args.toArray(new byte[args.size()][]));
return getResponse(VectorBuilderFactory.SCAN_CURSOR_STRING);
}
/**
* TVS.HSET TVS.HSET index entityid vector [(attribute_key attribute_value) ...]
*
* insert entity into tair-vector module
*
* @param index index name
* @param entityid entity id
* @param vector vector info
* @param params scalar attribute key, value
* @return integer-reply specifically:
* {@literal k} if success, k is the number of fields that were added..
* throw error like "(error) Illegal vector dimensions" if error
*/
public Response tvshset(final String index, final String entityid, final String vector, final String... params) {
getClient(index).sendCommand(ModuleCommand.TVSHSET, JoinParameters.joinParameters(SafeEncoder.encode(index), SafeEncoder.encode(entityid), SafeEncoder.encode(VectorBuilderFactory.VECTOR_TAG), SafeEncoder.encode(vector), SafeEncoder.encodeMany(params)));
return getResponse(BuilderFactory.LONG);
}
public Response tvshset(byte[] index, byte[] entityid, byte[] vector, final byte[]... params) {
getClient(index).sendCommand(ModuleCommand.TVSHSET, JoinParameters.joinParameters(index, entityid, SafeEncoder.encode(VectorBuilderFactory.VECTOR_TAG), vector, params));
return getResponse(BuilderFactory.LONG);
}
/**
* TVS.HGETALL TVS.HGETALL index entityid
*
* get entity from tair-vector module
*
* @param index index name
* @param entityid entity id
* @return Map, an empty list when {@code entityid} does not exist.
*/
public Response> tvshgetall(final String index, final String entityid) {
getClient(index).sendCommand(ModuleCommand.TVSHGETALL, SafeEncoder.encode(index), SafeEncoder.encode(entityid));
return getResponse(BuilderFactory.STRING_MAP);
}
public Response> tvshgetall(byte[] index, byte[] entityid) {
getClient(index).sendCommand(ModuleCommand.TVSHGETALL, index, entityid);
return getResponse(BuilderFactory.BYTE_ARRAY_MAP);
}
/**
* TVS.HMGETALL TVS.HMGETALL index entityid attribute_key [attribute_key ...]
*
* get entity attrs from tair-vector module
*
* @param index index name
* @param entityid entity id
* @param attrs attrs
* @return List, an empty list when {@code entityid} or {@code attrs} does not exist .
*/
public Response> tvshmget(final String index, final String entityid, final String... attrs) {
getClient(index).sendCommand(ModuleCommand.TVSHMGET, JoinParameters.joinParameters(SafeEncoder.encode(index), SafeEncoder.encode(entityid), SafeEncoder.encodeMany(attrs)));
return getResponse(BuilderFactory.STRING_LIST);
}
public Response> tvshmget(byte[] index, byte[] entityid, byte[]... attrs) {
getClient(SafeEncoder.encode(index)).sendCommand(ModuleCommand.TVSHMGET, JoinParameters.joinParameters(index, entityid, attrs));
return getResponse(BuilderFactory.BYTE_ARRAY_LIST);
}
/**
* TVS.DEL TVS.DEL index entityid
*
* delete entity from tair-vector module
*
* @param index index name
* @param entityid entity id
* @return Long integer-reply the number of fields that were removed from the tair-vector
* not including specified but non existing fields.
*/
public Response tvsdel(final String index, final String entityid) {
getClient(index).sendCommand(ModuleCommand.TVSDEL, SafeEncoder.encode(index), SafeEncoder.encode(entityid));
return getResponse(BuilderFactory.LONG);
}
public Response tvsdel(byte[] index, byte[] entityid) {
getClient(SafeEncoder.encode(index)).sendCommand(ModuleCommand.TVSDEL, index, entityid);
return getResponse(BuilderFactory.LONG);
}
/**
* TVS.HDEL TVS.HDEL index entityid attribute_key [attribute_key ...]
*
* delete entity attrs from tair-vector module
*
* @param index index name
* @param entityid entity id
* @param attrs attrs
* @return Long integer-reply the number of fields that were removed from the tair-vector
* not including specified but non existing fields.
*/
public Response tvshdel(final String index, final String entityid, final String... attrs) {
getClient(index).sendCommand(ModuleCommand.TVSHDEL, JoinParameters.joinParameters(SafeEncoder.encode(index), SafeEncoder.encode(entityid), SafeEncoder.encodeMany(attrs)));
return getResponse(BuilderFactory.LONG);
}
public Response tvshdel(byte[] index, byte[] entityid, byte[]... attrs) {
getClient(SafeEncoder.encode(index)).sendCommand(ModuleCommand.TVSHDEL, JoinParameters.joinParameters(index, entityid, attrs));
return getResponse(BuilderFactory.LONG);
}
/**
* TVS.SCAN TVS.SCAN index_name cursor [MATCH pattern] [COUNT count]
*
* scan entity from tair-vector module
*
* @param index index name
* @param cursor start offset
* @param params the params: [MATCH pattern] [COUNT count]
* `MATCH` - Set the pattern which is used to filter the results
* `COUNT` - Set the number of fields in a single scan (default is 10)
* `NOVAL` - The return result contains no data portion, only cursor information
* @return A ScanResult.
*/
public Response> tvsscan(final String index, Long cursor, HscanParams params) {
final List args = new ArrayList();
args.add(SafeEncoder.encode(index));
args.add(toByteArray(cursor));
args.addAll(params.getParams());
getClient(index).sendCommand(ModuleCommand.TVSSCAN, args.toArray(new byte[args.size()][]));
return getResponse(VectorBuilderFactory.SCAN_CURSOR_STRING);
}
public Response> tvsscan(byte[] index, Long cursor, HscanParams params) {
final List args = new ArrayList();
args.add(index);
args.add(toByteArray(cursor));
args.addAll(params.getParams());
getClient(SafeEncoder.encode(index)).sendCommand(ModuleCommand.TVSSCAN, args.toArray(new byte[args.size()][]));
return getResponse(VectorBuilderFactory.SCAN_CURSOR_BYTE);
}
/**
* TVS.KNNSEARCH TVS.KNNSEARCH index_name topn vector
*
* query entity by vector
*
* @param index index name
* @param topn topn result
* @param vector query vector
* @param params for HNSW, params include:
* ef_search range [0, 1000]
* @return Knn
*/
public Response> tvsknnsearch(final String index, Long topn, final String vector, final String... params) {
return tvsknnsearchfilter(index, topn, vector, "", params);
}
public Response> tvsknnsearch(byte[] index, Long topn, byte[] vector, final byte[]... params) {
return tvsknnsearchfilter(index, topn, vector, SafeEncoder.encode(""), params);
}
/**
* TVS.KNNSEARCH TVS.KNNSEARCH index_name topn vector pattern
*
* query entity by vector and scalar pattern
*
* @param index index name
* @param topn topn result
* @param vector query vector
* @param pattern support +, -，>, <, !=， ,()，&&, ||, !, ==
* @param params for HNSW, params include:
* ef_search range [0, 1000]
* @return VectorBuilderFactory.Knn<>
*/
public Response> tvsknnsearchfilter(final String index, Long topn, final String vector, final String pattern, final String... params) {
getClient(index).sendCommand(ModuleCommand.TVSKNNSEARCH, JoinParameters.joinParameters(SafeEncoder.encode(index), toByteArray(topn), SafeEncoder.encode(vector), SafeEncoder.encode(pattern), SafeEncoder.encodeMany(params)));
return getResponse(VectorBuilderFactory.STRING_KNN_RESULT);
}
public Response> tvsknnsearchfilter(byte[] index, Long topn, byte[] vector, byte[] pattern, final byte[]... params) {
getClient(SafeEncoder.encode(index)).sendCommand(ModuleCommand.TVSKNNSEARCH, JoinParameters.joinParameters(index, toByteArray(topn), vector, pattern, params));
return getResponse(VectorBuilderFactory.BYTE_KNN_RESULT);
}
/**
* TVS.MKNNSEARCH TVS.MKNNSEARCH index_name topn vector [vector...]
*
* @param index index name
* @param topn topn for each vector
* @param vectors vector list
* @param params for HNSW, params include:
* ef_search range [0, 1000]
* @return Collection<>
*/
public Response>> tvsmknnsearch(final String index, Long topn, Collection vectors, final String... params) {
return tvsmknnsearchfilter(index, topn, vectors, "", params);
}
public Response>> tvsmknnsearch(byte[] index, Long topn, Collection vectors, final byte[]... params) {
return tvsmknnsearchfilter(index, topn, vectors, SafeEncoder.encode(""), params);
}
/**
* TVS.MKNNSEARCH TVS.MKNNSEARCH index_name topn vector [vector...] pattern
*
* @param index index name
* @param topn topn for each vector
* @param vectors vector list
* @param pattern filter pattern
* @param params for HNSW, params include:
* ef_search range [0, 1000]
* @return Collection<>
*/
public Response>> tvsmknnsearchfilter(final String index, Long topn, Collection vectors, final String pattern, final String... params) {
final List args = new ArrayList();
args.add(SafeEncoder.encode(index));
args.add(toByteArray(topn));
args.add(toByteArray(vectors.size()));
args.addAll(vectors.stream().map(vector -> SafeEncoder.encode(vector)).collect(Collectors.toList()));
args.add(SafeEncoder.encode(pattern));
args.addAll(Arrays.stream(params).map(str -> SafeEncoder.encode(str)).collect(Collectors.toList()));
getClient(index).sendCommand(ModuleCommand.TVSMKNNSEARCH, args.toArray(new byte[args.size()][]));
return getResponse(VectorBuilderFactory.STRING_KNN_BATCH_RESULT);
}
public Response>> tvsmknnsearchfilter(byte[] index, Long topn, Collection vectors, byte[] pattern, final byte[]... params) {
final List args = new ArrayList();
args.add(index);
args.add(toByteArray(topn));
args.add(toByteArray(vectors.size()));
args.addAll(vectors);
args.add(pattern);
args.addAll(Arrays.stream(params).collect(Collectors.toList()));
getClient(SafeEncoder.encode(index)).sendCommand(ModuleCommand.TVSMKNNSEARCH, args.toArray(new byte[args.size()][]));
return getResponse(VectorBuilderFactory.BYTE_KNN_BATCH_RESULT);
}
}