Vertex AI v1beta1 API - Class RetrieveMemoriesRequest.Types.SimilaritySearchParams (1.0.0-beta73)

Version latest

• 1.0.0-beta73 (latest)
• 1.0.0-beta72

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

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

Parameters for semantic similarity search based retrieval.

Inheritance

object > RetrieveMemoriesRequest.Types.SimilaritySearchParams

Implements

IMessageRetrieveMemoriesRequestTypesSimilaritySearchParams, IEquatableRetrieveMemoriesRequestTypesSimilaritySearchParams, IDeepCloneableRetrieveMemoriesRequestTypesSimilaritySearchParams, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

SimilaritySearchParams()

public SimilaritySearchParams()

SimilaritySearchParams(SimilaritySearchParams)

public SimilaritySearchParams(RetrieveMemoriesRequest.Types.SimilaritySearchParams other)

Parameter
Name	Description
other	RetrieveMemoriesRequestTypesSimilaritySearchParams

Properties

SearchQuery

public string SearchQuery { get; set; }

Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have [ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig][google.cloud.aiplatform.v1beta1.ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig] set.

Property Value
Type	Description
string

TopK

public int TopK { get; set; }

Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Property Value
Type	Description
int