Package com.google.cloud.aiplatform.v1beta1

Class RetrieveMemoriesRequest.SimilaritySearchParams.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder>
com.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams.Builder
All Implemented Interfaces:
RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RetrieveMemoriesRequest.SimilaritySearchParams
public static final class RetrieveMemoriesRequest.SimilaritySearchParams.Builder extends com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder> implements RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder
 Parameters for semantic similarity search based retrieval.
Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder>

    • clear

      public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder>

    • getDefaultInstanceForType

      public RetrieveMemoriesRequest.SimilaritySearchParams getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public RetrieveMemoriesRequest.SimilaritySearchParams build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RetrieveMemoriesRequest.SimilaritySearchParams buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder>

    • mergeFrom

      public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(RetrieveMemoriesRequest.SimilaritySearchParams other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder>

    • mergeFrom

      public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder>
      Throws:
      IOException

    • getSearchQuery

      public 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];
      Specified by:
      getSearchQuery in interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder
      Returns:
      The searchQuery.

    • getSearchQueryBytes

      public 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];
      Specified by:
      getSearchQueryBytes in interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder
      Returns:
      The bytes for searchQuery.

    • setSearchQuery

      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][google.cloud.aiplatform.v1beta1.ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig]
 set.
      string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The searchQuery to set.
      Returns:
      This builder for chaining.

    • 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][google.cloud.aiplatform.v1beta1.ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig]
 set.
      string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setSearchQueryBytes

      public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setSearchQueryBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for searchQuery to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getTopK in interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder
      Returns:
      The topK.

    • setTopK

      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];
      Parameters:
      value - The topK to set.
      Returns:
      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:
      This builder for chaining.