Reference documentation and code samples for the Google Cloud Vector Search V1 Client class VectorSearch.
Defines a search operation using a query vector.
Generated from protobuf message google.cloud.vectorsearch.v1.VectorSearch
Namespace
Google \ Cloud \ VectorSearch \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ vector
↳ sparse_vector
↳ search_field
string
Required. The vector field to search.
↳ filter
Google\Protobuf\Struct
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.
↳ top_k
int
Optional. The number of nearest neighbors to return.
↳ output_fields
↳ search_hint
SearchHint
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.
↳ distance_metric
int
Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.
getVector
A dense vector for the query.
hasVector
setVector
A dense vector for the query.
$this
getSparseVector
A sparse vector for the query.
hasSparseVector
setSparseVector
A sparse vector for the query.
$this
getSearchField
Required. The vector field to search.
string
setSearchField
Required. The vector field to search.
var
string
$this
getFilter
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.
hasFilter
clearFilter
setFilter
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.
$this
getTopK
Optional. The number of nearest neighbors to return.
int
hasTopK
clearTopK
setTopK
Optional. The number of nearest neighbors to return.
var
int
$this
getOutputFields
Optional. Mask specifying which fields to return.
hasOutputFields
clearOutputFields
setOutputFields
Optional. Mask specifying which fields to return.
$this
getSearchHint
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.
hasSearchHint
clearSearchHint
setSearchHint
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.
$this
getDistanceMetric
Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.
setDistanceMetric
Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.
$this
getVectorType
string
