com.aliyun.ha3engine.vector.models

Class QueryRequest

java.lang.Object

com.aliyun.tea.TeaModel

com.aliyun.ha3engine.vector.models.QueryRequest

public class QueryRequest
extends com.aliyun.tea.TeaModel

Field Summary

Fields

Modifier and Type	Field and Description
String	content 需要向量化的内容
String	filter 过滤表达式
Boolean	includeVector 是否返回文档中的向量信息
String	indexName 查询的索引名
Map<String,String>	kvpairs kvpairs
String	modal 使用的模型
String	namespace 查询向量的空间
String	order 排序顺序, ASC：升序 DESC: 降序
List<String>	outputFields 需要返回值的字段列表
Float	scoreThreshold 分数过滤， 使用欧式距离时，只返回小于scoreThreshold的结果。使用内积时，只返回大于scoreThreshold的结果
String	searchParams 查询参数
String	sort 排序表达式
SparseData	sparseData 查询的稀疏向量
String	tableName 数据源名
Integer	topK 返回个数
List<Float>	vector 向量数据
Integer	vectorCount vector字段中包含的向量个数
Float	weight Query的权重

Constructor Summary

Constructors

Constructor and Description
QueryRequest()

Method Summary

Modifier and Type	Method and Description
static QueryRequest	build(Map<String,?> map)
String	getContent()
String	getFilter()
Boolean	getIncludeVector()
String	getIndexName()
Map<String,String>	getKvpairs()
String	getModal()
String	getNamespace()
String	getOrder()
List<String>	getOutputFields()
Float	getScoreThreshold()
String	getSearchParams()
String	getSort()
SparseData	getSparseData()
String	getTableName()
Integer	getTopK()
List<Float>	getVector()
Integer	getVectorCount()
Float	getWeight()
QueryRequest	setContent(String content)
QueryRequest	setFilter(String filter)
QueryRequest	setIncludeVector(Boolean includeVector)
QueryRequest	setIndexName(String indexName)
QueryRequest	setKvpairs(Map<String,String> kvpairs)
QueryRequest	setModal(String modal)
QueryRequest	setNamespace(String namespace)
QueryRequest	setOrder(String order)
QueryRequest	setOutputFields(List<String> outputFields)
QueryRequest	setScoreThreshold(Float scoreThreshold)
QueryRequest	setSearchParams(String searchParams)
QueryRequest	setSort(String sort)
QueryRequest	setSparseData(SparseData sparseData)
QueryRequest	setTableName(String tableName)
QueryRequest	setTopK(Integer topK)
QueryRequest	setVector(List<Float> vector)
QueryRequest	setVectorCount(Integer vectorCount)
QueryRequest	setWeight(Float weight)

Methods inherited from class com.aliyun.tea.TeaModel

build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tableName

@NameInMap(value="tableName")
 @Validation(required=true)
public String tableName

数据源名

vector

@NameInMap(value="vector")
 @Validation(required=true)
public List<Float> vector

向量数据

namespace

@NameInMap(value="namespace")
public String namespace

查询向量的空间

topK

@NameInMap(value="topK")
public Integer topK

返回个数

indexName

@NameInMap(value="indexName")
public String indexName

查询的索引名

sparseData

@NameInMap(value="sparseData")
public SparseData sparseData

查询的稀疏向量

weight

@NameInMap(value="weight")
public Float weight

Query的权重

content

@NameInMap(value="content")
public String content

需要向量化的内容

modal

@NameInMap(value="modal")
public String modal

使用的模型

includeVector

@NameInMap(value="includeVector")
public Boolean includeVector

是否返回文档中的向量信息

outputFields

@NameInMap(value="outputFields")
public List<String> outputFields

需要返回值的字段列表

order

@NameInMap(value="order")
public String order

排序顺序, ASC：升序 DESC: 降序

searchParams

@NameInMap(value="searchParams")
public String searchParams

查询参数

filter

@NameInMap(value="filter")
public String filter

过滤表达式

scoreThreshold

@NameInMap(value="scoreThreshold")
public Float scoreThreshold

分数过滤， 使用欧式距离时，只返回小于scoreThreshold的结果。使用内积时，只返回大于scoreThreshold的结果

vectorCount

@NameInMap(value="vectorCount")
public Integer vectorCount

vector字段中包含的向量个数

sort

@NameInMap(value="sort")
public String sort

排序表达式

kvpairs

@NameInMap(value="kvpairs")
public Map<String,String> kvpairs

kvpairs

Constructor Detail

QueryRequest

public QueryRequest()

Method Detail

build

public static QueryRequest build(Map<String,?> map)
                          throws Exception

Throws:

Exception

setTableName

public QueryRequest setTableName(String tableName)

getTableName

public String getTableName()

setVector

public QueryRequest setVector(List<Float> vector)

getVector

public List<Float> getVector()

setNamespace

public QueryRequest setNamespace(String namespace)

getNamespace

public String getNamespace()

setTopK

public QueryRequest setTopK(Integer topK)

getTopK

public Integer getTopK()

setIndexName

public QueryRequest setIndexName(String indexName)

getIndexName

public String getIndexName()

setSparseData

public QueryRequest setSparseData(SparseData sparseData)

getSparseData

public SparseData getSparseData()

setWeight

public QueryRequest setWeight(Float weight)

getWeight

public Float getWeight()

setContent

public QueryRequest setContent(String content)

getContent

public String getContent()

setModal

public QueryRequest setModal(String modal)

getModal

public String getModal()

setIncludeVector

public QueryRequest setIncludeVector(Boolean includeVector)

getIncludeVector

public Boolean getIncludeVector()

setOutputFields

public QueryRequest setOutputFields(List<String> outputFields)

getOutputFields

public List<String> getOutputFields()

setOrder

public QueryRequest setOrder(String order)

getOrder

public String getOrder()

setSearchParams

public QueryRequest setSearchParams(String searchParams)

getSearchParams

public String getSearchParams()

setFilter

public QueryRequest setFilter(String filter)

getFilter

public String getFilter()

setScoreThreshold

public QueryRequest setScoreThreshold(Float scoreThreshold)

getScoreThreshold

public Float getScoreThreshold()

setVectorCount

public QueryRequest setVectorCount(Integer vectorCount)

getVectorCount

public Integer getVectorCount()

setSort

public QueryRequest setSort(String sort)

getSort

public String getSort()

setKvpairs

public QueryRequest setKvpairs(Map<String,String> kvpairs)

getKvpairs

public Map<String,String> getKvpairs()