All Implemented Interfaces:

com.embabel.agent.rag.RagRequestRefinement , com.embabel.agent.rag.RetrievalFilters , com.embabel.common.core.types.SimilarityCutoff , com.embabel.common.core.types.SimilaritySearchRequest , com.embabel.common.core.types.TextSimilaritySearchRequest , com.embabel.common.core.types.Timestamped
```
public final class RagRequest
 implements TextSimilaritySearchRequest, RagRequestRefinement<RagRequest>, Timestamped
                    
```
RAG request. Contains a query and parameters for similarity search.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`query`
`private final Double`	`similarityThreshold`
`private final Integer`	`topK`
`private final HyDE`	`hyDE`
`private final Duration`	`desiredMaxLatency`
`private final CompressionConfig`	`compressionConfig`
`private final ContentElementSearch`	`contentElementSearch`
`private final EntitySearch`	`entitySearch`
`private final Instant`	`timestamp`

Constructor Summary

Constructors
Constructor	Description
`RagRequest(String query, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, ContentElementSearch contentElementSearch, EntitySearch entitySearch, Instant timestamp)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getQuery()`
`Double`	`getSimilarityThreshold()`
`Integer`	`getTopK()`
`HyDE`	`getHyDE()`
`Duration`	`getDesiredMaxLatency()`
`CompressionConfig`	`getCompressionConfig()`
`ContentElementSearch`	`getContentElementSearch()`
`EntitySearch`	`getEntitySearch()`
`Instant`	`getTimestamp()`
`RagRequest`	`withHyDE(HyDE hyDE)`
`RagRequest`	`withSimilarityThreshold(Double similarityThreshold)`
`RagRequest`	`withTopK(Integer topK)`
`RagRequest`	`withCompression(CompressionConfig compressionConfig)`
`RagRequest`	`withEntitySearch(EntitySearch entitySearch)`
`RagRequest`	`withContentElementSearch(ContentElementSearch contentElementSearch)`
`RagRequest`	`withDesiredMaxLatency(Duration desiredMaxLatency)`
`final static RagRequest`	`query(String query)`

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
- RagRequest
```
RagRequest(String query, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, ContentElementSearch contentElementSearch, EntitySearch entitySearch, Instant timestamp)
```
  Parameters:
  
  query - the query string to search for
  
  similarityThreshold - the minimum similarity score for results (default is 0.
  
  topK - the maximum number of results to return (default is 8) If set, only the given entities will be searched for.

Method Detail

getQuery
```
 String getQuery()
```

getSimilarityThreshold
```
 Double getSimilarityThreshold()
```

getTopK
```
 Integer getTopK()
```

getHyDE
```
 HyDE getHyDE()
```

getDesiredMaxLatency
```
 Duration getDesiredMaxLatency()
```

getCompressionConfig

 CompressionConfig getCompressionConfig()

getContentElementSearch

 ContentElementSearch getContentElementSearch()

getEntitySearch
```
 EntitySearch getEntitySearch()
```

getTimestamp
```
 Instant getTimestamp()
```

withHyDE
```
 RagRequest withHyDE(HyDE hyDE)
```

withSimilarityThreshold

 RagRequest withSimilarityThreshold(Double similarityThreshold)

withTopK
```
 RagRequest withTopK(Integer topK)
```

withCompression

 RagRequest withCompression(CompressionConfig compressionConfig)

withEntitySearch

@ApiStatus.Experimental() RagRequest withEntitySearch(EntitySearch entitySearch)

withContentElementSearch

 RagRequest withContentElementSearch(ContentElementSearch contentElementSearch)

withDesiredMaxLatency

 RagRequest withDesiredMaxLatency(Duration desiredMaxLatency)

query

 final static RagRequest query(String query)

Class RagRequest

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

RagRequest

Method Detail

getQuery

getSimilarityThreshold

getTopK

getHyDE

getDesiredMaxLatency

getCompressionConfig

getContentElementSearch

getEntitySearch

getTimestamp

withHyDE

withSimilarityThreshold

withTopK

withCompression

withEntitySearch

withContentElementSearch

withDesiredMaxLatency

query