Chat Memory

Categories: Artificial Intelligence

Type: chatMemory/v1

Actions

Add Messages

Name: addMessages

Adds messages to the chat memory for a conversation.

Properties

Name	Label	Type	Description	Required
conversationId	Conversation ID	STRING	The unique identifier for the conversation.	true
messages	Messages	ARRAY Items [{STRING(role), STRING(content)}]	The messages to add to the conversation.	true

Example JSON Structure

{
  "label" : "Add Messages",
  "name" : "addMessages",
  "parameters" : {
    "conversationId" : "",
    "messages" : [ {
      "role" : "",
      "content" : ""
    } ]
  },
  "type" : "chatMemory/v1/addMessages"
}

Output

Type: OBJECT

Properties

Name	Type	Description
conversationId	STRING
messageCount	INTEGER

Output Example

{
  "conversationId" : "",
  "messageCount" : 1
}

Get Messages

Name: getMessages

Retrieves all messages from a conversation.

Properties

Name	Label	Type	Description	Required
conversationId	Conversation ID	STRING	The unique identifier for the conversation.	true

Example JSON Structure

{
  "label" : "Get Messages",
  "name" : "getMessages",
  "parameters" : {
    "conversationId" : ""
  },
  "type" : "chatMemory/v1/getMessages"
}

Output

Type: OBJECT

Properties

Name	Type	Description
conversationId	STRING
messages	ARRAY Items [{STRING(role), STRING(content)}]

Output Example

{
  "conversationId" : "",
  "messages" : [ {
    "role" : "",
    "content" : ""
  } ]
}

Delete Conversation

Name: deleteConversation

Deletes all messages for a conversation.

Properties

Name	Label	Type	Description	Required
conversationId	Conversation ID	STRING	The unique identifier for the conversation to delete.	true

Example JSON Structure

{
  "label" : "Delete Conversation",
  "name" : "deleteConversation",
  "parameters" : {
    "conversationId" : ""
  },
  "type" : "chatMemory/v1/deleteConversation"
}

Output

Type: OBJECT

Properties

Name	Type	Description
conversationId	STRING
deleted	BOOLEAN Options true, false

Output Example

{
  "conversationId" : "",
  "deleted" : false
}

List Conversations

Name: listConversations

Lists all conversation IDs in the chat memory.

Example JSON Structure

{
  "label" : "List Conversations",
  "name" : "listConversations",
  "type" : "chatMemory/v1/listConversations"
}

Output

Type: OBJECT

Properties

Name	Type	Description
conversationIds	ARRAY Items [STRING]
count	INTEGER

Output Example

{
  "conversationIds" : [ "" ],
  "count" : 1
}

On this page