All Implemented Interfaces:: com.embabel.agent.rag.RetrievalFilters , com.embabel.common.core.types.SimilarityCutoff


public final class ClusterRetrievalRequest<E extends Object>
 implements RetrievalFilters<ClusterRetrievalRequest<E>>

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final EntitySearch`	`entitySearch`
`private final ContentElementSearch`	`contentElementSearch`
`private final Double`	`similarityThreshold`
`private final Integer`	`topK`
`private final String`	`vectorIndex`

Constructor Summary

Constructors
Constructor	Description
`ClusterRetrievalRequest(EntitySearch entitySearch, ContentElementSearch contentElementSearch, Double similarityThreshold, Integer topK, String vectorIndex)`
`ClusterRetrievalRequest(EntitySearch entitySearch, ContentElementSearch contentElementSearch, Double similarityThreshold, Integer topK)`
`ClusterRetrievalRequest(EntitySearch entitySearch, ContentElementSearch contentElementSearch, Double similarityThreshold)`
`ClusterRetrievalRequest(EntitySearch entitySearch, ContentElementSearch contentElementSearch)`
`ClusterRetrievalRequest(EntitySearch entitySearch)`
`ClusterRetrievalRequest()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`EntitySearch`	`getEntitySearch()`
`ContentElementSearch`	`getContentElementSearch()`
`Double`	`getSimilarityThreshold()`
`Integer`	`getTopK()`
`final String`	`getVectorIndex()`
`ClusterRetrievalRequest<E>`	`withSimilarityThreshold(Double similarityThreshold)`
`ClusterRetrievalRequest<E>`	`withTopK(Integer topK)`
`ClusterRetrievalRequest<E>`	`withEntitySearch(EntitySearch entitySearch)`
`ClusterRetrievalRequest<E>`	`withContentElementSearch(ContentElementSearch contentElementSearch)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClusterRetrievalRequest

ClusterRetrievalRequest(EntitySearch entitySearch, ContentElementSearch contentElementSearch, Double similarityThreshold, Integer topK, String vectorIndex)

ClusterRetrievalRequest

ClusterRetrievalRequest(EntitySearch entitySearch, ContentElementSearch contentElementSearch, Double similarityThreshold, Integer topK)

ClusterRetrievalRequest

ClusterRetrievalRequest(EntitySearch entitySearch, ContentElementSearch contentElementSearch, Double similarityThreshold)

ClusterRetrievalRequest

ClusterRetrievalRequest(EntitySearch entitySearch, ContentElementSearch contentElementSearch)

ClusterRetrievalRequest

ClusterRetrievalRequest(EntitySearch entitySearch)

ClusterRetrievalRequest
```
ClusterRetrievalRequest()
```

Method Detail

getEntitySearch
```
 EntitySearch getEntitySearch()
```

getContentElementSearch

 ContentElementSearch getContentElementSearch()

getSimilarityThreshold
```
 Double getSimilarityThreshold()
```

getTopK
```
 Integer getTopK()
```

getVectorIndex
```
 final String getVectorIndex()
```

withSimilarityThreshold

 ClusterRetrievalRequest<E> withSimilarityThreshold(Double similarityThreshold)

withTopK

 ClusterRetrievalRequest<E> withTopK(Integer topK)

withEntitySearch

 ClusterRetrievalRequest<E> withEntitySearch(EntitySearch entitySearch)

withContentElementSearch

 ClusterRetrievalRequest<E> withContentElementSearch(ContentElementSearch contentElementSearch)

Class ClusterRetrievalRequest

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusterRetrievalRequest

ClusterRetrievalRequest

ClusterRetrievalRequest

ClusterRetrievalRequest

ClusterRetrievalRequest

ClusterRetrievalRequest

Method Detail

getEntitySearch

getContentElementSearch

getSimilarityThreshold

getTopK

getVectorIndex

withSimilarityThreshold

withTopK

withEntitySearch

withContentElementSearch