public final class IndexDatapoint extends GeneratedMessageV3 implements IndexDatapointOrBuilder
A datapoint of Index.
Protobuf type google.cloud.aiplatform.v1beta1.IndexDatapoint
Static Fields
public static final int CROWDING_TAG_FIELD_NUMBER
Field Value
public static final int DATAPOINT_ID_FIELD_NUMBER
Field Value
public static final int FEATURE_VECTOR_FIELD_NUMBER
Field Value
public static final int RESTRICTS_FIELD_NUMBER
Field Value
Static Methods
public static IndexDatapoint getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static IndexDatapoint.Builder newBuilder()
Returns
public static IndexDatapoint.Builder newBuilder(IndexDatapoint prototype)
Parameter
Returns
public static IndexDatapoint parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static IndexDatapoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexDatapoint parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static IndexDatapoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexDatapoint parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static IndexDatapoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexDatapoint parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static IndexDatapoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexDatapoint parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static IndexDatapoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexDatapoint parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static IndexDatapoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<IndexDatapoint> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public IndexDatapoint.CrowdingTag getCrowdingTag()
Optional. CrowdingTag of the datapoint, the number of neighbors to return in each
crowding can be configured during query.
.google.cloud.aiplatform.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];
public IndexDatapoint.CrowdingTagOrBuilder getCrowdingTagOrBuilder()
Optional. CrowdingTag of the datapoint, the number of neighbors to return in each
crowding can be configured during query.
.google.cloud.aiplatform.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];
public String getDatapointId()
Required. Unique identifier of the datapoint.
string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The datapointId.
|
public ByteString getDatapointIdBytes()
Required. Unique identifier of the datapoint.
string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for datapointId.
|
public IndexDatapoint getDefaultInstanceForType()
Returns
public float getFeatureVector(int index)
Required. Feature embedding vector. An array of numbers with the length of
[NearestNeighborSearchConfig.dimensions].
repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| float | The featureVector at the given index.
|
public int getFeatureVectorCount()
Required. Feature embedding vector. An array of numbers with the length of
[NearestNeighborSearchConfig.dimensions].
repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| int | The count of featureVector.
|
public List<Float> getFeatureVectorList()
Required. Feature embedding vector. An array of numbers with the length of
[NearestNeighborSearchConfig.dimensions].
repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| List<Float> | A list containing the featureVector.
|
public Parser<IndexDatapoint> getParserForType()
Returns
Overrides
public IndexDatapoint.Restriction getRestricts(int index)
Optional. List of Restrict of the datapoint, used to perform "restricted searches"
where boolean rule are used to filter the subset of the database eligible
for matching.
See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
repeated .google.cloud.aiplatform.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
public int getRestrictsCount()
Optional. List of Restrict of the datapoint, used to perform "restricted searches"
where boolean rule are used to filter the subset of the database eligible
for matching.
See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
repeated .google.cloud.aiplatform.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
public List<IndexDatapoint.Restriction> getRestrictsList()
Optional. List of Restrict of the datapoint, used to perform "restricted searches"
where boolean rule are used to filter the subset of the database eligible
for matching.
See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
repeated .google.cloud.aiplatform.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
public IndexDatapoint.RestrictionOrBuilder getRestrictsOrBuilder(int index)
Optional. List of Restrict of the datapoint, used to perform "restricted searches"
where boolean rule are used to filter the subset of the database eligible
for matching.
See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
repeated .google.cloud.aiplatform.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
public List<? extends IndexDatapoint.RestrictionOrBuilder> getRestrictsOrBuilderList()
Optional. List of Restrict of the datapoint, used to perform "restricted searches"
where boolean rule are used to filter the subset of the database eligible
for matching.
See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
repeated .google.cloud.aiplatform.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| List<? extends com.google.cloud.aiplatform.v1beta1.IndexDatapoint.RestrictionOrBuilder> | |
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasCrowdingTag()
Optional. CrowdingTag of the datapoint, the number of neighbors to return in each
crowding can be configured during query.
.google.cloud.aiplatform.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the crowdingTag field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public IndexDatapoint.Builder newBuilderForType()
Returns
protected IndexDatapoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public IndexDatapoint.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
