Interface RetrieveMemoriesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RetrieveMemoriesRequest, RetrieveMemoriesRequest.Builder

@Generated public interface RetrieveMemoriesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • hasSimilaritySearchParams

      boolean hasSimilaritySearchParams()
       Parameters for semantic similarity search based retrieval.
       
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
      Returns:
      Whether the similaritySearchParams field is set.
    • getSimilaritySearchParams

       Parameters for semantic similarity search based retrieval.
       
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
      Returns:
      The similaritySearchParams.
    • getSimilaritySearchParamsOrBuilder

      RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder getSimilaritySearchParamsOrBuilder()
       Parameters for semantic similarity search based retrieval.
       
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
    • hasSimpleRetrievalParams

      boolean hasSimpleRetrievalParams()
       Parameters for simple (non-similarity search) retrieval.
       
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
      Returns:
      Whether the simpleRetrievalParams field is set.
    • getSimpleRetrievalParams

       Parameters for simple (non-similarity search) retrieval.
       
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
      Returns:
      The simpleRetrievalParams.
    • getSimpleRetrievalParamsOrBuilder

      RetrieveMemoriesRequest.SimpleRetrievalParamsOrBuilder getSimpleRetrievalParamsOrBuilder()
       Parameters for simple (non-similarity search) retrieval.
       
      .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
    • getParent

      String getParent()
       Required. The resource name of the ReasoningEngine to retrieve memories
       from. Format:
       `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.
    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the ReasoningEngine to retrieve memories
       from. Format:
       `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.
    • getScopeCount

      int getScopeCount()
       Required. The scope of the memories to retrieve. A memory must have
       exactly the same scope (`Memory.scope`) as the scope provided here to be
       retrieved (same keys and values). Order does not matter, but it is
       case-sensitive.
       
      map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];
    • containsScope

      boolean containsScope(String key)
       Required. The scope of the memories to retrieve. A memory must have
       exactly the same scope (`Memory.scope`) as the scope provided here to be
       retrieved (same keys and values). Order does not matter, but it is
       case-sensitive.
       
      map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];
    • getScope

      Deprecated.
      Use getScopeMap() instead.
    • getScopeMap

      Map<String,String> getScopeMap()
       Required. The scope of the memories to retrieve. A memory must have
       exactly the same scope (`Memory.scope`) as the scope provided here to be
       retrieved (same keys and values). Order does not matter, but it is
       case-sensitive.
       
      map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];
    • getScopeOrDefault

      String getScopeOrDefault(String key, String defaultValue)
       Required. The scope of the memories to retrieve. A memory must have
       exactly the same scope (`Memory.scope`) as the scope provided here to be
       retrieved (same keys and values). Order does not matter, but it is
       case-sensitive.
       
      map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];
    • getScopeOrThrow

      String getScopeOrThrow(String key)
       Required. The scope of the memories to retrieve. A memory must have
       exactly the same scope (`Memory.scope`) as the scope provided here to be
       retrieved (same keys and values). Order does not matter, but it is
       case-sensitive.
       
      map<string, string> scope = 8 [(.google.api.field_behavior) = REQUIRED];
    • getRetrievalParamsCase