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

| Edit this page View Source

VectorQuery(string, VectorQueryOptions?)

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

Fields

| Edit this page View Source

DefaultNumCandidates

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

Properties

| Edit this page 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
| Edit this page View Source

Boost

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

NumCandidates

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

Options

Declaration
[JsonIgnore]
[JsonIgnore]
public VectorQueryOptions? Options { get; init; }
Property Value
Type Description
VectorQueryOptions
| Edit this page 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[]
| Edit this page View Source

VectorFieldName

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

Methods

| Edit this page 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
| Edit this page 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
| Edit this page View Source

WithBase64EncodedVector(string)

Declaration
public VectorQuery WithBase64EncodedVector(string vector)
Parameters
Type Name Description
string vector
Returns
Type Description
VectorQuery
| Edit this page View Source

WithOptions(VectorQueryOptions)

Declaration
public VectorQuery WithOptions(VectorQueryOptions options)
Parameters
Type Name Description
VectorQueryOptions options
Returns
Type Description
VectorQuery
| Edit this page View Source

WithVector(float[])

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

Implements