Class VectorSearch (0.1.0)

public final class VectorSearch extends GeneratedMessageV3 implements VectorSearchOrBuilder

Defines a search operation using a query vector.

Protobuf type google.cloud.vectorsearch.v1beta.VectorSearch

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > VectorSearch

Implements

VectorSearchOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DISTANCE_METRIC_FIELD_NUMBER

public static final int DISTANCE_METRIC_FIELD_NUMBER

Field Value
Type	Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

Field Value
Type	Description
int

OUTPUT_FIELDS_FIELD_NUMBER

public static final int OUTPUT_FIELDS_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_FIELD_FIELD_NUMBER

public static final int SEARCH_FIELD_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_HINT_FIELD_NUMBER

public static final int SEARCH_HINT_FIELD_NUMBER

Field Value
Type	Description
int

SPARSE_VECTOR_FIELD_NUMBER

public static final int SPARSE_VECTOR_FIELD_NUMBER

Field Value
Type	Description
int

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER

Field Value
Type	Description
int

VECTOR_FIELD_NUMBER

public static final int VECTOR_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static VectorSearch getDefaultInstance()

Returns
Type	Description
VectorSearch

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static VectorSearch.Builder newBuilder()

Returns
Type	Description
VectorSearch.Builder

newBuilder(VectorSearch prototype)

public static VectorSearch.Builder newBuilder(VectorSearch prototype)

Parameter
Name	Description
prototype	VectorSearch

Returns
Type	Description
VectorSearch.Builder

parseDelimitedFrom(InputStream input)

public static VectorSearch parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VectorSearch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static VectorSearch parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VectorSearch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VectorSearch parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VectorSearch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VectorSearch parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VectorSearch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static VectorSearch parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VectorSearch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static VectorSearch parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VectorSearch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VectorSearch

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<VectorSearch> parser()

Returns
Type	Description
Parser<VectorSearch>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public VectorSearch getDefaultInstanceForType()

Returns
Type	Description
VectorSearch

getDistanceMetric()

public DistanceMetric getDistanceMetric()

Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DistanceMetric	The distanceMetric.

getDistanceMetricValue()

public int getDistanceMetricValue()

Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for distanceMetric.

getFilter()

public Struct getFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The filter.

getFilterOrBuilder()

public StructOrBuilder getFilterOrBuilder()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getOutputFields()

public OutputFields getOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFields	The outputFields.

getOutputFieldsOrBuilder()

public OutputFieldsOrBuilder getOutputFieldsOrBuilder()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFieldsOrBuilder

getParserForType()

public Parser<VectorSearch> getParserForType()

Returns
Type	Description
Parser<VectorSearch>

Overrides

GeneratedMessageV3.getParserForType()

getSearchField()

public String getSearchField()

Required. The vector field to search.

string search_field = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The searchField.

getSearchFieldBytes()

public ByteString getSearchFieldBytes()

Required. The vector field to search.

string search_field = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for searchField.

getSearchHint()

public SearchHint getSearchHint()

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint	The searchHint.

getSearchHintOrBuilder()

public SearchHintOrBuilder getSearchHintOrBuilder()

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHintOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSparseVector()

public SparseVector getSparseVector()

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Returns
Type	Description
SparseVector	The sparseVector.

getSparseVectorOrBuilder()

public SparseVectorOrBuilder getSparseVectorOrBuilder()

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Returns
Type	Description
SparseVectorOrBuilder

getTopK()

public int getTopK()

Optional. The number of nearest neighbors to return.

optional int32 top_k = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The topK.

getVector()

public DenseVector getVector()

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Returns
Type	Description
DenseVector	The vector.

getVectorOrBuilder()

public DenseVectorOrBuilder getVectorOrBuilder()

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Returns
Type	Description
DenseVectorOrBuilder

getVectorTypeCase()

public VectorSearch.VectorTypeCase getVectorTypeCase()

Returns
Type	Description
VectorSearch.VectorTypeCase

hasFilter()

public boolean hasFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the filter field is set.

hasOutputFields()

public boolean hasOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the outputFields field is set.

hasSearchHint()

public boolean hasSearchHint()

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the searchHint field is set.

hasSparseVector()

public boolean hasSparseVector()

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Returns
Type	Description
boolean	Whether the sparseVector field is set.

hasTopK()

public boolean hasTopK()

Optional. The number of nearest neighbors to return.

optional int32 top_k = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the topK field is set.

hasVector()

public boolean hasVector()

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Returns
Type	Description
boolean	Whether the vector field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public VectorSearch.Builder newBuilderForType()

Returns
Type	Description
VectorSearch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VectorSearch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
VectorSearch.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public VectorSearch.Builder toBuilder()

Returns
Type	Description
VectorSearch.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException