- 3.79.0 (latest)
 - 3.77.0
 - 3.76.0
 - 3.75.0
 - 3.74.0
 - 3.73.0
 - 3.71.0
 - 3.69.0
 - 3.68.0
 - 3.65.0
 - 3.64.0
 - 3.63.0
 - 3.61.0
 - 3.60.0
 - 3.59.0
 - 3.58.0
 - 3.57.0
 - 3.56.0
 - 3.55.0
 - 3.54.0
 - 3.53.0
 - 3.52.0
 - 3.50.0
 - 3.49.0
 - 3.48.0
 - 3.47.0
 - 3.46.0
 - 3.45.0
 - 3.44.0
 - 3.43.0
 - 3.42.0
 - 3.41.0
 - 3.40.0
 - 3.38.0
 - 3.37.0
 - 3.36.0
 - 3.35.0
 - 3.34.0
 - 3.33.0
 - 3.32.0
 - 3.31.0
 - 3.30.0
 - 3.29.0
 - 3.28.0
 - 3.25.0
 - 3.24.0
 - 3.23.0
 - 3.22.0
 - 3.21.0
 - 3.20.0
 - 3.19.0
 - 3.18.0
 - 3.17.0
 - 3.16.0
 - 3.15.0
 - 3.14.0
 - 3.13.0
 - 3.12.0
 - 3.11.0
 - 3.10.0
 - 3.9.0
 - 3.8.0
 - 3.7.0
 - 3.6.0
 - 3.5.0
 - 3.4.2
 - 3.3.0
 - 3.2.0
 - 3.0.0
 - 2.9.8
 - 2.8.9
 - 2.7.4
 - 2.5.3
 - 2.4.0
 
public interface RetrieveMemoriesRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsScope(String key)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
getParent()
public abstract 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 | |
|---|---|
| Type | Description | 
String | 
        The parent.  | 
      
getParentBytes()
public abstract 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 | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for parent.  | 
      
getRetrievalParamsCase()
public abstract RetrieveMemoriesRequest.RetrievalParamsCase getRetrievalParamsCase()| Returns | |
|---|---|
| Type | Description | 
RetrieveMemoriesRequest.RetrievalParamsCase | 
        |
getScope() (deprecated)
public abstract Map<String,String> getScope()Use #getScopeMap() instead.
| Returns | |
|---|---|
| Type | Description | 
Map<String,String> | 
        |
getScopeCount()
public abstract 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];
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getScopeMap()
public abstract 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];
| Returns | |
|---|---|
| Type | Description | 
Map<String,String> | 
        |
getScopeOrDefault(String key, String defaultValue)
public abstract 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];
| Parameters | |
|---|---|
| Name | Description | 
key | 
        String | 
      
defaultValue | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
String | 
        |
getScopeOrThrow(String key)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
String | 
        |
getSimilaritySearchParams()
public abstract RetrieveMemoriesRequest.SimilaritySearchParams getSimilaritySearchParams()Parameters for semantic similarity search based retrieval.
 
 .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
 
| Returns | |
|---|---|
| Type | Description | 
RetrieveMemoriesRequest.SimilaritySearchParams | 
        The similaritySearchParams.  | 
      
getSimilaritySearchParamsOrBuilder()
public abstract RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder getSimilaritySearchParamsOrBuilder()Parameters for semantic similarity search based retrieval.
 
 .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
 
| Returns | |
|---|---|
| Type | Description | 
RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder | 
        |
getSimpleRetrievalParams()
public abstract RetrieveMemoriesRequest.SimpleRetrievalParams getSimpleRetrievalParams()Parameters for simple (non-similarity search) retrieval.
 
 .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
 
| Returns | |
|---|---|
| Type | Description | 
RetrieveMemoriesRequest.SimpleRetrievalParams | 
        The simpleRetrievalParams.  | 
      
getSimpleRetrievalParamsOrBuilder()
public abstract RetrieveMemoriesRequest.SimpleRetrievalParamsOrBuilder getSimpleRetrievalParamsOrBuilder()Parameters for simple (non-similarity search) retrieval.
 
 .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
 
| Returns | |
|---|---|
| Type | Description | 
RetrieveMemoriesRequest.SimpleRetrievalParamsOrBuilder | 
        |
hasSimilaritySearchParams()
public abstract boolean hasSimilaritySearchParams()Parameters for semantic similarity search based retrieval.
 
 .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the similaritySearchParams field is set.  | 
      
hasSimpleRetrievalParams()
public abstract boolean hasSimpleRetrievalParams()Parameters for simple (non-similarity search) retrieval.
 
 .google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the simpleRetrievalParams field is set.  |