AS AgentScopeAPI 手册 / API Reference

SearchDocumentDtoBuilder

public static class SearchDocumentDtoBuilder
源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:156–217

用于SearchDocument DTO的构建器类。位于 io.agentscope.core.rag.store.dto 包。核心成员包括 vectorName、queryEmbedding、limit、scoreThreshold、build。

Builder class for SearchDocument DTO.

方法摘要Method Summary

方法Method说明Description
public SearchDocumentDtoBuilder vectorName(String vectorName)
设置向量名称。
Set the vector name.
public SearchDocumentDtoBuilder queryEmbedding(double[] queryEmbedding)
设置查询向量化向量。
Set the query embedding vector.
public SearchDocumentDtoBuilder limit(int limit)
设置限制。
Set the limit for returned results.
public SearchDocumentDtoBuilder scoreThreshold(Double scoreThreshold)
设置分数阈值。
Set the similarity score threshold.
public SearchDocumentDto build()
构建SearchDocumentDto 实例。
Build a SearchDocumentDto instance.

方法详情Method Detail

vectorName

public SearchDocumentDtoBuilder vectorName(String vectorName)

设置向量名称。

Set the vector name.

参数Parameters
名称Name类型Type说明Description
vectorNameString向量名称(类型 `String`)。Vector name
返回Returns SearchDocumentDtoBuilder
返回SearchDocumentDtoBuilder。Builder instance
源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:170–173

queryEmbedding

public SearchDocumentDtoBuilder queryEmbedding(double[] queryEmbedding)

设置查询向量化向量。

Set the query embedding vector.

参数Parameters
名称Name类型Type说明Description
queryEmbeddingdouble[]查询向量化(类型 `double[]`)。Query embedding vector
返回Returns SearchDocumentDtoBuilder
返回SearchDocumentDtoBuilder。Builder instance
源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:181–184

limit

public SearchDocumentDtoBuilder limit(int limit)

设置限制。

Set the limit for returned results.

参数Parameters
名称Name类型Type说明Description
limitint数量上限(类型 `int`)。Limit for returned results
返回Returns SearchDocumentDtoBuilder
返回SearchDocumentDtoBuilder。Builder instance
源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:192–195

scoreThreshold

public SearchDocumentDtoBuilder scoreThreshold(Double scoreThreshold)

设置分数阈值。

Set the similarity score threshold.

参数Parameters
名称Name类型Type说明Description
scoreThresholdDouble分数阈值(类型 `Double`)。Similarity score threshold
返回Returns SearchDocumentDtoBuilder
返回SearchDocumentDtoBuilder。Builder instance
源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:203–206

build

public SearchDocumentDto build()

构建SearchDocumentDto 实例。

Build a SearchDocumentDto instance.

返回Returns SearchDocumentDto
返回SearchDocumentDto。Search document DTO instance
源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:213–216
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.