模型

本节介绍 SuperSQL 的数据模型类。

DocumentWithScore

DocumentWithScore 表示带有相似度分数的文档。

属性

属性	类型	说明
document	Document	文档内容
score	Double	相似度分数

使用示例

List<DocumentWithScore> results = vectorStore.similaritySearch(query, 5);

for (DocumentWithScore result : results) {
    System.out.println("Score: " + result.getScore());
    System.out.println("Content: " + result.getDocument().getContent());
}

RerankRequest

RerankRequest 是重排序请求模型。

属性

属性	类型	说明
model	String	重排序模型名称
query	String	查询文本
documents	List<String>	文档列表
topN	Integer	返回的 top N 结果

使用示例

RerankRequest request = RerankRequest.builder()
        .model("Qwen3-Reranker-8B")
        .query("查询用户信息")
        .documents(List.of("用户表", "订单表"))
        .topN(5)
        .build();

RerankResponse

RerankResponse 是重排序响应模型。

属性

属性	类型	说明
results	List<RerankResult>	重排序结果列表
model	String	使用的模型名称
usage	RerankResponseMetadata	使用情况元数据

使用示例

RerankResponse response = rerankModel.rerank(request);

for (RerankResult result : response.getResults()) {
    System.out.println("Index: " + result.getIndex());
    System.out.println("Score: " + result.getRelevanceScore());
}

RerankResult

RerankResult 表示单个重排序结果。

属性

属性	类型	说明
index	Integer	原始索引
relevanceScore	Double	相关性分数
document	RerankResultMetadata	文档元数据

RerankResponseMetadata

RerankResponseMetadata 是重排序响应元数据。

属性

属性	类型	说明
promptTokens	Integer	Prompt token 数量
completionTokens	Integer	完成 token 数量
totalTokens	Integer	总 token 数量

RerankResultMetadata

RerankResultMetadata 是重排序结果元数据。

属性

属性	类型	说明
text	String	文档文本
index	Integer	文档索引

TrainPolicyType

TrainPolicyType 是训练策略枚举。

枚举值

值	说明
DDL	训练 DDL 语句
SQL	训练 SQL 示例

使用示例

sqlEngine.train(TrainBuilder.builder()
        .content(ddl)
        .policy(TrainPolicyType.DDL)
        .build());

sqlEngine.train(TrainBuilder.builder()
        .content(sql)
        .question("查询所有用户")
        .policy(TrainPolicyType.SQL)
        .build());

下一步

• 查看 核心类文档 了解核心类的使用
• 学习 构建器文档 了解构建器的使用
• 探索 引擎文档 了解引擎接口