com.google.cloud.aiplatform.v1beta1

Interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RetrieveMemoriesRequest.SimilaritySearchParams, RetrieveMemoriesRequest.SimilaritySearchParams.Builder

Enclosing class:

RetrieveMemoriesRequest

public static interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getSearchQuery() Required.
com.google.protobuf.ByteString	getSearchQueryBytes() Required.
int	getTopK() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSearchQuery

String getSearchQuery()

 Required. Query to use for similarity search retrieval. If provided, then
 the parent ReasoningEngine must have
 [ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig][google.cloud.aiplatform.v1beta1.ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig]
 set.
 

string search_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The searchQuery.

getSearchQueryBytes

com.google.protobuf.ByteString getSearchQueryBytes()

 Required. Query to use for similarity search retrieval. If provided, then
 the parent ReasoningEngine must have
 [ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig][google.cloud.aiplatform.v1beta1.ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig]
 set.
 

string search_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for searchQuery.

getTopK

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:

The topK.