REST Resource: projects.locations.reasoningEngines.memories

Resource: Memory

A memory.

Fields
name string

Identifier. The resource name of the Memory. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}/memories/{memory}

displayName string

Optional. Display name of the Memory.

description string

Optional. description of the Memory.

createTime string (Timestamp format)

Output only. timestamp when this Memory was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Output only. timestamp when this Memory was most recently updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

fact string

Required. Semantic knowledge extracted from the source content.

scope map (key: string, value: string)

Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. scope values cannot contain the wildcard character '*'.

topics[] object (MemoryTopicId)

Optional. The Topics of the Memory.

revisionLabels map (key: string, value: string)

Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.

metadata map (key: string, value: object (MemoryMetadataValue))

Optional. user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.

expiration Union type
The expiration of the Memory. If not set, the Memory will not be automatically deleted. expiration can be only one of the following:
expireTime string (Timestamp format)

Optional. timestamp of when this resource is considered expired. This is always provided on output when expiration is set on input, regardless of whether expireTime or ttl was provided.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

ttl string (Duration format)

Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

revision_expiration Union type
(Input-only)The expiration of the Memory Revision created as a result of this request. If not set, Memory Bank will defer to MemoryBankConfig.memory_revision_default_ttl or the global default, 365 days. revision_expiration can be only one of the following:
revisionExpireTime string (Timestamp format)

Optional. Input only. timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

revisionTtl string (Duration format)

Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

disableMemoryRevisions boolean

Optional. Input only. If true, no revision will be created for this request.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "fact": string,
  "scope": {
    string: string,
    ...
  },
  "topics": [
    {
      object (MemoryTopicId)
    }
  ],
  "revisionLabels": {
    string: string,
    ...
  },
  "metadata": {
    string: {
      object (MemoryMetadataValue)
    },
    ...
  },

  // expiration
  "expireTime": string,
  "ttl": string
  // Union type

  // revision_expiration
  "revisionExpireTime": string,
  "revisionTtl": string,
  "disableMemoryRevisions": boolean
  // Union type
}

MemoryMetadataValue

Memory metadata.

Fields
value Union type
The value of the metadata. value can be only one of the following:
stringValue string

String value.

doubleValue number

Double value.

boolValue boolean

Boolean value.

timestampValue string (Timestamp format)

timestamp value. When filtering on timestamp values, only the seconds field will be compared.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

JSON representation
{

  // value
  "stringValue": string,
  "doubleValue": number,
  "boolValue": boolean,
  "timestampValue": string
  // Union type
}

Methods

create

Create a Memory.

delete

Delete a Memory.

generate

Generate memories.

get

Get a Memory.

list

List Memories.

patch

Update a Memory.

purge

Purge memories.

retrieve

Retrieve memories.

rollback

Rollback Memory to a specific revision.