Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class VectorQueryOptions

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

Constructors

View Source

VectorQueryOptions(float?, ISearchQuery?)

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

Properties

View Source

Boost

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

Filter

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

NumCandidates

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

Methods

View Source

Deconstruct(out float?, out ISearchQuery?)

Declaration
public void Deconstruct(out float? Boost, out ISearchQuery? Filter)
Parameters
Type Name Description
float? Boost
ISearchQuery Filter
View Source

Equals(VectorQueryOptions?)

Declaration
public bool Equals(VectorQueryOptions? other)
Parameters
Type Name Description
VectorQueryOptions other
Returns
Type Description
bool
View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()
View Source

WithBoost(float)

Declaration
public VectorQueryOptions WithBoost(float boost)
Parameters
Type Name Description
float boost
Returns
Type Description
VectorQueryOptions
View Source

WithFilter(ISearchQuery)

Declaration
public VectorQueryOptions WithFilter(ISearchQuery filter)
Parameters
Type Name Description
ISearchQuery filter
Returns
Type Description
VectorQueryOptions
View Source

WithNumCandidates(uint)

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

Operators

View Source

operator ==(VectorQueryOptions?, VectorQueryOptions?)

Declaration
public static bool operator ==(VectorQueryOptions? left, VectorQueryOptions? right)
Parameters
Type Name Description
VectorQueryOptions left
VectorQueryOptions right
Returns
Type Description
bool
View Source

operator !=(VectorQueryOptions?, VectorQueryOptions?)

Declaration
public static bool operator !=(VectorQueryOptions? left, VectorQueryOptions? right)
Parameters
Type Name Description
VectorQueryOptions left
VectorQueryOptions right
Returns
Type Description
bool

Implements

IEquatable<T>
  • View Source
In this article
Back to top Copyright © 2020 Couchbase, Inc. All rights reserved.