Class RetrieveMemoriesRequest.Builder (3.68.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RetrieveMemoriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

build()

public RetrieveMemoriesRequest build()
Returns
Type Description
RetrieveMemoriesRequest

buildPartial()

public RetrieveMemoriesRequest buildPartial()
Returns
Type Description
RetrieveMemoriesRequest

clear()

public RetrieveMemoriesRequest.Builder clear()
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RetrieveMemoriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RetrieveMemoriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

clearParent()

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) = { ... }

Returns
Type Description
RetrieveMemoriesRequest.Builder

This builder for chaining.

clearRetrievalParams()

public RetrieveMemoriesRequest.Builder clearRetrievalParams()
Returns
Type Description
RetrieveMemoriesRequest.Builder

clearScope()

public RetrieveMemoriesRequest.Builder clearScope()
Returns
Type Description
RetrieveMemoriesRequest.Builder

clearSimilaritySearchParams()

public RetrieveMemoriesRequest.Builder clearSimilaritySearchParams()

Parameters for semantic similarity search based retrieval.

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

Returns
Type Description
RetrieveMemoriesRequest.Builder

clearSimpleRetrievalParams()

public RetrieveMemoriesRequest.Builder clearSimpleRetrievalParams()

Parameters for simple (non-similarity search) retrieval.

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

Returns
Type Description
RetrieveMemoriesRequest.Builder

clone()

public RetrieveMemoriesRequest.Builder clone()
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

containsScope(String key)

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
Returns
Type Description
boolean

getDefaultInstanceForType()

public RetrieveMemoriesRequest getDefaultInstanceForType()
Returns
Type Description
RetrieveMemoriesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableScope() (deprecated)

public Map<String,String> getMutableScope()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getParent()

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.

getParentBytes()

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.

getRetrievalParamsCase()

public RetrieveMemoriesRequest.RetrievalParamsCase getRetrievalParamsCase()
Returns
Type Description
RetrieveMemoriesRequest.RetrievalParamsCase

getScope() (deprecated)

public Map<String,String> getScope()

Use #getScopeMap() instead.

Returns
Type Description
Map<String,String>

getScopeCount()

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

getScopeMap()

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];

Returns
Type Description
Map<String,String>

getScopeOrDefault(String key, String defaultValue)

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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getScopeOrThrow(String key)

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

getSimilaritySearchParams()

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

getSimilaritySearchParamsBuilder()

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder getSimilaritySearchParamsBuilder()

Parameters for semantic similarity search based retrieval.

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

Returns
Type Description
RetrieveMemoriesRequest.SimilaritySearchParams.Builder

getSimilaritySearchParamsOrBuilder()

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

getSimpleRetrievalParamsBuilder()

public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder getSimpleRetrievalParamsBuilder()

Parameters for simple (non-similarity search) retrieval.

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams.Builder

getSimpleRetrievalParamsOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

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)

internalGetMutableMapFieldReflection(int number)

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)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RetrieveMemoriesRequest other)

public RetrieveMemoriesRequest.Builder mergeFrom(RetrieveMemoriesRequest other)
Parameter
Name Description
other RetrieveMemoriesRequest
Returns
Type Description
RetrieveMemoriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RetrieveMemoriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RetrieveMemoriesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

mergeSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams value)

public RetrieveMemoriesRequest.Builder mergeSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams value)

Parameters for semantic similarity search based retrieval.

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

Parameter
Name Description
value RetrieveMemoriesRequest.SimilaritySearchParams
Returns
Type Description
RetrieveMemoriesRequest.Builder

mergeSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams value)

public RetrieveMemoriesRequest.Builder mergeSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams value)

Parameters for simple (non-similarity search) retrieval.

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

Parameter
Name Description
value RetrieveMemoriesRequest.SimpleRetrievalParams
Returns
Type Description
RetrieveMemoriesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RetrieveMemoriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

putAllScope(Map<String,String> values)

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];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
RetrieveMemoriesRequest.Builder

putScope(String key, String value)

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];

Parameters
Name Description
key String
value String
Returns
Type Description
RetrieveMemoriesRequest.Builder

removeScope(String key)

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
Returns
Type Description
RetrieveMemoriesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RetrieveMemoriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

setParent(String value)

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.

Returns
Type Description
RetrieveMemoriesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

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.

Returns
Type Description
RetrieveMemoriesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RetrieveMemoriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

setSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams value)

public RetrieveMemoriesRequest.Builder setSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams value)

Parameters for semantic similarity search based retrieval.

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams similarity_search_params = 6;

Parameter
Name Description
value RetrieveMemoriesRequest.SimilaritySearchParams
Returns
Type Description
RetrieveMemoriesRequest.Builder

setSimilaritySearchParams(RetrieveMemoriesRequest.SimilaritySearchParams.Builder builderForValue)

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;

Parameter
Name Description
builderForValue RetrieveMemoriesRequest.SimilaritySearchParams.Builder
Returns
Type Description
RetrieveMemoriesRequest.Builder

setSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams value)

public RetrieveMemoriesRequest.Builder setSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams value)

Parameters for simple (non-similarity search) retrieval.

.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams simple_retrieval_params = 7;

Parameter
Name Description
value RetrieveMemoriesRequest.SimpleRetrievalParams
Returns
Type Description
RetrieveMemoriesRequest.Builder

setSimpleRetrievalParams(RetrieveMemoriesRequest.SimpleRetrievalParams.Builder builderForValue)

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;

Parameter
Name Description
builderForValue RetrieveMemoriesRequest.SimpleRetrievalParams.Builder
Returns
Type Description
RetrieveMemoriesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RetrieveMemoriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides