Vector Search V1 API - Class Google::Cloud::VectorSearch::V1::SearchHint (v0.1.0)

Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::SearchHint.

Represents a hint to the search index engine.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#index_hint

def index_hint() -> ::Google::Cloud::VectorSearch::V1::SearchHint::IndexHint
Returns
  • (::Google::Cloud::VectorSearch::V1::SearchHint::IndexHint) — Optional. Specifies that the search should use a particular index.

    Note: The following fields are mutually exclusive: index_hint, knn_hint. If a field in that set is populated, all other fields in the set will automatically be cleared.

#index_hint=

def index_hint=(value) -> ::Google::Cloud::VectorSearch::V1::SearchHint::IndexHint
Parameter
  • value (::Google::Cloud::VectorSearch::V1::SearchHint::IndexHint) — Optional. Specifies that the search should use a particular index.

    Note: The following fields are mutually exclusive: index_hint, knn_hint. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::VectorSearch::V1::SearchHint::IndexHint) — Optional. Specifies that the search should use a particular index.

    Note: The following fields are mutually exclusive: index_hint, knn_hint. If a field in that set is populated, all other fields in the set will automatically be cleared.

#knn_hint

def knn_hint() -> ::Google::Cloud::VectorSearch::V1::SearchHint::KnnHint
Returns
  • (::Google::Cloud::VectorSearch::V1::SearchHint::KnnHint) — Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

    Note: The following fields are mutually exclusive: knn_hint, index_hint. If a field in that set is populated, all other fields in the set will automatically be cleared.

#knn_hint=

def knn_hint=(value) -> ::Google::Cloud::VectorSearch::V1::SearchHint::KnnHint
Parameter
  • value (::Google::Cloud::VectorSearch::V1::SearchHint::KnnHint) — Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

    Note: The following fields are mutually exclusive: knn_hint, index_hint. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::VectorSearch::V1::SearchHint::KnnHint) — Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

    Note: The following fields are mutually exclusive: knn_hint, index_hint. If a field in that set is populated, all other fields in the set will automatically be cleared.