Class VectorQuery

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

Constructors

View Source

VectorQuery(string, VectorQueryOptions?)

Declaration
public VectorQuery(string VectorFieldName, VectorQueryOptions? Options = null)
Parameters
Type Name Description
string VectorFieldName
VectorQueryOptions Options

Fields

View Source

DefaultNumCandidates

Declaration
public const int DefaultNumCandidates = 3
Field Value
Type Description
int

Properties

View Source

Base64EncodedVector

Declaration
[JsonPropertyName("vector_base64")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonProperty("vector_base64", NullValueHandling = NullValueHandling.Ignore)]
public string? Base64EncodedVector { get; init; }
Property Value
Type Description
string
View Source

Boost

Declaration
[JsonPropertyName("boost")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonProperty("boost", NullValueHandling = NullValueHandling.Ignore)]
public float? Boost { get; }
Property Value
Type Description
float?
View Source

Filter

Declaration
[JsonPropertyName("filter")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonProperty("filter", NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(SearchQuerySystemTextJsonConverter))]
[JsonConverter(typeof(SearchQueryNewtonsoftConverter))]
public ISearchQuery? Filter { get; }
Property Value
Type Description
ISearchQuery
View Source

NumCandidates

Declaration
[JsonPropertyName("k")]
[JsonProperty("k")]
public uint NumCandidates { get; }
Property Value
Type Description
uint
View Source

Options

Declaration
[JsonIgnore]
[JsonIgnore]
public VectorQueryOptions? Options { get; init; }
Property Value
Type Description
VectorQueryOptions
View Source

Vector

Declaration
[JsonPropertyName("vector")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonProperty("vector", NullValueHandling = NullValueHandling.Ignore)]
public float[]? Vector { get; init; }
Property Value
Type Description
float[]
View Source

VectorFieldName

Declaration
[JsonPropertyName("field")]
[JsonProperty("field")]
public string VectorFieldName { get; init; }
Property Value
Type Description
string

Methods

View Source

Create(string, float[], VectorQueryOptions?)

Declaration
public static VectorQuery Create(string vectorFieldName, float[] vector, VectorQueryOptions? options = null)
Parameters
Type Name Description
string vectorFieldName
float[] vector
VectorQueryOptions options
Returns
Type Description
VectorQuery
View Source

Create(string, string, VectorQueryOptions?)

Declaration
public static VectorQuery Create(string vectorFieldName, string base64EncodedVector, VectorQueryOptions? options = null)
Parameters
Type Name Description
string vectorFieldName
string base64EncodedVector
VectorQueryOptions options
Returns
Type Description
VectorQuery
View Source

Deconstruct(out string, out VectorQueryOptions?)

Declaration
public void Deconstruct(out string VectorFieldName, out VectorQueryOptions? Options)
Parameters
Type Name Description
string VectorFieldName
VectorQueryOptions Options
View Source

Equals(VectorQuery?)

Declaration
public bool Equals(VectorQuery? other)
Parameters
Type Name Description
VectorQuery 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
View Source

GetHashCode()

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

ToString()

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

WithBase64EncodedVector(string)

Declaration
public VectorQuery WithBase64EncodedVector(string vector)
Parameters
Type Name Description
string vector
Returns
Type Description
VectorQuery
View Source

WithOptions(VectorQueryOptions)

Declaration
public VectorQuery WithOptions(VectorQueryOptions options)
Parameters
Type Name Description
VectorQueryOptions options
Returns
Type Description
VectorQuery
View Source

WithVector(float[])

Declaration
public VectorQuery WithVector(float[] vector)
Parameters
Type Name Description
float[] vector
Returns
Type Description
VectorQuery

Operators

View Source

operator ==(VectorQuery?, VectorQuery?)

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

operator !=(VectorQuery?, VectorQuery?)

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

Implements