Vertex AI v1beta1 API - Class RetrieveMemoriesRequest (1.0.0-beta61)

Version latest

• 1.0.0-beta61 (latest)
• 1.0.0-beta60

public sealed class RetrieveMemoriesRequest : IMessage<RetrieveMemoriesRequest>, IEquatable<RetrieveMemoriesRequest>, IDeepCloneable<RetrieveMemoriesRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1beta1 API class RetrieveMemoriesRequest.

Request message for [MemoryBankService.RetrieveMemories][google.cloud.aiplatform.v1beta1.MemoryBankService.RetrieveMemories].

Inheritance

object > RetrieveMemoriesRequest

Implements

IMessageRetrieveMemoriesRequest, IEquatableRetrieveMemoriesRequest, IDeepCloneableRetrieveMemoriesRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

RetrieveMemoriesRequest()

public RetrieveMemoriesRequest()

RetrieveMemoriesRequest(RetrieveMemoriesRequest)

public RetrieveMemoriesRequest(RetrieveMemoriesRequest other)

Parameter
Name	Description
other	RetrieveMemoriesRequest

Properties

Parent

public string Parent { get; set; }

Required. The resource name of the ReasoningEngine to retrieve memories from. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Property Value
Type	Description
string

ParentAsReasoningEngineName

public ReasoningEngineName ParentAsReasoningEngineName { get; set; }

ReasoningEngineName-typed view over the Parent resource name property.

Property Value
Type	Description
ReasoningEngineName

RetrievalParamsCase

public RetrieveMemoriesRequest.RetrievalParamsOneofCase RetrievalParamsCase { get; }

Property Value
Type	Description
RetrieveMemoriesRequestRetrievalParamsOneofCase

Scope

public MapField<string, string> Scope { get; }

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.

Property Value
Type	Description
MapFieldstringstring

SimilaritySearchParams

public RetrieveMemoriesRequest.Types.SimilaritySearchParams SimilaritySearchParams { get; set; }

Parameters for semantic similarity search based retrieval.

Property Value
Type	Description
RetrieveMemoriesRequestTypesSimilaritySearchParams

SimpleRetrievalParams

public RetrieveMemoriesRequest.Types.SimpleRetrievalParams SimpleRetrievalParams { get; set; }

Parameters for simple (non-similarity search) retrieval.

Property Value
Type	Description
RetrieveMemoriesRequestTypesSimpleRetrievalParams