Class GoogleCloudAiplatformV1RetrieveMemoriesRequest

Request message for MemoryBankService.RetrieveMemories.

Inheritance

object

GoogleCloudAiplatformV1RetrieveMemoriesRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1.Data

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class GoogleCloudAiplatformV1RetrieveMemoriesRequest : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Filter

Optional. The standard list filter that will be applied to the retrieved memories. More detail in AIP-160. Supported fields: * fact * create_time * update_time * topics (i.e. topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES)

Declaration

[JsonProperty("filter")]
public virtual string Filter { get; set; }

Property Value

Type	Description
string

FilterGroups

Optional. Metadata filters that will be applied to the retrieved memories' metadata using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}] would be equivalent to the logical expression: (metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321")).

Declaration

[JsonProperty("filterGroups")]
public virtual IList<GoogleCloudAiplatformV1MemoryConjunctionFilter> FilterGroups { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1MemoryConjunctionFilter>

Scope

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.

Declaration

[JsonProperty("scope")]
public virtual IDictionary<string, string> Scope { get; set; }

Property Value

Type	Description
IDictionary<string, string>

SimilaritySearchParams

Parameters for semantic similarity search based retrieval.

Declaration

[JsonProperty("similaritySearchParams")]
public virtual GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams SimilaritySearchParams { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams

SimpleRetrievalParams

Parameters for simple (non-similarity search) retrieval.

Declaration

[JsonProperty("simpleRetrievalParams")]
public virtual GoogleCloudAiplatformV1RetrieveMemoriesRequestSimpleRetrievalParams SimpleRetrievalParams { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1RetrieveMemoriesRequestSimpleRetrievalParams

Implements

IDirectResponseSchema