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. |