类class io.agentscope.core.rag.store.dto 2.x

SearchDocumentDto

public class SearchDocumentDto

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:24–218

搜索文档 Dto，把私有文档转化为可检索的知识。位于 io.agentscope.core.rag.store.dto 包。核心成员包括 getVectorName、setVectorName、getQueryEmbedding、setQueryEmbedding、getLimit、setLimit。

Search document data transfer object, used to encapsulate parameters for vector search. Contains vector name, query embedding, limit for returned results, and similarity score threshold.

嵌套类摘要Nested Class Summary

类Class	类型Kind	说明Description
`SearchDocumentDtoBuilder`	类class	用于SearchDocument DTO的构建器类。 Builder class for SearchDocument DTO.

方法摘要Method Summary

方法Method	说明Description
`public String getVectorName()`	获取向量名称。 Get the vector name.
`public void setVectorName(String vectorName)`	设置向量名称。 Set the vector name.
`public double[] getQueryEmbedding()`	获取查询向量化向量。 Get the query embedding vector.
`public void setQueryEmbedding(double[] queryEmbedding)`	设置查询向量化向量。 Set the query embedding vector.
`public int getLimit()`	获取限制。 Get the limit for returned results.
`public void setLimit(int limit)`	设置限制。 Set the limit for returned results.
`public Double getScoreThreshold()`	获取分数阈值。 Get the similarity score threshold.
`public void setScoreThreshold(Double scoreThreshold)`	设置分数阈值。 Set the similarity score threshold.
`public String toString()`	返回 `toString` 结果。 Returns the to string.
`public static` `SearchDocumentDtoBuilder builder()` static	创建SearchDocumentDto 构建器实例。 Create a SearchDocumentDto Builder instance.

方法详情Method Detail

getVectorName

public String getVectorName()

获取向量名称。

Get the vector name.

返回Returns String

返回字符串结果。Vector name

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:68–70

setVectorName

public void setVectorName(String vectorName)

设置向量名称。

Set the vector name.

参数Parameters

名称Name	类型Type	说明Description
`vectorName`	String	向量名称（类型 `String`）。Vector name

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:77–79

getQueryEmbedding

public double[] getQueryEmbedding()

获取查询向量化向量。

Get the query embedding vector.

返回Returns double[]

返回double[]。Query embedding vector

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:86–88

setQueryEmbedding

public void setQueryEmbedding(double[] queryEmbedding)

设置查询向量化向量。

Set the query embedding vector.

参数Parameters

名称Name	类型Type	说明Description
`queryEmbedding`	double[]	查询向量化（类型 `double[]`）。Query embedding vector

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:95–97

getLimit

public int getLimit()

获取限制。

Get the limit for returned results.

返回Returns int

返回数值结果。Limit for returned results

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:104–106

setLimit

public void setLimit(int limit)

设置限制。

Set the limit for returned results.

参数Parameters

名称Name	类型Type	说明Description
`limit`	int	数量上限（类型 `int`）。Limit for returned results

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:113–115

getScoreThreshold

public Double getScoreThreshold()

获取分数阈值。

Get the similarity score threshold.

返回Returns Double

返回数值结果。Similarity score threshold

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:122–124

setScoreThreshold

public void setScoreThreshold(Double scoreThreshold)

设置分数阈值。

Set the similarity score threshold.

参数Parameters

名称Name	类型Type	说明Description
`scoreThreshold`	Double	分数阈值（类型 `Double`）。Similarity score threshold

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:131–133

toString

public String toString()

返回 toString 结果。

Returns the to string.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:135–142

builder

public static SearchDocumentDtoBuilder builder()

static

创建SearchDocumentDto 构建器实例。

Create a SearchDocumentDto Builder instance.

返回Returns SearchDocumentDtoBuilder

返回SearchDocumentDtoBuilder。Builder instance

源码Source io/agentscope/core/rag/store/dto/SearchDocumentDto.java:149–151

嵌套类详情Nested Class Detail

SearchDocumentDtoBuilder

public static class SearchDocumentDtoBuilder

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

Builder class for SearchDocument DTO.