Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

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

Implements

RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`RetrieveMemoriesRequest.SimilaritySearchParams.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`RetrieveMemoriesRequest.SimilaritySearchParams.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public RetrieveMemoriesRequest.SimilaritySearchParams getDefaultInstanceForType()

Returns
Type	Description
`RetrieveMemoriesRequest.SimilaritySearchParams`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RetrieveMemoriesRequest.SimilaritySearchParams.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)