Embabel Agent Documentation/com.embabel.agent.rag.tools/RagOptions

RagOptions

data class RagOptions constructor(val ragService: RagService, val similarityThreshold: <Error class: unknown class> = 0.7, val topK: Int = 8, val hyDE: HyDE? = null, val desiredMaxLatency: Duration = Duration.ofMillis(5000), val compressionConfig: CompressionConfig = CompressionConfig(), val llm: <Error class: unknown class> = LlmOptions.withAutoLlm(), val contentElementSearch: ContentElementSearch = ContentElementSearch.CHUNKS_ONLY, val entitySearch: EntitySearch? = null, val ragResponseFormatter: RagResponseFormatter = SimpleRagResponseFormatter, val dualShot: DualShotConfig? = null) : RagRequestRefinement<RagOptions>

Operations for RAG use as an LLM tool. Options are immutable and stable.

Parameters

ragService

the RagService to use for retrieval

similarityThreshold

minimum similarity threshold for results (0.0 to 1.0)

topK

maximum number of results to return returned. If set, only the given entities will be searched for.

ragResponseFormatter

formatter to convert RagResponse to String

dualShot

whether to use dual-shot RAG, where the first tool returns a summary and the second tool returns detailed results.

Constructors

RagOptions

constructor(ragService: RagService, similarityThreshold: <Error class: unknown class> = 0.7, topK: Int = 8, hyDE: HyDE? = null, desiredMaxLatency: Duration = Duration.ofMillis(5000), compressionConfig: CompressionConfig = CompressionConfig(), llm: <Error class: unknown class> = LlmOptions.withAutoLlm(), contentElementSearch: ContentElementSearch = ContentElementSearch.CHUNKS_ONLY, entitySearch: EntitySearch? = null, ragResponseFormatter: RagResponseFormatter = SimpleRagResponseFormatter, dualShot: DualShotConfig? = null)