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

| Edit this page View Source

VectorSearch(ICollection<VectorQuery>, VectorSearchOptions?)

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

Properties

| Edit this page View Source

Options

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

VectorQueries

Declaration
[JsonPropertyName("knn")]
[JsonProperty("knn")]
public ICollection<VectorQuery> VectorQueries { get; init; }
Property Value
Type Description
ICollection<VectorQuery>
| Edit this page 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

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

Implements