A simple Rest API that allows for you GPT to save and recall snippets of data (memories). You can read my blog post explaining it in detail here: xkonti.tech

Demonstration

First conversation:

FirstConversation.png

What GPT sent do the API:

{
  "name": "Life Essence and Biological Processes",
  "description": "Explore the role of life essence in enabling biological processes, with a focus on how dimensional interference, particularly from the Incorporeal dimension, facilitates the existence of these processes. This exploration should delve into the complex interplay between the Physical and Incorporeal dimensions, examining how life essence acts as a crucial element in the emergence and sustenance of life in the Physical dimension.",
  "summary": "Expanding on the role of life essence in biological processes, emphasizing the interaction between the Physical and Incorporeal dimensions.",
  "reason": "To deepen the understanding of how life essence, influenced by dimensional interference, is essential for biological processes in the novel's universe."
}

Separate conversation somewhere in the future:

Second Conversation.png

Setup

There are several steps to set up the API:

  • deploy and configure the API
  • create the API key for your GPT
  • add an action for the API in you GPT
  • add prompt section to your GPT so that it can use it properly

Deploying the API on Val Town

Deploy your own memory API. You can fork the following Val to do it: https://www.val.town/v/xkonti/memoryApiExample

In the code configure the appropriate values:

  • apiName the name of your API - used in the Privacy Policy (eg. Memory API)
  • contactEmail - the email to provide for contact in the Privacy Policy (eg. some@email.com)
  • lastPolicyUpdate - the date the Privacy Policy was last updated (eg. 2023-11-28)
  • blobKeyPrefix - the prefix for the blob storage keys used by your API - more info below (eg. gpt:memories:)
  • apiKeyPrefix - the prefix for you API Keys secrets - more info below (eg. GPTMEMORYAPI_KEY_)

Create API keys

The Memory API is designed to serve multiple GPTs at the same time. Each GPT should have it's own unique name and API key.

The name is used for identifying the specific GPT and appended to both:

  • blobKeyPrefix- to maintain separate memory storage from other GPTs
  • apiKeyPrefix - to maintain separate API key for each GPT
  1. Please pick a unique alphanumeric name for your GPT. For example personaltrainer.
  2. Generate some alphanumeric API key for your GPT. For example Wrangle-Chapped-Monkhood4-Domain-Suspend
  3. Add a new secret to your Val.town secrets storage. The Key should be the picked name prefixed by apiKeyPrefix. Using the default it would be GPTMEMORYAPI_KEY_personaltrainer. The value of the secret should be the API key itself.

The memories of the GPT will be stored in the blob storage under the key blobKeyPrefix + name, for example: gpt:memories:personaltrainer.

Adding GPT action

  1. Add a new action in your GPT.
  2. Get the OpenAPI spefication by calling the /openapi endpoint of your API
  3. Change all <APIURL> instances within the specification to the url of your deployed API. For example https://xkonti-memoryapiexample.web.val.run
  4. Set the authentication method to basic and provide a base64 encoded version of the <name>:<apiKey>. For example: personaltrainer:Wrangle-Chapped-Monkhood4-Domain-Suspend -> cGVyc29uYWx0cmFpbmVyOldyYW5nbGUtQ2hhcHBlZC1Nb25raG9vZDQtRG9tYWluLVN1c3BlbmQ=
  5. Add the link to the privacy policy, which is the /privacy endpoint of your API. For example: https://xkonti-memoryapiexample.web.val.run/privacy

Adding the prompt section

To make your GPT understand the usage of your new action you should include usage instruction in your prompt. Here's an example of such instructions section:

# Long-term memory

At some point the user might ask you to do something with "memory". Things like "remember", "save to memory", "forget", "update memory", etc. Please use corresponding actions to achieve those tasks. User might also ask you to perform some task with the context of your "memory" - in that case fetch all memories before proceeding with the task. The memories should be formed in a clear and purely informative language, void of unnecessary adjectives or decorative language forms. An exception to that rule might be a case when the language itself is the integral part of information (snippet of writing to remember for later, examples of some specific language forms, quotes, etc.).

Structure of a memory:
- name - a simple name of the memory to give it context at a glance
- description - a detailed description of the thing that should be remembered. There is no length limit.
- summary - a short summary of the memory. This should be formed in a way that will allow for ease of understanding which memories to retrieve in full detail just by reading the list of summaries. If there are some simple facts that have to be remembered and are the main point of the memory they should be included in the summary. The summary should also be written in a compressed way with all unnecessary words skipped if possible (more like a set of keywords or a Google Search input).
- reason - the reason for the remembering - this should give extra information about the situation in which the memory was requested to be saved.

The memory accessed through those actions is a long-term memory persistent between various conversations with the user. You can assume that there already are many memories available for retrieval.

In some situations you might want to save some information to your memory for future recall. Do it in situations where you expect that some important details of the conversation might be lost and should be preserved.

Analogously you can retrieve memories at any point if the task at hand suggests the need or there isn't much information about the subject in your knowledge base.
Readme
Fork
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
import * as uuid from "https://deno.land/std/uuid/mod.ts";
import { blob } from "https://esm.town/v/std/blob";
import { getPolicy } from "https://esm.town/v/xkonti/memoryApiPolicy";
import { Hono } from "npm:hono@3";
export const handleMemoryApiRequest = async (
req: Request,
apiName: string,
contactEmail: string,
lastPolicyUpdate: string,
blobKeyPrefix: string,
apiKeyPrefix: string,
) => {
// ==== HELPERS ====
const getMemoriesKey = (key: string): string => {
return `${blobKeyPrefix}${key}`;
};
const getMemories = async (key: string) => {
return await blob.getJSON(getMemoriesKey(key), []);
};
const setMemories = async (memories: any, key: string) => {
await blob.setJSON(getMemoriesKey(key), memories);
};
const verifyRequest = (c): { memoriesKey: string; error: any } => {
// Verify API key coming as a Bearer header
const authHeader = c.req.headers.get("Authorization");
if (!authHeader || !authHeader.startsWith("Basic ")) {
console.error("Missing or invalid authorization header");
return { memoriesKey: "", error: c.text("Unauthorized", 401) };
}
// Extract and decode the base64 encoded credentials
const base64Credentials = authHeader.split(" ")[1];
const credentials = atob(base64Credentials);
// Split into user and password
const [key, token] = credentials.split(":");
if (key == null || key === "") {
console.error("No memory key in authorization header");
return { memoriesKey: "", error: c.text("Forbidden", 403) };
}
const expectedKey = Deno.env.get(apiKeyPrefix + key) ?? null;
if (token !== expectedKey) {
console.error("Invalid API KEY header");
return { memoriesKey: "", error: c.text("Forbidden", 403) };
}
return { memoriesKey: key, error: null };
👆 This is a val. Vals are TypeScript snippets of code, written in the browser and run on our servers. Create scheduled functions, email yourself, and persist small pieces of data — all from the browser.