- 3.49.0 (latest)
- 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 static final class NearestNeighborQuery.Parameters extends GeneratedMessageV3 implements NearestNeighborQuery.ParametersOrBuilder
Parameters that can be overrided in each query to tune query latency and recall.
Protobuf type google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NearestNeighborQuery.ParametersImplements
NearestNeighborQuery.ParametersOrBuilderStatic Fields
APPROXIMATE_NEIGHBOR_CANDIDATES_FIELD_NUMBER
public static final int APPROXIMATE_NEIGHBOR_CANDIDATES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LEAF_NODES_SEARCH_FRACTION_FIELD_NUMBER
public static final int LEAF_NODES_SEARCH_FRACTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static NearestNeighborQuery.Parameters getDefaultInstance()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static NearestNeighborQuery.Parameters.Builder newBuilder()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters.Builder |
newBuilder(NearestNeighborQuery.Parameters prototype)
public static NearestNeighborQuery.Parameters.Builder newBuilder(NearestNeighborQuery.Parameters prototype)
Parameter | |
---|---|
Name | Description |
prototype |
NearestNeighborQuery.Parameters |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters.Builder |
parseDelimitedFrom(InputStream input)
public static NearestNeighborQuery.Parameters parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static NearestNeighborQuery.Parameters parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static NearestNeighborQuery.Parameters parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static NearestNeighborQuery.Parameters parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static NearestNeighborQuery.Parameters parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static NearestNeighborQuery.Parameters parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<NearestNeighborQuery.Parameters> parser()
Returns | |
---|---|
Type | Description |
Parser<Parameters> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getApproximateNeighborCandidates()
public int getApproximateNeighborCandidates()
Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.
int32 approximate_neighbor_candidates = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The approximateNeighborCandidates. |
getDefaultInstanceForType()
public NearestNeighborQuery.Parameters getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters |
getLeafNodesSearchFraction()
public double getLeafNodesSearchFraction()
Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.
double leaf_nodes_search_fraction = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
double |
The leafNodesSearchFraction. |
getParserForType()
public Parser<NearestNeighborQuery.Parameters> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Parameters> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public NearestNeighborQuery.Parameters.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NearestNeighborQuery.Parameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public NearestNeighborQuery.Parameters.Builder toBuilder()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.Parameters.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |