Interface FindNeighborsRequestOrBuilder (3.55.0) 

public interface FindNeighborsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDeployedIndexId()

public abstract String getDeployedIndexId()

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.

string deployed_index_id = 2;

Returns
Type Description
String

The deployedIndexId.

getDeployedIndexIdBytes()

public abstract ByteString getDeployedIndexIdBytes()

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.

string deployed_index_id = 2;

Returns
Type Description
ByteString

The bytes for deployedIndexId.

getIndexEndpoint()

public abstract String getIndexEndpoint()

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The indexEndpoint.

getIndexEndpointBytes()

public abstract ByteString getIndexEndpointBytes()

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for indexEndpoint.

getQueries(int index)

public abstract FindNeighborsRequest.Query getQueries(int index)

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Parameter
Name Description
index int
Returns
Type Description
FindNeighborsRequest.Query

getQueriesCount()

public abstract int getQueriesCount()

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Returns
Type Description
int

getQueriesList()

public abstract List<FindNeighborsRequest.Query> getQueriesList()

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Returns
Type Description
List<Query>

getQueriesOrBuilder(int index)

public abstract FindNeighborsRequest.QueryOrBuilder getQueriesOrBuilder(int index)

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Parameter
Name Description
index int
Returns
Type Description
FindNeighborsRequest.QueryOrBuilder

getQueriesOrBuilderList()

public abstract List<? extends FindNeighborsRequest.QueryOrBuilder> getQueriesOrBuilderList()

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.FindNeighborsRequest.QueryOrBuilder>

getReturnFullDatapoint()

public abstract boolean getReturnFullDatapoint()

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.

bool return_full_datapoint = 4;

Returns
Type Description
boolean

The returnFullDatapoint.