Quick Start - Memory

Updated as of 2023-Jun-24

In this example, we will create an AI chatbot with memory.

1. Add your OpenAI API key

  • Go to the Dashboard and submit your OpenAI API Key.

2. Get an API Key

3. Create a chat

  • Chats are used to organize conversational memory.

  • All POST requests can accept the optional String parameters: reference_id and name.

    • These are not used by DopplerAI. They are for your reference only.

    • You may find them useful to organize chats. For example, assigning a user id to reference_id or a category to name.

    • The only exception is the POST /messages API endpoint, which does not have those parameters.

4. Send a message with memory enabled

  • Here we send a message to the LLM with access to conversational memory.

  • You have the option to specify memory for the LLM.

    • When you set 'memorize': True, the conversation from this API request will be saved into the chat.

    • When you set 'remember': True, the LLM will be able to access past memories that were previously saved into the chat.

  • This API endpoint returns a dictionary with the following format.

    • {'completion': { ... }, 'uuid': ..., 'created_at': ...}

    • 'completion' is OpenAI's response.

    • 'uuid' and created_at are metadata from DopplerAI. These fields will return None if the memorize parameter is set to False.

Last updated

Was this helpful?