public interface SemanticSearchOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 = 6 [(.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 = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getOutputFields()
public abstract OutputFields getOutputFields()Optional. The fields to return in the search results.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OutputFields |
The outputFields. |
getOutputFieldsOrBuilder()
public abstract OutputFieldsOrBuilder getOutputFieldsOrBuilder()Optional. The fields to return in the search results.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OutputFieldsOrBuilder |
|
getSearchField()
public abstract String getSearchField()Required. The vector field to search.
string search_field = 2 [(.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 = 2 [(.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 KNN search otherwise.
.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 7 [(.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 KNN search otherwise.
.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHintOrBuilder |
|
getSearchText()
public abstract String getSearchText()Required. The query text, which is used to generate an embedding according to the embedding model specified in the collection config.
string search_text = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The searchText. |
getSearchTextBytes()
public abstract ByteString getSearchTextBytes()Required. The query text, which is used to generate an embedding according to the embedding model specified in the collection config.
string search_text = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for searchText. |
getTaskType()
public abstract EmbeddingTaskType getTaskType()Optional. The task type of the query embedding.
.google.cloud.vectorsearch.v1beta.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EmbeddingTaskType |
The taskType. |
getTaskTypeValue()
public abstract int getTaskTypeValue()Optional. The task type of the query embedding.
.google.cloud.vectorsearch.v1beta.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for taskType. |
getTopK()
public abstract int getTopK()Optional. The number of data objects to return.
optional int32 top_k = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The topK. |
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 = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the filter field is set. |
hasOutputFields()
public abstract boolean hasOutputFields()Optional. The fields to return in the search results.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.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 KNN search otherwise.
.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the searchHint field is set. |
hasTopK()
public abstract boolean hasTopK()Optional. The number of data objects to return.
optional int32 top_k = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the topK field is set. |