Vector Search v1 API - Class VectorSearch (1.0.0-beta01) 

public sealed class VectorSearch : IMessage<VectorSearch>, IEquatable<VectorSearch>, IDeepCloneable<VectorSearch>, IBufferMessage, IMessage

Reference documentation and code samples for the Vector Search v1 API class VectorSearch.

Defines a search operation using a query vector.

Inheritance

object > VectorSearch

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

VectorSearch()

public VectorSearch()

VectorSearch(VectorSearch)

public VectorSearch(VectorSearch other)
Parameter
Name Description
other VectorSearch

Properties

DistanceMetric

public DistanceMetric DistanceMetric { get; set; }

Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.

Property Value
Type Description
DistanceMetric

Filter

public Struct Filter { get; set; }

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

Property Value
Type Description
Struct

HasTopK

public bool HasTopK { get; }

Gets whether the "top_k" field is set

Property Value
Type Description
bool

OutputFields

public OutputFields OutputFields { get; set; }

Optional. Mask specifying which fields to return.

Property Value
Type Description
OutputFields

SearchField

public string SearchField { get; set; }

Required. The vector field to search.

Property Value
Type Description
string

SearchHint

public SearchHint SearchHint { get; set; }

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

Property Value
Type Description
SearchHint

SparseVector

public SparseVector SparseVector { get; set; }

A sparse vector for the query.

Property Value
Type Description
SparseVector

TopK

public int TopK { get; set; }

Optional. The number of nearest neighbors to return.

Property Value
Type Description
int

Vector

public DenseVector Vector { get; set; }

A dense vector for the query.

Property Value
Type Description
DenseVector

VectorTypeCase

public VectorSearch.VectorTypeOneofCase VectorTypeCase { get; }
Property Value
Type Description
VectorSearchVectorTypeOneofCase