public final class RetrieveMemoriesRequest extends GeneratedMessageV3 implements RetrieveMemoriesRequestOrBuilder
Request message for
MemoryBankService.RetrieveMemories.
Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SCOPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SIMILARITY_SEARCH_PARAMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SIMPLE_RETRIEVAL_PARAMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static RetrieveMemoriesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static RetrieveMemoriesRequest.Builder newBuilder()
public static RetrieveMemoriesRequest.Builder newBuilder(RetrieveMemoriesRequest prototype)
public static RetrieveMemoriesRequest parseDelimitedFrom(InputStream input)
public static RetrieveMemoriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RetrieveMemoriesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static RetrieveMemoriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RetrieveMemoriesRequest parseFrom(ByteString data)
public static RetrieveMemoriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RetrieveMemoriesRequest parseFrom(CodedInputStream input)
public static RetrieveMemoriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RetrieveMemoriesRequest parseFrom(InputStream input)
public static RetrieveMemoriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RetrieveMemoriesRequest parseFrom(ByteBuffer data)
public static RetrieveMemoriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<RetrieveMemoriesRequest> parser()
Methods
public 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
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public RetrieveMemoriesRequest getDefaultInstanceForType()
public 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.
|
public 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.
|
public Parser<RetrieveMemoriesRequest> getParserForType()
Overrides
public RetrieveMemoriesRequest.RetrievalParamsCase getRetrievalParamsCase()
public Map<String,String> getScope()
public 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 |
|
public 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];
public 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];
| Returns |
| Type |
Description |
String |
|
public 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 |
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public RetrieveMemoriesRequest.SimilaritySearchParams getSimilaritySearchParams()
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder getSimilaritySearchParamsOrBuilder()
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest.SimpleRetrievalParams getSimpleRetrievalParams()
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
public RetrieveMemoriesRequest.SimpleRetrievalParamsOrBuilder getSimpleRetrievalParamsOrBuilder()
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
public 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.
|
public 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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public RetrieveMemoriesRequest.Builder newBuilderForType()
protected RetrieveMemoriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public RetrieveMemoriesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
