AS AgentScopeAPI 手册 / API Reference

BailianClient

public class BailianClient
源码Source io/agentscope/core/rag/integration/bailian/BailianClient.java:51–305

Bailian 客户端,封装与远端服务的连接和调用。位于 io.agentscope.core.rag.integration.bailian 包。核心成员包括 retrieve、getWorkspaceId、BailianClient。

Client for interacting with Alibaba Cloud Bailian Knowledge Base API.

This class wraps the Bailian SDK and provides reactive API methods for knowledge base operations. It handles client initialization, request construction, and error handling.

Example usage:

`BailianConfig config = BailianConfig.builder()
.accessKeyId(...)
.accessKeySecret(...)
.workspaceId(...)
.build();

BailianClient client = new BailianClient(config);
RetrieveResponse response = client.retrieve("indexId", "query").block();
`

构造器摘要Constructor Summary

构造器Constructor说明Description
public BailianClient(BailianConfig config) throws Exception
创建新的BailianClient 实例。
Creates a new BailianClient instance.

方法摘要Method Summary

方法Method说明Description
public Mono<RetrieveResponse> retrieve(String indexId, String query, Integer limit)
按查询检索相关文档。
Retrieves relevant documents from a knowledge base with a limit.
public Mono<RetrieveResponse> retrieve(String indexId, String query, Integer limit, List<QueryHistoryEntry> conversationHistory)
按查询检索相关文档。
Retrieves relevant documents from a knowledge base with conversation history.
public String getWorkspaceId()
获取工作区标识。
Gets the workspace ID associated with this client.

构造器详情Constructor Detail

BailianClient

public BailianClient(BailianConfig config) throws Exception

创建新的BailianClient 实例。

Creates a new BailianClient instance.

参数Parameters
名称Name类型Type说明Description
configBailianConfig配置对象(类型 `BailianConfig`)。the Bailian configuration
抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/core/rag/integration/bailian/BailianClient.java:65–78

方法详情Method Detail

retrieve

public Mono<RetrieveResponse> retrieve(String indexId, String query, Integer limit)

按查询检索相关文档。

Retrieves relevant documents from a knowledge base with a limit.

参数Parameters
名称Name类型Type说明Description
indexIdString知识库基类标识到搜索 in。the knowledge base ID to search in
queryString搜索查询文本。the search query text
limitInteger数量上限(类型 `Integer`)。the maximum number of documents to retrieve (null for default)
返回Returns Mono<RetrieveResponse>
返回Mono。a Mono emitting the retrieve response
源码Source io/agentscope/core/rag/integration/bailian/BailianClient.java:117–119

retrieve

public Mono<RetrieveResponse> retrieve(String indexId, String query, Integer limit, List<QueryHistoryEntry> conversationHistory)

按查询检索相关文档。

Retrieves relevant documents from a knowledge base with conversation history.

参数Parameters
名称Name类型Type说明Description
indexIdString知识库基类标识到搜索 in。the knowledge base ID to search in
queryString搜索查询文本。the search query text
limitInteger数量上限(类型 `Integer`)。the maximum number of documents to retrieve (null for default)
conversationHistoryList<QueryHistoryEntry>会话历史(类型 `List`)。the conversation history for multi-turn rewrite (can be null)
返回Returns Mono<RetrieveResponse>
返回Mono。a Mono emitting the retrieve response
源码Source io/agentscope/core/rag/integration/bailian/BailianClient.java:138–277

getWorkspaceId

public String getWorkspaceId()

获取工作区标识。

Gets the workspace ID associated with this client.

返回Returns String
工作区标识。the workspace ID
源码Source io/agentscope/core/rag/integration/bailian/BailianClient.java:284–286
基于官方固定版本源码静态生成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.