Class BaseFindAndRerankOptions<T, TSort>

Namespace

DataStax.AstraDB.DataApi.Core.Query

Assembly

DataStax.AstraDB.DataApi.dll

Base class for find-and-rerank operation options.

public abstract class BaseFindAndRerankOptions<T, TSort> : BasePaginatedFindOptions<T, BaseFindAndRerankOptions<T, TSort>> where T : class where TSort : FindAndRerankSortBuilder<T>

Type Parameters

T

TSort

Inheritance

object

CommandOptions

BasePaginatedFindOptions<T, BaseFindAndRerankOptions<T, TSort>>

BaseFindAndRerankOptions<T, TSort>

Derived

CollectionFindAndRerankOptions<T>

Inherited Members

BasePaginatedFindOptions<T, BaseFindAndRerankOptions<T, TSort>>.Projection

BasePaginatedFindOptions<T, BaseFindAndRerankOptions<T, TSort>>.IncludeSortVector

BasePaginatedFindOptions<T, BaseFindAndRerankOptions<T, TSort>>.InitialPageState

BasePaginatedFindOptions<T, BaseFindAndRerankOptions<T, TSort>>.Limit

CommandOptions.Token

CommandOptions.RunMode

CommandOptions.Destination

CommandOptions.HttpClientOptions

CommandOptions.APICallers

CommandOptions.TimeoutOptions

CommandOptions.APIVersion

CommandOptions.CancellationToken

CommandOptions.Defaults()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

HybridLimits

A maximum number of results to retrieve for each of the vector and lexical sub-searches in a FindAndRerank operation. When specifying this parameter, VectorLimit and LexicalLimit cannot be set.

public int? HybridLimits { get; set; }

Property Value

int?

IncludeScores

Whether to include similarity scores in the results.

public bool? IncludeScores { get; set; }

Property Value

bool?

LexicalLimit

A maximum number of results to retrieve for the lexical sub-search in a FindAndRerank operation. When specifying this parameter, VectorLimit must be set as well and HybridLimits cannot be set.

public int? LexicalLimit { get; set; }

Property Value

int?

RerankOn

The field to use for the reranking step of a FindAndRerank operation.

public string RerankOn { get; set; }

Property Value

string

RerankQuery

The query string to rerank against in the reranking step of a FindAndRerank operation.

public string RerankQuery { get; set; }

Property Value

string

Sort

Sort order for the query.

public TSort Sort { get; set; }

Property Value

TSort

VectorLimit

A maximum number of results to retrieve for the vector sub-search in a FindAndRerank operation. When specifying this parameter, LexicalLimit must be set as well and HybridLimits cannot be set.

public int? VectorLimit { get; set; }

Property Value

int?