public static final class RetrieveMemoriesRequest.Builder extends GeneratedMessageV3.Builder<RetrieveMemoriesRequest.Builder> implements RetrieveMemoriesRequestOrBuilder
Request message for
MemoryBankService.RetrieveMemories.
Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public RetrieveMemoriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public RetrieveMemoriesRequest build()
public RetrieveMemoriesRequest buildPartial()
public RetrieveMemoriesRequest.Builder clear()
Overrides
public RetrieveMemoriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public RetrieveMemoriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public RetrieveMemoriesRequest.Builder clearParent()
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) = { ... }
public RetrieveMemoriesRequest.Builder clearRetrievalParams()
public RetrieveMemoriesRequest.Builder clearScope()
public RetrieveMemoriesRequest.Builder clearSimilaritySearchParams()
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest.Builder clearSimpleRetrievalParams()
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
public RetrieveMemoriesRequest.Builder clone()
Overrides
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 RetrieveMemoriesRequest getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
public Map<String,String> getMutableScope()
Use alternate mutation accessors instead.
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 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 RetrieveMemoriesRequest.SimilaritySearchParams getSimilaritySearchParams()
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder getSimilaritySearchParamsBuilder()
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.SimpleRetrievalParams.Builder getSimpleRetrievalParamsBuilder()
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.
|
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.Builder.internalGetMapFieldReflection(int)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public RetrieveMemoriesRequest.Builder mergeFrom(RetrieveMemoriesRequest other)
public RetrieveMemoriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public RetrieveMemoriesRequest.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public RetrieveMemoriesRequest.Builder mergeSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams value)
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest.Builder mergeSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams value)
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
public final RetrieveMemoriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public RetrieveMemoriesRequest.Builder putAllScope(Map<String,String> values)
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 RetrieveMemoriesRequest.Builder putScope(String key, String value)
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 RetrieveMemoriesRequest.Builder removeScope(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 RetrieveMemoriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public RetrieveMemoriesRequest.Builder setParent(String value)
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) = { ... }
| Parameter |
| Name |
Description |
value |
String
The parent to set.
|
public RetrieveMemoriesRequest.Builder setParentBytes(ByteString value)
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) = { ... }
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for parent to set.
|
public RetrieveMemoriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public RetrieveMemoriesRequest.Builder setSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams value)
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest.Builder setSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams.Builder builderForValue)
Parameters for semantic similarity search based retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;
public RetrieveMemoriesRequest.Builder setSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams value)
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
public RetrieveMemoriesRequest.Builder setSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams.Builder builderForValue)
Parameters for simple (non-similarity search) retrieval.
.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;
public final RetrieveMemoriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
