Send feedback
Class RetrieveMemoriesRequest.SimilaritySearchParams (3.69.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public static final class RetrieveMemoriesRequest . SimilaritySearchParams extends GeneratedMessageV3 implements RetrieveMemoriesRequest . SimilaritySearchParamsOrBuilder
Parameters for semantic similarity search based retrieval.
Protobuf type
google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams
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
public static final int SEARCH_QUERY_FIELD_NUMBER
Field Value
Type Description
int
public static final int TOP_K_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static RetrieveMemoriesRequest . SimilaritySearchParams getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static RetrieveMemoriesRequest . SimilaritySearchParams . Builder newBuilder ()
public static RetrieveMemoriesRequest . SimilaritySearchParams . Builder newBuilder ( RetrieveMemoriesRequest . SimilaritySearchParams prototype )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseDelimitedFrom ( InputStream input )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( ByteString data )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( CodedInputStream input )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( InputStream input )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( ByteBuffer data )
public static RetrieveMemoriesRequest . SimilaritySearchParams parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<RetrieveMemoriesRequest . SimilaritySearchParams > parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public RetrieveMemoriesRequest . SimilaritySearchParams getDefaultInstanceForType ()
public Parser<RetrieveMemoriesRequest . SimilaritySearchParams > getParserForType ()
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.
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public RetrieveMemoriesRequest . SimilaritySearchParams . Builder newBuilderForType ()
protected RetrieveMemoriesRequest . SimilaritySearchParams . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public RetrieveMemoriesRequest . SimilaritySearchParams . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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-07-18 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-18 UTC."],[],[]]
