- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface FindNeighborsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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. |