Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FindNeighborsRequest (v0.49.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::FindNeighborsRequest.

The request message for MatchService.FindNeighbors.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#deployed_index_id

def deployed_index_id() -> ::String
Returns
  • (::String) — The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.

#deployed_index_id=

def deployed_index_id=(value) -> ::String
Parameter
  • value (::String) — The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.
Returns
  • (::String) — The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.

#index_endpoint

def index_endpoint() -> ::String
Returns
  • (::String) — Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

#index_endpoint=

def index_endpoint=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
Returns
  • (::String) — Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

#queries

def queries() -> ::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query>
Returns

#queries=

def queries=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query>
Parameter
Returns

#return_full_datapoint

def return_full_datapoint() -> ::Boolean
Returns
  • (::Boolean) — If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.

#return_full_datapoint=

def return_full_datapoint=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.
Returns
  • (::Boolean) — If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.