public interface VectorSearchOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDistanceMetric()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getSearchField()
public abstract 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 abstract 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 abstract 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 abstract 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 |
|
getSparseVector()
public abstract SparseVector getSparseVector()A sparse vector for the query.
.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;
| Returns | |
|---|---|
| Type | Description |
SparseVector |
The sparseVector. |
getSparseVectorOrBuilder()
public abstract SparseVectorOrBuilder getSparseVectorOrBuilder()A sparse vector for the query.
.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;
| Returns | |
|---|---|
| Type | Description |
SparseVectorOrBuilder |
|
getTopK()
public abstract 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 abstract DenseVector getVector()A dense vector for the query.
.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;
| Returns | |
|---|---|
| Type | Description |
DenseVector |
The vector. |
getVectorOrBuilder()
public abstract DenseVectorOrBuilder getVectorOrBuilder()A dense vector for the query.
.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;
| Returns | |
|---|---|
| Type | Description |
DenseVectorOrBuilder |
|
getVectorTypeCase()
public abstract VectorSearch.VectorTypeCase getVectorTypeCase()| Returns | |
|---|---|
| Type | Description |
VectorSearch.VectorTypeCase |
|
hasFilter()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |