Class RetrieveMemoriesRequest.SimilaritySearchParams (3.68.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RetrieveMemoriesRequest.SimilaritySearchParams

Static Fields

SEARCH_QUERY_FIELD_NUMBER

public static final int SEARCH_QUERY_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 RetrieveMemoriesRequest.SimilaritySearchParams getDefaultInstance()
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RetrieveMemoriesRequest.SimilaritySearchParams.Builder newBuilder()
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

newBuilder(RetrieveMemoriesRequest.SimilaritySearchParams prototype)

public static RetrieveMemoriesRequest.SimilaritySearchParams.Builder newBuilder(RetrieveMemoriesRequest.SimilaritySearchParams prototype)
Parameter
Name Description
prototype RetrieveMemoriesRequest.SimilaritySearchParams
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

parseDelimitedFrom(InputStream input)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RetrieveMemoriesRequest.SimilaritySearchParams> parser()
Returns
Type Description
Parser<SimilaritySearchParams>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RetrieveMemoriesRequest.SimilaritySearchParams getDefaultInstanceForType()
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams

getParserForType()

public Parser<RetrieveMemoriesRequest.SimilaritySearchParams> getParserForType()
Returns
Type Description
Parser<SimilaritySearchParams>
Overrides

getSearchQuery()

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.

getSearchQueryBytes()

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTopK()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder newBuilderForType()
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetrieveMemoriesRequest.SimilaritySearchParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder toBuilder()
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException