Class VectorQueryOptions

Inheritance
object
VectorQueryOptions
Implements
Inherited Members
Namespace: Couchbase.Search.Queries.Vector
Assembly: Couchbase.NetClient.dll
Syntax
[InterfaceStability(Level.Committed)]
public sealed record VectorQueryOptions : IEquatable<VectorQueryOptions>

Constructors

| Edit this page View Source

VectorQueryOptions(float?, ISearchQuery?)

Declaration
public VectorQueryOptions(float? Boost = null, ISearchQuery? Filter = null)
Parameters
Type Name Description
float? Boost
ISearchQuery Filter

Properties

| Edit this page View Source

Boost

Declaration
public float? Boost { get; init; }
Property Value
Type Description
float?
| Edit this page View Source

Filter

Declaration
public ISearchQuery? Filter { get; init; }
Property Value
Type Description
ISearchQuery
| Edit this page View Source

NumCandidates

Declaration
public uint? NumCandidates { get; init; }
Property Value
Type Description
uint?

Methods

| Edit this page View Source

WithBoost(float)

Declaration
public VectorQueryOptions WithBoost(float boost)
Parameters
Type Name Description
float boost
Returns
Type Description
VectorQueryOptions
| Edit this page View Source

WithFilter(ISearchQuery)

Declaration
public VectorQueryOptions WithFilter(ISearchQuery filter)
Parameters
Type Name Description
ISearchQuery filter
Returns
Type Description
VectorQueryOptions
| Edit this page View Source

WithNumCandidates(uint)

Declaration
public VectorQueryOptions WithNumCandidates(uint numCandidates)
Parameters
Type Name Description
uint numCandidates
Returns
Type Description
VectorQueryOptions

Implements