Class RetrieveMemoriesRequest.SimilaritySearchParams.Builder (3.68.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

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

build()

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

buildPartial()

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

clear()

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clear()
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

clearSearchQuery()

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];

Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

This builder for chaining.

clearTopK()

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];

Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

This builder for chaining.

clone()

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clone()
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RetrieveMemoriesRequest.SimilaritySearchParams other)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(RetrieveMemoriesRequest.SimilaritySearchParams other)
Parameter
Name Description
other RetrieveMemoriesRequest.SimilaritySearchParams
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides

setSearchQuery(String value)

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.

Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

This builder for chaining.

setSearchQueryBytes(ByteString value)

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.

Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

This builder for chaining.

setTopK(int value)

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.

Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RetrieveMemoriesRequest.SimilaritySearchParams.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Overrides