Package com.embabel.agent.rag
Class RagRequest
-
- 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.
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringqueryprivate final DoublesimilarityThresholdprivate final IntegertopKprivate final HyDEhyDEprivate final DurationdesiredMaxLatencyprivate final CompressionConfigcompressionConfigprivate final ContentElementSearchcontentElementSearchprivate final EntitySearchentitySearchprivate final Instanttimestamp
-
Constructor Summary
Constructors Constructor Description RagRequest(String query, Double similarityThreshold, Integer topK, HyDE hyDE, Duration desiredMaxLatency, CompressionConfig compressionConfig, ContentElementSearch contentElementSearch, EntitySearch entitySearch, Instant timestamp)
-
Method Summary
Modifier and Type Method Description StringgetQuery()DoublegetSimilarityThreshold()IntegergetTopK()HyDEgetHyDE()DurationgetDesiredMaxLatency()CompressionConfiggetCompressionConfig()ContentElementSearchgetContentElementSearch()EntitySearchgetEntitySearch()InstantgetTimestamp()RagRequestwithHyDE(HyDE hyDE)RagRequestwithSimilarityThreshold(Double similarityThreshold)RagRequestwithTopK(Integer topK)RagRequestwithCompression(CompressionConfig compressionConfig)RagRequestwithEntitySearch(EntitySearch entitySearch)RagRequestwithContentElementSearch(ContentElementSearch contentElementSearch)RagRequestwithDesiredMaxLatency(Duration desiredMaxLatency)final static RagRequestquery(String query)-
-
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 forsimilarityThreshold- 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
-
getSimilarityThreshold
Double getSimilarityThreshold()
-
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)
-
-
-
-