Class SemanticSearch (0.1.0)
public final class SemanticSearch extends GeneratedMessageV3 implements SemanticSearchOrBuilder
Defines a semantic search operation.
Protobuf type google.cloud.vectorsearch.v1beta.SemanticSearch
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
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_TEXT_FIELD_NUMBER
public static final int SEARCH_TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TASK_TYPE_FIELD_NUMBER
public static final int TASK_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOP_K_FIELD_NUMBER
public static final int TOP_K_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SemanticSearch getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SemanticSearch.Builder newBuilder()
newBuilder(SemanticSearch prototype)
public static SemanticSearch.Builder newBuilder(SemanticSearch prototype)
public static SemanticSearch parseDelimitedFrom(InputStream input)
public static SemanticSearch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SemanticSearch parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SemanticSearch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SemanticSearch parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SemanticSearch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SemanticSearch parseFrom(CodedInputStream input)
public static SemanticSearch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SemanticSearch parseFrom(InputStream input)
public static SemanticSearch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SemanticSearch parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SemanticSearch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SemanticSearch> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SemanticSearch getDefaultInstanceForType()
getOutputFields()
public OutputFields getOutputFields()
Optional. The fields to return in the search results.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
getOutputFieldsOrBuilder()
public OutputFieldsOrBuilder getOutputFieldsOrBuilder()
Optional. The fields to return in the search results.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<SemanticSearch> getParserForType()
Overrides
getSearchField()
public 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 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 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTaskType()
public EmbeddingTaskType getTaskType()
Optional. The task type of the query embedding.
.google.cloud.vectorsearch.v1beta.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
getTaskTypeValue()
public 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()
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 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()
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SemanticSearch.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SemanticSearch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SemanticSearch.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
