类class io.agentscope.core.rag.integration.bailian 2.x

Builder

public static class Builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:238–446

BailianConfig的构建器。位于 io.agentscope.core.rag.integration.bailian 包。核心成员包括 accessKeyId、accessKeySecret、workspaceId、indexId、endpoint、denseSimilarityTopK。

Builder for BailianConfig.

方法摘要Method Summary

方法Method	说明Description
`public` `Builder accessKeyId(String accessKeyId)`	设置访问键标识。 Sets the Alibaba Cloud Access Key ID.
`public` `Builder accessKeySecret(String accessKeySecret)`	设置访问键密钥。 Sets the Alibaba Cloud Access Key Secret.
`public` `Builder workspaceId(String workspaceId)`	设置工作区标识。 Sets the Bailian workspace ID.
`public` `Builder indexId(String indexId)`	设置知识库基类索引标识。 Sets the knowledge base index ID.
`public` `Builder endpoint(String endpoint)`	设置端点。 Sets the Bailian API endpoint.
`public` `Builder denseSimilarityTopK(Integer denseSimilarityTopK)`	设置该配置项。 Sets the dense similarity top K.
`public` `Builder sparseSimilarityTopK(Integer sparseSimilarityTopK)`	设置该配置项。 Sets the sparse similarity top K.
`public` `Builder enableReranking(Boolean enableReranking)`	启用该配置。 Sets whether to enable reranking.
`public` `Builder rerankConfig(RerankConfig rerankConfig)`	设置重排配置。 Sets the rerank configuration.
`public` `Builder enableRewrite(Boolean enableRewrite)`	启用该配置。 Sets whether to enable multi-turn conversation rewrite.
`public` `Builder rewriteConfig(RewriteConfig rewriteConfig)`	设置该配置项。 Sets the rewrite configuration.
`public` `Builder searchFilters(List<Map<String, String>> searchFilters)`	设置该配置项。 Sets search filters for personalized retrieval.
`public` `Builder saveRetrieverHistory(Boolean saveRetrieverHistory)`	设置保存检索器历史。 Sets whether to save retriever history.
`public` `BailianConfig build()`	构建新的BailianConfig 实例。 Builds a new BailianConfig instance.

方法详情Method Detail

accessKeyId

public Builder accessKeyId(String accessKeyId)

设置访问键标识。

Sets the Alibaba Cloud Access Key ID.

参数Parameters

名称Name	类型Type	说明Description
`accessKeyId`	String	访问密钥标识。the access key ID

返回Returns Builder

返回当前实例，以支持链式调用。this builder for method chaining

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:264–267

accessKeySecret

public Builder accessKeySecret(String accessKeySecret)

设置访问键密钥。

Sets the Alibaba Cloud Access Key Secret.

参数Parameters

名称Name	类型Type	说明Description
`accessKeySecret`	String	访问密钥密钥。the access key secret

返回Returns Builder

返回当前实例，以支持链式调用。this builder for method chaining

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:275–278

workspaceId

public Builder workspaceId(String workspaceId)

设置工作区标识。

Sets the Bailian workspace ID.

参数Parameters

名称Name	类型Type	说明Description
`workspaceId`	String	工作区标识。the workspace ID

返回Returns Builder

返回当前实例，以支持链式调用。this builder for method chaining

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:286–289

indexId

public Builder indexId(String indexId)

设置知识库基类索引标识。

Sets the knowledge base index ID.

参数Parameters

名称Name	类型Type	说明Description
`indexId`	String	索引标识。the index ID

返回Returns Builder

返回当前实例，以支持链式调用。this builder for method chaining

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:299–302

endpoint

public Builder endpoint(String endpoint)

设置端点。

Sets the Bailian API endpoint.

参数Parameters

名称Name	类型Type	说明Description
`endpoint`	String	API 端点。the API endpoint

返回Returns Builder

返回当前实例，以支持链式调用。this builder for method chaining

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:320–323

denseSimilarityTopK

public Builder denseSimilarityTopK(Integer denseSimilarityTopK)

设置该配置项。

Sets the dense similarity top K.

参数Parameters

名称Name	类型Type	说明Description
`denseSimilarityTopK`	Integer	dense Similarity Top K（类型 `Integer`）。the top K value

返回Returns Builder

返回当前实例，以支持链式调用。this builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:334–341

sparseSimilarityTopK

public Builder sparseSimilarityTopK(Integer sparseSimilarityTopK)

设置该配置项。

Sets the sparse similarity top K.

参数Parameters

名称Name	类型Type	说明Description
`sparseSimilarityTopK`	Integer	sparse Similarity Top K（类型 `Integer`）。the top K value

返回Returns Builder

返回当前实例，以支持链式调用。this builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:352–360

enableReranking

public Builder enableReranking(Boolean enableReranking)

启用该配置。

Sets whether to enable reranking.

参数Parameters

名称Name	类型Type	说明Description
`enableReranking`	Boolean	启用 Reranking（类型 `Boolean`）。true to enable reranking

返回Returns Builder

返回当前实例，以支持链式调用。this builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:370–373

rerankConfig

public Builder rerankConfig(RerankConfig rerankConfig)

设置重排配置。

Sets the rerank configuration.

参数Parameters

名称Name	类型Type	说明Description
`rerankConfig`	RerankConfig	重排配置。the rerank config

返回Returns Builder

返回当前实例，以支持链式调用。this builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:381–384

enableRewrite

public Builder enableRewrite(Boolean enableRewrite)

启用该配置。

Sets whether to enable multi-turn conversation rewrite.

参数Parameters

名称Name	类型Type	说明Description
`enableRewrite`	Boolean	启用 Rewrite（类型 `Boolean`）。true to enable rewrite

返回Returns Builder

返回当前实例，以支持链式调用。this builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:394–397

rewriteConfig

public Builder rewriteConfig(RewriteConfig rewriteConfig)

设置该配置项。

Sets the rewrite configuration.

参数Parameters

名称Name	类型Type	说明Description
`rewriteConfig`	RewriteConfig	rewrite 配置（类型 `RewriteConfig`）。the rewrite config

返回Returns Builder

返回当前实例，以支持链式调用。this builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:405–408

searchFilters

public Builder searchFilters(List<Map<String, String>> searchFilters)

设置该配置项。

Sets search filters for personalized retrieval.

参数Parameters

名称Name	类型Type	说明Description
`searchFilters`	List<Map<String, String>>	搜索 Filters（类型 `List >`）。the search filters

返回Returns Builder

返回当前实例，以支持链式调用。this builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:419–422

saveRetrieverHistory

public Builder saveRetrieverHistory(Boolean saveRetrieverHistory)

设置保存检索器历史。

Sets whether to save retriever history.

参数Parameters

名称Name	类型Type	说明Description
`saveRetrieverHistory`	Boolean	保存检索器历史（类型 `Boolean`）。true to save history

返回Returns Builder

返回当前实例，以支持链式调用。this builder

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:432–435

build

public BailianConfig build()

构建新的BailianConfig 实例。

Builds a new BailianConfig instance.

返回Returns BailianConfig

一种新的BailianConfig 实例。a new BailianConfig instance

抛出Throws

IllegalArgumentException 可能抛出 `IllegalArgumentException`。if required parameters are missing

源码Source io/agentscope/core/rag/integration/bailian/BailianConfig.java:443–445