public interface SemanticSearchOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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. |
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. |
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. |
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. |