Class RetrieveMemoriesRequest (1.122.0)

Version latest

• 1.122.0 (latest)
• 1.121.0
• 1.120.0
• 1.119.0
• 1.118.0
• 1.117.0
• 1.116.0
• 1.115.0
• 1.114.0
• 1.113.0
• 1.112.0
• 1.111.0
• 1.110.0
• 1.109.0
• 1.108.0
• 1.107.0
• 1.106.0
• 1.105.0
• 1.104.0
• 1.103.0
• 1.102.0
• 1.101.0
• 1.100.0
• 1.99.0
• 1.98.0
• 1.97.0
• 1.96.0
• 1.95.1
• 1.94.0
• 1.93.1
• 1.92.0
• 1.91.0
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.0
• 1.75.0
• 1.74.0
• 1.73.0
• 1.72.0
• 1.71.1
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.1
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

RetrieveMemoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for MemoryBankService.RetrieveMemories.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
similarity_search_params	google.cloud.aiplatform_v1beta1.types.RetrieveMemoriesRequest.SimilaritySearchParams Parameters for semantic similarity search based retrieval. This field is a member of oneof_ retrieval_params.
simple_retrieval_params	google.cloud.aiplatform_v1beta1.types.RetrieveMemoriesRequest.SimpleRetrievalParams Parameters for simple (non-similarity search) retrieval. This field is a member of oneof_ retrieval_params.
parent	str Required. The resource name of the ReasoningEngine to retrieve memories from. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
scope	MutableMapping[str, str] 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.

Classes

ScopeEntry

ScopeEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

SimilaritySearchParams

SimilaritySearchParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Parameters for semantic similarity search based retrieval.

SimpleRetrievalParams

SimpleRetrievalParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Parameters for simple (non-similarity search) retrieval.

Methods

RetrieveMemoriesRequest

RetrieveMemoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for MemoryBankService.RetrieveMemories.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields