Class RetrieveMemoriesRequest (3.68.0)

public final class RetrieveMemoriesRequest extends GeneratedMessageV3 implements RetrieveMemoriesRequestOrBuilder

Request message for MemoryBankService.RetrieveMemories.

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

SIMILARITY_SEARCH_PARAMS_FIELD_NUMBER

public static final int SIMILARITY_SEARCH_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

SIMPLE_RETRIEVAL_PARAMS_FIELD_NUMBER

public static final int SIMPLE_RETRIEVAL_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RetrieveMemoriesRequest getDefaultInstance()
Returns
Type Description
RetrieveMemoriesRequest

getDescriptor()

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

newBuilder()

public static RetrieveMemoriesRequest.Builder newBuilder()
Returns
Type Description
RetrieveMemoriesRequest.Builder

newBuilder(RetrieveMemoriesRequest prototype)

public static RetrieveMemoriesRequest.Builder newBuilder(RetrieveMemoriesRequest prototype)
Parameter
Name Description
prototype RetrieveMemoriesRequest
Returns
Type Description
RetrieveMemoriesRequest.Builder

parseDelimitedFrom(InputStream input)

public static RetrieveMemoriesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RetrieveMemoriesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetrieveMemoriesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetrieveMemoriesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RetrieveMemoriesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RetrieveMemoriesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetrieveMemoriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveMemoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RetrieveMemoriesRequest> parser()
Returns
Type Description
Parser<RetrieveMemoriesRequest>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RetrieveMemoriesRequest getDefaultInstanceForType()
Returns
Type Description
RetrieveMemoriesRequest

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.

getParserForType()

public Parser<RetrieveMemoriesRequest> getParserForType()
Returns
Type Description
Parser<RetrieveMemoriesRequest>
Overrides

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetrieveMemoriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RetrieveMemoriesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException