Class FindNeighborsResponse.Neighbor (3.77.0)
public static final class FindNeighborsResponse.Neighbor extends GeneratedMessageV3 implements FindNeighborsResponse.NeighborOrBuilder
A neighbor of the query vector.
Protobuf type google.cloud.aiplatform.v1.FindNeighborsResponse.Neighbor
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DATAPOINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISTANCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SPARSE_DISTANCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static FindNeighborsResponse.Neighbor getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static FindNeighborsResponse.Neighbor.Builder newBuilder()
public static FindNeighborsResponse.Neighbor.Builder newBuilder(FindNeighborsResponse.Neighbor prototype)
public static FindNeighborsResponse.Neighbor parseDelimitedFrom(InputStream input)
public static FindNeighborsResponse.Neighbor parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FindNeighborsResponse.Neighbor parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static FindNeighborsResponse.Neighbor parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FindNeighborsResponse.Neighbor parseFrom(ByteString data)
public static FindNeighborsResponse.Neighbor parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FindNeighborsResponse.Neighbor parseFrom(CodedInputStream input)
public static FindNeighborsResponse.Neighbor parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FindNeighborsResponse.Neighbor parseFrom(InputStream input)
public static FindNeighborsResponse.Neighbor parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FindNeighborsResponse.Neighbor parseFrom(ByteBuffer data)
public static FindNeighborsResponse.Neighbor parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<FindNeighborsResponse.Neighbor> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public IndexDatapoint getDatapoint()
The datapoint of the neighbor.
Note that full datapoints are returned only when "return_full_datapoint"
is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
fields are populated.
.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;
public IndexDatapointOrBuilder getDatapointOrBuilder()
The datapoint of the neighbor.
Note that full datapoints are returned only when "return_full_datapoint"
is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
fields are populated.
.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;
public FindNeighborsResponse.Neighbor getDefaultInstanceForType()
public double getDistance()
The distance between the neighbor and the dense embedding query.
double distance = 2;
| Returns |
| Type |
Description |
double |
The distance.
|
public Parser<FindNeighborsResponse.Neighbor> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public double getSparseDistance()
The distance between the neighbor and the query sparse_embedding.
double sparse_distance = 3;
| Returns |
| Type |
Description |
double |
The sparseDistance.
|
public boolean hasDatapoint()
The datapoint of the neighbor.
Note that full datapoints are returned only when "return_full_datapoint"
is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
fields are populated.
.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;
| Returns |
| Type |
Description |
boolean |
Whether the datapoint field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public FindNeighborsResponse.Neighbor.Builder newBuilderForType()
protected FindNeighborsResponse.Neighbor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public FindNeighborsResponse.Neighbor.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
