Interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder (3.77.0)

public static interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSearchQuery()

public abstract 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.

getSearchQueryBytes()

public abstract 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.

getTopK()

public abstract int getTopK()

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.