Reference documentation and code samples for the Google Cloud Vector Search V1 Client class SearchHint.
Represents a hint to the search index engine.
Generated from protobuf message google.cloud.vectorsearch.v1.SearchHint
Namespace
Google \ Cloud \ VectorSearch \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ knn_hint |
SearchHint\KnnHint
Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine. |
↳ index_hint |
SearchHint\IndexHint
Optional. Specifies that the search should use a particular index. |
getKnnHint
Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.
| Returns | |
|---|---|
| Type | Description |
SearchHint\KnnHint|null |
|
hasKnnHint
setKnnHint
Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchHint\KnnHint
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIndexHint
Optional. Specifies that the search should use a particular index.
| Returns | |
|---|---|
| Type | Description |
SearchHint\IndexHint|null |
|
hasIndexHint
setIndexHint
Optional. Specifies that the search should use a particular index.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchHint\IndexHint
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIndexType
| Returns | |
|---|---|
| Type | Description |
string |
|