Class VectorSearch

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

Constructors

View Source

VectorSearch(ICollection<VectorQuery>, VectorSearchOptions?)

Declaration
public VectorSearch(ICollection<VectorQuery> VectorQueries, VectorSearchOptions? Options)
Parameters
Type Name Description
ICollection<VectorQuery> VectorQueries
VectorSearchOptions Options

Properties

View Source

Options

Declaration
public VectorSearchOptions? Options { get; init; }
Property Value
Type Description
VectorSearchOptions
View Source

VectorQueries

Declaration
[JsonPropertyName("knn")]
[JsonProperty("knn")]
public ICollection<VectorQuery> VectorQueries { get; init; }
Property Value
Type Description
ICollection<VectorQuery>
View Source

VectorQueryCombination

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

Methods

View Source

Create(VectorQuery, VectorSearchOptions?)

Declaration
public static VectorSearch Create(VectorQuery vectorQuery, VectorSearchOptions? options = null)
Parameters
Type Name Description
VectorQuery vectorQuery
VectorSearchOptions options
Returns
Type Description
VectorSearch
View Source

Create(ICollection<VectorQuery>, VectorSearchOptions?)

Declaration
public static VectorSearch Create(ICollection<VectorQuery> vectorQueries, VectorSearchOptions? options = null)
Parameters
Type Name Description
ICollection<VectorQuery> vectorQueries
VectorSearchOptions options
Returns
Type Description
VectorSearch
View Source

Deconstruct(out ICollection<VectorQuery>, out VectorSearchOptions?)

Declaration
public void Deconstruct(out ICollection<VectorQuery> VectorQueries, out VectorSearchOptions? Options)
Parameters
Type Name Description
ICollection<VectorQuery> VectorQueries
VectorSearchOptions Options
View Source

Equals(VectorSearch?)

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

Operators

View Source

operator ==(VectorSearch?, VectorSearch?)

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

operator !=(VectorSearch?, VectorSearch?)

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

Implements