Class RetrieveMemoriesRequest.SimilaritySearchParams.Builder (3.77.0)
public static final class RetrieveMemoriesRequest.SimilaritySearchParams.Builder extends GeneratedMessageV3.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder> implements RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder
Parameters for semantic similarity search based retrieval.
Protobuf type
google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams build()
public RetrieveMemoriesRequest.SimilaritySearchParams buildPartial()
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clear()
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearSearchQuery()
Required. Query to use for similarity search retrieval. If provided, then
the parent ReasoningEngine must have
ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig
set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearTopK()
Optional. The maximum number of memories to return.
The service may return fewer than this value. If unspecified, at most 3
memories will be returned. The maximum value is 100; values above 100
will be coerced to 100.
int32 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clone()
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
public String getSearchQuery()
Required. Query to use for similarity search retrieval. If provided, then
the parent ReasoningEngine must have
ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig
set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The searchQuery.
|
public ByteString getSearchQueryBytes()
Required. Query to use for similarity search retrieval. If provided, then
the parent ReasoningEngine must have
ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig
set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for searchQuery.
|
Optional. The maximum number of memories to return.
The service may return fewer than this value. If unspecified, at most 3
memories will be returned. The maximum value is 100; values above 100
will be coerced to 100.
int32 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The topK.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(RetrieveMemoriesRequest.SimilaritySearchParams other)
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public final RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setSearchQuery(String value)
Required. Query to use for similarity search retrieval. If provided, then
the parent ReasoningEngine must have
ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig
set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
String
The searchQuery to set.
|
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setSearchQueryBytes(ByteString value)
Required. Query to use for similarity search retrieval. If provided, then
the parent ReasoningEngine must have
ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig
set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for searchQuery to set.
|
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setTopK(int value)
Optional. The maximum number of memories to return.
The service may return fewer than this value. If unspecified, at most 3
memories will be returned. The maximum value is 100; values above 100
will be coerced to 100.
int32 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
value |
int
The topK to set.
|
public final RetrieveMemoriesRequest.SimilaritySearchParams.Builder setUnknownFields(UnknownFieldSet unknownFields)
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-10-11 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-10-11 UTC."],[],[]]
