Reference documentation and code samples for the Google Cloud Vector Search V1 Client class IndexHint.
Message to specify the index to use for the search.
Generated from protobuf message google.cloud.vectorsearch.v1.SearchHint.IndexHint
Namespace
Google \ Cloud \ VectorSearch \ V1 \ SearchHintMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ dense_scann_params |
IndexHint\DenseScannParams
Optional. Dense ScaNN parameters. |
↳ name |
string
Required. The resource name of the index to use for the search. The index must be in the same project, location, and collection. Format: |
getDenseScannParams
Optional. Dense ScaNN parameters.
| Returns | |
|---|---|
| Type | Description |
IndexHint\DenseScannParams|null |
|
hasDenseScannParams
setDenseScannParams
Optional. Dense ScaNN parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
IndexHint\DenseScannParams
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Required. The resource name of the index to use for the search.
The index must be in the same project, location, and collection.
Format:
projects/{project}/locations/{location}/collections/{collection}/indexes/{index}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name of the index to use for the search.
The index must be in the same project, location, and collection.
Format:
projects/{project}/locations/{location}/collections/{collection}/indexes/{index}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParams
| Returns | |
|---|---|
| Type | Description |
string |
|