All Implemented Interfaces:

com.embabel.agent.rag.RagRequestRefinement , com.embabel.agent.rag.RetrievalFilters , com.embabel.common.core.types.SimilarityCutoff
```
public final class RagOptions
 implements RagRequestRefinement<RagOptions>
                    
```
Operations for RAG use as an LLM tool. Options are immutable and stable.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final RagService`	`ragService`
`private final Double`	`similarityThreshold`
`private final Integer`	`topK`
`private final HyDE`	`hyDE`
`private final Duration`	`desiredMaxLatency`
`private final CompressionConfig`	`compressionConfig`
`private final LlmOptions`	`llm`
`private final ContentElementSearch`	`contentElementSearch`
`private final EntitySearch`	`entitySearch`
`private final RagResponseFormatter`	`ragResponseFormatter`
`private final DualShotConfig`	`dualShot`

Constructor Summary

Constructors
Constructor	Description
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm, ContentElementSearch contentElementSearch, EntitySearch entitySearch, RagResponseFormatter ragResponseFormatter, DualShotConfig dualShot)`
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm, ContentElementSearch contentElementSearch, EntitySearch entitySearch, RagResponseFormatter ragResponseFormatter)`
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm, ContentElementSearch contentElementSearch, EntitySearch entitySearch)`
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm, ContentElementSearch contentElementSearch)`
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm)`
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig)`
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency)`
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE)`
`RagOptions(RagService ragService, Double similarityThreshold, Integer topK)`
`RagOptions(RagService ragService, Double similarityThreshold)`
`RagOptions(RagService ragService)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final RagService`	`getRagService()`
`Double`	`getSimilarityThreshold()`
`Integer`	`getTopK()`
`HyDE`	`getHyDE()`
`Duration`	`getDesiredMaxLatency()`
`CompressionConfig`	`getCompressionConfig()`
`final LlmOptions`	`getLlm()`
`ContentElementSearch`	`getContentElementSearch()`
`EntitySearch`	`getEntitySearch()`
`final RagResponseFormatter`	`getRagResponseFormatter()`
`final DualShotConfig`	`getDualShot()`
`RagOptions`	`withHyDE(HyDE hyDE)`
`RagOptions`	`withSimilarityThreshold(Double similarityThreshold)`
`RagOptions`	`withTopK(Integer topK)`
`RagOptions`	`withDesiredMaxLatency(Duration desiredMaxLatency)`
`RagOptions`	`withCompression(CompressionConfig compressionConfig)`
`RagOptions`	`withContentElementSearch(ContentElementSearch contentElementSearch)`
`RagOptions`	`withEntitySearch(EntitySearch entitySearch)`
`final RagOptions`	`withDualShot(DualShotConfig dualShot)`

Methods inherited from class com.embabel.agent.rag.RagRequestRefinement
toRequest
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm, ContentElementSearch contentElementSearch, EntitySearch entitySearch, RagResponseFormatter ragResponseFormatter, DualShotConfig dualShot)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
  
  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.
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm, ContentElementSearch contentElementSearch, EntitySearch entitySearch, RagResponseFormatter ragResponseFormatter)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
  
  ragResponseFormatter - formatter to convert RagResponse to String
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm, ContentElementSearch contentElementSearch, EntitySearch entitySearch)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm, ContentElementSearch contentElementSearch)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, LlmOptions llm)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK, HyDE hyDE)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold, Integer topK)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
  
  topK - maximum number of results to return returned.
- RagOptions
```
RagOptions(RagService ragService, Double similarityThreshold)
```
  Parameters:
  
  ragService - the RagService to use for retrieval
  
  similarityThreshold - minimum similarity threshold for results (0.0 to 1.
- RagOptions
```
RagOptions(RagService ragService)
```
  Parameters:
  
  ragService - the RagService to use for retrieval

Method Detail

getRagService
```
 final RagService getRagService()
```

getSimilarityThreshold
```
 Double getSimilarityThreshold()
```

getTopK
```
 Integer getTopK()
```

getHyDE
```
 HyDE getHyDE()
```

getDesiredMaxLatency
```
 Duration getDesiredMaxLatency()
```

getCompressionConfig

 CompressionConfig getCompressionConfig()

getLlm
```
 final LlmOptions getLlm()
```

getContentElementSearch

 ContentElementSearch getContentElementSearch()

getEntitySearch
```
 EntitySearch getEntitySearch()
```

getRagResponseFormatter

 final RagResponseFormatter getRagResponseFormatter()

getDualShot
```
 final DualShotConfig getDualShot()
```

withHyDE
```
 RagOptions withHyDE(HyDE hyDE)
```

withSimilarityThreshold

 RagOptions withSimilarityThreshold(Double similarityThreshold)

withTopK
```
 RagOptions withTopK(Integer topK)
```

withDesiredMaxLatency

 RagOptions withDesiredMaxLatency(Duration desiredMaxLatency)

withCompression

 RagOptions withCompression(CompressionConfig compressionConfig)

withContentElementSearch

 RagOptions withContentElementSearch(ContentElementSearch contentElementSearch)

withEntitySearch

 RagOptions withEntitySearch(EntitySearch entitySearch)

withDualShot

 final RagOptions withDualShot(DualShotConfig dualShot)

Class RagOptions

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.embabel.agent.rag.RagRequestRefinement

Methods inherited from class java.lang.Object

Constructor Detail

RagOptions

RagOptions

RagOptions

RagOptions

RagOptions

RagOptions

RagOptions

RagOptions

RagOptions

RagOptions

RagOptions

Method Detail

getRagService

getSimilarityThreshold

getTopK

getHyDE

getDesiredMaxLatency

getCompressionConfig

getLlm

getContentElementSearch

getEntitySearch

getRagResponseFormatter

getDualShot

withHyDE

withSimilarityThreshold

withTopK

withDesiredMaxLatency

withCompression

withContentElementSearch

withEntitySearch

withDualShot