BailianClient
public class BailianClient
源码Source
io/agentscope/core/rag/integration/bailian/BailianClient.java:51–305Bailian 客户端,封装与远端服务的连接和调用。位于 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 |
|---|---|---|
config | BailianConfig | 配置对象(类型 `BailianConfig`)。the Bailian configuration |
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 |
|---|---|---|
indexId | String | 知识库基类标识到搜索 in。the knowledge base ID to search in |
query | String | 搜索查询文本。the search query text |
limit | Integer | 数量上限(类型 `Integer`)。the maximum number of documents to retrieve (null for default) |
Mono<RetrieveResponse>返回Mono。a Mono emitting the retrieve response
源码Source
io/agentscope/core/rag/integration/bailian/BailianClient.java:117–119retrieve
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 |
|---|---|---|
indexId | String | 知识库基类标识到搜索 in。the knowledge base ID to search in |
query | String | 搜索查询文本。the search query text |
limit | Integer | 数量上限(类型 `Integer`)。the maximum number of documents to retrieve (null for default) |
conversationHistory | List<QueryHistoryEntry> | 会话历史(类型 `List`)。the conversation history for multi-turn rewrite (can be null) |
Mono<RetrieveResponse>返回Mono。a Mono emitting the retrieve response
源码Source
io/agentscope/core/rag/integration/bailian/BailianClient.java:138–277getWorkspaceId
public String getWorkspaceId()
获取工作区标识。
Gets the workspace ID associated with this client.
String工作区标识。the workspace ID
源码Source
io/agentscope/core/rag/integration/bailian/BailianClient.java:284–286