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

RAGFlowConfig

public class RAGFlowConfig

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:33–724

RAG Flow 配置，保存相关配置项。位于 io.agentscope.core.rag.integration.ragflow 包。核心成员包括 builder、getApiKey、getBaseUrl、getDatasetIds、getDocumentIds、getTopK。

Configuration for RAGFlow integration.

This class holds the configuration for connecting to RAGFlow service, including authentication, endpoint, and retrieval parameters.

API Reference: This configuration is designed to work with RAGFlow's retrieval API: POST /api/v1/retrieval

嵌套类摘要Nested Class Summary

类Class	类型Kind	说明Description
`Builder`	类class	构建器，用于构建并配置目标实例。 A class in io.agentscope.core.rag.integration.ragflow that turns private documents into retrievable knowledge.

方法摘要Method Summary

方法Method	说明Description
`public static Builder builder()` static	返回构建器实例。 Returns the builder.
`public String getApiKey()`	获取API 键。 Returns the api key.
`public String getBaseUrl()`	获取基类 URL。 Returns the base url.
`public List<String> getDatasetIds()`	获取 `getDatasetIds`。 Gets the dataset IDs.
`public List<String> getDocumentIds()`	获取文档 IDs 到过滤检索。 Gets the document IDs to filter retrieval.
`public Integer getTopK()`	获取 `getTopK`。 Gets the top K value for retrieval.
`public Double getSimilarityThreshold()`	获取 `getSimilarityThreshold`。 Gets the similarity threshold for filtering results.
`public Double getVectorSimilarityWeight()`	获取 `getVectorSimilarityWeight`。 Gets the vector similarity weight.
`public Integer getPage()`	获取页码。 Gets the page number for pagination.
`public Integer getPageSize()`	获取页码大小。 Gets the page size for pagination.
`public Boolean getUseKg()`	获取使用 Kg。 Gets whether to use knowledge graph for multi-hop queries.
`public Boolean getTocEnhance()`	获取 `getTocEnhance`。 Gets whether to use TOC (Table of Contents) enhancement.
`public String getRerankId()`	获取重排模型标识。 Gets the rerank model ID.
`public Boolean getKeyword()`	获取 `getKeyword`。 Gets whether keyword-based matching is enabled.
`public Boolean getHighlight()`	获取 `getHighlight`。 Gets whether highlighting of matched terms is enabled.
`public List<String> getCrossLanguages()`	获取 `getCrossLanguages`。 Gets the list of languages for cross-language retrieval.
`public Map<String, Object> getMetadataCondition()`	获取 `getMetadataCondition`。 Gets the metadata filtering conditions.
`public Duration getTimeout()`	获取超时。 Returns the timeout.
`public Integer getMaxRetries()`	获取最大重试。 Returns the max retries.
`public Map<String, String> getCustomHeaders()`	获取自定义请求头。 Returns the custom headers.

方法详情Method Detail

builder

public static Builder builder()

static

返回构建器实例。

Returns the builder.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:115–117

getApiKey

public String getApiKey()

获取API 键。

Returns the api key.

返回Returns String

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

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:119–121

getBaseUrl

public String getBaseUrl()

获取基类 URL。

Returns the base url.

返回Returns String

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

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:123–125

getDatasetIds

public List<String> getDatasetIds()

获取 getDatasetIds。

Gets the dataset IDs.

返回Returns List<String>

返回列出。the list of dataset IDs

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:134–136

getDocumentIds

public List<String> getDocumentIds()

获取文档 IDs 到过滤检索。

Gets the document IDs to filter retrieval.

返回Returns List<String>

返回列出。the list of document IDs, or null if not set

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:145–147

getTopK

public Integer getTopK()

获取 getTopK。

Gets the top K value for retrieval.

返回Returns Integer

返回数值结果。the top K value

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:156–158

getSimilarityThreshold

public Double getSimilarityThreshold()

获取 getSimilarityThreshold。

Gets the similarity threshold for filtering results.

返回Returns Double

返回数值结果。the similarity threshold (0.0-1.0)

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:167–169

getVectorSimilarityWeight

public Double getVectorSimilarityWeight()

获取 getVectorSimilarityWeight。

Gets the vector similarity weight.

返回Returns Double

返回数值结果。the vector similarity weight (0.0-1.0)

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:181–183

getPage

public Integer getPage()

获取页码。

Gets the page number for pagination.

返回Returns Integer

页码数量。the page number

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:192–194

getPageSize

public Integer getPageSize()

获取页码大小。

Gets the page size for pagination.

返回Returns Integer

页码大小。the page size

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:203–205

getUseKg

public Boolean getUseKg()

获取使用 Kg。

Gets whether to use knowledge graph for multi-hop queries.

返回Returns Boolean

返回布尔值，表示判断结果。true if knowledge graph is enabled

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:214–216

getTocEnhance

public Boolean getTocEnhance()

获取 getTocEnhance。

Gets whether to use TOC (Table of Contents) enhancement.

返回Returns Boolean

返回布尔值，表示判断结果。true if TOC enhancement is enabled

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:225–227

getRerankId

public String getRerankId()

获取重排模型标识。

Gets the rerank model ID.

返回Returns String

返回字符串结果。the rerank model ID, or null if not set

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:237–239

getKeyword

public Boolean getKeyword()

获取 getKeyword。

Gets whether keyword-based matching is enabled.

返回Returns Boolean

返回布尔值，表示判断结果。true if keyword matching is enabled

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:248–250

getHighlight

public Boolean getHighlight()

获取 getHighlight。

Gets whether highlighting of matched terms is enabled.

返回Returns Boolean

返回布尔值，表示判断结果。true if highlighting is enabled

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:259–261

getCrossLanguages

public List<String> getCrossLanguages()

获取 getCrossLanguages。

Gets the list of languages for cross-language retrieval.

返回Returns List<String>

返回列出。the list of target languages, or null if not set

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:268–270

getMetadataCondition

public Map<String, Object> getMetadataCondition()

获取 getMetadataCondition。

Gets the metadata filtering conditions.

返回Returns Map<String, Object>

返回映射。the metadata condition map, or null if not set

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:286–288

getTimeout

public Duration getTimeout()

获取超时。

Returns the timeout.

返回Returns Duration

返回时长。Returns duration.

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:290–292

getMaxRetries

public Integer getMaxRetries()

获取最大重试。

Returns the max retries.

返回Returns Integer

返回数值结果。Returns a numeric result.

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:294–296

getCustomHeaders

public Map<String, String> getCustomHeaders()

获取自定义请求头。

Returns the custom headers.

返回Returns Map<String, String>

返回映射。Returns map.

源码Source io/agentscope/core/rag/integration/ragflow/RAGFlowConfig.java:298–300

嵌套类详情Nested Class Detail

Builder

public static class Builder

构建器，用于构建并配置目标实例。位于 io.agentscope.core.rag.integration.ragflow 包。核心成员包括 apiKey、baseUrl、datasetIds、addDatasetId、documentIds、addDocumentId。

A class in io.agentscope.core.rag.integration.ragflow that turns private documents into retrievable knowledge. Declared in io.agentscope.core.rag.integration.ragflow.